v1.2.0

Separate comicapi into it's own package
Add support for tar files
Insert standard gitignore
Use suggested _version from setuptools-scm
Cleanup setup.py

Fix formatting in the rename template help

.flake8

@@ -1,4 +0,0 @@
-[flake8]
-max-line-length = 120
-extend-ignore = E203, E501, E722
-extend-exclude = venv, scripts

.github/workflows/build.yaml

@@ -1,63 +0,0 @@
-name: Build
-
-on:
-  push:
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+*"
-  pull_request:
-
-jobs:
-  build:
-    permissions:
-      contents: write
-
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        python-version: [3.9]
-        os: [ubuntu-latest, macos-10.15, windows-latest]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python3 -m pip install -r requirements_dev.txt
-          python3 -m pip install -r requirements.txt
-          for requirement in requirements-*.txt; do
-            python3 -m pip install -r "$requirement"
-          done
-        shell: bash
-      - name: Install Windows dependencies
-        run: |
-          choco install -y zip
-        if: runner.os == 'Windows'
-      - name: build
-        run: |
-          make pydist
-          make dist
-      - name: Archive production artifacts
-        uses: actions/upload-artifact@v2
-        if: runner.os != 'Linux' # linux binary currently has a segfault when running on latest fedora
-        with:
-          name: "${{ format('ComicTagger-{0}', runner.os) }}"
-          path: dist/*.zip
-
-      - name: Release
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          prerelease: "${{ contains(github.ref, '-') }}" # alpha-releases should be 1.3.0-alpha.x full releases should be 1.3.0
-          draft: true
-          files: dist/*.zip
-      - name: "Publish distribution 📦 to PyPI"
-        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'Linux'
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
-          packages_dir: piprelease

.gitignore

@@ -1,6 +1,3 @@
-# generated by setuptools_scm
-ctversion.py
-
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion
 
 *.iml

.travis.yml

@@ -1,59 +0,0 @@
-language: python
-# Only build tags
-if: type = pull_request OR tag IS present
-branches:
-  only:
-    - develop
-    - /^\d+\.\d+\.\d+.*$/
-env:
-  global:
-    - PYTHON=python3
-    - PIP=pip3
-    - SETUPTOOLS_SCM_PRETEND_VERSION=$TRAVIS_TAG
-    - MAKE=make
-matrix:
-  include:
-    - os: linux
-      python: 3.8
-    - name: "Python: 3.7"
-      os: osx
-      language: shell
-      python: 3.7
-      env: PYTHON=python3 PIP="python3 -m pip"
-      cache:
-        - directories:
-          - $HOME/Library/Caches/pip
-    - os: windows
-      language: bash
-      env: PATH=/C/Python37:/C/Python37/Scripts:$PATH MAKE=mingw32-make PIP=pip PYTHON=python
-before_install:
-  - if [ "$TRAVIS_OS_NAME" = "windows" ]; then choco install -y python --version 3.7.9; choco install -y mingw zip; fi
-install:
-  - $PIP install -r requirements_dev.txt
-  - $PIP install -r requirements-GUI.txt
-  - $PIP install -r requirements-CBR.txt
-script:
-  - if [ "$TRAVIS_OS_NAME" != "linux" ]; then $MAKE dist ; fi
-
-deploy:
-  - name: "$TRAVIS_TAG"
-    body: Released ComicTagger $TRAVIS_TAG
-    provider: releases
-    skip_cleanup: true
-    api_key:
-      secure: RgohcOJOfLhXXT12bMWaLwOqhe+ClSCYXjYuUJuWK4/E1fdd1xu1ebdQU+MI/R8cZ0Efz3sr2n3NkO/Aa8gN68xEfuF7RVRMm64P9oPrfZgGdsD6H43rU/6kN8bgaDRmCYpLTfXaJ+/gq0x1QDkhWJuceF2BYEGGvL0BvS/TUsLyjVxs8ujTplLyguXHNEv4/7Yz7SBNZZmUHjBuq/y+l8ds3ra9rSgAVAN1tMXoFKJPv+SNNkpTo5WUNMPzBnN041F1rzqHwYDLog2V7Krp9JkXzheRFdAr51/tJBYzEd8AtYVdYvaIvoO6A4PiTZ7MpsmcZZPAWqLQU00UTm/PhT/LVR+7+f8lOBG07RgNNHB+edjDRz3TAuqyuZl9wURWTZKTPuO49TkZMz7Wm0DRNZHvBm1IXLeSG7Tll2YL1+WpZNZg+Dhro2J1QD3vxDXafhMdTCB4z0q5aKpG93IT0p6oXOO0oEGOPZYbA2c5R3SXWSyqd1E1gdhbVjIZr59h++TEf1zz07tvWHqPuAF/Ly/j+dIcY2wj0EzRWaSASWgUpTnMljAkHtWhqDw4GXGDRkRUWRJl1d0/JyVqCeIdRzDQNl8/q7BcO3F1zqr1PgnYdz0lfwWxL1/ekw2vHOJE/GOdkyvX0aJrnaOV338mjJbfGHYv4ESc9ow1kdtIbiU=
-    file_glob: true
-    file: dist/*.zip
-    draft: true
-    on:
-      tags: true
-      condition: $TRAVIS_OS_NAME != "linux"
-  - provider: pypi
-    user: __token__
-    password:
-      secure: h+y5WkE8igf864dnsbGPFvOBkyPkuBYtnDRt+EgxHd71EZnV2YP7ns2Cx12su/SVVDdZCBlmHVtkhl6Jmqy+0rTkSYx+3mlBOqyl8Cj5+BlP/dP7Bdmhs2uLZk2YYL1avbC0A6eoNJFtCkjurnB/jCGE433rvMECWJ5x2HsQTKchCmDAEdAZbRBJrzLFsrIC+6NXW1IJZjd+OojbhLSyVar2Jr32foh6huTcBu/x278V1+zIC/Rwy3W67+3c4aZxYrI47FoYFza0jjFfr3EoSkKYUSByMTIvhWaqB2gIsF0T160jgDd8Lcgej+86ACEuG0v01VE7xoougqlOaJ94eAmapeM7oQXzekSwSAxcK3JQSfgWk/AvPhp07T4pQ8vCZmky6yqvVp1EzfKarTeub1rOnv+qo1znKLrBtOoq6t8pOAeczDdIDs51XT/hxaijpMRCM8vHxN4Kqnc4DY+3KcF7UFyH1ifQJHQe71tLBsM/GnAcJM5/3ykFVGvRJ716p4aa6IoGsdNk6bqlysNh7nURDl+bfm+CDXRkO2jkFwUFNqPHW7JwY6ZFx+b5SM3TzC3obJhfMS7OC37fo2geISOTR0xVie6NvpN6TjNAxFTfDxWJI7yH3Al2w43B3uYDd97WeiN+B+HVWtdaER87IVSRbRqFrRub+V+xrozT0y0=
-    skip_existing: true
-    skip_cleanup: true
-    on:
-      tags: true
-      condition: $TRAVIS_OS_NAME = "linux"

MANIFEST.in

@@ -1,7 +0,0 @@
-include README.md
-include release_notes.txt
-include requirements.txt
-recursive-include scripts *.py *.txt
-recursive-include desktop-integration *
-include windows/app.ico
-include mac/app.icns

Makefile

@@ -1,22 +1,21 @@
-PIP ?= pip3
-PYTHON ?= python3
-VERSION_STR := $(shell $(PYTHON) setup.py --version)
+VERSION_STR := $(shell python -c 'import comictaggerlib._version; print( comictaggerlib._version.version)')
 
 ifeq ($(OS),Windows_NT)
-	OS_VERSION=win-$(PROCESSOR_ARCHITECTURE)
 	APP_NAME=comictagger.exe
-	FINAL_NAME=ComicTagger-$(VERSION_STR)-$(OS_VERSION).exe
+	FINAL_NAME=ComicTagger-$(VERSION_STR).exe
+	ICON_PATH="windows/app.ico"
 else ifeq ($(shell uname -s),Darwin)
-	OS_VERSION=osx-$(shell defaults read loginwindow SystemVersionStampAsString)-$(shell uname -m)
 	APP_NAME=ComicTagger.app
-	FINAL_NAME=ComicTagger-$(VERSION_STR)-$(OS_VERSION).app
+	FINAL_NAME=ComicTagger-$(VERSION_STR).app
+	ICON_PATH="mac/app.icns"
 else
 	APP_NAME=comictagger
 	FINAL_NAME=ComicTagger-$(VERSION_STR)
+	ICON_PATH="windows/app.ico"
 endif
 
-.PHONY: all clean pydist upload dist CI
-
+.PHONY: all clean pydist upload dist
+	
 all: clean dist
 
 clean:
@@ -26,29 +25,22 @@ clean:
 	rm -rf dist MANIFEST
 	rm -rf *.deb
 	rm -rf logdict*.log
-	$(MAKE) -C mac clean
+	$(MAKE) -C mac clean   
 	rm -rf build
 	rm -rf comictaggerlib/ui/__pycache__
-	rm comictaggerlib/ctversion.py
 
-CI:
-	black .
-	isort .
-	flake8 .
-
-pydist: CI
+pydist:
 	make clean
 	mkdir -p piprelease
 	rm -f comictagger-$(VERSION_STR).zip
-	$(PYTHON) setup.py sdist --formats=gztar
-	mv dist/comictagger-$(VERSION_STR).tar.gz piprelease
+	python setup.py sdist --formats=zip  #,gztar
+	mv dist/comictagger-$(VERSION_STR).zip piprelease
 	rm -rf comictagger.egg-info dist
-
+		
 upload:
-	$(PYTHON) setup.py register
-	$(PYTHON) setup.py sdist --formats=gztar upload
+	python setup.py register
+	python setup.py sdist --formats=zip upload
 
-dist: CI
-	$(PIP) install .
-	pyinstaller -y comictagger.spec
-	cd dist && zip -r $(FINAL_NAME).zip $(APP_NAME)
+dist:
+	pyinstaller.exe --name="comictagger" --windowed --add-data 'comictaggerlib/ui/*.ui;ui' --add-data 'comictaggerlib/graphics;graphics' -i windows/app.ico --version-file file_version_info.py comictagger.py
+	mv dist/$(APP_NAME) dist/$(FINAL_NAME)

README.md

@@ -1,50 +1,16 @@
-[![Build Status](https://travis-ci.org/comictagger/comictagger.svg?branch=develop)](https://travis-ci.org/comictagger/comictagger)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/comictagger/community)
-[![Google Group](https://img.shields.io/badge/discuss-on%20groups-%23207de5)](https://groups.google.com/forum/#!forum/comictagger)
-[![Twitter](https://img.shields.io/badge/%40comictagger-twitter-lightgrey)](https://twitter.com/comictagger)
-[![Facebook](https://img.shields.io/badge/comictagger-facebook-lightgrey)](https://www.facebook.com/ComicTagger-139615369550787/)
-
-# ComicTagger
-
-ComicTagger is a **multi-platform** app for **writing metadata to digital comics**, written in Python and PyQt.
-
-![ComicTagger logo](https://raw.githubusercontent.com/comictagger/comictagger/develop/comictaggerlib/graphics/app.png)
-
-## Features
-
-* Runs on macOS, Microsoft Windows, and Linux systems
-* Get comic information from [Comic Vine](https://comicvine.gamespot.com/)
-* **Automatic issue matching** using advanced image processing techniques
-* **Batch processing** in the GUI for tagging hundreds or more comics at a time
-* Support for **ComicRack** and **ComicBookLover** tagging formats
-* Native full support for **CBZ** digital comics
-* Native read only support for **CBR** digital comics: full support enabled installing additional [rar tools](https://www.rarlab.com/download.htm)
-* Command line interface (CLI) enabling **custom scripting** and **batch operations on large collections**
-
-For details, screen-shots, release notes, and more, visit [the Wiki](https://github.com/comictagger/comictagger/wiki)
-
-
-## Installation
-
-### Binaries
-
-Windows and macOS binaries are provided in the [Releases Page](https://github.com/comictagger/comictagger/releases).
-
-Just unzip the archive in any folder and run, no additional installation steps are required.
-
-### PIP installation
-
-A pip package is provided, you can install it with:
-
-```
- $ pip3 install comictagger[GUI]
-```
-
-### From source
-
- 1. Ensure you have a recent version of python3 installed
- 2. Clone this repository `git clone https://github.com/comictagger/comictagger.git`
- 3. `pip3 install -r requirements_dev.txt`
- 4. Optionally install the GUI `pip3 install -r requirements-GUI.txt`
- 5. Optionally install CBR support `pip3 install -r requirements-CBR.txt`
- 6. `python3 comictagger.py`
+A fork from https://github.com/comictagger/comictagger
+
+Changes:
+ - switched to rarfile, makes dependencies simpler and I had issues using unrar-cffi with python<6.7
+ - Move to Python requests module, requests is much simpler and fixes all ssl errors.
+ - Moved to using Python format strings and use pathvalidate to handle filenames, supports directory structures
+ - Issue string parsing now strips off (# of #) (e.g. 1 of 45)
+ - Add publisher and imprint handling, currently hardcoded
+ 
+Notes:
+- I did some testing with the pyinstaller build, and it worked on both platforms.  I did encounter two problems:
+  - Mac build showed the wrong widget set. I found a solution here that seemed to work: https://stackoverflow.com/questions/48626999/packaging-with-pyinstaller-pyqt5-setstyle-ignored
+  - Windows build had problems grabbing images from ComicVine using SSL.  It think that some libraries are missing from the monolithic exe, but I couldn't figure out how to fix the problem. 
+- In setup.py you can also find the remains of an attempt to do some desktop integration from a pip install.  It does work, but can cause problems with wheel installs, and I don't know if it's worth the bother.  I kept the commented-out code in place, just in case.
+
+With Python 3, it's much easier to get the app working from scratch on a new distro, as all of the dependencies are available as wheels, including PyQt5, so just a simple "pip install comictagger.zip" is all that's needed.

appveyor.yml

@@ -0,0 +1,6 @@
+version: 1.0.{build}
+build_script:
+- cmd: powershell -exec bypass -File windows\fullbuild.ps1
+artifacts:
+- path: dist\*.exe
+  name: ComicTagger

comicapi/__init__.py

@@ -1 +0,0 @@
-__author__ = "dromanin"

comicapi/comet.py

@@ -1,226 +0,0 @@
-"""A class to encapsulate CoMet data"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import logging
-import xml.etree.ElementTree as ET
-
-from comicapi import utils
-from comicapi.genericmetadata import GenericMetadata
-
-logger = logging.getLogger(__name__)
-
-
-class CoMet:
-
-    writer_synonyms = ["writer", "plotter", "scripter"]
-    penciller_synonyms = ["artist", "penciller", "penciler", "breakdowns"]
-    inker_synonyms = ["inker", "artist", "finishes"]
-    colorist_synonyms = ["colorist", "colourist", "colorer", "colourer"]
-    letterer_synonyms = ["letterer"]
-    cover_synonyms = ["cover", "covers", "coverartist", "cover artist"]
-    editor_synonyms = ["editor"]
-
-    def metadata_from_string(self, string):
-
-        tree = ET.ElementTree(ET.fromstring(string))
-        return self.convert_xml_to_metadata(tree)
-
-    def string_from_metadata(self, metadata):
-
-        header = '<?xml version="1.0" encoding="UTF-8"?>\n'
-
-        tree = self.convert_metadata_to_xml(metadata)
-        return header + ET.tostring(tree.getroot())
-
-    def convert_metadata_to_xml(self, metadata):
-
-        # shorthand for the metadata
-        md = metadata
-
-        # build a tree structure
-        root = ET.Element("comet")
-        root.attrib["xmlns:comet"] = "http://www.denvog.com/comet/"
-        root.attrib["xmlns:xsi"] = "http://www.w3.org/2001/XMLSchema-instance"
-        root.attrib["xsi:schemaLocation"] = "http://www.denvog.com http://www.denvog.com/comet/comet.xsd"
-
-        # helper func
-        def assign(comet_entry, md_entry):
-            if md_entry is not None:
-                ET.SubElement(root, comet_entry).text = str(md_entry)
-
-        # title is manditory
-        if md.title is None:
-            md.title = ""
-        assign("title", md.title)
-        assign("series", md.series)
-        assign("issue", md.issue)  # must be int??
-        assign("volume", md.volume)
-        assign("description", md.comments)
-        assign("publisher", md.publisher)
-        assign("pages", md.page_count)
-        assign("format", md.format)
-        assign("language", md.language)
-        assign("rating", md.maturity_rating)
-        assign("price", md.price)
-        assign("isVersionOf", md.is_version_of)
-        assign("rights", md.rights)
-        assign("identifier", md.identifier)
-        assign("lastMark", md.last_mark)
-        assign("genre", md.genre)  # TODO repeatable
-
-        if md.characters is not None:
-            char_list = [c.strip() for c in md.characters.split(",")]
-            for c in char_list:
-                assign("character", c)
-
-        if md.manga is not None and md.manga == "YesAndRightToLeft":
-            assign("readingDirection", "rtl")
-
-        if md.year is not None:
-            date_str = str(md.year).zfill(4)
-            if md.month is not None:
-                date_str += "-" + str(md.month).zfill(2)
-            assign("date", date_str)
-
-        assign("coverImage", md.cover_image)
-
-        # loop thru credits, and build a list for each role that CoMet supports
-        for credit in metadata.credits:
-
-            if credit["role"].lower() in set(self.writer_synonyms):
-                ET.SubElement(root, "writer").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.penciller_synonyms):
-                ET.SubElement(root, "penciller").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.inker_synonyms):
-                ET.SubElement(root, "inker").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.colorist_synonyms):
-                ET.SubElement(root, "colorist").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.letterer_synonyms):
-                ET.SubElement(root, "letterer").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.cover_synonyms):
-                ET.SubElement(root, "coverDesigner").text = str(credit["person"])
-
-            if credit["role"].lower() in set(self.editor_synonyms):
-                ET.SubElement(root, "editor").text = str(credit["person"])
-
-        utils.indent(root)
-
-        # wrap it in an ElementTree instance, and save as XML
-        tree = ET.ElementTree(root)
-        return tree
-
-    def convert_xml_to_metadata(self, tree):
-
-        root = tree.getroot()
-
-        if root.tag != "comet":
-            raise "1"
-
-        metadata = GenericMetadata()
-        md = metadata
-
-        # Helper function
-        def xlate(tag):
-            node = root.find(tag)
-            if node is not None:
-                return node.text
-            return None
-
-        md.series = xlate("series")
-        md.title = xlate("title")
-        md.issue = xlate("issue")
-        md.volume = xlate("volume")
-        md.comments = xlate("description")
-        md.publisher = xlate("publisher")
-        md.language = xlate("language")
-        md.format = xlate("format")
-        md.page_count = xlate("pages")
-        md.maturity_rating = xlate("rating")
-        md.price = xlate("price")
-        md.is_version_of = xlate("isVersionOf")
-        md.rights = xlate("rights")
-        md.identifier = xlate("identifier")
-        md.last_mark = xlate("lastMark")
-        md.genre = xlate("genre")  # TODO - repeatable field
-
-        date = xlate("date")
-        if date is not None:
-            parts = date.split("-")
-            if len(parts) > 0:
-                md.year = parts[0]
-            if len(parts) > 1:
-                md.month = parts[1]
-
-        md.cover_image = xlate("coverImage")
-
-        reading_direction = xlate("readingDirection")
-        if reading_direction is not None and reading_direction == "rtl":
-            md.manga = "YesAndRightToLeft"
-
-        # loop for character tags
-        char_list = []
-        for n in root:
-            if n.tag == "character":
-                char_list.append(n.text.strip())
-        md.characters = utils.list_to_string(char_list)
-
-        # Now extract the credit info
-        for n in root:
-            if any(
-                [
-                    n.tag == "writer",
-                    n.tag == "penciller",
-                    n.tag == "inker",
-                    n.tag == "colorist",
-                    n.tag == "letterer",
-                    n.tag == "editor",
-                ]
-            ):
-                metadata.add_credit(n.text.strip(), n.tag.title())
-
-            if n.tag == "coverDesigner":
-                metadata.add_credit(n.text.strip(), "Cover")
-
-        metadata.is_empty = False
-
-        return metadata
-
-    # verify that the string actually contains CoMet data in XML format
-    def validate_string(self, string):
-        try:
-            tree = ET.ElementTree(ET.fromstring(string))
-            root = tree.getroot()
-            if root.tag != "comet":
-                raise Exception
-        except:
-            return False
-
-        return True
-
-    def write_to_external_file(self, filename, metadata):
-
-        tree = self.convert_metadata_to_xml(metadata)
-        tree.write(filename, encoding="utf-8")
-
-    def read_from_external_file(self, filename):
-
-        tree = ET.parse(filename)
-        return self.convert_xml_to_metadata(tree)

comicapi/comicbookinfo.py

@@ -1,123 +0,0 @@
-"""A class to encapsulate the ComicBookInfo data"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import json
-import logging
-from collections import defaultdict
-from datetime import datetime
-
-from comicapi import utils
-from comicapi.genericmetadata import GenericMetadata
-
-logger = logging.getLogger(__name__)
-
-
-class ComicBookInfo:
-    def metadata_from_string(self, string):
-
-        cbi_container = json.loads(str(string, "utf-8"))
-
-        metadata = GenericMetadata()
-
-        cbi = defaultdict(lambda: None, cbi_container["ComicBookInfo/1.0"])
-
-        metadata.series = utils.xlate(cbi["series"])
-        metadata.title = utils.xlate(cbi["title"])
-        metadata.issue = utils.xlate(cbi["issue"])
-        metadata.publisher = utils.xlate(cbi["publisher"])
-        metadata.month = utils.xlate(cbi["publicationMonth"], True)
-        metadata.year = utils.xlate(cbi["publicationYear"], True)
-        metadata.issue_count = utils.xlate(cbi["numberOfIssues"], True)
-        metadata.comments = utils.xlate(cbi["comments"])
-        metadata.genre = utils.xlate(cbi["genre"])
-        metadata.volume = utils.xlate(cbi["volume"], True)
-        metadata.volume_count = utils.xlate(cbi["numberOfVolumes"], True)
-        metadata.language = utils.xlate(cbi["language"])
-        metadata.country = utils.xlate(cbi["country"])
-        metadata.critical_rating = utils.xlate(cbi["rating"])
-
-        metadata.credits = cbi["credits"]
-        metadata.tags = cbi["tags"]
-
-        # make sure credits and tags are at least empty lists and not None
-        if metadata.credits is None:
-            metadata.credits = []
-        if metadata.tags is None:
-            metadata.tags = []
-
-        # need the language string to be ISO
-        if metadata.language is not None:
-            metadata.language = utils.get_language(metadata.language)
-
-        metadata.is_empty = False
-
-        return metadata
-
-    def string_from_metadata(self, metadata):
-
-        cbi_container = self.create_json_dictionary(metadata)
-        return json.dumps(cbi_container)
-
-    def validate_string(self, string):
-        """Verify that the string actually contains CBI data in JSON format"""
-
-        try:
-            cbi_container = json.loads(string)
-        except:
-            return False
-
-        return "ComicBookInfo/1.0" in cbi_container
-
-    def create_json_dictionary(self, metadata):
-        """Create the dictionary that we will convert to JSON text"""
-
-        cbi = {}
-        cbi_container = {
-            "appID": "ComicTagger/" + "1.0.0",
-            "lastModified": str(datetime.now()),
-            "ComicBookInfo/1.0": cbi,
-        }  # TODO: ctversion.version,
-
-        # helper func
-        def assign(cbi_entry, md_entry):
-            if md_entry is not None or isinstance(md_entry, str) and md_entry != "":
-                cbi[cbi_entry] = md_entry
-
-        assign("series", utils.xlate(metadata.series))
-        assign("title", utils.xlate(metadata.title))
-        assign("issue", utils.xlate(metadata.issue))
-        assign("publisher", utils.xlate(metadata.publisher))
-        assign("publicationMonth", utils.xlate(metadata.month, True))
-        assign("publicationYear", utils.xlate(metadata.year, True))
-        assign("numberOfIssues", utils.xlate(metadata.issue_count, True))
-        assign("comments", utils.xlate(metadata.comments))
-        assign("genre", utils.xlate(metadata.genre))
-        assign("volume", utils.xlate(metadata.volume, True))
-        assign("numberOfVolumes", utils.xlate(metadata.volume_count, True))
-        assign("language", utils.xlate(utils.get_language_from_iso(metadata.language)))
-        assign("country", utils.xlate(metadata.country))
-        assign("rating", utils.xlate(metadata.critical_rating))
-        assign("credits", metadata.credits)
-        assign("tags", metadata.tags)
-
-        return cbi_container
-
-    def write_to_external_file(self, filename, metadata):
-
-        cbi_container = self.create_json_dictionary(metadata)
-
-        with open(filename, "w") as f:
-            f.write(json.dumps(cbi_container, indent=4))

comicapi/comicinfoxml.py

@@ -1,268 +0,0 @@
-"""A class to encapsulate ComicRack's ComicInfo.xml data"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import logging
-import xml.etree.ElementTree as ET
-
-from comicapi import utils
-from comicapi.genericmetadata import GenericMetadata
-from comicapi.issuestring import IssueString
-
-logger = logging.getLogger(__name__)
-
-
-class ComicInfoXml:
-
-    writer_synonyms = ["writer", "plotter", "scripter"]
-    penciller_synonyms = ["artist", "penciller", "penciler", "breakdowns"]
-    inker_synonyms = ["inker", "artist", "finishes"]
-    colorist_synonyms = ["colorist", "colourist", "colorer", "colourer"]
-    letterer_synonyms = ["letterer"]
-    cover_synonyms = ["cover", "covers", "coverartist", "cover artist"]
-    editor_synonyms = ["editor"]
-
-    def get_parseable_credits(self):
-        parsable_credits = []
-        parsable_credits.extend(self.writer_synonyms)
-        parsable_credits.extend(self.penciller_synonyms)
-        parsable_credits.extend(self.inker_synonyms)
-        parsable_credits.extend(self.colorist_synonyms)
-        parsable_credits.extend(self.letterer_synonyms)
-        parsable_credits.extend(self.cover_synonyms)
-        parsable_credits.extend(self.editor_synonyms)
-        return parsable_credits
-
-    def metadata_from_string(self, string):
-
-        tree = ET.ElementTree(ET.fromstring(string))
-        return self.convert_xml_to_metadata(tree)
-
-    def string_from_metadata(self, metadata, xml=None):
-        tree = self.convert_metadata_to_xml(self, metadata, xml)
-        tree_str = ET.tostring(tree.getroot(), encoding="utf-8", xml_declaration=True).decode()
-        return tree_str
-
-    def convert_metadata_to_xml(self, filename, metadata, xml=None):
-
-        # shorthand for the metadata
-        md = metadata
-
-        if xml:
-            root = ET.ElementTree(ET.fromstring(xml)).getroot()
-        else:
-            # build a tree structure
-            root = ET.Element("ComicInfo")
-            root.attrib["xmlns:xsi"] = "http://www.w3.org/2001/XMLSchema-instance"
-            root.attrib["xmlns:xsd"] = "http://www.w3.org/2001/XMLSchema"
-        # helper func
-
-        def assign(cix_entry, md_entry):
-            if md_entry is not None and md_entry:
-                et_entry = root.find(cix_entry)
-                if et_entry is not None:
-                    et_entry.text = str(md_entry)
-                else:
-                    ET.SubElement(root, cix_entry).text = str(md_entry)
-            else:
-                et_entry = root.find(cix_entry)
-                if et_entry is not None:
-                    et_entry.clear()
-
-        assign("Title", md.title)
-        assign("Series", md.series)
-        assign("Number", md.issue)
-        assign("Count", md.issue_count)
-        assign("Volume", md.volume)
-        assign("AlternateSeries", md.alternate_series)
-        assign("AlternateNumber", md.alternate_number)
-        assign("StoryArc", md.story_arc)
-        assign("SeriesGroup", md.series_group)
-        assign("AlternateCount", md.alternate_count)
-        assign("Summary", md.comments)
-        assign("Notes", md.notes)
-        assign("Year", md.year)
-        assign("Month", md.month)
-        assign("Day", md.day)
-
-        # need to specially process the credits, since they are structured
-        # differently than CIX
-        credit_writer_list = []
-        credit_penciller_list = []
-        credit_inker_list = []
-        credit_colorist_list = []
-        credit_letterer_list = []
-        credit_cover_list = []
-        credit_editor_list = []
-
-        # first, loop thru credits, and build a list for each role that CIX
-        # supports
-        for credit in metadata.credits:
-
-            if credit["role"].lower() in set(self.writer_synonyms):
-                credit_writer_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.penciller_synonyms):
-                credit_penciller_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.inker_synonyms):
-                credit_inker_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.colorist_synonyms):
-                credit_colorist_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.letterer_synonyms):
-                credit_letterer_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.cover_synonyms):
-                credit_cover_list.append(credit["person"].replace(",", ""))
-
-            if credit["role"].lower() in set(self.editor_synonyms):
-                credit_editor_list.append(credit["person"].replace(",", ""))
-
-        # second, convert each list to string, and add to XML struct
-        assign("Writer", utils.list_to_string(credit_writer_list))
-
-        assign("Penciller", utils.list_to_string(credit_penciller_list))
-
-        assign("Inker", utils.list_to_string(credit_inker_list))
-
-        assign("Colorist", utils.list_to_string(credit_colorist_list))
-
-        assign("Letterer", utils.list_to_string(credit_letterer_list))
-
-        assign("CoverArtist", utils.list_to_string(credit_cover_list))
-
-        assign("Editor", utils.list_to_string(credit_editor_list))
-
-        assign("Publisher", md.publisher)
-        assign("Imprint", md.imprint)
-        assign("Genre", md.genre)
-        assign("Web", md.web_link)
-        assign("PageCount", md.page_count)
-        assign("LanguageISO", md.language)
-        assign("Format", md.format)
-        assign("AgeRating", md.maturity_rating)
-        assign("BlackAndWhite", "Yes" if md.black_and_white else None)
-        assign("Manga", md.manga)
-        assign("Characters", md.characters)
-        assign("Teams", md.teams)
-        assign("Locations", md.locations)
-        assign("ScanInformation", md.scan_info)
-
-        #  loop and add the page entries under pages node
-        pages_node = root.find("Pages")
-        if pages_node is not None:
-            pages_node.clear()
-        else:
-            pages_node = ET.SubElement(root, "Pages")
-
-        for page_dict in md.pages:
-            page_node = ET.SubElement(pages_node, "Page")
-            page_node.attrib = dict(sorted(page_dict.items()))
-
-        utils.indent(root)
-
-        # wrap it in an ElementTree instance, and save as XML
-        tree = ET.ElementTree(root)
-        return tree
-
-    def convert_xml_to_metadata(self, tree):
-
-        root = tree.getroot()
-
-        if root.tag != "ComicInfo":
-            raise "1"
-
-        def get(name):
-            tag = root.find(name)
-            if tag is None:
-                return None
-            return tag.text
-
-        md = GenericMetadata()
-
-        md.series = utils.xlate(get("Series"))
-        md.title = utils.xlate(get("Title"))
-        md.issue = IssueString(utils.xlate(get("Number"))).as_string()
-        md.issue_count = utils.xlate(get("Count"), True)
-        md.volume = utils.xlate(get("Volume"), True)
-        md.alternate_series = utils.xlate(get("AlternateSeries"))
-        md.alternate_number = IssueString(utils.xlate(get("AlternateNumber"))).as_string()
-        md.alternate_count = utils.xlate(get("AlternateCount"), True)
-        md.comments = utils.xlate(get("Summary"))
-        md.notes = utils.xlate(get("Notes"))
-        md.year = utils.xlate(get("Year"), True)
-        md.month = utils.xlate(get("Month"), True)
-        md.day = utils.xlate(get("Day"), True)
-        md.publisher = utils.xlate(get("Publisher"))
-        md.imprint = utils.xlate(get("Imprint"))
-        md.genre = utils.xlate(get("Genre"))
-        md.web_link = utils.xlate(get("Web"))
-        md.language = utils.xlate(get("LanguageISO"))
-        md.format = utils.xlate(get("Format"))
-        md.manga = utils.xlate(get("Manga"))
-        md.characters = utils.xlate(get("Characters"))
-        md.teams = utils.xlate(get("Teams"))
-        md.locations = utils.xlate(get("Locations"))
-        md.page_count = utils.xlate(get("PageCount"), True)
-        md.scan_info = utils.xlate(get("ScanInformation"))
-        md.story_arc = utils.xlate(get("StoryArc"))
-        md.series_group = utils.xlate(get("SeriesGroup"))
-        md.maturity_rating = utils.xlate(get("AgeRating"))
-
-        tmp = utils.xlate(get("BlackAndWhite"))
-        if tmp is not None and tmp.lower() in ["yes", "true", "1"]:
-            md.black_and_white = True
-        # Now extract the credit info
-        for n in root:
-            if any(
-                [
-                    n.tag == "Writer",
-                    n.tag == "Penciller",
-                    n.tag == "Inker",
-                    n.tag == "Colorist",
-                    n.tag == "Letterer",
-                    n.tag == "Editor",
-                ]
-            ):
-                if n.text is not None:
-                    for name in n.text.split(","):
-                        md.add_credit(name.strip(), n.tag)
-
-            if n.tag == "CoverArtist":
-                if n.text is not None:
-                    for name in n.text.split(","):
-                        md.add_credit(name.strip(), "Cover")
-
-        # parse page data now
-        pages_node = root.find("Pages")
-        if pages_node is not None:
-            for page in pages_node:
-                md.pages.append(page.attrib)
-
-        md.is_empty = False
-
-        return md
-
-    def write_to_external_file(self, filename, metadata, xml=None):
-
-        tree = self.convert_metadata_to_xml(self, metadata, xml)
-        tree.write(filename, encoding="utf-8", xml_declaration=True)
-
-    def read_from_external_file(self, filename):
-
-        tree = ET.parse(filename)
-        return self.convert_xml_to_metadata(tree)

comicapi/filenameparser.py

@@ -1,294 +0,0 @@
-"""Functions for parsing comic info from filename
-
-This should probably be re-written, but, well, it mostly works!
-"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Some portions of this code were modified from pyComicMetaThis project
-# http://code.google.com/p/pycomicmetathis/
-
-import logging
-import os
-import re
-from urllib.parse import unquote
-
-logger = logging.getLogger(__name__)
-
-
-class FileNameParser:
-    def __init__(self):
-        self.series = ""
-        self.volume = ""
-        self.year = ""
-        self.issue_count = ""
-        self.remainder = ""
-        self.issue = ""
-
-    def repl(self, m):
-        return " " * len(m.group())
-
-    def fix_spaces(self, string, remove_dashes=True):
-        if remove_dashes:
-            placeholders = [r"[-_]", r"  +"]
-        else:
-            placeholders = [r"[_]", r"  +"]
-        for ph in placeholders:
-            string = re.sub(ph, self.repl, string)
-        return string  # .strip()
-
-    def get_issue_count(self, filename, issue_end):
-
-        count = ""
-        filename = filename[issue_end:]
-
-        # replace any name separators with spaces
-        tmpstr = self.fix_spaces(filename)
-        found = False
-
-        match = re.search(r"(?<=\sof\s)\d+(?=\s)", tmpstr, re.IGNORECASE)
-        if match:
-            count = match.group()
-            found = True
-
-        if not found:
-            match = re.search(r"(?<=\(of\s)\d+(?=\))", tmpstr, re.IGNORECASE)
-            if match:
-                count = match.group()
-
-        count = count.lstrip("0")
-
-        return count
-
-    def get_issue_number(self, filename):
-        """Returns a tuple of issue number string, and start and end indexes in the filename
-        (The indexes will be used to split the string up for further parsing)
-        """
-
-        found = False
-        issue = ""
-        start = 0
-        end = 0
-
-        # first, look for multiple "--", this means it's formatted differently
-        # from most:
-        if "--" in filename:
-            # the pattern seems to be that anything to left of the first "--"
-            # is the series name followed by issue
-            filename = re.sub(r"--.*", self.repl, filename)
-
-        elif "__" in filename:
-            # the pattern seems to be that anything to left of the first "__"
-            # is the series name followed by issue
-            filename = re.sub(r"__.*", self.repl, filename)
-
-        filename = filename.replace("+", " ")
-
-        # replace parenthetical phrases with spaces
-        filename = re.sub(r"\(.*?\)", self.repl, filename)
-        filename = re.sub(r"\[.*?]", self.repl, filename)
-
-        # replace any name separators with spaces
-        filename = self.fix_spaces(filename)
-
-        # remove any "of NN" phrase with spaces (problem: this could break on
-        # some titles)
-        filename = re.sub(r"of [\d]+", self.repl, filename)
-
-        # print u"[{0}]".format(filename)
-
-        # we should now have a cleaned up filename version with all the words in
-        # the same positions as original filename
-
-        # make a list of each word and its position
-        word_list = []
-        for m in re.finditer(r"\S+", filename):
-            word_list.append((m.group(0), m.start(), m.end()))
-
-        # remove the first word, since it can't be the issue number
-        if len(word_list) > 1:
-            word_list = word_list[1:]
-        else:
-            # only one word??  just bail.
-            return issue, start, end
-
-        # Now try to search for the likely issue number word in the list
-
-        # first look for a word with "#" followed by digits with optional suffix
-        # this is almost certainly the issue number
-        for w in reversed(word_list):
-            if re.match(r"#[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
-                found = True
-                break
-
-        # same as above but w/o a '#', and only look at the last word in the
-        # list
-        if not found:
-            w = word_list[-1]
-            if re.match(r"[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
-                found = True
-
-        # now try to look for a # followed by any characters
-        if not found:
-            for w in reversed(word_list):
-                if re.match(r"#\S+", w[0]):
-                    found = True
-                    break
-
-        if found:
-            issue = w[0]
-            start = w[1]
-            end = w[2]
-            if issue[0] == "#":
-                issue = issue[1:]
-
-        return issue, start, end
-
-    def get_series_name(self, filename, issue_start):
-        """Use the issue number string index to split the filename string"""
-
-        if issue_start != 0:
-            filename = filename[:issue_start]
-
-        # in case there is no issue number, remove some obvious stuff
-        if "--" in filename:
-            # the pattern seems to be that anything to left of the first "--"
-            # is the series name followed by issue
-            filename = re.sub(r"--.*", self.repl, filename)
-
-        elif "__" in filename:
-            # the pattern seems to be that anything to left of the first "__"
-            # is the series name followed by issue
-            filename = re.sub(r"__.*", self.repl, filename)
-
-        filename = filename.replace("+", " ")
-        tmpstr = self.fix_spaces(filename, remove_dashes=False)
-
-        series = tmpstr
-        volume = ""
-
-        # save the last word
-        try:
-            last_word = series.split()[-1]
-        except:
-            last_word = ""
-
-        # remove any parenthetical phrases
-        series = re.sub(r"\(.*?\)", "", series)
-
-        # search for volume number
-        match = re.search(r"(.+)([vV]|[Vv][oO][Ll]\.?\s?)(\d+)\s*$", series)
-        if match:
-            series = match.group(1)
-            volume = match.group(3)
-
-        # if a volume wasn't found, see if the last word is a year in parentheses
-        # since that's a common way to designate the volume
-        if volume == "":
-            # match either (YEAR), (YEAR-), or (YEAR-YEAR2)
-            match = re.search(r"(\()(\d{4})(-(\d{4}|)|)(\))", last_word)
-            if match:
-                volume = match.group(2)
-
-        series = series.strip()
-
-        # if we don't have an issue number (issue_start==0), look
-        # for hints i.e. "TPB", "one-shot", "OS", "OGN", etc that might
-        # be removed to help search online
-        if issue_start == 0:
-            one_shot_words = ["tpb", "os", "one-shot", "ogn", "gn"]
-            try:
-                last_word = series.split()[-1]
-                if last_word.lower() in one_shot_words:
-                    series = series.rsplit(" ", 1)[0]
-            except:
-                pass
-
-        return series, volume.strip()
-
-    def get_year(self, filename, issue_end):
-
-        filename = filename[issue_end:]
-
-        year = ""
-        # look for four digit number with "(" ")" or "--" around it
-        match = re.search(r"(\(\d\d\d\d\))|(--\d\d\d\d--)", filename)
-        if match:
-            year = match.group()
-            # remove non-digits
-            year = re.sub(r"[^0-9]", "", year)
-        return year
-
-    def get_remainder(self, filename, year, count, volume, issue_end):
-        """Make a guess at where the the non-interesting stuff begins"""
-
-        remainder = ""
-
-        if "--" in filename:
-            remainder = filename.split("--", 1)[1]
-        elif "__" in filename:
-            remainder = filename.split("__", 1)[1]
-        elif issue_end != 0:
-            remainder = filename[issue_end:]
-
-        remainder = self.fix_spaces(remainder, remove_dashes=False)
-        if volume != "":
-            remainder = remainder.replace("Vol." + volume, "", 1)
-        if year != "":
-            remainder = remainder.replace(year, "", 1)
-        if count != "":
-            remainder = remainder.replace("of " + count, "", 1)
-
-        remainder = remainder.replace("()", "")
-        remainder = remainder.replace("  ", " ")  # cleans some whitespace mess
-
-        return remainder.strip()
-
-    def parse_filename(self, filename):
-
-        # remove the path
-        filename = os.path.basename(filename)
-
-        # remove the extension
-        filename = os.path.splitext(filename)[0]
-
-        # url decode, just in case
-        filename = unquote(filename)
-
-        # sometimes archives get messed up names from too many decodes
-        # often url encodings will break and leave "_28" and "_29" in place
-        # of "(" and ")"  see if there are a number of these, and replace them
-        if filename.count("_28") > 1 and filename.count("_29") > 1:
-            filename = filename.replace("_28", "(")
-            filename = filename.replace("_29", ")")
-
-        self.issue, issue_start, issue_end = self.get_issue_number(filename)
-        self.series, self.volume = self.get_series_name(filename, issue_start)
-
-        # provides proper value when the filename doesn't have a issue number
-        if issue_end == 0:
-            issue_end = len(self.series)
-
-        self.year = self.get_year(filename, issue_end)
-        self.issue_count = self.get_issue_count(filename, issue_end)
-        self.remainder = self.get_remainder(filename, self.year, self.issue_count, self.volume, issue_end)
-
-        if self.issue != "":
-            # strip off leading zeros
-            self.issue = self.issue.lstrip("0")
-            if self.issue == "":
-                self.issue = "0"
-            if self.issue[0] == ".":
-                self.issue = "0" + self.issue

comicapi/genericmetadata.py

@@ -1,332 +0,0 @@
-"""A class for internal metadata storage
-
-The goal of this class is to handle ALL the data that might come from various
-tagging schemes and databases, such as ComicVine or GCD.  This makes conversion
-possible, however lossy it might be
-
-"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import logging
-from typing import List, TypedDict
-
-from comicapi import utils
-
-logger = logging.getLogger(__name__)
-
-
-class PageType:
-
-    """
-    These page info classes are exactly the same as the CIX scheme, since
-    it's unique
-    """
-
-    FrontCover = "FrontCover"
-    InnerCover = "InnerCover"
-    Roundup = "Roundup"
-    Story = "Story"
-    Advertisement = "Advertisement"
-    Editorial = "Editorial"
-    Letters = "Letters"
-    Preview = "Preview"
-    BackCover = "BackCover"
-    Other = "Other"
-    Deleted = "Deleted"
-
-
-class ImageMetadata(TypedDict):
-    Type: PageType
-    Image: int
-    ImageSize: str
-    ImageHeight: str
-    ImageWidth: str
-
-
-class CreditMetadata(TypedDict):
-    person: str
-    role: str
-    primary: bool
-
-
-class GenericMetadata:
-    writer_synonyms = ["writer", "plotter", "scripter"]
-    penciller_synonyms = ["artist", "penciller", "penciler", "breakdowns"]
-    inker_synonyms = ["inker", "artist", "finishes"]
-    colorist_synonyms = ["colorist", "colourist", "colorer", "colourer"]
-    letterer_synonyms = ["letterer"]
-    cover_synonyms = ["cover", "covers", "coverartist", "cover artist"]
-    editor_synonyms = ["editor"]
-
-    def __init__(self):
-
-        self.is_empty = True
-        self.tag_origin = None
-
-        self.series = None
-        self.issue = None
-        self.title = None
-        self.publisher = None
-        self.month = None
-        self.year = None
-        self.day = None
-        self.issue_count = None
-        self.volume = None
-        self.genre = None
-        self.language = None  # 2 letter iso code
-        self.comments = None  # use same way as Summary in CIX
-
-        self.volume_count = None
-        self.critical_rating = None
-        self.country = None
-
-        self.alternate_series = None
-        self.alternate_number = None
-        self.alternate_count = None
-        self.imprint = None
-        self.notes = None
-        self.web_link = None
-        self.format = None
-        self.manga = None
-        self.black_and_white = None
-        self.page_count = None
-        self.maturity_rating = None
-
-        self.story_arc = None
-        self.series_group = None
-        self.scan_info = None
-
-        self.characters = None
-        self.teams = None
-        self.locations = None
-
-        self.credits: List[CreditMetadata] = []
-        self.tags: List[str] = []
-        self.pages: List[ImageMetadata] = []
-
-        # Some CoMet-only items
-        self.price = None
-        self.is_version_of = None
-        self.rights = None
-        self.identifier = None
-        self.last_mark = None
-        self.cover_image = None
-
-    def overlay(self, new_md):
-        """Overlay a metadata object on this one
-
-        That is, when the new object has non-None values, over-write them
-        to this one.
-        """
-
-        def assign(cur, new):
-            if new is not None:
-                if isinstance(new, str) and len(new) == 0:
-                    setattr(self, cur, None)
-                else:
-                    setattr(self, cur, new)
-
-        new_md: GenericMetadata
-        if not new_md.is_empty:
-            self.is_empty = False
-
-        assign("series", new_md.series)
-        assign("issue", new_md.issue)
-        assign("issue_count", new_md.issue_count)
-        assign("title", new_md.title)
-        assign("publisher", new_md.publisher)
-        assign("day", new_md.day)
-        assign("month", new_md.month)
-        assign("year", new_md.year)
-        assign("volume", new_md.volume)
-        assign("volume_count", new_md.volume_count)
-        assign("genre", new_md.genre)
-        assign("language", new_md.language)
-        assign("country", new_md.country)
-        assign("critical_rating", new_md.critical_rating)
-        assign("alternate_series", new_md.alternate_series)
-        assign("alternate_number", new_md.alternate_number)
-        assign("alternate_count", new_md.alternate_count)
-        assign("imprint", new_md.imprint)
-        assign("web_link", new_md.web_link)
-        assign("format", new_md.format)
-        assign("manga", new_md.manga)
-        assign("black_and_white", new_md.black_and_white)
-        assign("maturity_rating", new_md.maturity_rating)
-        assign("story_arc", new_md.story_arc)
-        assign("series_group", new_md.series_group)
-        assign("scan_info", new_md.scan_info)
-        assign("characters", new_md.characters)
-        assign("teams", new_md.teams)
-        assign("locations", new_md.locations)
-        assign("comments", new_md.comments)
-        assign("notes", new_md.notes)
-
-        assign("price", new_md.price)
-        assign("is_version_of", new_md.is_version_of)
-        assign("rights", new_md.rights)
-        assign("identifier", new_md.identifier)
-        assign("last_mark", new_md.last_mark)
-
-        self.overlay_credits(new_md.credits)
-        # TODO
-
-        # not sure if the tags and pages should broken down, or treated
-        # as whole lists....
-
-        # For now, go the easy route, where any overlay
-        # value wipes out the whole list
-        if len(new_md.tags) > 0:
-            assign("tags", new_md.tags)
-
-        if len(new_md.pages) > 0:
-            assign("pages", new_md.pages)
-
-    def overlay_credits(self, new_credits):
-        for c in new_credits:
-            primary = bool("primary" in c and c["primary"])
-
-            # Remove credit role if person is blank
-            if c["person"] == "":
-                for r in reversed(self.credits):
-                    if r["role"].lower() == c["role"].lower():
-                        self.credits.remove(r)
-            # otherwise, add it!
-            else:
-                self.add_credit(c["person"], c["role"], primary)
-
-    def set_default_page_list(self, count):
-        # generate a default page list, with the first page marked as the cover
-        for i in range(count):
-            page_dict = {}
-            page_dict["Image"] = str(i)
-            if i == 0:
-                page_dict["Type"] = PageType.FrontCover
-            self.pages.append(page_dict)
-
-    def get_archive_page_index(self, pagenum):
-        # convert the displayed page number to the page index of the file in
-        # the archive
-        if pagenum < len(self.pages):
-            return int(self.pages[pagenum]["Image"])
-
-        return 0
-
-    def get_cover_page_index_list(self):
-        # return a list of archive page indices of cover pages
-        coverlist = []
-        for p in self.pages:
-            if "Type" in p and p["Type"] == PageType.FrontCover:
-                coverlist.append(int(p["Image"]))
-
-        if len(coverlist) == 0:
-            coverlist.append(0)
-
-        return coverlist
-
-    def add_credit(self, person, role, primary=False):
-
-        credit = {}
-        credit["person"] = person
-        credit["role"] = role
-        if primary:
-            credit["primary"] = primary
-
-        # look to see if it's not already there...
-        found = False
-        for c in self.credits:
-            if c["person"].lower() == person.lower() and c["role"].lower() == role.lower():
-                # no need to add it. just adjust the "primary" flag as needed
-                c["primary"] = primary
-                found = True
-                break
-
-        if not found:
-            self.credits.append(credit)
-
-    def __str__(self):
-        vals = []
-        if self.is_empty:
-            return "No metadata"
-
-        def add_string(tag, val):
-            if val is not None and str(val) != "":
-                vals.append((tag, val))
-
-        def add_attr_string(tag):
-            add_string(tag, getattr(self, tag))
-
-        add_attr_string("series")
-        add_attr_string("issue")
-        add_attr_string("issue_count")
-        add_attr_string("title")
-        add_attr_string("publisher")
-        add_attr_string("year")
-        add_attr_string("month")
-        add_attr_string("day")
-        add_attr_string("volume")
-        add_attr_string("volume_count")
-        add_attr_string("genre")
-        add_attr_string("language")
-        add_attr_string("country")
-        add_attr_string("critical_rating")
-        add_attr_string("alternate_series")
-        add_attr_string("alternate_number")
-        add_attr_string("alternate_count")
-        add_attr_string("imprint")
-        add_attr_string("web_link")
-        add_attr_string("format")
-        add_attr_string("manga")
-
-        add_attr_string("price")
-        add_attr_string("is_version_of")
-        add_attr_string("rights")
-        add_attr_string("identifier")
-        add_attr_string("last_mark")
-
-        if self.black_and_white:
-            add_attr_string("black_and_white")
-        add_attr_string("maturity_rating")
-        add_attr_string("story_arc")
-        add_attr_string("series_group")
-        add_attr_string("scan_info")
-        add_attr_string("characters")
-        add_attr_string("teams")
-        add_attr_string("locations")
-        add_attr_string("comments")
-        add_attr_string("notes")
-
-        add_string("tags", utils.list_to_string(self.tags))
-
-        for c in self.credits:
-            primary = ""
-            if "primary" in c and c["primary"]:
-                primary = " [P]"
-            add_string("credit", c["role"] + ": " + c["person"] + primary)
-
-        # find the longest field name
-        flen = 0
-        for i in vals:
-            flen = max(flen, len(i[0]))
-        flen += 1
-
-        # format the data nicely
-        outstr = ""
-        fmt_str = "{0: <" + str(flen) + "} {1}\n"
-        for i in vals:
-            outstr += fmt_str.format(i[0] + ":", i[1])
-
-        return outstr

comicapi/issuestring.py

@@ -1,127 +0,0 @@
-"""Support for mixed digit/string type Issue field
-
-Class for handling the odd permutations of an 'issue number' that the
-comics industry throws at us.
-  e.g.: "12", "12.1", "0", "-1", "5AU", "100-2"
-"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-import logging
-
-logger = logging.getLogger(__name__)
-
-
-class IssueString:
-    def __init__(self, text):
-
-        # break up the issue number string into 2 parts: the numeric and suffix string.
-        # (assumes that the numeric portion is always first)
-
-        self.num = None
-        self.suffix = ""
-
-        if text is None:
-            return
-
-        text = str(text)
-
-        if len(text) == 0:
-            return
-
-        # skip the minus sign if it's first
-        if text[0] == "-":
-            start = 1
-        else:
-            start = 0
-
-        # if it's still not numeric at start skip it
-        if text[start].isdigit() or text[start] == ".":
-            # walk through the string, look for split point (the first
-            # non-numeric)
-            decimal_count = 0
-            for idx in range(start, len(text)):
-                if text[idx] not in "0123456789.":
-                    break
-                # special case: also split on second "."
-                if text[idx] == ".":
-                    decimal_count += 1
-                    if decimal_count > 1:
-                        break
-            else:
-                idx = len(text)
-
-            # move trailing numeric decimal to suffix
-            # (only if there is other junk after )
-            if text[idx - 1] == "." and len(text) != idx:
-                idx = idx - 1
-
-            # if there is no numeric after the minus, make the minus part of
-            # the suffix
-            if idx == 1 and start == 1:
-                idx = 0
-
-            part1 = text[0:idx]
-            part2 = text[idx : len(text)]
-
-            if part1 != "":
-                self.num = float(part1)
-            self.suffix = part2
-        else:
-            self.suffix = text
-
-    def as_string(self, pad=0):
-        # return the float, left side zero-padded, with suffix attached
-        if self.num is None:
-            return self.suffix
-
-        negative = self.num < 0
-
-        num_f = abs(self.num)
-
-        num_int = int(num_f)
-        num_s = str(num_int)
-        if float(num_int) != num_f:
-            num_s = str(num_f)
-
-        num_s += self.suffix
-
-        # create padding
-        padding = ""
-        length = len(str(num_int))
-        if length < pad:
-            padding = "0" * (pad - length)
-
-        num_s = padding + num_s
-        if negative:
-            num_s = "-" + num_s
-
-        return num_s
-
-    def as_float(self):
-        # return the float, with no suffix
-        if self.suffix == "½":
-            if self.num is not None:
-                return self.num + 0.5
-
-            return 0.5
-        return self.num
-
-    def as_int(self):
-        # return the int version of the float
-        if self.num is None:
-            return None
-        return int(self.num)

comicapi/utils.py

@@ -1,241 +0,0 @@
-"""Some generic utilities"""
-
-# Copyright 2012-2014 Anthony Beville
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import codecs
-import locale
-import logging
-import os
-import platform
-import re
-import sys
-import unicodedata
-from collections import defaultdict
-
-import pycountry
-
-logger = logging.getLogger(__name__)
-
-
-class UtilsVars:
-    already_fixed_encoding = False
-
-
-def indent(elem, level=0):
-    # for making the XML output readable
-    i = "\n" + level * "  "
-    if len(elem):
-        if not elem.text or not elem.text.strip():
-            elem.text = i + "  "
-        if not elem.tail or not elem.tail.strip():
-            elem.tail = i
-        for ele in elem:
-            indent(ele, level + 1)
-        if not elem.tail or not elem.tail.strip():
-            elem.tail = i
-    else:
-        if level and (not elem.tail or not elem.tail.strip()):
-            elem.tail = i
-
-
-def get_actual_preferred_encoding():
-    preferred_encoding = locale.getpreferredencoding()
-    if platform.system() == "Darwin":
-        preferred_encoding = "utf-8"
-    return preferred_encoding
-
-
-def fix_output_encoding():
-    if not UtilsVars.already_fixed_encoding:
-        # this reads the environment and inits the right locale
-        locale.setlocale(locale.LC_ALL, "")
-
-        # try to make stdout/stderr encodings happy for unicode printing
-        preferred_encoding = get_actual_preferred_encoding()
-        sys.stdout = codecs.getwriter(preferred_encoding)(sys.stdout)
-        sys.stderr = codecs.getwriter(preferred_encoding)(sys.stderr)
-        UtilsVars.already_fixed_encoding = True
-
-
-def get_recursive_filelist(pathlist):
-    """Get a recursive list of of all files under all path items in the list"""
-
-    filelist = []
-    for p in pathlist:
-        # if path is a folder, walk it recursively, and all files underneath
-        if not isinstance(p, str):
-            # it's probably a QString
-            p = str(p)
-
-        if os.path.isdir(p):
-            for root, _, files in os.walk(p):
-                for f in files:
-                    if not isinstance(f, str):
-                        # it's probably a QString
-                        f = str(f)
-                    filelist.append(os.path.join(root, f))
-        else:
-            filelist.append(p)
-
-    return filelist
-
-
-def list_to_string(lst):
-    string = ""
-    if lst is not None:
-        for item in lst:
-            if len(string) > 0:
-                string += ", "
-            string += item
-    return string
-
-
-def add_to_path(dirname):
-    if dirname is not None and dirname != "":
-
-        # verify that path doesn't already contain the given dirname
-        tmpdirname = re.escape(dirname)
-        pattern = r"(^|{sep}){dir}({sep}|$)".format(dir=tmpdirname, sep=os.pathsep)
-
-        match = re.search(pattern, os.environ["PATH"])
-        if not match:
-            os.environ["PATH"] = dirname + os.pathsep + os.environ["PATH"]
-
-
-def which(program):
-    """Returns path of the executable, if it exists"""
-
-    def is_exe(fpath):
-        return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
-
-    fpath, _ = os.path.split(program)
-    if fpath:
-        if is_exe(program):
-            return program
-    else:
-        for path in os.environ["PATH"].split(os.pathsep):
-            exe_file = os.path.join(path, program)
-            if is_exe(exe_file):
-                return exe_file
-
-    return None
-
-
-def xlate(data, is_int=False):
-    if data is None or data == "":
-        return None
-    if is_int:
-        i = str(data).translate(defaultdict(lambda: None, zip((ord(c) for c in "1234567890"), "1234567890")))
-        if i == "0":
-            return "0"
-        if i == "":
-            return None
-        return int(i)
-
-    return str(data)
-
-
-def remove_articles(text):
-    text = text.lower()
-    articles = [
-        "&",
-        "a",
-        "am",
-        "an",
-        "and",
-        "as",
-        "at",
-        "be",
-        "but",
-        "by",
-        "for",
-        "if",
-        "is",
-        "issue",
-        "it",
-        "it's",
-        "its",
-        "itself",
-        "of",
-        "or",
-        "so",
-        "the",
-        "the",
-        "with",
-    ]
-    new_text = ""
-    for word in text.split(" "):
-        if word not in articles:
-            new_text += word + " "
-
-    new_text = new_text[:-1]
-
-    return new_text
-
-
-def sanitize_title(text):
-    # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
-    # this will probably cause issues with titles in other character sets e.g. chinese, japanese
-    text = unicodedata.normalize("NFKD", text).encode("ascii", "ignore").decode("ascii")
-    # comicvine keeps apostrophes a part of the word
-    text = text.replace("'", "")
-    text = text.replace('"', "")
-    # comicvine ignores punctuation and accents
-    text = re.sub(r"[^A-Za-z0-9]+", " ", text)
-    # remove extra space and articles and all lower case
-    text = remove_articles(text).lower().strip()
-
-    return text
-
-
-def unique_file(file_name):
-    counter = 1
-    file_name_parts = os.path.splitext(file_name)
-    while True:
-        if not os.path.lexists(file_name):
-            return file_name
-        file_name = file_name_parts[0] + " (" + str(counter) + ")" + file_name_parts[1]
-        counter += 1
-
-
-languages = defaultdict(lambda: None)
-
-countries = defaultdict(lambda: None)
-
-for c in pycountry.countries:
-    if "alpha_2" in c._fields:
-        countries[c.alpha_2] = c.name
-
-for lng in pycountry.languages:
-    if "alpha_2" in lng._fields:
-        languages[lng.alpha_2] = lng.name
-
-
-def get_language_from_iso(iso: str):
-    return languages[iso]
-
-
-def get_language(string):
-    if string is None:
-        return None
-
-    lang = get_language_from_iso(string)
-
-    if lang is None:
-        try:
-            return pycountry.languages.lookup(string).name
-        except:
-            return None
-    return lang

comictagger.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python3
-import localefix
 from comictaggerlib.main import ctmain
 
 if __name__ == "__main__":
-    localefix.configure_locale()
     ctmain()

comictagger.spec

@@ -1,50 +0,0 @@
-# -*- mode: python -*-
-
-import platform
-from os.path import join
-from comictaggerlib import ctversion
-
-enable_console = False
-binaries = []
-block_cipher = None
-
-if platform.system() == "Windows":
-    enable_console = True
-
-a = Analysis(['comictagger.py'],
-             binaries=binaries,
-             datas=[('comictaggerlib/ui/*.ui', 'ui'), ('comictaggerlib/graphics', 'graphics')],
-             hiddenimports=['PIL'],
-             hookspath=[],
-             runtime_hooks=[],
-             excludes=[],
-             win_no_prefer_redirects=False,
-             win_private_assemblies=False,
-             cipher=block_cipher)
-pyz = PYZ(a.pure, a.zipped_data,
-             cipher=block_cipher)
-exe = EXE(pyz,
-          a.scripts,
-          a.binaries,
-          a.zipfiles,
-          a.datas,
-          # single file setup
-          exclude_binaries=False,
-          name='comictagger',
-          debug=False,
-          strip=False,
-          upx=True,
-          console=enable_console,
-          icon="windows/app.ico" )
-
-app = BUNDLE(exe,
-            name='ComicTagger.app',
-            icon='mac/app.icns',
-            info_plist={
-                'NSHighResolutionCapable': 'True',
-                'NSRequiresAquaSystemAppearance': 'False',
-                'CFBundleDisplayName': 'ComicTagger',
-                'CFBundleShortVersionString': ctversion.version,
-                'CFBundleVersion': ctversion.version
-            },
-            bundle_identifier=None)

comictagger.sublime-project

@@ -0,0 +1,17 @@
+{
+	"build_systems":
+	[
+		{
+			"file_regex": "^[ ]*File \"(...*?)\", line ([0-9]*)",
+			"name": "Anaconda Python Builder",
+			"selector": "source.python",
+			"shell_cmd": "\"python3\" -u \"$file\""
+		}
+	],
+	"folders":
+	[
+		{
+			"path": "."
+		}
+	]
+}

comictaggerlib/__init__.py

@@ -0,0 +1 @@
+from ._version import version as __version__

comictaggerlib/autotagmatchwindow.py

@@ -14,30 +14,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import os
-from typing import List, Optional
 
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comicapi.comicarchive import MetaDataStyle
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.resulttypes import MultipleMatch
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
 
-logger = logging.getLogger(__name__)
+from .comicarchive import MetaDataStyle
+from .coverimagewidget import CoverImageWidget
+from .settings import ComicTaggerSettings
 
 
 class AutoTagMatchWindow(QtWidgets.QDialog):
+
     volume_id = 0
 
-    def __init__(self, parent, match_set_list: List[MultipleMatch], style, fetch_func):
-        super().__init__(parent)
+    def __init__(self, parent, match_set_list, style, fetch_func):
+        super(AutoTagMatchWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("matchselectionwindow.ui"), self)
-
-        self.current_match_set: Optional[MultipleMatch] = None
+        uic.loadUi(ComicTaggerSettings.getUIFile("matchselectionwindow.ui"), self)
 
         self.altCoverWidget = CoverImageWidget(self.altCoverContainer, CoverImageWidget.AltCoverMode)
         gridlayout = QtWidgets.QGridLayout(self.altCoverContainer)
@@ -49,20 +44,14 @@ class AutoTagMatchWindow(QtWidgets.QDialog):
         gridlayout.addWidget(self.archiveCoverWidget)
         gridlayout.setContentsMargins(0, 0, 0, 0)
 
-        reduce_widget_font_size(self.twList)
-        reduce_widget_font_size(self.teDescription, 1)
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
-        self.skipButton = QtWidgets.QPushButton("Skip to Next")
-        self.buttonBox.addButton(self.skipButton, QtWidgets.QDialogButtonBox.ButtonRole.ActionRole)
-        self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Ok).setText("Accept and Write Tags")
+        self.skipButton = QtWidgets.QPushButton(self.tr("Skip to Next"))
+        self.buttonBox.addButton(self.skipButton, QtWidgets.QDialogButtonBox.ActionRole)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setText("Accept and Write Tags")
 
         self.match_set_list = match_set_list
         self.style = style
@@ -70,35 +59,32 @@ class AutoTagMatchWindow(QtWidgets.QDialog):
 
         self.current_match_set_idx = 0
 
-        self.twList.currentItemChanged.connect(self.current_item_changed)
-        self.twList.cellDoubleClicked.connect(self.cell_double_clicked)
-        self.skipButton.clicked.connect(self.skip_to_next)
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
+        self.skipButton.clicked.connect(self.skipToNext)
 
-        self.update_data()
+        self.updateData()
 
-    def update_data(self):
+    def updateData(self):
 
         self.current_match_set = self.match_set_list[self.current_match_set_idx]
 
         if self.current_match_set_idx + 1 == len(self.match_set_list):
-            self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Cancel).setDisabled(True)
-            self.skipButton.setText("Skip")
+            self.buttonBox.button(QtWidgets.QDialogButtonBox.Cancel).setDisabled(True)
+            # self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setText("Accept")
+            self.skipButton.setText(self.tr("Skip"))
 
-        self.set_cover_image()
-        self.populate_table()
+        self.setCoverImage()
+        self.populateTable()
         self.twList.resizeColumnsToContents()
         self.twList.selectRow(0)
 
         path = self.current_match_set.ca.path
         self.setWindowTitle(
-            "Select correct match or skip ({0} of {1}): {2}".format(
-                self.current_match_set_idx + 1,
-                len(self.match_set_list),
-                os.path.split(path)[1],
-            )
+            "Select correct match or skip ({0} of {1}): {2}".format(self.current_match_set_idx + 1, len(self.match_set_list), os.path.split(path)[1])
         )
 
-    def populate_table(self):
+    def populateTable(self):
 
         while self.twList.rowCount() > 0:
             self.twList.removeRow(0)
@@ -111,132 +97,130 @@ class AutoTagMatchWindow(QtWidgets.QDialog):
 
             item_text = match["series"]
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setData(QtCore.Qt.ItemDataRole.UserRole, (match,))
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, (match,))
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 0, item)
 
             if match["publisher"] is not None:
-                item_text = str(match["publisher"])
+                item_text = "{0}".format(match["publisher"])
             else:
                 item_text = "Unknown"
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 1, item)
 
             month_str = ""
             year_str = "????"
             if match["month"] is not None:
-                month_str = f"-{int(match['month']):02d}"
+                month_str = "-{0:02d}".format(int(match["month"]))
             if match["year"] is not None:
-                year_str = str(match["year"])
+                year_str = "{0}".format(match["year"])
 
             item_text = year_str + month_str
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 2, item)
 
             item_text = match["issue_title"]
             if item_text is None:
                 item_text = ""
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 3, item)
 
             row += 1
 
         self.twList.resizeColumnsToContents()
         self.twList.setSortingEnabled(True)
-        self.twList.sortItems(2, QtCore.Qt.SortOrder.AscendingOrder)
+        self.twList.sortItems(2, QtCore.Qt.AscendingOrder)
         self.twList.selectRow(0)
         self.twList.resizeColumnsToContents()
         self.twList.horizontalHeader().setStretchLastSection(True)
 
-    def cell_double_clicked(self, r, c):
+    def cellDoubleClicked(self, r, c):
         self.accept()
 
-    def current_item_changed(self, curr, prev):
+    def currentItemChanged(self, curr, prev):
 
         if curr is None:
             return
         if prev is not None and prev.row() == curr.row():
             return
 
-        self.altCoverWidget.set_issue_id(self.current_match()["issue_id"])
-        if self.current_match()["description"] is None:
+        self.altCoverWidget.setIssueID(self.currentMatch()["issue_id"])
+        if self.currentMatch()["description"] is None:
             self.teDescription.setText("")
         else:
-            self.teDescription.setText(self.current_match()["description"])
+            self.teDescription.setText(self.currentMatch()["description"])
 
-    def set_cover_image(self):
+    def setCoverImage(self):
         ca = self.current_match_set.ca
-        self.archiveCoverWidget.set_archive(ca)
+        self.archiveCoverWidget.setArchive(ca)
 
-    def current_match(self):
+    def currentMatch(self):
         row = self.twList.currentRow()
-        match = self.twList.item(row, 0).data(QtCore.Qt.ItemDataRole.UserRole)[0]
+        match = self.twList.item(row, 0).data(QtCore.Qt.UserRole)[0]
         return match
 
     def accept(self):
 
-        self.save_match()
+        self.saveMatch()
         self.current_match_set_idx += 1
 
         if self.current_match_set_idx == len(self.match_set_list):
             # no more items
             QtWidgets.QDialog.accept(self)
         else:
-            self.update_data()
+            self.updateData()
 
-    def skip_to_next(self):
+    def skipToNext(self):
         self.current_match_set_idx += 1
 
         if self.current_match_set_idx == len(self.match_set_list):
             # no more items
             QtWidgets.QDialog.reject(self)
         else:
-            self.update_data()
+            self.updateData()
 
     def reject(self):
         reply = QtWidgets.QMessageBox.question(
             self,
-            "Cancel Matching",
-            "Are you sure you wish to cancel the matching process?",
-            QtWidgets.QMessageBox.StandardButton.Yes,
-            QtWidgets.QMessageBox.StandardButton.No,
+            self.tr("Cancel Matching"),
+            self.tr("Are you sure you wish to cancel the matching process?"),
+            QtWidgets.QMessageBox.Yes,
+            QtWidgets.QMessageBox.No,
         )
 
-        if reply == QtWidgets.QMessageBox.StandardButton.No:
+        if reply == QtWidgets.QMessageBox.No:
             return
 
         QtWidgets.QDialog.reject(self)
 
-    def save_match(self):
+    def saveMatch(self):
 
-        match = self.current_match()
+        match = self.currentMatch()
         ca = self.current_match_set.ca
 
-        md = ca.read_metadata(self.style)
-        if md.is_empty:
-            md = ca.metadata_from_filename()
+        md = ca.readMetadata(self.style)
+        if md.isEmpty:
+            md = ca.metadataFromFilename()
 
         # now get the particular issue data
         cv_md = self.fetch_func(match)
         if cv_md is None:
-            QtWidgets.QMessageBox.critical(
-                self, "Network Issue", "Could not connect to Comic Vine to get issue details!"
-            )
+            QtWidgets.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to Comic Vine to get issue details!"))
             return
 
-        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.CursorShape.WaitCursor))
+        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
         md.overlay(cv_md)
-        success = ca.write_metadata(md, self.style)
-        ca.load_cache([MetaDataStyle.CBI, MetaDataStyle.CIX])
+        success = ca.writeMetadata(md, self.style)
+        ca.loadCache([MetaDataStyle.CBI, MetaDataStyle.CIX])
 
         QtWidgets.QApplication.restoreOverrideCursor()
 
         if not success:
-            QtWidgets.QMessageBox.warning(self, "Write Error", "Saving the tags to the archive seemed to fail!")
+            QtWidgets.QMessageBox.warning(self, self.tr("Write Error"), self.tr("Saving the tags to the archive seemed to fail!"))

comictaggerlib/autotagprogresswindow.py

@@ -14,23 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-import logging
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
 
-from PyQt5 import QtCore, QtWidgets, uic
-
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
-
-logger = logging.getLogger(__name__)
+from .coverimagewidget import CoverImageWidget
+from .settings import ComicTaggerSettings
 
 
 class AutoTagProgressWindow(QtWidgets.QDialog):
     def __init__(self, parent):
-        super().__init__(parent)
+        super(AutoTagProgressWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("autotagprogresswindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("autotagprogresswindow.ui"), self)
 
         self.archiveCoverWidget = CoverImageWidget(self.archiveCoverContainer, CoverImageWidget.DataMode, False)
         gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
@@ -44,24 +40,18 @@ class AutoTagProgressWindow(QtWidgets.QDialog):
 
         self.isdone = False
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
-        reduce_widget_font_size(self.textEdit)
+        reduceWidgetFontSize(self.textEdit)
 
-    def set_archive_image(self, img_data):
-        self.set_cover_image(img_data, self.archiveCoverWidget)
+    def setArchiveImage(self, img_data):
+        self.setCoverImage(img_data, self.archiveCoverWidget)
 
-    def set_test_image(self, img_data):
-        self.set_cover_image(img_data, self.testCoverWidget)
+    def setTestImage(self, img_data):
+        self.setCoverImage(img_data, self.testCoverWidget)
 
-    def set_cover_image(self, img_data, widget):
-        widget.set_image_data(img_data)
+    def setCoverImage(self, img_data, widget):
+        widget.setImageData(img_data)
         QtCore.QCoreApplication.processEvents()
         QtCore.QCoreApplication.processEvents()
 

comictaggerlib/autotagstartwindow.py

@@ -14,105 +14,101 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-import logging
-
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class AutoTagStartWindow(QtWidgets.QDialog):
     def __init__(self, parent, settings, msg):
-        super().__init__(parent)
+        super(AutoTagStartWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("autotagstartwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("autotagstartwindow.ui"), self)
         self.label.setText(msg)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(self.windowFlags() & ~QtCore.Qt.WindowType.WindowContextHelpButtonHint)
-        )
+        self.setWindowFlags(self.windowFlags() & ~QtCore.Qt.WindowContextHelpButtonHint)
 
         self.settings = settings
 
-        self.cbxSaveOnLowConfidence.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxDontUseYear.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxAssumeIssueOne.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxIgnoreLeadingDigitsInFilename.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxRemoveAfterSuccess.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxSpecifySearchString.setCheckState(QtCore.Qt.CheckState.Unchecked)
+        self.cbxSaveOnLowConfidence.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxDontUseYear.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxAssumeIssueOne.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxIgnoreLeadingDigitsInFilename.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxRemoveAfterSuccess.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxSpecifySearchString.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxAutoImprint.setCheckState(QtCore.Qt.Unchecked)
         self.leNameLengthMatchTolerance.setText(str(self.settings.id_length_delta_thresh))
         self.leSearchString.setEnabled(False)
 
         if self.settings.save_on_low_confidence:
-            self.cbxSaveOnLowConfidence.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxSaveOnLowConfidence.setCheckState(QtCore.Qt.Checked)
         if self.settings.dont_use_year_when_identifying:
-            self.cbxDontUseYear.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxDontUseYear.setCheckState(QtCore.Qt.Checked)
         if self.settings.assume_1_if_no_issue_num:
-            self.cbxAssumeIssueOne.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxAssumeIssueOne.setCheckState(QtCore.Qt.Checked)
         if self.settings.ignore_leading_numbers_in_filename:
-            self.cbxIgnoreLeadingDigitsInFilename.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxIgnoreLeadingDigitsInFilename.setCheckState(QtCore.Qt.Checked)
         if self.settings.remove_archive_after_successful_match:
-            self.cbxRemoveAfterSuccess.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxRemoveAfterSuccess.setCheckState(QtCore.Qt.Checked)
         if self.settings.wait_and_retry_on_rate_limit:
-            self.cbxWaitForRateLimit.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxWaitForRateLimit.setCheckState(QtCore.Qt.Checked)
+        if self.settings.auto_imprint:
+            self.cbxAutoImprint.setCheckState(QtCore.Qt.Checked)
 
-        nlmt_tip = """ <html>The <b>Name Length Match Tolerance</b> is for eliminating automatic
+        nlmtTip = """ <html>The <b>Name Length Match Tolerance</b> is for eliminating automatic
                 search matches that are too long compared to your series name search. The higher
                 it is, the more likely to have a good match, but each search will take longer and
                 use more bandwidth. Too low, and only the very closest lexical matches will be
                 explored.</html>"""
 
-        self.leNameLengthMatchTolerance.setToolTip(nlmt_tip)
+        self.leNameLengthMatchTolerance.setToolTip(nlmtTip)
 
-        ss_tip = """<html>
+        ssTip = """<html>
             The <b>series search string</b> specifies the search string to be used for all selected archives.
             Use this when trying to match archives with hard-to-parse or incorrect filenames.  All archives selected
             should be from the same series.
             </html>"""
-        self.leSearchString.setToolTip(ss_tip)
-        self.cbxSpecifySearchString.setToolTip(ss_tip)
+        self.leSearchString.setToolTip(ssTip)
+        self.cbxSpecifySearchString.setToolTip(ssTip)
 
         validator = QtGui.QIntValidator(0, 99, self)
         self.leNameLengthMatchTolerance.setValidator(validator)
 
-        self.cbxSpecifySearchString.stateChanged.connect(self.search_string_toggle)
+        self.cbxSpecifySearchString.stateChanged.connect(self.searchStringToggle)
 
-        self.auto_save_on_low = False
-        self.dont_use_year = False
-        self.assume_issue_one = False
-        self.ignore_leading_digits_in_filename = False
-        self.remove_after_success = False
-        self.wait_and_retry_on_rate_limit = False
-        self.search_string = None
-        self.name_length_match_tolerance = self.settings.id_length_delta_thresh
+        self.autoSaveOnLow = False
+        self.dontUseYear = False
+        self.assumeIssueOne = False
+        self.ignoreLeadingDigitsInFilename = False
+        self.removeAfterSuccess = False
+        self.waitAndRetryOnRateLimit = False
+        self.searchString = None
+        self.nameLengthMatchTolerance = self.settings.id_length_delta_thresh
 
-    def search_string_toggle(self):
+    def searchStringToggle(self):
         enable = self.cbxSpecifySearchString.isChecked()
         self.leSearchString.setEnabled(enable)
 
     def accept(self):
         QtWidgets.QDialog.accept(self)
 
-        self.auto_save_on_low = self.cbxSaveOnLowConfidence.isChecked()
-        self.dont_use_year = self.cbxDontUseYear.isChecked()
-        self.assume_issue_one = self.cbxAssumeIssueOne.isChecked()
-        self.ignore_leading_digits_in_filename = self.cbxIgnoreLeadingDigitsInFilename.isChecked()
-        self.remove_after_success = self.cbxRemoveAfterSuccess.isChecked()
-        self.name_length_match_tolerance = int(self.leNameLengthMatchTolerance.text())
-        self.wait_and_retry_on_rate_limit = self.cbxWaitForRateLimit.isChecked()
+        self.autoSaveOnLow = self.cbxSaveOnLowConfidence.isChecked()
+        self.dontUseYear = self.cbxDontUseYear.isChecked()
+        self.assumeIssueOne = self.cbxAssumeIssueOne.isChecked()
+        self.ignoreLeadingDigitsInFilename = self.cbxIgnoreLeadingDigitsInFilename.isChecked()
+        self.removeAfterSuccess = self.cbxRemoveAfterSuccess.isChecked()
+        self.nameLengthMatchTolerance = int(self.leNameLengthMatchTolerance.text())
+        self.waitAndRetryOnRateLimit = self.cbxWaitForRateLimit.isChecked()
 
         # persist some settings
-        self.settings.save_on_low_confidence = self.auto_save_on_low
-        self.settings.dont_use_year_when_identifying = self.dont_use_year
-        self.settings.assume_1_if_no_issue_num = self.assume_issue_one
-        self.settings.ignore_leading_numbers_in_filename = self.ignore_leading_digits_in_filename
-        self.settings.remove_archive_after_successful_match = self.remove_after_success
-        self.settings.wait_and_retry_on_rate_limit = self.wait_and_retry_on_rate_limit
+        self.settings.save_on_low_confidence = self.autoSaveOnLow
+        self.settings.dont_use_year_when_identifying = self.dontUseYear
+        self.settings.assume_1_if_no_issue_num = self.assumeIssueOne
+        self.settings.ignore_leading_numbers_in_filename = self.ignoreLeadingDigitsInFilename
+        self.settings.remove_archive_after_successful_match = self.removeAfterSuccess
+        self.settings.wait_and_retry_on_rate_limit = self.waitAndRetryOnRateLimit
 
         if self.cbxSpecifySearchString.isChecked():
-            self.search_string = str(self.leSearchString.text())
-            if len(self.search_string) == 0:
-                self.search_string = None
+            self.searchString = str(self.leSearchString.text())
+            if len(self.searchString) == 0:
+                self.searchString = None

comictaggerlib/cbltransformer.py

@@ -14,15 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
-
-from comicapi.genericmetadata import GenericMetadata
-
-logger = logging.getLogger(__name__)
 
 
 class CBLTransformer:
-    def __init__(self, metadata: GenericMetadata, settings):
+    def __init__(self, metadata, settings):
         self.metadata = metadata
         self.settings = settings
 
@@ -41,7 +36,7 @@ class CBLTransformer:
         if self.settings.assume_lone_credit_is_primary:
 
             # helper
-            def set_lone_primary(role_list):
+            def setLonePrimary(role_list):
                 lone_credit = None
                 count = 0
                 for c in self.metadata.credits:
@@ -57,13 +52,13 @@ class CBLTransformer:
 
             # need to loop three times, once for 'writer', 'artist', and then
             # 'penciler' if no artist
-            set_lone_primary(["writer"])
-            c, count = set_lone_primary(["artist"])
+            setLonePrimary(["writer"])
+            c, count = setLonePrimary(["artist"])
             if c is None and count == 0:
-                c, count = set_lone_primary(["penciler", "penciller"])
+                c, count = setLonePrimary(["penciler", "penciller"])
                 if c is not None:
                     c["primary"] = False
-                    self.metadata.add_credit(c["person"], "Artist", True)
+                    self.metadata.addCredit(c["person"], "Artist", True)
 
         if self.settings.copy_characters_to_tags:
             add_string_list_to_tags(self.metadata.characters)
@@ -75,7 +70,7 @@ class CBLTransformer:
             add_string_list_to_tags(self.metadata.locations)
 
         if self.settings.copy_storyarcs_to_tags:
-            add_string_list_to_tags(self.metadata.story_arc)
+            add_string_list_to_tags(self.metadata.storyArc)
 
         if self.settings.copy_notes_to_comments:
             if self.metadata.notes is not None:
@@ -87,12 +82,12 @@ class CBLTransformer:
                     self.metadata.comments += self.metadata.notes
 
         if self.settings.copy_weblink_to_comments:
-            if self.metadata.web_link is not None:
+            if self.metadata.webLink is not None:
                 if self.metadata.comments is None:
                     self.metadata.comments = ""
                 else:
                     self.metadata.comments += "\n\n"
-                if self.metadata.web_link not in self.metadata.comments:
-                    self.metadata.comments += self.metadata.web_link
+                if self.metadata.webLink not in self.metadata.comments:
+                    self.metadata.comments += self.metadata.webLink
 
         return self.metadata

comictaggerlib/cli.py

@@ -17,33 +17,48 @@
 # limitations under the License.
 
 import json
-import logging
 import os
 import sys
 from pprint import pprint
 
-from comicapi import utils
-from comicapi.comicarchive import ComicArchive, MetaDataStyle
-from comicapi.genericmetadata import GenericMetadata
-from comictaggerlib.cbltransformer import CBLTransformer
-from comictaggerlib.comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from comictaggerlib.filerenamer import FileRenamer
-from comictaggerlib.issueidentifier import IssueIdentifier
-from comictaggerlib.resulttypes import MultipleMatch, OnlineMatchResults
-from comictaggerlib.settings import ComicTaggerSettings
+from . import utils
+from .cbltransformer import CBLTransformer
+from .comicarchive import ComicArchive, MetaDataStyle
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .filerenamer import FileRenamer
+from .genericmetadata import GenericMetadata
+from .issueidentifier import IssueIdentifier
+from .options import Options
+from .settings import ComicTaggerSettings
 
 filename_encoding = sys.getfilesystemencoding()
-logger = logging.getLogger(__name__)
+
+
+class MultipleMatch:
+    def __init__(self, filename, match_list):
+        self.filename = filename
+        self.matches = match_list
+
+
+class OnlineMatchResults:
+    def __init__(self):
+        self.goodMatches = []
+        self.noMatches = []
+        self.multipleMatches = []
+        self.lowConfidenceMatches = []
+        self.writeFailures = []
+        self.fetchDataFailures = []
 
 
 def actual_issue_data_fetch(match, settings, opts):
+
     # now get the particular issue data
     try:
-        comic_vine = ComicVineTalker()
-        comic_vine.wait_for_rate_limit = opts.wait_and_retry_on_rate_limit
-        cv_md = comic_vine.fetch_issue_data(match["volume_id"], match["issue_number"], settings)
+        comicVine = ComicVineTalker()
+        comicVine.wait_for_rate_limit = opts.wait_and_retry_on_rate_limit
+        cv_md = comicVine.fetchIssueData(match["volume_id"], match["issue_number"], settings)
     except ComicVineTalkerException:
-        logger.exception("Network error while getting issue details.  Save aborted")
+        print("Network error while getting issue details.  Save aborted", file=sys.stderr)
         return None
 
     if settings.apply_cbl_transform_on_cv_import:
@@ -52,28 +67,26 @@ def actual_issue_data_fetch(match, settings, opts):
     return cv_md
 
 
-def actual_metadata_save(ca: ComicArchive, opts, md):
+def actual_metadata_save(ca, opts, md):
+
     if not opts.dryrun:
         # write out the new data
-        if not ca.write_metadata(md, opts.data_style):
-            logger.error("The tag save seemed to fail!")
+        if not ca.writeMetadata(md, opts.data_style):
+            print("The tag save seemed to fail!", file=sys.stderr)
             return False
-
-        print("Save complete.")
-        logger.info("Save complete.")
+        else:
+            print("Save complete.", file=sys.stderr)
     else:
         if opts.terse:
-            logger.info("dry-run option was set, so nothing was written")
-            print("dry-run option was set, so nothing was written")
+            print("dry-run option was set, so nothing was written", file=sys.stderr)
         else:
-            logger.info("dry-run option was set, so nothing was written, but here is the final set of tags:")
-            print("dry-run option was set, so nothing was written, but here is the final set of tags:")
-            print(f"{md}")
+            print("dry-run option was set, so nothing was written, but here is the final set of tags:", file=sys.stderr)
+            print("{0}".format(md))
     return True
 
 
-def display_match_set_for_choice(label, match_set: MultipleMatch, opts, settings):
-    print(f"{match_set.ca.path} -- {label}:")
+def display_match_set_for_choice(label, match_set, opts, settings):
+    print("{0} -- {1}:".format(match_set.filename, label))
 
     # sort match list by year
     match_set.matches.sort(key=lambda k: k["year"])
@@ -82,13 +95,7 @@ def display_match_set_for_choice(label, match_set: MultipleMatch, opts, settings
         counter += 1
         print(
             "    {0}. {1} #{2} [{3}] ({4}/{5}) - {6}".format(
-                counter,
-                m["series"],
-                m["issue_number"],
-                m["publisher"],
-                m["month"],
-                m["year"],
-                m["issue_title"],
+                counter, m["series"], m["issue_number"], m["publisher"], m["month"], m["year"], m["issue_title"]
             )
         )
     if opts.interactive:
@@ -100,48 +107,52 @@ def display_match_set_for_choice(label, match_set: MultipleMatch, opts, settings
             i = int(i) - 1
             # save the data!
             # we know at this point, that the file is all good to go
-            ca = match_set.ca
-            md = create_local_metadata(opts, ca, ca.has_metadata(opts.data_style))
+            ca = ComicArchive(match_set.filename, settings.rar_exe_path, ComicTaggerSettings.getGraphic("nocover.png"))
+            md = create_local_metadata(opts, ca, ca.hasMetadata(opts.data_style))
             cv_md = actual_issue_data_fetch(match_set.matches[int(i)], settings, opts)
             md.overlay(cv_md)
+
+            if settings.auto_imprint:
+                md.fixPublisher()
+
             actual_metadata_save(ca, opts, md)
 
 
-def post_process_matches(match_results: OnlineMatchResults, opts, settings):
+def post_process_matches(match_results, opts, settings):
     # now go through the match results
     if opts.show_save_summary:
-        if len(match_results.good_matches) > 0:
+        if len(match_results.goodMatches) > 0:
             print("\nSuccessful matches:\n------------------")
-            for f in match_results.good_matches:
+            for f in match_results.goodMatches:
                 print(f)
 
-        if len(match_results.no_matches) > 0:
+        if len(match_results.noMatches) > 0:
             print("\nNo matches:\n------------------")
-            for f in match_results.no_matches:
+            for f in match_results.noMatches:
                 print(f)
 
-        if len(match_results.write_failures) > 0:
+        if len(match_results.writeFailures) > 0:
             print("\nFile Write Failures:\n------------------")
-            for f in match_results.write_failures:
+            for f in match_results.writeFailures:
                 print(f)
 
-        if len(match_results.fetch_data_failures) > 0:
+        if len(match_results.fetchDataFailures) > 0:
             print("\nNetwork Data Fetch Failures:\n------------------")
-            for f in match_results.fetch_data_failures:
+            for f in match_results.fetchDataFailures:
                 print(f)
 
     if not opts.show_save_summary and not opts.interactive:
         # just quit if we're not interactive or showing the summary
         return
 
-    if len(match_results.multiple_matches) > 0:
+    if len(match_results.multipleMatches) > 0:
         print("\nArchives with multiple high-confidence matches:\n------------------")
-        for match_set in match_results.multiple_matches:
+        for match_set in match_results.multipleMatches:
             display_match_set_for_choice("Multiple high-confidence matches", match_set, opts, settings)
 
-    if len(match_results.low_confidence_matches) > 0:
+    if len(match_results.lowConfidenceMatches) > 0:
         print("\nArchives with low-confidence matches:\n------------------")
-        for match_set in match_results.low_confidence_matches:
+        for match_set in match_results.lowConfidenceMatches:
             if len(match_set.matches) == 1:
                 label = "Single low-confidence match"
             else:
@@ -152,28 +163,31 @@ def post_process_matches(match_results: OnlineMatchResults, opts, settings):
 
 def cli_mode(opts, settings):
     if len(opts.file_list) < 1:
-        logger.error("You must specify at least one filename.  Use the -h option for more info")
+        print("You must specify at least one filename.  Use the -h option for more info", file=sys.stderr)
         return
 
     match_results = OnlineMatchResults()
 
     for f in opts.file_list:
+        if isinstance(f, str):
+            pass
         process_file_cli(f, opts, settings, match_results)
         sys.stdout.flush()
 
     post_process_matches(match_results, opts, settings)
 
 
-def create_local_metadata(opts, ca: ComicArchive, has_desired_tags):
+def create_local_metadata(opts, ca, has_desired_tags):
+
     md = GenericMetadata()
-    md.set_default_page_list(ca.get_number_of_pages())
+    md.setDefaultPageList(ca.getNumberOfPages())
+
+    if has_desired_tags:
+        md = ca.readMetadata(opts.data_style)
 
     # now, overlay the parsed filename info
     if opts.parse_filename:
-        md.overlay(ca.metadata_from_filename())
-
-    if has_desired_tags:
-        md = ca.read_metadata(opts.data_style)
+        md.overlay(ca.metadataFromFilename())
 
     # finally, use explicit stuff
     if opts.metadata is not None:
@@ -182,51 +196,54 @@ def create_local_metadata(opts, ca: ComicArchive, has_desired_tags):
     return md
 
 
-def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults):
+def process_file_cli(filename, opts, settings, match_results):
+
     batch_mode = len(opts.file_list) > 1
 
-    ca = ComicArchive(filename, settings.rar_exe_path, ComicTaggerSettings.get_graphic("nocover.png"))
+    settings.auto_imprint = opts.auto_imprint
+
+    ca = ComicArchive(filename, settings.rar_exe_path, ComicTaggerSettings.getGraphic("nocover.png"))
 
     if not os.path.lexists(filename):
-        logger.error("Cannot find " + filename)
+        print("Cannot find " + filename, file=sys.stderr)
         return
 
-    if not ca.seems_to_be_a_comic_archive():
-        logger.error("Sorry, but %s is not a comic archive!", filename)
+    if not ca.seemsToBeAComicArchive():
+        print("Sorry, but " + filename + "  is not a comic archive!", file=sys.stderr)
         return
 
-    if not ca.is_writable() and (opts.delete_tags or opts.copy_tags or opts.save_tags or opts.rename_file):
-        logger.error("This archive is not writable for that tag type")
+    # if not ca.isWritableForStyle(opts.data_style) and (opts.delete_tags or
+    # opts.save_tags or opts.rename_file):
+    if not ca.isWritable() and (opts.delete_tags or opts.copy_tags or opts.save_tags or opts.rename_file):
+        print("This archive is not writable for that tag type", file=sys.stderr)
         return
 
     has = [False, False, False]
-    if ca.has_cix():
+    if ca.hasCIX():
         has[MetaDataStyle.CIX] = True
-    if ca.has_cbi():
+    if ca.hasCBI():
         has[MetaDataStyle.CBI] = True
-    if ca.has_comet():
+    if ca.hasCoMet():
         has[MetaDataStyle.COMET] = True
 
     if opts.print_tags:
 
         if opts.data_style is None:
-            page_count = ca.get_number_of_pages()
+            page_count = ca.getNumberOfPages()
 
             brief = ""
 
             if batch_mode:
-                brief = f"{ca.path}: "
+                brief = "{0}: ".format(filename)
 
-            if ca.is_sevenzip():
-                brief += "7Z archive     "
-            elif ca.is_zip():
+            if ca.isZip():
                 brief += "ZIP archive    "
-            elif ca.is_rar():
+            elif ca.isRar():
                 brief += "RAR archive    "
-            elif ca.is_folder():
+            elif ca.isFolder():
                 brief += "Folder archive "
 
-            brief += f"({page_count: >3} pages)"
+            brief += "({0: >3} pages)".format(page_count)
             brief += "  tags:[ "
 
             if not (has[MetaDataStyle.CBI] or has[MetaDataStyle.CIX] or has[MetaDataStyle.COMET]):
@@ -251,73 +268,73 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
             if has[MetaDataStyle.CIX]:
                 print("--------- ComicRack tags ---------")
                 if opts.raw:
-                    print(ca.read_raw_cix())
+                    print("{0}".format(str(ca.readRawCIX(), errors="ignore")))
                 else:
-                    print(ca.read_cix())
+                    print("{0}".format(ca.readCIX()))
 
         if opts.data_style is None or opts.data_style == MetaDataStyle.CBI:
             if has[MetaDataStyle.CBI]:
                 print("------- ComicBookLover tags -------")
                 if opts.raw:
-                    pprint(json.loads(ca.read_raw_cbi()))
+                    pprint(json.loads(ca.readRawCBI()))
                 else:
-                    print(ca.read_cbi())
+                    print("{0}".format(ca.readCBI()))
 
         if opts.data_style is None or opts.data_style == MetaDataStyle.COMET:
             if has[MetaDataStyle.COMET]:
                 print("----------- CoMet tags -----------")
                 if opts.raw:
-                    print(ca.read_raw_comet())
+                    print("{0}".format(ca.readRawCoMet()))
                 else:
-                    print(ca.read_comet())
+                    print("{0}".format(ca.readCoMet()))
 
     elif opts.delete_tags:
         style_name = MetaDataStyle.name[opts.data_style]
         if has[opts.data_style]:
             if not opts.dryrun:
-                if not ca.remove_metadata(opts.data_style):
-                    print(f"{filename}: Tag removal seemed to fail!")
+                if not ca.removeMetadata(opts.data_style):
+                    print("{0}: Tag removal seemed to fail!".format(filename))
                 else:
-                    print(f"{filename}: Removed {style_name} tags.")
+                    print("{0}: Removed {1} tags.".format(filename, style_name))
             else:
-                print(f"{filename}: dry-run. {style_name} tags not removed")
+                print("{0}: dry-run. {1} tags not removed".format(filename, style_name))
         else:
-            print(f"{filename}: This archive doesn't have {style_name} tags to remove.")
+            print("{0}: This archive doesn't have {1} tags to remove.".format(filename, style_name))
 
     elif opts.copy_tags:
         dst_style_name = MetaDataStyle.name[opts.data_style]
         if opts.no_overwrite and has[opts.data_style]:
-            print(f"{filename}: Already has {dst_style_name} tags. Not overwriting.")
+            print("{0}: Already has {1} tags. Not overwriting.".format(filename, dst_style_name))
             return
         if opts.copy_source == opts.data_style:
-            print(f"{filename}: Destination and source are same: {dst_style_name}. Nothing to do.")
+            print("{0}: Destination and source are same: {1}. Nothing to do.".format(filename, dst_style_name))
             return
 
         src_style_name = MetaDataStyle.name[opts.copy_source]
         if has[opts.copy_source]:
             if not opts.dryrun:
-                md = ca.read_metadata(opts.copy_source)
+                md = ca.readMetadata(opts.copy_source)
 
                 if settings.apply_cbl_transform_on_bulk_operation and opts.data_style == MetaDataStyle.CBI:
                     md = CBLTransformer(md, settings).apply()
 
-                if not ca.write_metadata(md, opts.data_style):
-                    print(f"{filename}: Tag copy seemed to fail!")
+                if not ca.writeMetadata(md, opts.data_style):
+                    print("{0}: Tag copy seemed to fail!".format(filename))
                 else:
-                    print(f"{filename}: Copied {src_style_name} tags to {dst_style_name}.")
+                    print("{0}: Copied {1} tags to {2} .".format(filename, src_style_name, dst_style_name))
             else:
-                print(f"{filename}: dry-run.  {src_style_name} tags not copied")
+                print("{0}: dry-run.  {1} tags not copied".format(filename, src_style_name))
         else:
-            print(f"{filename}: This archive doesn't have {src_style_name} tags to copy.")
+            print("{0}: This archive doesn't have {1} tags to copy.".format(filename, src_style_name))
 
     elif opts.save_tags:
 
         if opts.no_overwrite and has[opts.data_style]:
-            print(f"{filename}: Already has {MetaDataStyle.name[opts.data_style]} tags. Not overwriting.")
+            print("{0}: Already has {1} tags. Not overwriting.".format(filename, MetaDataStyle.name[opts.data_style]))
             return
 
         if batch_mode:
-            print(f"Processing {ca.path}...")
+            print("Processing {0}...".format(filename))
 
         md = create_local_metadata(opts, ca, has[opts.data_style])
         if md.issue is None or md.issue == "":
@@ -329,17 +346,17 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
             if opts.issue_id is not None:
                 # we were given the actual ID to search with
                 try:
-                    comic_vine = ComicVineTalker()
-                    comic_vine.wait_for_rate_limit = opts.wait_and_retry_on_rate_limit
-                    cv_md = comic_vine.fetch_issue_data_by_issue_id(opts.issue_id, settings)
+                    comicVine = ComicVineTalker()
+                    comicVine.wait_for_rate_limit = opts.wait_and_retry_on_rate_limit
+                    cv_md = comicVine.fetchIssueDataByIssueID(opts.issue_id, settings)
                 except ComicVineTalkerException:
-                    logger.exception("Network error while getting issue details. Save aborted")
-                    match_results.fetch_data_failures.append(ca.path)
+                    print("Network error while getting issue details.  Save aborted", file=sys.stderr)
+                    match_results.fetchDataFailures.append(filename)
                     return
 
                 if cv_md is None:
-                    logger.error("No match for ID %s was found.", opts.issue_id)
-                    match_results.no_matches.append(ca.path)
+                    print("No match for ID {0} was found.".format(opts.issue_id), file=sys.stderr)
+                    match_results.noMatches.append(filename)
                     return
 
                 if settings.apply_cbl_transform_on_cv_import:
@@ -347,21 +364,21 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
             else:
                 ii = IssueIdentifier(ca, settings)
 
-                if md is None or md.is_empty:
-                    logger.error("No metadata given to search online with!")
-                    match_results.no_matches.append(ca.path)
+                if md is None or md.isEmpty:
+                    print("No metadata given to search online with!", file=sys.stderr)
+                    match_results.noMatches.append(filename)
                     return
 
                 def myoutput(text):
                     if opts.verbose:
-                        IssueIdentifier.default_write_output(text)
+                        IssueIdentifier.defaultWriteOutput(text)
 
                 # use our overlayed MD struct to search
-                ii.set_additional_metadata(md)
-                ii.only_use_additional_meta_data = True
-                ii.wait_and_retry_on_rate_limit = opts.wait_and_retry_on_rate_limit
-                ii.set_output_function(myoutput)
-                ii.cover_page_index = md.get_cover_page_index_list()[0]
+                ii.setAdditionalMetadata(md)
+                ii.onlyUseAdditionalMetaData = True
+                ii.waitAndRetryOnRateLimit = opts.wait_and_retry_on_rate_limit
+                ii.setOutputFunction(myoutput)
+                ii.cover_page_index = md.getCoverPageIndexList()[0]
                 matches = ii.search()
 
                 result = ii.search_result
@@ -370,37 +387,37 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
                 choices = False
                 low_confidence = False
 
-                if result == ii.result_no_matches:
+                if result == ii.ResultNoMatches:
                     pass
-                elif result == ii.result_found_match_but_bad_cover_score:
+                elif result == ii.ResultFoundMatchButBadCoverScore:
                     low_confidence = True
                     found_match = True
-                elif result == ii.result_found_match_but_not_first_page:
+                elif result == ii.ResultFoundMatchButNotFirstPage:
                     found_match = True
-                elif result == ii.result_multiple_matches_with_bad_image_scores:
+                elif result == ii.ResultMultipleMatchesWithBadImageScores:
                     low_confidence = True
                     choices = True
-                elif result == ii.result_one_good_match:
+                elif result == ii.ResultOneGoodMatch:
                     found_match = True
-                elif result == ii.result_multiple_good_matches:
+                elif result == ii.ResultMultipleGoodMatches:
                     choices = True
 
                 if choices:
                     if low_confidence:
-                        logger.error("Online search: Multiple low confidence matches. Save aborted")
-                        match_results.low_confidence_matches.append(MultipleMatch(ca, matches))
+                        print("Online search: Multiple low confidence matches.  Save aborted", file=sys.stderr)
+                        match_results.lowConfidenceMatches.append(MultipleMatch(filename, matches))
+                        return
+                    else:
+                        print("Online search: Multiple good matches.  Save aborted", file=sys.stderr)
+                        match_results.multipleMatches.append(MultipleMatch(filename, matches))
                         return
-
-                    logger.error("Online search: Multiple good matches. Save aborted")
-                    match_results.multiple_matches.append(MultipleMatch(ca, matches))
-                    return
                 if low_confidence and opts.abortOnLowConfidence:
-                    logger.error("Online search: Low confidence match. Save aborted")
-                    match_results.low_confidence_matches.append(MultipleMatch(ca, matches))
+                    print("Online search: Low confidence match.  Save aborted", file=sys.stderr)
+                    match_results.lowConfidenceMatches.append(MultipleMatch(filename, matches))
                     return
                 if not found_match:
-                    logger.error("Online search: No match found. Save aborted")
-                    match_results.no_matches.append(ca.path)
+                    print("Online search: No match found.  Save aborted", file=sys.stderr)
+                    match_results.noMatches.append(filename)
                     return
 
                 # we got here, so we have a single match
@@ -408,22 +425,25 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
                 # now get the particular issue data
                 cv_md = actual_issue_data_fetch(matches[0], settings, opts)
                 if cv_md is None:
-                    match_results.fetch_data_failures.append(ca.path)
+                    match_results.fetchDataFailures.append(filename)
                     return
 
             md.overlay(cv_md)
 
+            if settings.auto_imprint:
+                md.fixPublisher()
+
         # ok, done building our metadata. time to save
         if not actual_metadata_save(ca, opts, md):
-            match_results.write_failures.append(ca.path)
+            match_results.writeFailures.append(filename)
         else:
-            match_results.good_matches.append(ca.path)
+            match_results.goodMatches.append(filename)
 
     elif opts.rename_file:
 
         msg_hdr = ""
         if batch_mode:
-            msg_hdr = f"{ca.path}: "
+            msg_hdr = "{0}: ".format(filename)
 
         if opts.data_style is not None:
             use_tags = has[opts.data_style]
@@ -433,55 +453,68 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
         md = create_local_metadata(opts, ca, use_tags)
 
         if md.series is None:
-            logger.error(msg_hdr + "Can't rename without series name")
+            print(msg_hdr + "Can't rename without series name", file=sys.stderr)
             return
 
         new_ext = None  # default
         if settings.rename_extension_based_on_archive:
-            if ca.is_sevenzip():
-                new_ext = ".cb7"
-            elif ca.is_zip():
+            if ca.isZip():
                 new_ext = ".cbz"
-            elif ca.is_rar():
+            elif ca.isRar():
                 new_ext = ".cbr"
 
         renamer = FileRenamer(md)
-        renamer.set_template(settings.rename_template)
-        renamer.set_issue_zero_padding(settings.rename_issue_number_padding)
-        renamer.set_smart_cleanup(settings.rename_use_smart_string_cleanup)
+        renamer.setTemplate(settings.rename_template)
+        renamer.setIssueZeroPadding(settings.rename_issue_number_padding)
+        renamer.setSmartCleanup(settings.rename_use_smart_string_cleanup)
+        renamer.move = settings.rename_move_dir
 
-        new_name = renamer.determine_name(ca.path, ext=new_ext)
-
-        if new_name == os.path.basename(ca.path):
-            logger.error(msg_hdr + "Filename is already good!")
+        try:
+            new_name = renamer.determineName(filename, ext=new_ext)
+        except Exception as e:
+            print(
+                msg_hdr + "Invalid format string!\nYour rename template is invalid!\n\n"
+                "{}\n\nPlease consult the template help in the settings "
+                "and the documentation on the format at "
+                "https://docs.python.org/3/library/string.html#format-string-syntax",
+                file=sys.stderr,
+            )
             return
 
-        folder = os.path.dirname(os.path.abspath(ca.path))
+        folder = os.path.dirname(os.path.abspath(filename))
+        if settings.rename_move_dir and len(settings.rename_dir.strip()) > 3:
+            folder = settings.rename_dir.strip()
+
         new_abs_path = utils.unique_file(os.path.join(folder, new_name))
 
+        if os.path.join(folder, new_name) == os.path.abspath(filename):
+            print(msg_hdr + "Filename is already good!", file=sys.stderr)
+            return
+
         suffix = ""
         if not opts.dryrun:
             # rename the file
-            os.rename(ca.path, new_abs_path)
+            os.makedirs(os.path.dirname(new_abs_path), 0o777, True)
+            os.rename(filename, new_abs_path)
         else:
             suffix = " (dry-run, no change)"
 
-        print(f"renamed '{os.path.basename(ca.path)}' -> '{new_name}' {suffix}")
+        print("renamed '{0}' -> '{1}' {2}".format(os.path.basename(filename), new_name, suffix))
 
     elif opts.export_to_zip:
         msg_hdr = ""
         if batch_mode:
-            msg_hdr = f"{ca.path}: "
+            msg_hdr = "{0}: ".format(filename)
 
-        if not ca.is_rar():
-            logger.error(msg_hdr + "Archive is not a RAR.")
+        if not ca.isRar():
+            print(msg_hdr + "Archive is not a RAR.", file=sys.stderr)
             return
 
         rar_file = os.path.abspath(os.path.abspath(filename))
         new_file = os.path.splitext(rar_file)[0] + ".cbz"
 
         if opts.abort_export_on_conflict and os.path.lexists(new_file):
-            print(msg_hdr + f"{os.path.split(new_file)[1]} already exists in the that folder.")
+            print(msg_hdr + "{0} already exists in the that folder.".format(os.path.split(new_file)[1]))
             return
 
         new_file = utils.unique_file(os.path.join(new_file))
@@ -489,13 +522,13 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
         delete_success = False
         export_success = False
         if not opts.dryrun:
-            if ca.export_as_zip(new_file):
+            if ca.exportAsZip(new_file):
                 export_success = True
                 if opts.delete_rar_after_export:
                     try:
                         os.unlink(rar_file)
                     except:
-                        logger.exception(msg_hdr + "Error deleting original RAR after export")
+                        print(msg_hdr + "Error deleting original RAR after export", file=sys.stderr)
                         delete_success = False
                     else:
                         delete_success = True
@@ -504,15 +537,15 @@ def process_file_cli(filename, opts, settings, match_results: OnlineMatchResults
                 if os.path.lexists(new_file):
                     os.remove(new_file)
         else:
-            msg = msg_hdr + f"Dry-run:  Would try to create {os.path.split(new_file)[1]}"
-            if opts.delete_after_zip_export:
+            msg = msg_hdr + "Dry-run:  Would try to create {0}".format(os.path.split(new_file)[1])
+            if opts.delete_rar_after_export:
                 msg += " and delete orginal."
             print(msg)
             return
 
         msg = msg_hdr
         if export_success:
-            msg += f"Archive exported successfully to: {os.path.split(new_file)[1]}"
+            msg += "Archive exported successfully to: {0}".format(os.path.split(new_file)[1])
             if opts.delete_rar_after_export and delete_success:
                 msg += " (Original deleted) "
         else:

comictaggerlib/comet.py

@@ -0,0 +1 @@
+from comicapi.comet import *

comictaggerlib/comicarchive.py

@@ -0,0 +1 @@
+from comicapi.comicarchive import *

comictaggerlib/comicbookinfo.py

@@ -0,0 +1 @@
+from comicapi.comicbookinfo import *

comictaggerlib/comicinfoxml.py

@@ -0,0 +1 @@
+from comicapi.comicinfoxml import *

comictaggerlib/comicvinecacher.py

@@ -15,20 +15,16 @@
 # limitations under the License.
 
 import datetime
-import logging
 import os
 import sqlite3 as lite
 
-from comicapi import utils
-from comictaggerlib import ctversion
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from . import _version, utils
+from .settings import ComicTaggerSettings
 
 
 class ComicVineCacher:
     def __init__(self):
-        self.settings_folder = ComicTaggerSettings.get_settings_folder()
+        self.settings_folder = ComicTaggerSettings.getSettingsFolder()
         self.db_file = os.path.join(self.settings_folder, "cv_cache.db")
         self.version_file = os.path.join(self.settings_folder, "cache_version.txt")
 
@@ -40,13 +36,13 @@ class ComicVineCacher:
                 f.close()
         except:
             pass
-        if data != ctversion.version:
-            self.clear_cache()
+        if data != _version.version:
+            self.clearCache()
 
         if not os.path.exists(self.db_file):
             self.create_cache_db()
 
-    def clear_cache(self):
+    def clearCache(self):
         try:
             os.unlink(self.db_file)
         except:
@@ -60,7 +56,7 @@ class ComicVineCacher:
 
         # create the version file
         with open(self.version_file, "w") as f:
-            f.write(ctversion.version)
+            f.write(_version.version)
 
         # this will wipe out any existing version
         open(self.db_file, "w").close()
@@ -69,6 +65,7 @@ class ComicVineCacher:
 
         # create tables
         with con:
+
             cur = con.cursor()
             # name,id,start_year,publisher,image,description,count_of_issues
             cur.execute(
@@ -131,6 +128,7 @@ class ComicVineCacher:
 
             # now add in new results
             for record in cv_search_results:
+                timestamp = datetime.datetime.now()
 
                 if record["publisher"] is None:
                     pub_name = ""
@@ -160,7 +158,7 @@ class ComicVineCacher:
 
     def get_search_results(self, search_term):
 
-        results = []
+        results = list()
         con = lite.connect(self.db_file)
         with con:
             con.text_factory = str
@@ -175,14 +173,15 @@ class ComicVineCacher:
             rows = cur.fetchall()
             # now process the results
             for record in rows:
-                result = {}
+
+                result = dict()
                 result["id"] = record[1]
                 result["name"] = record[2]
                 result["start_year"] = record[3]
-                result["publisher"] = {}
+                result["publisher"] = dict()
                 result["publisher"]["name"] = record[4]
                 result["count_of_issues"] = record[5]
-                result["image"] = {}
+                result["image"] = dict()
                 result["image"]["super_url"] = record[6]
                 result["description"] = record[7]
 
@@ -201,9 +200,9 @@ class ComicVineCacher:
             # remove all previous entries with this search term
             cur.execute("DELETE FROM AltCovers WHERE issue_id = ?", [issue_id])
 
-            url_list_str = utils.list_to_string(url_list)
+            url_list_str = utils.listToString(url_list)
             # now add in new record
-            cur.execute("INSERT INTO AltCovers (issue_id, url_list) VALUES(?, ?)", (issue_id, url_list_str))
+            cur.execute("INSERT INTO AltCovers " + "(issue_id, url_list) " + "VALUES(?, ?)", (issue_id, url_list_str))
 
     def get_alt_covers(self, issue_id):
 
@@ -221,15 +220,15 @@ class ComicVineCacher:
             row = cur.fetchone()
             if row is None:
                 return None
-
-            url_list_str = row[0]
-            if len(url_list_str) == 0:
-                return []
-            raw_list = url_list_str.split(",")
-            url_list = []
-            for item in raw_list:
-                url_list.append(str(item).strip())
-            return url_list
+            else:
+                url_list_str = row[0]
+                if len(url_list_str) == 0:
+                    return []
+                raw_list = url_list_str.split(",")
+                url_list = []
+                for item in raw_list:
+                    url_list.append(str(item).strip())
+                return url_list
 
     def add_volume_info(self, cv_volume_record):
 
@@ -260,6 +259,7 @@ class ComicVineCacher:
         con = lite.connect(self.db_file)
 
         with con:
+
             cur = con.cursor()
 
             timestamp = datetime.datetime.now()
@@ -267,6 +267,7 @@ class ComicVineCacher:
             # add in issues
 
             for issue in cv_volume_issues:
+
                 data = {
                     "volume_id": volume_id,
                     "name": issue["name"],
@@ -301,21 +302,23 @@ class ComicVineCacher:
             if row is None:
                 return result
 
-            result = {}
+            result = dict()
 
             # since ID is primary key, there is only one row
             result["id"] = row[0]
             result["name"] = row[1]
-            result["publisher"] = {}
+            result["publisher"] = dict()
             result["publisher"]["name"] = row[2]
             result["count_of_issues"] = row[3]
             result["start_year"] = row[4]
-            result["issues"] = []
+            result["issues"] = list()
 
         return result
 
     def get_volume_issues_info(self, volume_id):
 
+        result = None
+
         con = lite.connect(self.db_file)
         with con:
             cur = con.cursor()
@@ -327,24 +330,23 @@ class ComicVineCacher:
             cur.execute("DELETE FROM Issues WHERE timestamp  < ?", [str(a_week_ago)])
 
             # fetch
-            results = []
+            results = list()
 
             cur.execute(
-                "SELECT id,name,issue_number,site_detail_url,cover_date,super_url,thumb_url,description FROM Issues WHERE volume_id = ?",
-                [volume_id],
+                "SELECT id,name,issue_number,site_detail_url,cover_date,super_url,thumb_url,description FROM Issues WHERE volume_id = ?", [volume_id]
             )
             rows = cur.fetchall()
 
             # now process the results
             for row in rows:
-                record = {}
+                record = dict()
 
                 record["id"] = row[0]
                 record["name"] = row[1]
                 record["issue_number"] = row[2]
                 record["site_detail_url"] = row[3]
                 record["cover_date"] = row[4]
-                record["image"] = {}
+                record["image"] = dict()
                 record["image"]["super_url"] = row[5]
                 record["image"]["thumb_url"] = row[6]
                 record["description"] = row[7]
@@ -384,7 +386,7 @@ class ComicVineCacher:
             cur.execute("SELECT super_url,thumb_url,cover_date,site_detail_url FROM Issues WHERE id=?", [issue_id])
             row = cur.fetchone()
 
-            details = {}
+            details = dict()
             if row is None or row[0] is None:
                 details["image_url"] = None
                 details["thumb_image_url"] = None
@@ -407,8 +409,10 @@ class ComicVineCacher:
         TODO: should the cursor be created here, and not up the stack?
         """
 
+        ins_count = len(data) + 1
+
         keys = ""
-        vals = []
+        vals = list()
         ins_slots = ""
         set_slots = ""
 
@@ -431,8 +435,8 @@ class ComicVineCacher:
         ins_slots += ", ?"
         condition = pkname + " = ?"
 
-        sql_ins = f"INSERT OR IGNORE INTO {tablename} ({keys})  VALUES ({ins_slots})"
+        sql_ins = "INSERT OR IGNORE INTO " + tablename + " (" + keys + ") " + " VALUES (" + ins_slots + ")"
         cur.execute(sql_ins, vals)
 
-        sql_upd = f"UPDATE {tablename} SET {set_slots} WHERE {condition}"
+        sql_upd = "UPDATE " + tablename + " SET " + set_slots + " WHERE " + condition
         cur.execute(sql_upd, vals)

comictaggerlib/comicvinetalker.py

@@ -14,40 +14,40 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import datetime
 import json
-import logging
 import re
+import ssl
 import sys
 import time
-from datetime import datetime
-from typing import TypedDict
+import unicodedata
 
 import requests
 from bs4 import BeautifulSoup
 
-from comicapi import utils
-from comicapi.genericmetadata import GenericMetadata
-from comicapi.issuestring import IssueString
-from comictaggerlib import ctversion
-from comictaggerlib.comicvinecacher import ComicVineCacher
-
-logger = logging.getLogger(__name__)
+from . import _version, utils
+from .comicvinecacher import ComicVineCacher
+from .genericmetadata import GenericMetadata
+from .issuestring import IssueString
 
 try:
-    from PyQt5 import QtCore, QtNetwork
-
-    qt_available = True
+    from PyQt5.QtCore import QByteArray, QObject, QUrl, pyqtSignal
+    from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest
 except ImportError:
-    qt_available = False
+    # No Qt, so define a few dummy QObjects to help us compile
+    class QObject:
+        def __init__(self, *args):
+            pass
 
-logger = logging.getLogger(__name__)
+    class pyqtSignal:
+        def __init__(self, *args):
+            pass
+
+        def emit(a, b, c):
+            pass
 
 
-class SelectDetails(TypedDict):
-    image_url: str
-    thumb_image_url: str
-    cover_date: str
-    site_detail_url: str
+# from settings import ComicTaggerSettings
 
 
 class CVTypeID:
@@ -62,40 +62,30 @@ class ComicVineTalkerException(Exception):
     RateLimit = 107
 
     def __init__(self, code=-1, desc=""):
-        super().__init__()
         self.desc = desc
         self.code = code
 
     def __str__(self):
-        if self.code in (ComicVineTalkerException.Unknown, ComicVineTalkerException.Network):
+        if self.code == ComicVineTalkerException.Unknown or self.code == ComicVineTalkerException.Network:
             return self.desc
-
-        return f"CV error #{self.code}:  [{self.desc}]. \n"
+        else:
+            return "CV error #{0}:  [{1}]. \n".format(self.code, self.desc)
 
 
-def list_fetch_complete(url_list: list):
-    ...
+class ComicVineTalker(QObject):
 
-
-def url_fetch_complete(image_url: str, thumb_url: str):
-    ...
-
-
-class ComicVineTalker:
     logo_url = "http://static.comicvine.com/bundles/comicvinesite/images/logo.png"
     api_key = ""
 
-    alt_url_list_fetch_complete = list_fetch_complete
-    url_fetch_complete = url_fetch_complete
-
     @staticmethod
-    def get_rate_limit_message():
+    def getRateLimitMessage():
         if ComicVineTalker.api_key == "":
             return "Comic Vine rate limit exceeded.  You should configue your own Comic Vine API key."
-
-        return "Comic Vine rate limit exceeded.  Please wait a bit."
+        else:
+            return "Comic Vine rate limit exceeded.  Please wait a bit."
 
     def __init__(self):
+        QObject.__init__(self)
 
         self.api_base_url = "https://comicvine.gamespot.com/api"
         self.wait_for_rate_limit = False
@@ -103,8 +93,6 @@ class ComicVineTalker:
         # key that is registered to comictagger
         default_api_key = "27431e6787042105bd3e47e169a624521f89f3a4"
 
-        self.issue_id = ""
-
         if ComicVineTalker.api_key == "":
             self.api_key = default_api_key
         else:
@@ -112,19 +100,18 @@ class ComicVineTalker:
 
         self.log_func = None
 
-        if qt_available:
-            self.nam = QtNetwork.QNetworkAccessManager()
-
-    def set_log_func(self, log_func):
+    def setLogFunc(self, log_func):
         self.log_func = log_func
 
-    def write_log(self, text):
+    def writeLog(self, text):
         if self.log_func is None:
-            logger.info(text, file=sys.stderr)
+            # sys.stdout.write(text.encode(errors='replace'))
+            # sys.stdout.flush()
+            print(text, file=sys.stderr)
         else:
             self.log_func(text)
 
-    def parse_date_str(self, date_str):
+    def parseDateStr(self, date_str):
         day = None
         month = None
         year = None
@@ -137,12 +124,12 @@ class ComicVineTalker:
                     day = utils.xlate(parts[2], True)
         return day, month, year
 
-    def test_key(self, key):
+    def testKey(self, key):
 
         try:
             test_url = self.api_base_url + "/issue/1/?api_key=" + key + "&format=json&field_list=name"
 
-            cv_response = requests.get(test_url, headers={"user-agent": "comictagger/" + ctversion.version}).json()
+            cv_response = requests.get(test_url, headers={"user-agent": "comictagger/" + _version.version}).json()
 
             # Bogus request, but if the key is wrong, you get error 100: "Invalid
             # API Key"
@@ -150,19 +137,20 @@ class ComicVineTalker:
         except:
             return False
 
-    def get_cv_content(self, url, params):
-        """
-        Get the content from the CV server.  If we're in "wait mode" and status code is a rate limit error
-        sleep for a bit and retry.
-        """
+    """
+    Get the contect from the CV server.  If we're in "wait mode" and status code is a rate limit error
+    sleep for a bit and retry.
+    """
+
+    def getCVContent(self, url, params):
         total_time_waited = 0
         limit_wait_time = 1
         counter = 0
         wait_times = [1, 2, 3, 4]
         while True:
-            cv_response = self.get_url_content(url, params)
+            cv_response = self.getUrlContent(url, params)
             if self.wait_for_rate_limit and cv_response["status_code"] == ComicVineTalkerException.RateLimit:
-                self.write_log(f"Rate limit encountered.  Waiting for {limit_wait_time} minutes\n")
+                self.writeLog("Rate limit encountered.  Waiting for {0} minutes\n".format(limit_wait_time))
                 time.sleep(limit_wait_time * 60)
                 total_time_waited += limit_wait_time
                 limit_wait_time = wait_times[counter]
@@ -172,41 +160,103 @@ class ComicVineTalker:
                 if total_time_waited < 20:
                     continue
             if cv_response["status_code"] != 1:
-                self.write_log(
-                    f"Comic Vine query failed with error #{cv_response['status_code']}:  [{cv_response['error']}]. \n"
-                )
+                self.writeLog("Comic Vine query failed with error #{0}:  [{1}]. \n".format(cv_response["status_code"], cv_response["error"]))
                 raise ComicVineTalkerException(cv_response["status_code"], cv_response["error"])
-
-            # it's all good
-            break
+            else:
+                # it's all good
+                break
         return cv_response
 
-    def get_url_content(self, url, params):
+    def getUrlContent(self, url, params):
         # connect to server:
         #  if there is a 500 error, try a few more times before giving up
         #  any other error, just bail
+        # print("---", url)
         for tries in range(3):
             try:
-                resp = requests.get(url, params=params, headers={"user-agent": "comictagger/" + ctversion.version})
+                resp = requests.get(url, params=params, headers={"user-agent": "comictagger/" + _version.version})
                 if resp.status_code == 200:
                     return resp.json()
                 if resp.status_code == 500:
-                    self.write_log(f"Try #{tries + 1}: ")
+                    self.writeLog("Try #{0}: ".format(tries + 1))
                     time.sleep(1)
-                    self.write_log(str(resp.status_code) + "\n")
+                    self.writeLog(str(resp.status_code) + "\n")
                 else:
                     break
 
             except requests.exceptions.RequestException as e:
-                self.write_log(str(e) + "\n")
-                raise ComicVineTalkerException(ComicVineTalkerException.Network, "Network Error!") from e
+                self.writeLog(str(e) + "\n")
+                raise ComicVineTalkerException(ComicVineTalkerException.Network, "Network Error!")
 
         raise ComicVineTalkerException(ComicVineTalkerException.Unknown, "Error on Comic Vine server")
 
-    def search_for_series(self, series_name, callback=None, refresh_cache=False):
+    def literalSearchForSeries(self, series_name, callback=None):
 
-        # Sanitize the series name for comicvine searching, comicvine search ignore symbols
-        search_series_name = utils.sanitize_title(series_name)
+        # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+        search_series_name = unicodedata.normalize("NFKD", series_name).encode("ascii", "ignore").decode("ascii")
+
+        params = {
+            "api_key": self.api_key,
+            "format": "json",
+            "resources": "volume",
+            "query": search_series_name,
+            "field_list": "volume,name,id,start_year,publisher,image,description,count_of_issues",
+            "page": 1,
+            "limit": 100,
+        }
+
+        cv_response = self.getCVContent(self.api_base_url + "/search", params)
+
+        search_results = list()
+
+        # see http://api.comicvine.com/documentation/#handling_responses
+
+        limit = cv_response["limit"]
+        current_result_count = cv_response["number_of_page_results"]
+        total_result_count = cv_response["number_of_total_results"]
+
+        # 8 Dec 2018 - Comic Vine changed query results again. Terms are now
+        # ORed together, and we get thousands of results.  Good news is the
+        # results are sorted by relevance, so we can be smart about halting
+        # the search.
+        # 1. Don't fetch more than some sane amount of pages.
+        max_results = 50
+
+        total_result_count = min(total_result_count, max_results)
+
+        if callback is None:
+            self.writeLog("Found {0} of {1} results\n".format(cv_response["number_of_page_results"], cv_response["number_of_total_results"]))
+        search_results.extend(cv_response["results"])
+        page = 1
+
+        if callback is not None:
+            callback(current_result_count, total_result_count)
+
+        # see if we need to keep asking for more pages...
+        while current_result_count < total_result_count:
+            if callback is None:
+                self.writeLog("getting another page of results {0} of {1}...\n".format(current_result_count, total_result_count))
+            page += 1
+
+            params["page"] = page
+            cv_response = self.getCVContent(self.api_base_url + "/search", params)
+
+            search_results.extend(cv_response["results"])
+            current_result_count += cv_response["number_of_page_results"]
+
+            if callback is not None:
+                callback(current_result_count, total_result_count)
+
+        return search_results
+
+    def searchForSeries(self, series_name, callback=None, refresh_cache=False):
+
+        # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+        search_series_name = unicodedata.normalize("NFKD", series_name).encode("ascii", "ignore").decode("ascii")
+        # comicvine ignores punctuation and accents
+        search_series_name = re.sub(r"[^A-Za-z0-9]+", " ", search_series_name)
+        # remove extra space and articles and all lower case
+        search_series_name = utils.removearticles(search_series_name).lower().strip()
 
         # before we search online, look in our cache, since we might have
         # done this same search recently
@@ -227,12 +277,13 @@ class ComicVineTalker:
             "limit": 100,
         }
 
-        cv_response = self.get_cv_content(self.api_base_url + "/search", params)
+        cv_response = self.getCVContent(self.api_base_url + "/search", params)
 
-        search_results = []
+        search_results = list()
 
         # see http://api.comicvine.com/documentation/#handling_responses
 
+        limit = cv_response["limit"]
         current_result_count = cv_response["number_of_page_results"]
         total_result_count = cv_response["number_of_total_results"]
 
@@ -250,9 +301,7 @@ class ComicVineTalker:
         total_result_count = min(total_result_count, max_results)
 
         if callback is None:
-            self.write_log(
-                f"Found {cv_response['number_of_page_results']} of {cv_response['number_of_total_results']} results\n"
-            )
+            self.writeLog("Found {0} of {1} results\n".format(cv_response["number_of_page_results"], cv_response["number_of_total_results"]))
         search_results.extend(cv_response["results"])
         page = 1
 
@@ -265,29 +314,41 @@ class ComicVineTalker:
 
             last_result = search_results[-1]["name"]
 
-            # Sanitize the series name for comicvine searching, comicvine search ignore symbols
-            last_result = utils.sanitize_title(last_result)
+            # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+            last_result = unicodedata.normalize("NFKD", last_result).encode("ascii", "ignore").decode("ascii")
+            # comicvine ignores punctuation and accents
+            last_result = re.sub(r"[^A-Za-z0-9]+", " ", last_result)
+            # remove extra space and articles and all lower case
+            last_result = utils.removearticles(last_result).lower().strip()
 
             # See if the last result's name has all the of the search terms.
-            # If not, break out of this, loop, we're done.
+            # if not, break out of this, loop, we're done.
             for term in search_series_name.split():
                 if term not in last_result.lower():
+                    # print("Term '{}' not in last result. Halting search result fetching".format(term))
                     stop_searching = True
                     break
 
-            # Also, stop searching when the word count of last results is too much longer than our search terms list
-            if len(last_result) > result_word_count_max:
+            # Also, stop searching when the word count of last results is too much longer
+            # than our search terms list
+            if len(last_result.split()) > result_word_count_max:
+                print(
+                    "Last result '{}' is too long: max word count: {}; Search terms {}. Halting search result fetching".format(
+                        last_result, result_word_count_max, search_series_name.split()
+                    ),
+                    file=sys.stderr,
+                )
                 stop_searching = True
 
             if stop_searching:
                 break
 
             if callback is None:
-                self.write_log(f"getting another page of results {current_result_count} of {total_result_count}...\n")
+                self.writeLog("getting another page of results {0} of {1}...\n".format(current_result_count, total_result_count))
             page += 1
 
             params["page"] = page
-            cv_response = self.get_cv_content(self.api_base_url + "/search", params)
+            cv_response = self.getCVContent(self.api_base_url + "/search", params)
 
             search_results.extend(cv_response["results"])
             current_result_count += cv_response["number_of_page_results"]
@@ -295,25 +356,37 @@ class ComicVineTalker:
             if callback is not None:
                 callback(current_result_count, total_result_count)
 
-        # Remove any search results that don't contain all the search terms (iterate backwards for easy removal)
+        # Remove any search results that don't contain all the search terms
+        # (iterate backwards for easy removal)
         for i in range(len(search_results) - 1, -1, -1):
             record = search_results[i]
-            # Sanitize the series name for comicvine searching, comicvine search ignore symbols
-            record_name = utils.sanitize_title(record["name"])
             for term in search_series_name.split():
+                # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+                recordName = unicodedata.normalize("NFKD", record["name"]).encode("ascii", "ignore").decode("ascii")
+                # comicvine ignores punctuation and accents
+                recordName = re.sub(r"[^A-Za-z0-9]+", " ", recordName)
+                # remove extra space and articles and all lower case
+                recordName = utils.removearticles(recordName).lower().strip()
 
-                if term not in record_name:
+                if term not in recordName:
                     del search_results[i]
                     break
 
+        # for record in search_results:
+        # print(u"{0}: {1} ({2})".format(record['id'], record['name'] , record['start_year']))
+        # print(record)
+        # record['count_of_issues'] = record['count_of_isssues']
+        # print(u"{0}: {1} ({2})".format(search_results['results'][0]['id'], search_results['results'][0]['name'] , search_results['results'][0]['start_year']))
+
         # cache these search results
         cvc.add_search_results(series_name, search_results)
 
         return search_results
 
-    def fetch_volume_data(self, series_id):
+    def fetchVolumeData(self, series_id):
 
-        # before we search online, look in our cache, since we might already have this info
+        # before we search online, look in our cache, since we might already
+        # have this info
         cvc = ComicVineCacher()
         cached_volume_result = cvc.get_volume_info(series_id)
 
@@ -322,12 +395,8 @@ class ComicVineTalker:
 
         volume_url = self.api_base_url + "/volume/" + CVTypeID.Volume + "-" + str(series_id)
 
-        params = {
-            "api_key": self.api_key,
-            "format": "json",
-            "field_list": "name,id,start_year,publisher,count_of_issues",
-        }
-        cv_response = self.get_cv_content(volume_url, params)
+        params = {"api_key": self.api_key, "format": "json", "field_list": "name,id,start_year,publisher,count_of_issues"}
+        cv_response = self.getCVContent(volume_url, params)
 
         volume_results = cv_response["results"]
 
@@ -335,9 +404,10 @@ class ComicVineTalker:
 
         return volume_results
 
-    def fetch_issues_by_volume(self, series_id):
+    def fetchIssuesByVolume(self, series_id):
 
-        # before we search online, look in our cache, since we might already have this info
+        # before we search online, look in our cache, since we might already
+        # have this info
         cvc = ComicVineCacher()
         cached_volume_issues_result = cvc.get_volume_issues_info(series_id)
 
@@ -350,135 +420,150 @@ class ComicVineTalker:
             "format": "json",
             "field_list": "id,volume,issue_number,name,image,cover_date,site_detail_url,description",
         }
-        cv_response = self.get_cv_content(self.api_base_url + "/issues/", params)
+        cv_response = self.getCVContent(self.api_base_url + "/issues/", params)
 
+        # ------------------------------------
+
+        limit = cv_response["limit"]
         current_result_count = cv_response["number_of_page_results"]
         total_result_count = cv_response["number_of_total_results"]
+        # print("total_result_count", total_result_count)
 
+        # print("Found {0} of {1} results".format(cv_response['number_of_page_results'], cv_response['number_of_total_results']))
         volume_issues_result = cv_response["results"]
         page = 1
         offset = 0
 
         # see if we need to keep asking for more pages...
         while current_result_count < total_result_count:
+            # print("getting another page of issue results {0} of {1}...".format(current_result_count, total_result_count))
             page += 1
             offset += cv_response["number_of_page_results"]
 
             params["offset"] = offset
-            cv_response = self.get_cv_content(self.api_base_url + "/issues/", params)
+            cv_response = self.getCVContent(self.api_base_url + "/issues/", params)
 
             volume_issues_result.extend(cv_response["results"])
             current_result_count += cv_response["number_of_page_results"]
 
-        self.repair_urls(volume_issues_result)
+        self.repairUrls(volume_issues_result)
 
         cvc.add_volume_issues_info(series_id, volume_issues_result)
 
         return volume_issues_result
 
-    def fetch_issues_by_volume_issue_num_and_year(self, volume_id_list, issue_number, year):
+    def fetchIssuesByVolumeIssueNumAndYear(self, volume_id_list, issue_number, year):
         volume_filter = ""
         for vid in volume_id_list:
             volume_filter += str(vid) + "|"
-        flt = f"volume:{volume_filter},issue_number:{issue_number}"
+        filter = "volume:{},issue_number:{}".format(volume_filter, issue_number)
 
-        int_year = utils.xlate(year, True)
-        if int_year is not None:
-            flt += f",cover_date:{int_year}-1-1|{int_year+1}-1-1"
+        intYear = utils.xlate(year, True)
+        if intYear is not None:
+            filter += ",cover_date:{}-1-1|{}-1-1".format(intYear, intYear + 1)
 
         params = {
             "api_key": self.api_key,
             "format": "json",
             "field_list": "id,volume,issue_number,name,image,cover_date,site_detail_url,description",
-            "filter": flt,
+            "filter": filter,
         }
 
-        cv_response = self.get_cv_content(self.api_base_url + "/issues", params)
+        cv_response = self.getCVContent(self.api_base_url + "/issues", params)
 
+        # ------------------------------------
+
+        limit = cv_response["limit"]
         current_result_count = cv_response["number_of_page_results"]
         total_result_count = cv_response["number_of_total_results"]
+        # print("total_result_count", total_result_count)
 
+        # print("Found {0} of {1} results\n".format(cv_response['number_of_page_results'], cv_response['number_of_total_results']))
         filtered_issues_result = cv_response["results"]
         page = 1
         offset = 0
 
         # see if we need to keep asking for more pages...
         while current_result_count < total_result_count:
+            # print("getting another page of issue results {0} of {1}...\n".format(current_result_count, total_result_count))
             page += 1
             offset += cv_response["number_of_page_results"]
 
             params["offset"] = offset
-            cv_response = self.get_cv_content(self.api_base_url + "/issues/", params)
+            cv_response = self.getCVContent(self.api_base_url + "/issues/", params)
 
             filtered_issues_result.extend(cv_response["results"])
             current_result_count += cv_response["number_of_page_results"]
 
-        self.repair_urls(filtered_issues_result)
+        self.repairUrls(filtered_issues_result)
 
         return filtered_issues_result
 
-    def fetch_issue_data(self, series_id, issue_number, settings):
+    def fetchIssueData(self, series_id, issue_number, settings):
 
-        volume_results = self.fetch_volume_data(series_id)
-        issues_list_results = self.fetch_issues_by_volume(series_id)
+        volume_results = self.fetchVolumeData(series_id)
+        issues_list_results = self.fetchIssuesByVolume(series_id)
 
         found = False
-        f_record = None
         for record in issues_list_results:
-            if IssueString(issue_number).as_string() is None:
+            if IssueString(issue_number).asString() is None:
                 issue_number = 1
-            if IssueString(record["issue_number"]).as_string().lower() == IssueString(issue_number).as_string().lower():
+            if IssueString(record["issue_number"]).asString().lower() == IssueString(issue_number).asString().lower():
                 found = True
-                f_record = record
                 break
 
         if found:
-            issue_url = self.api_base_url + "/issue/" + CVTypeID.Issue + "-" + str(f_record["id"])
+            issue_url = self.api_base_url + "/issue/" + CVTypeID.Issue + "-" + str(record["id"])
             params = {"api_key": self.api_key, "format": "json"}
-            cv_response = self.get_cv_content(issue_url, params)
+            cv_response = self.getCVContent(issue_url, params)
             issue_results = cv_response["results"]
 
         else:
             return None
 
         # Now, map the Comic Vine data to generic metadata
-        return self.map_cv_data_to_metadata(volume_results, issue_results, settings)
+        return self.mapCVDataToMetadata(volume_results, issue_results, settings)
 
-    def fetch_issue_data_by_issue_id(self, issue_id, settings):
+    def fetchIssueDataByIssueID(self, issue_id, settings):
 
         issue_url = self.api_base_url + "/issue/" + CVTypeID.Issue + "-" + str(issue_id)
         params = {"api_key": self.api_key, "format": "json"}
-        cv_response = self.get_cv_content(issue_url, params)
+        cv_response = self.getCVContent(issue_url, params)
 
         issue_results = cv_response["results"]
 
-        volume_results = self.fetch_volume_data(issue_results["volume"]["id"])
+        volume_results = self.fetchVolumeData(issue_results["volume"]["id"])
 
         # Now, map the Comic Vine data to generic metadata
-        md = self.map_cv_data_to_metadata(volume_results, issue_results, settings)
-        md.is_empty = False
+        md = self.mapCVDataToMetadata(volume_results, issue_results, settings)
+        md.isEmpty = False
         return md
 
-    def map_cv_data_to_metadata(self, volume_results, issue_results, settings):
+    def mapCVDataToMetadata(self, volume_results, issue_results, settings):
 
         # Now, map the Comic Vine data to generic metadata
         metadata = GenericMetadata()
-        metadata.is_empty = False
 
         metadata.series = utils.xlate(issue_results["volume"]["name"])
-        metadata.issue = IssueString(issue_results["issue_number"]).as_string()
+        metadata.issue = IssueString(issue_results["issue_number"]).asString()
         metadata.title = utils.xlate(issue_results["name"])
 
         if volume_results["publisher"] is not None:
             metadata.publisher = utils.xlate(volume_results["publisher"]["name"])
-        metadata.day, metadata.month, metadata.year = self.parse_date_str(issue_results["cover_date"])
+        metadata.day, metadata.month, metadata.year = self.parseDateStr(issue_results["cover_date"])
 
+        metadata.seriesYear = utils.xlate(volume_results["start_year"])
+        metadata.issueCount = utils.xlate(volume_results["count_of_issues"])
         metadata.comments = self.cleanup_html(issue_results["description"], settings.remove_html_tables)
         if settings.use_series_start_as_volume:
-            metadata.volume = volume_results["start_year"]
+            metadata.volume = utils.xlate(volume_results["start_year"])
 
-        metadata.notes = f"Tagged with ComicTagger {ctversion.version} using info from Comic Vine on {datetime.now():%Y-%m-%d %H:%M:%S}.  [Issue ID {issue_results['id']}]"
-        metadata.web_link = issue_results["site_detail_url"]
+        metadata.notes = "Tagged with ComicTagger {0} using info from Comic Vine on {1}.  [Issue ID {2}]".format(
+            ctversion.version, datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), issue_results["id"]
+        )
+        # metadata.notes  += issue_results['site_detail_url']
+
+        metadata.webLink = issue_results["site_detail_url"]
 
         person_credits = issue_results["person_credits"]
         for person in person_credits:
@@ -486,32 +571,32 @@ class ComicVineTalker:
                 roles = person["role"].split(",")
                 for role in roles:
                     # can we determine 'primary' from CV??
-                    metadata.add_credit(person["name"], role.title().strip(), False)
+                    metadata.addCredit(person["name"], role.title().strip(), False)
 
         character_credits = issue_results["character_credits"]
-        character_list = []
+        character_list = list()
         for character in character_credits:
             character_list.append(character["name"])
-        metadata.characters = utils.list_to_string(character_list)
+        metadata.characters = utils.listToString(character_list)
 
         team_credits = issue_results["team_credits"]
-        team_list = []
+        team_list = list()
         for team in team_credits:
             team_list.append(team["name"])
-        metadata.teams = utils.list_to_string(team_list)
+        metadata.teams = utils.listToString(team_list)
 
         location_credits = issue_results["location_credits"]
-        location_list = []
+        location_list = list()
         for location in location_credits:
             location_list.append(location["name"])
-        metadata.locations = utils.list_to_string(location_list)
+        metadata.locations = utils.listToString(location_list)
 
         story_arc_credits = issue_results["story_arc_credits"]
         arc_list = []
         for arc in story_arc_credits:
             arc_list.append(arc["name"])
         if len(arc_list) > 0:
-            metadata.story_arc = utils.list_to_string(arc_list)
+            metadata.storyArc = utils.listToString(arc_list)
 
         return metadata
 
@@ -543,7 +628,7 @@ class ComicVineTalker:
         string = string.replace("</h4>", "*\n")
 
         # remove the tables
-        p = re.compile(r"<table[^<]*?>.*?</table>")
+        p = re.compile(r"<table[^<]*?>.*?<\/table>")
         if remove_html_tables:
             string = p.sub("", string)
             string = string.replace("*List of covers and their creators:*", "")
@@ -590,6 +675,7 @@ class ComicVineTalker:
                     for w in col_widths:
                         fmtstr += " {{:{}}}|".format(w + 1)
                     width = sum(col_widths) + len(col_widths) * 2
+                    print("width=", width)
                     table_text = ""
                     counter = 0
                     for row in rows:
@@ -604,26 +690,28 @@ class ComicVineTalker:
             except:
                 # we caught an error rebuilding the table.
                 # just bail and remove the formatting
-                logger.exception("table parse error")
+                print("table parse error")
                 newstring.replace("{}", "")
 
         return newstring
 
-    def fetch_issue_date(self, issue_id):
-        details = self.fetch_issue_select_details(issue_id)
-        _, month, year = self.parse_date_str(details["cover_date"])
+    def fetchIssueDate(self, issue_id):
+        details = self.fetchIssueSelectDetails(issue_id)
+        day, month, year = self.parseDateStr(details["cover_date"])
         return month, year
 
-    def fetch_issue_cover_urls(self, issue_id):
-        details = self.fetch_issue_select_details(issue_id)
+    def fetchIssueCoverURLs(self, issue_id):
+        details = self.fetchIssueSelectDetails(issue_id)
         return details["image_url"], details["thumb_image_url"]
 
-    def fetch_issue_page_url(self, issue_id):
-        details = self.fetch_issue_select_details(issue_id)
+    def fetchIssuePageURL(self, issue_id):
+        details = self.fetchIssueSelectDetails(issue_id)
         return details["site_detail_url"]
 
-    def fetch_issue_select_details(self, issue_id):
-        cached_details = self.fetch_cached_issue_select_details(issue_id)
+    def fetchIssueSelectDetails(self, issue_id):
+
+        # cached_image_url,cached_thumb_url,cached_month,cached_year = self.fetchCachedIssueSelectDetails(issue_id)
+        cached_details = self.fetchCachedIssueSelectDetails(issue_id)
         if cached_details["image_url"] is not None:
             return cached_details
 
@@ -631,9 +719,9 @@ class ComicVineTalker:
 
         params = {"api_key": self.api_key, "format": "json", "field_list": "image,cover_date,site_detail_url"}
 
-        cv_response = self.get_cv_content(issue_url, params)
+        cv_response = self.getCVContent(issue_url, params)
 
-        details: SelectDetails = {}
+        details = dict()
         details["image_url"] = None
         details["thumb_image_url"] = None
         details["cover_date"] = None
@@ -645,41 +733,38 @@ class ComicVineTalker:
         details["site_detail_url"] = cv_response["results"]["site_detail_url"]
 
         if details["image_url"] is not None:
-            self.cache_issue_select_details(
-                issue_id,
-                details["image_url"],
-                details["thumb_image_url"],
-                details["cover_date"],
-                details["site_detail_url"],
+            self.cacheIssueSelectDetails(
+                issue_id, details["image_url"], details["thumb_image_url"], details["cover_date"], details["site_detail_url"]
             )
+        # print(details['site_detail_url'])
         return details
 
-    def fetch_cached_issue_select_details(self, issue_id):
+    def fetchCachedIssueSelectDetails(self, issue_id):
 
         # before we search online, look in our cache, since we might already
         # have this info
         cvc = ComicVineCacher()
         return cvc.get_issue_select_details(issue_id)
 
-    def cache_issue_select_details(self, issue_id, image_url, thumb_url, cover_date, page_url):
+    def cacheIssueSelectDetails(self, issue_id, image_url, thumb_url, cover_date, page_url):
         cvc = ComicVineCacher()
         cvc.add_issue_select_details(issue_id, image_url, thumb_url, cover_date, page_url)
 
-    def fetch_alternate_cover_urls(self, issue_id, issue_page_url):
-        url_list = self.fetch_cached_alternate_cover_urls(issue_id)
+    def fetchAlternateCoverURLs(self, issue_id, issue_page_url):
+        url_list = self.fetchCachedAlternateCoverURLs(issue_id)
         if url_list is not None:
             return url_list
 
         # scrape the CV issue page URL to get the alternate cover URLs
-        content = requests.get(issue_page_url, headers={"user-agent": "comictagger/" + ctversion.version}).text
-        alt_cover_url_list = self.parse_out_alt_cover_urls(content)
+        content = requests.get(issue_page_url, headers={"user-agent": "comictagger/" + _version.version}).text
+        alt_cover_url_list = self.parseOutAltCoverUrls(content)
 
         # cache this alt cover URL list
-        self.cache_alternate_cover_urls(issue_id, alt_cover_url_list)
+        self.cacheAlternateCoverURLs(issue_id, alt_cover_url_list)
 
         return alt_cover_url_list
 
-    def parse_out_alt_cover_urls(self, page_html):
+    def parseOutAltCoverUrls(self, page_html):
         soup = BeautifulSoup(page_html, "html.parser")
 
         alt_cover_url_list = []
@@ -692,19 +777,15 @@ class ComicVineTalker:
         for d in div_list:
             if "class" in d.attrs:
                 c = d["class"]
-                if "imgboxart" in c and "issue-cover" in c:
-                    if d.img["src"].startswith("http"):
-                        covers_found += 1
-                        if covers_found != 1:
-                            alt_cover_url_list.append(d.img["src"])
-                    elif d.img["data-src"].startswith("http"):
-                        covers_found += 1
-                        if covers_found != 1:
-                            alt_cover_url_list.append(d.img["data-src"])
+                if "imgboxart" in c and "issue-cover" in c and d.img["src"].startswith("http"):
+
+                    covers_found += 1
+                    if covers_found != 1:
+                        alt_cover_url_list.append(d.img["src"])
 
         return alt_cover_url_list
 
-    def fetch_cached_alternate_cover_urls(self, issue_id):
+    def fetchCachedAlternateCoverURLs(self, issue_id):
 
         # before we search online, look in our cache, since we might already
         # have this info
@@ -712,19 +793,22 @@ class ComicVineTalker:
         url_list = cvc.get_alt_covers(issue_id)
         if url_list is not None:
             return url_list
+        else:
+            return None
 
-        return None
-
-    def cache_alternate_cover_urls(self, issue_id, url_list):
+    def cacheAlternateCoverURLs(self, issue_id, url_list):
         cvc = ComicVineCacher()
         cvc.add_alt_covers(issue_id, url_list)
 
-    def async_fetch_issue_cover_urls(self, issue_id):
+    # -------------------------------------------------------------------------
+    urlFetchComplete = pyqtSignal(str, str, int)
+
+    def asyncFetchIssueCoverURLs(self, issue_id):
 
         self.issue_id = issue_id
-        details = self.fetch_cached_issue_select_details(issue_id)
+        details = self.fetchCachedIssueSelectDetails(issue_id)
         if details["image_url"] is not None:
-            self.url_fetch_complete(details["image_url"], details["thumb_image_url"])
+            self.urlFetchComplete.emit(details["image_url"], details["thumb_image_url"], self.issue_id)
             return
 
         issue_url = (
@@ -737,22 +821,24 @@ class ComicVineTalker:
             + self.api_key
             + "&format=json&field_list=image,cover_date,site_detail_url"
         )
+        self.nam = QNetworkAccessManager()
+        self.nam.finished.connect(self.asyncFetchIssueCoverURLComplete)
+        self.nam.get(QNetworkRequest(QUrl(issue_url)))
 
-        self.nam.finished.connect(self.async_fetch_issue_cover_url_complete)
-        self.nam.get(QtNetwork.QNetworkRequest(QtCore.QUrl(issue_url)))
+    def asyncFetchIssueCoverURLComplete(self, reply):
 
-    def async_fetch_issue_cover_url_complete(self, reply):
         # read in the response
         data = reply.readAll()
 
         try:
             cv_response = json.loads(bytes(data))
-        except Exception:
-            logger.exception("Comic Vine query failed to get JSON data\n%s", str(data))
+        except Exception as e:
+            print("Comic Vine query failed to get JSON data", file=sys.stderr)
+            print(str(data), file=sys.stderr)
             return
 
         if cv_response["status_code"] != 1:
-            logger.error("Comic Vine query failed with error:  [%s]. ", cv_response["error"])
+            print("Comic Vine query failed with error:  [{0}]. ".format(cv_response["error"]), file=sys.stderr)
             return
 
         image_url = cv_response["results"]["image"]["super_url"]
@@ -760,35 +846,38 @@ class ComicVineTalker:
         cover_date = cv_response["results"]["cover_date"]
         page_url = cv_response["results"]["site_detail_url"]
 
-        self.cache_issue_select_details(self.issue_id, image_url, thumb_url, cover_date, page_url)
+        self.cacheIssueSelectDetails(self.issue_id, image_url, thumb_url, cover_date, page_url)
 
-        self.url_fetch_complete(image_url, thumb_url)
+        self.urlFetchComplete.emit(image_url, thumb_url, self.issue_id)
 
-    def async_fetch_alternate_cover_urls(self, issue_id, issue_page_url):
+    altUrlListFetchComplete = pyqtSignal(list, int)
+
+    def asyncFetchAlternateCoverURLs(self, issue_id, issue_page_url):
         # This async version requires the issue page url to be provided!
         self.issue_id = issue_id
-        url_list = self.fetch_cached_alternate_cover_urls(issue_id)
+        url_list = self.fetchCachedAlternateCoverURLs(issue_id)
         if url_list is not None:
-            self.alt_url_list_fetch_complete(url_list)
+            self.altUrlListFetchComplete.emit(url_list, int(self.issue_id))
             return
 
-        self.nam.finished.connect(self.async_fetch_alternate_cover_urls_complete)
-        self.nam.get(QtNetwork.QNetworkRequest(QtCore.QUrl(str(issue_page_url))))
+        self.nam = QNetworkAccessManager()
+        self.nam.finished.connect(self.asyncFetchAlternateCoverURLsComplete)
+        self.nam.get(QNetworkRequest(QUrl(str(issue_page_url))))
 
-    def async_fetch_alternate_cover_urls_complete(self, reply):
+    def asyncFetchAlternateCoverURLsComplete(self, reply):
         # read in the response
         html = str(reply.readAll())
-        alt_cover_url_list = self.parse_out_alt_cover_urls(html)
+        alt_cover_url_list = self.parseOutAltCoverUrls(html)
 
         # cache this alt cover URL list
-        self.cache_alternate_cover_urls(self.issue_id, alt_cover_url_list)
+        self.cacheAlternateCoverURLs(self.issue_id, alt_cover_url_list)
 
-        self.alt_url_list_fetch_complete(alt_cover_url_list)
+        self.altUrlListFetchComplete.emit(alt_cover_url_list, int(self.issue_id))
 
-    def repair_urls(self, issue_list):
+    def repairUrls(self, issue_list):
         # make sure there are URLs for the image fields
         for issue in issue_list:
             if issue["image"] is None:
-                issue["image"] = {}
+                issue["image"] = dict()
                 issue["image"]["super_url"] = ComicVineTalker.logo_url
                 issue["image"]["thumb_url"] = ComicVineTalker.logo_url

comictaggerlib/coverimagewidget.py

@@ -18,113 +18,77 @@ TODO: This should be re-factored using subclasses!
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from PyQt5 import uic
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
 
-import logging
+from comictaggerlib.ui.qtutils import getQImageFromData, reduceWidgetFontSize
 
-from PyQt5 import QtCore, QtGui, QtWidgets, uic
-
-from comicapi.comicarchive import ComicArchive
-from comictaggerlib.comicvinetalker import ComicVineTalker
-from comictaggerlib.imagefetcher import ImageFetcher
-from comictaggerlib.imagepopup import ImagePopup
-from comictaggerlib.pageloader import PageLoader
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import get_qimage_from_data, reduce_widget_font_size
-
-logger = logging.getLogger(__name__)
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .imagefetcher import ImageFetcher
+from .imagepopup import ImagePopup
+from .pageloader import PageLoader
+from .settings import ComicTaggerSettings
 
 
 def clickable(widget):
-    """Allow a label to be clickable"""
+    """# Allow a label to be clickable"""
 
-    class Filter(QtCore.QObject):
+    class Filter(QObject):
 
-        dblclicked = QtCore.pyqtSignal()
+        dblclicked = pyqtSignal()
 
         def eventFilter(self, obj, event):
 
             if obj == widget:
-                if event.type() == QtCore.QEvent.Type.MouseButtonDblClick:
+                if event.type() == QEvent.MouseButtonDblClick:
                     self.dblclicked.emit()
                     return True
 
             return False
 
-    flt = Filter(widget)
-    widget.installEventFilter(flt)
-    return flt.dblclicked
+    filter = Filter(widget)
+    widget.installEventFilter(filter)
+    return filter.dblclicked
 
 
-class Signal(QtCore.QObject):
-    alt_url_list_fetch_complete = QtCore.pyqtSignal(list)
-    url_fetch_complete = QtCore.pyqtSignal(str, str)
-    image_fetch_complete = QtCore.pyqtSignal(QtCore.QByteArray)
+class CoverImageWidget(QWidget):
 
-    def __init__(self, list_fetch, url_fetch, image_fetch):
-        super().__init__()
-        self.alt_url_list_fetch_complete.connect(list_fetch)
-        self.url_fetch_complete.connect(url_fetch)
-        self.image_fetch_complete.connect(image_fetch)
-
-    def emit_list(self, url_list: list):
-        self.alt_url_list_fetch_complete.emit(url_list)
-
-    def emit_url(self, image_url: str, thumb_url: str):
-        self.url_fetch_complete.emit(image_url, thumb_url)
-
-    def emit_image(self, image_data: QtCore.QByteArray):
-        self.image_fetch_complete.emit(image_data)
-
-
-class CoverImageWidget(QtWidgets.QWidget):
     ArchiveMode = 0
     AltCoverMode = 1
     URLMode = 1
     DataMode = 3
 
     def __init__(self, parent, mode, expand_on_click=True):
-        super().__init__(parent)
+        super(CoverImageWidget, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("coverimagewidget.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("coverimagewidget.ui"), self)
 
-        reduce_widget_font_size(self.label)
-
-        self.sig = Signal(
-            self.alt_cover_url_list_fetch_complete, self.primary_url_fetch_complete, self.cover_remote_fetch_complete
-        )
+        reduceWidgetFontSize(self.label)
 
         self.mode = mode
+        self.comicVine = ComicVineTalker()
         self.page_loader = None
         self.showControls = True
 
-        self.current_pixmap = QtGui.QPixmap()
+        self.btnLeft.setIcon(QIcon(ComicTaggerSettings.getGraphic("left.png")))
+        self.btnRight.setIcon(QIcon(ComicTaggerSettings.getGraphic("right.png")))
 
-        self.comic_archive = None
-        self.issue_id = None
-        self.cover_fetcher = None
-        self.url_list = []
-        if self.page_loader is not None:
-            self.page_loader.abandoned = True
-        self.page_loader = None
-        self.imageIndex = -1
-        self.imageCount = 1
-        self.imageData = None
-
-        self.btnLeft.setIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("left.png")))
-        self.btnRight.setIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("right.png")))
-
-        self.btnLeft.clicked.connect(self.decrement_image)
-        self.btnRight.clicked.connect(self.increment_image)
+        self.btnLeft.clicked.connect(self.decrementImage)
+        self.btnRight.clicked.connect(self.incrementImage)
+        self.resetWidget()
         if expand_on_click:
-            clickable(self.lblImage).connect(self.show_popup)
+            clickable(self.lblImage).connect(self.showPopup)
         else:
             self.lblImage.setToolTip("")
 
-        self.update_content()
+        self.updateContent()
 
-    def reset_widget(self):
+    def resetWidget(self):
         self.comic_archive = None
         self.issue_id = None
+        self.comicVine = None
         self.cover_fetcher = None
         self.url_list = []
         if self.page_loader is not None:
@@ -135,52 +99,53 @@ class CoverImageWidget(QtWidgets.QWidget):
         self.imageData = None
 
     def clear(self):
-        self.reset_widget()
-        self.update_content()
+        self.resetWidget()
+        self.updateContent()
 
-    def increment_image(self):
+    def incrementImage(self):
         self.imageIndex += 1
         if self.imageIndex == self.imageCount:
             self.imageIndex = 0
-        self.update_content()
+        self.updateContent()
 
-    def decrement_image(self):
+    def decrementImage(self):
         self.imageIndex -= 1
         if self.imageIndex == -1:
             self.imageIndex = self.imageCount - 1
-        self.update_content()
+        self.updateContent()
 
-    def set_archive(self, ca: ComicArchive, page=0):
+    def setArchive(self, ca, page=0):
         if self.mode == CoverImageWidget.ArchiveMode:
-            self.reset_widget()
+            self.resetWidget()
             self.comic_archive = ca
             self.imageIndex = page
-            self.imageCount = ca.get_number_of_pages()
-            self.update_content()
+            self.imageCount = ca.getNumberOfPages()
+            self.updateContent()
 
-    def set_url(self, url):
+    def setURL(self, url):
         if self.mode == CoverImageWidget.URLMode:
-            self.reset_widget()
-            self.update_content()
+            self.resetWidget()
+            self.updateContent()
 
             self.url_list = [url]
             self.imageIndex = 0
             self.imageCount = 1
-            self.update_content()
+            self.updateContent()
 
-    def set_issue_id(self, issue_id):
+    def setIssueID(self, issue_id):
         if self.mode == CoverImageWidget.AltCoverMode:
-            self.reset_widget()
-            self.update_content()
+            self.resetWidget()
+            self.updateContent()
+
             self.issue_id = issue_id
 
-            comic_vine = ComicVineTalker()
-            comic_vine.url_fetch_complete = self.sig.emit_url
-            comic_vine.async_fetch_issue_cover_urls(int(self.issue_id))
+            self.comicVine = ComicVineTalker()
+            self.comicVine.urlFetchComplete.connect(self.primaryUrlFetchComplete)
+            self.comicVine.asyncFetchIssueCoverURLs(int(self.issue_id))
 
-    def set_image_data(self, image_data):
+    def setImageData(self, image_data):
         if self.mode == CoverImageWidget.DataMode:
-            self.reset_widget()
+            self.resetWidget()
 
             if image_data is None:
                 self.imageIndex = -1
@@ -188,54 +153,54 @@ class CoverImageWidget(QtWidgets.QWidget):
                 self.imageIndex = 0
                 self.imageData = image_data
 
-            self.update_content()
+            self.updateContent()
 
-    def primary_url_fetch_complete(self, primary_url, thumb_url):
+    def primaryUrlFetchComplete(self, primary_url, thumb_url, issue_id):
         self.url_list.append(str(primary_url))
         self.imageIndex = 0
         self.imageCount = len(self.url_list)
-        self.update_content()
+        self.updateContent()
 
         # defer the alt cover search
-        QtCore.QTimer.singleShot(1, self.start_alt_cover_search)
+        QTimer.singleShot(1, self.startAltCoverSearch)
 
-    def start_alt_cover_search(self):
+    def startAltCoverSearch(self):
 
         # now we need to get the list of alt cover URLs
         self.label.setText("Searching for alt. covers...")
 
         # page URL should already be cached, so no need to defer
-        comic_vine = ComicVineTalker()
-        issue_page_url = comic_vine.fetch_issue_page_url(self.issue_id)
-        comic_vine.alt_url_list_fetch_complete = self.sig.emit_list
-        comic_vine.async_fetch_alternate_cover_urls(int(self.issue_id), issue_page_url)
+        self.comicVine = ComicVineTalker()
+        issue_page_url = self.comicVine.fetchIssuePageURL(self.issue_id)
+        self.comicVine.altUrlListFetchComplete.connect(self.altCoverUrlListFetchComplete)
+        self.comicVine.asyncFetchAlternateCoverURLs(int(self.issue_id), issue_page_url)
 
-    def alt_cover_url_list_fetch_complete(self, url_list):
+    def altCoverUrlListFetchComplete(self, url_list, issue_id):
         if len(url_list) > 0:
             self.url_list.extend(url_list)
             self.imageCount = len(self.url_list)
-        self.update_controls()
+        self.updateControls()
 
-    def set_page(self, pagenum):
+    def setPage(self, pagenum):
         if self.mode == CoverImageWidget.ArchiveMode:
             self.imageIndex = pagenum
-            self.update_content()
+            self.updateContent()
 
-    def update_content(self):
-        self.update_image()
-        self.update_controls()
+    def updateContent(self):
+        self.updateImage()
+        self.updateControls()
 
-    def update_image(self):
+    def updateImage(self):
         if self.imageIndex == -1:
-            self.load_default()
+            self.loadDefault()
         elif self.mode in [CoverImageWidget.AltCoverMode, CoverImageWidget.URLMode]:
-            self.load_url()
+            self.loadURL()
         elif self.mode == CoverImageWidget.DataMode:
-            self.cover_remote_fetch_complete(self.imageData)
+            self.coverRemoteFetchComplete(self.imageData, 0)
         else:
-            self.load_page()
+            self.loadPage()
 
-    def update_controls(self):
+    def updateControls(self):
         if not self.showControls or self.mode == CoverImageWidget.DataMode:
             self.btnLeft.hide()
             self.btnRight.hide()
@@ -256,47 +221,62 @@ class CoverImageWidget(QtWidgets.QWidget):
         if self.imageIndex == -1 or self.imageCount == 1:
             self.label.setText("")
         elif self.mode == CoverImageWidget.AltCoverMode:
-            self.label.setText(f"Cover {self.imageIndex + 1} (of {self.imageCount})")
+            self.label.setText("Cover {0} (of {1})".format(self.imageIndex + 1, self.imageCount))
         else:
-            self.label.setText(f"Page {self.imageIndex + 1} (of {self.imageCount})")
+            self.label.setText("Page {0} (of {1})".format(self.imageIndex + 1, self.imageCount))
 
-    def load_url(self):
-        self.load_default()
+    def loadURL(self):
+        self.loadDefault()
         self.cover_fetcher = ImageFetcher()
-        self.cover_fetcher.image_fetch_complete = self.sig.emit_image
+        self.cover_fetcher.fetchComplete.connect(self.coverRemoteFetchComplete)
         self.cover_fetcher.fetch(self.url_list[self.imageIndex])
+        # print("ATB cover fetch started...")
 
     # called when the image is done loading from internet
-    def cover_remote_fetch_complete(self, image_data):
-        img = get_qimage_from_data(image_data)
-        self.current_pixmap = QtGui.QPixmap.fromImage(img)
-        self.set_display_pixmap()
+    def coverRemoteFetchComplete(self, image_data, issue_id):
+        img = getQImageFromData(image_data)
+        self.current_pixmap = QPixmap(img)
+        self.setDisplayPixmap(0, 0)
+        # print("ATB cover fetch complete!")
 
-    def load_page(self):
+    def loadPage(self):
         if self.comic_archive is not None:
             if self.page_loader is not None:
                 self.page_loader.abandoned = True
             self.page_loader = PageLoader(self.comic_archive, self.imageIndex)
-            self.page_loader.loadComplete.connect(self.page_load_complete)
+            self.page_loader.loadComplete.connect(self.pageLoadComplete)
             self.page_loader.start()
 
-    def page_load_complete(self, image_data):
-        img = get_qimage_from_data(image_data)
-        self.current_pixmap = QtGui.QPixmap.fromImage(img)
-        self.set_display_pixmap()
+    def pageLoadComplete(self, img):
+        self.current_pixmap = QPixmap(img)
+        self.setDisplayPixmap(0, 0)
         self.page_loader = None
 
-    def load_default(self):
-        self.current_pixmap = QtGui.QPixmap(ComicTaggerSettings.get_graphic("nocover.png"))
-        self.set_display_pixmap()
+    def loadDefault(self):
+        self.current_pixmap = QPixmap(ComicTaggerSettings.getGraphic("nocover.png"))
+        # print("loadDefault called")
+        self.setDisplayPixmap(0, 0)
 
     def resizeEvent(self, resize_event):
         if self.current_pixmap is not None:
-            self.set_display_pixmap()
+            delta_w = resize_event.size().width() - resize_event.oldSize().width()
+            delta_h = resize_event.size().height() - resize_event.oldSize().height()
+            # print "ATB resizeEvent deltas", resize_event.size().width(),
+            # resize_event.size().height()
+            self.setDisplayPixmap(delta_w, delta_h)
 
-    def set_display_pixmap(self):
+    def setDisplayPixmap(self, delta_w, delta_h):
         """The deltas let us know what the new width and height of the label will be"""
 
+        # new_h = self.frame.height() + delta_h
+        # new_w = self.frame.width() + delta_w
+        # print "ATB setDisplayPixmap deltas", delta_w , delta_h
+        # print "ATB self.frame", self.frame.width(), self.frame.height()
+        # print "ATB self.", self.width(), self.height()
+
+        # frame_w = new_w
+        # frame_h = new_h
+
         new_h = self.frame.height()
         new_w = self.frame.width()
         frame_w = self.frame.width()
@@ -305,18 +285,24 @@ class CoverImageWidget(QtWidgets.QWidget):
         new_h -= 4
         new_w -= 4
 
-        new_h = max(new_h, 0)
-        new_w = max(new_w, 0)
+        if new_h < 0:
+            new_h = 0
+        if new_w < 0:
+            new_w = 0
+
+        # print "ATB setDisplayPixmap deltas", delta_w , delta_h
+        # print "ATB self.frame", frame_w, frame_h
+        # print "ATB new size", new_w, new_h
 
         # scale the pixmap to fit in the frame
-        scaled_pixmap = self.current_pixmap.scaled(new_w, new_h, QtCore.Qt.AspectRatioMode.KeepAspectRatio)
+        scaled_pixmap = self.current_pixmap.scaled(new_w, new_h, Qt.KeepAspectRatio, Qt.SmoothTransformation)
         self.lblImage.setPixmap(scaled_pixmap)
 
         # move and resize the label to be centered in the fame
         img_w = scaled_pixmap.width()
         img_h = scaled_pixmap.height()
         self.lblImage.resize(img_w, img_h)
-        self.lblImage.move(int((frame_w - img_w) / 2), int((frame_h - img_h) / 2))
+        self.lblImage.move((frame_w - img_w) / 2, (frame_h - img_h) / 2)
 
-    def show_popup(self):
-        ImagePopup(self, self.current_pixmap)
+    def showPopup(self):
+        self.popup = ImagePopup(self, self.current_pixmap)

comictaggerlib/crediteditorwindow.py

@@ -14,24 +14,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-import logging
-
-from PyQt5 import QtCore, QtWidgets, uic
-
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class CreditEditorWindow(QtWidgets.QDialog):
+
     ModeEdit = 0
     ModeNew = 1
 
     def __init__(self, parent, mode, role, name, primary):
-        super().__init__(parent)
+        super(CreditEditorWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("crediteditorwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("crediteditorwindow.ui"), self)
 
         self.mode = mode
 
@@ -64,33 +60,33 @@ class CreditEditorWindow(QtWidgets.QDialog):
                 self.cbRole.setCurrentIndex(i)
 
         if primary:
-            self.cbPrimary.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbPrimary.setCheckState(QtCore.Qt.Checked)
 
-        self.cbRole.currentIndexChanged.connect(self.role_changed)
-        self.cbRole.editTextChanged.connect(self.role_changed)
+        self.cbRole.currentIndexChanged.connect(self.roleChanged)
+        self.cbRole.editTextChanged.connect(self.roleChanged)
 
-        self.update_primary_button()
+        self.updatePrimaryButton()
 
-    def update_primary_button(self):
-        enabled = self.current_role_can_be_primary()
+    def updatePrimaryButton(self):
+        enabled = self.currentRoleCanBePrimary()
         self.cbPrimary.setEnabled(enabled)
 
-    def current_role_can_be_primary(self):
+    def currentRoleCanBePrimary(self):
         role = self.cbRole.currentText()
         if str(role).lower() == "writer" or str(role).lower() == "artist":
             return True
+        else:
+            return False
 
-        return False
+    def roleChanged(self, s):
+        self.updatePrimaryButton()
 
-    def role_changed(self, s):
-        self.update_primary_button()
-
-    def get_credits(self):
-        primary = self.current_role_can_be_primary() and self.cbPrimary.isChecked()
+    def getCredits(self):
+        primary = self.currentRoleCanBePrimary() and self.cbPrimary.isChecked()
         return self.cbRole.currentText(), self.leName.text(), primary
 
     def accept(self):
         if self.cbRole.currentText() == "" or self.leName.text() == "":
-            QtWidgets.QMessageBox.warning(self, "Whoops", "You need to enter both role and name for a credit.")
+            QtWidgets.QMessageBox.warning(self, self.tr("Whoops"), self.tr("You need to enter both role and name for a credit."))
         else:
             QtWidgets.QDialog.accept(self)

comictaggerlib/exportwindow.py

@@ -14,14 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-import logging
-
-from PyQt5 import QtCore, QtWidgets, uic
-
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class ExportConflictOpts:
@@ -32,19 +27,17 @@ class ExportConflictOpts:
 
 class ExportWindow(QtWidgets.QDialog):
     def __init__(self, parent, settings, msg):
-        super().__init__(parent)
+        super(ExportWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("exportwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("exportwindow.ui"), self)
         self.label.setText(msg)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(self.windowFlags() & ~QtCore.Qt.WindowType.WindowContextHelpButtonHint)
-        )
+        self.setWindowFlags(self.windowFlags() & ~QtCore.Qt.WindowContextHelpButtonHint)
 
         self.settings = settings
 
-        self.cbxDeleteOriginal.setCheckState(QtCore.Qt.CheckState.Unchecked)
-        self.cbxAddToList.setCheckState(QtCore.Qt.CheckState.Checked)
+        self.cbxDeleteOriginal.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxAddToList.setCheckState(QtCore.Qt.Checked)
         self.radioDontCreate.setChecked(True)
 
         self.deleteOriginal = False
@@ -60,3 +53,5 @@ class ExportWindow(QtWidgets.QDialog):
             self.fileConflictBehavior = ExportConflictOpts.dontCreate
         elif self.radioCreateNew.isChecked():
             self.fileConflictBehavior = ExportConflictOpts.createUnique
+        # else:
+        #    self.fileConflictBehavior = ExportConflictOpts.overwrite

comictaggerlib/filenameparser.py

@@ -0,0 +1 @@
+from comicapi.filenameparser import *

comictaggerlib/filerenamer.py

@@ -14,131 +14,131 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import datetime
-import logging
 import os
 import re
+import string
+import sys
 
-from comicapi.genericmetadata import GenericMetadata
-from comicapi.issuestring import IssueString
+from pathvalidate import sanitize_filepath
 
-logger = logging.getLogger(__name__)
+from . import utils
+from .issuestring import IssueString
+
+
+class MetadataFormatter(string.Formatter):
+    def __init__(self, smart_cleanup=False):
+        super().__init__()
+        self.smart_cleanup = smart_cleanup
+
+    def format_field(self, value, format_spec):
+        if value is None or value == "":
+            return ""
+        return super().format_field(value, format_spec)
+
+    def _vformat(self, format_string, args, kwargs, used_args, recursion_depth, auto_arg_index=0):
+        if recursion_depth < 0:
+            raise ValueError("Max string recursion exceeded")
+        result = []
+        lstrip = False
+        for literal_text, field_name, format_spec, conversion in self.parse(format_string):
+
+            # output the literal text
+            if literal_text:
+                if lstrip:
+                    result.append(literal_text.lstrip("-_)}]#"))
+                else:
+                    result.append(literal_text)
+            lstrip = False
+            # if there's a field, output it
+            if field_name is not None:
+                # this is some markup, find the object and do
+                #  the formatting
+
+                # handle arg indexing when empty field_names are given.
+                if field_name == "":
+                    if auto_arg_index is False:
+                        raise ValueError("cannot switch from manual field specification to automatic field numbering")
+                    field_name = str(auto_arg_index)
+                    auto_arg_index += 1
+                elif field_name.isdigit():
+                    if auto_arg_index:
+                        raise ValueError("cannot switch from manual field specification to automatic field numbering")
+                    # disable auto arg incrementing, if it gets
+                    # used later on, then an exception will be raised
+                    auto_arg_index = False
+
+                # given the field_name, find the object it references
+                #  and the argument it came from
+                obj, arg_used = self.get_field(field_name, args, kwargs)
+                used_args.add(arg_used)
+
+                # do any conversion on the resulting object
+                obj = self.convert_field(obj, conversion)
+
+                # expand the format spec, if needed
+                format_spec, auto_arg_index = self._vformat(format_spec, args, kwargs, used_args, recursion_depth - 1, auto_arg_index=auto_arg_index)
+
+                # format the object and append to the result
+                fmtObj = self.format_field(obj, format_spec)
+                if fmtObj == "" and len(result) > 0 and self.smart_cleanup:
+                    lstrip = True
+                    result.pop()
+                result.append(fmtObj)
+
+        return "".join(result), auto_arg_index
 
 
 class FileRenamer:
     def __init__(self, metadata):
-        self.template = "%series% v%volume% #%issue% (of %issuecount%) (%year%)"
+        self.setMetadata(metadata)
+        self.setTemplate("{publisher}/{series}/{series} v{volume} #{issue} (of {issueCount}) ({year})")
         self.smart_cleanup = True
         self.issue_zero_padding = 3
-        self.metadata = metadata
+        self.move = False
 
-    def set_metadata(self, metadata: GenericMetadata):
-        self.metadata = metadata
+    def setMetadata(self, metadata):
+        self.metdata = metadata
 
-    def set_issue_zero_padding(self, count):
+    def setIssueZeroPadding(self, count):
         self.issue_zero_padding = count
 
-    def set_smart_cleanup(self, on):
+    def setSmartCleanup(self, on):
         self.smart_cleanup = on
 
-    def set_template(self, template: str):
+    def setTemplate(self, template):
         self.template = template
 
-    def replace_token(self, text, value, token):
-        # helper func
-        def is_token(word):
-            return word[0] == "%" and word[-1:] == "%"
+    def determineName(self, filename, ext=None):
+        class Default(dict):
+            def __missing__(self, key):
+                return "{" + key + "}"
 
-        if value is not None:
-            return text.replace(token, str(value))
+        md = self.metdata
 
-        if self.smart_cleanup:
-            # smart cleanup means we want to remove anything appended to token if it's empty (e.g "#%issue%"  or "v%volume%")
-            # (TODO: This could fail if there is more than one token appended together, I guess)
-            text_list = text.split()
+        # padding for issue
+        md.issue = IssueString(md.issue).asString(pad=self.issue_zero_padding)
 
-            # special case for issuecount, remove preceding non-token word,
-            # as in "...(of %issuecount%)..."
-            if token == "%issuecount%":
-                for idx, word in enumerate(text_list):
-                    if token in word and not is_token(text_list[idx - 1]):
-                        text_list[idx - 1] = ""
+        template = self.template
 
-            text_list = [x for x in text_list if token not in x]
-            return " ".join(text_list)
+        pathComponents = template.split(os.sep)
+        new_name = ""
 
-        return text.replace(token, "")
+        fmt = MetadataFormatter(self.smart_cleanup)
+        for Component in pathComponents:
+            new_name = os.path.join(new_name, fmt.vformat(Component, args=[], kwargs=Default(vars(md))).replace("/", "-"))
 
-    def determine_name(self, filename, ext=None):
-
-        md = self.metadata
-        new_name = self.template
-
-        new_name = self.replace_token(new_name, md.series, "%series%")
-        new_name = self.replace_token(new_name, md.volume, "%volume%")
-
-        if md.issue is not None:
-            issue_str = IssueString(md.issue).as_string(pad=self.issue_zero_padding)
-        else:
-            issue_str = None
-        new_name = self.replace_token(new_name, issue_str, "%issue%")
-
-        new_name = self.replace_token(new_name, md.issue_count, "%issuecount%")
-        new_name = self.replace_token(new_name, md.year, "%year%")
-        new_name = self.replace_token(new_name, md.publisher, "%publisher%")
-        new_name = self.replace_token(new_name, md.title, "%title%")
-        new_name = self.replace_token(new_name, md.month, "%month%")
-        month_name = None
-        if md.month is not None:
-            if (isinstance(md.month, str) and md.month.isdigit()) or isinstance(md.month, int):
-                if int(md.month) in range(1, 13):
-                    dt = datetime.datetime(1970, int(md.month), 1, 0, 0)
-                    month_name = dt.strftime("%B")
-        new_name = self.replace_token(new_name, month_name, "%month_name%")
-
-        new_name = self.replace_token(new_name, md.genre, "%genre%")
-        new_name = self.replace_token(new_name, md.language, "%language_code%")
-        new_name = self.replace_token(new_name, md.critical_rating, "%criticalrating%")
-        new_name = self.replace_token(new_name, md.alternate_series, "%alternateseries%")
-        new_name = self.replace_token(new_name, md.alternate_number, "%alternatenumber%")
-        new_name = self.replace_token(new_name, md.alternate_count, "%alternatecount%")
-        new_name = self.replace_token(new_name, md.imprint, "%imprint%")
-        new_name = self.replace_token(new_name, md.format, "%format%")
-        new_name = self.replace_token(new_name, md.maturity_rating, "%maturityrating%")
-        new_name = self.replace_token(new_name, md.story_arc, "%storyarc%")
-        new_name = self.replace_token(new_name, md.series_group, "%seriesgroup%")
-        new_name = self.replace_token(new_name, md.scan_info, "%scaninfo%")
-
-        if self.smart_cleanup:
-            # remove empty braces,brackets, parentheses
-            new_name = re.sub(r"\(\s*[-:]*\s*\)", "", new_name)
-            new_name = re.sub(r"\[\s*[-:]*\s*]", "", new_name)
-            new_name = re.sub(r"{\s*[-:]*\s*}", "", new_name)
-
-            # remove duplicate spaces
-            new_name = " ".join(new_name.split())
-
-            # remove remove duplicate -, _,
-            new_name = re.sub(r"[-_]{2,}\s+", "-- ", new_name)
-            new_name = re.sub(r"(\s--)+", " --", new_name)
-            new_name = re.sub(r"(\s-)+", " -", new_name)
-
-            # remove dash or double dash at end of line
-            new_name = re.sub(r"[-]{1,2}\s*$", "", new_name)
-
-            # remove duplicate spaces (again!)
-            new_name = " ".join(new_name.split())
-
-        if ext is None:
+        if ext is None or ext == "":
             ext = os.path.splitext(filename)[1]
 
         new_name += ext
 
         # some tweaks to keep various filesystems happy
-        new_name = new_name.replace("/", "-")
-        new_name = new_name.replace(" :", " -")
         new_name = new_name.replace(": ", " - ")
         new_name = new_name.replace(":", "-")
-        new_name = new_name.replace("?", "")
 
-        return new_name
+        # remove padding
+        md.issue = IssueString(md.issue).asString()
+        if self.move:
+            return sanitize_filepath(new_name.strip())
+        else:
+            return os.path.basename(sanitize_filepath(new_name.strip()))

comictaggerlib/fileselectionlist.py

@@ -1,3 +1,4 @@
+# coding=utf-8
 """A PyQt5 widget for managing list of comic archive files"""
 
 # Copyright 2012-2014 Anthony Beville
@@ -14,33 +15,40 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import os
-from typing import List
+import platform
+import sys
 
-from PyQt5 import QtCore, QtWidgets, uic
+from PyQt5 import uic
+from PyQt5.QtCore import *
+from PyQt5.QtCore import pyqtSignal
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
 
-from comicapi import utils
-from comicapi.comicarchive import ComicArchive
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import center_window_on_parent, reduce_widget_font_size
+from comictaggerlib.ui.qtutils import centerWindowOnParent, reduceWidgetFontSize
 
-logger = logging.getLogger(__name__)
+from . import utils
+from .comicarchive import ComicArchive
+from .optionalmsgdialog import OptionalMessageDialog
+from .settings import ComicTaggerSettings
 
 
-class FileTableWidgetItem(QtWidgets.QTableWidgetItem):
+class FileTableWidgetItem(QTableWidgetItem):
     def __lt__(self, other):
-        return self.data(QtCore.Qt.ItemDataRole.UserRole) < other.data(QtCore.Qt.ItemDataRole.UserRole)
+        # return (self.data(Qt.UserRole).toBool() <
+        #        other.data(Qt.UserRole).toBool())
+        return self.data(Qt.UserRole) < other.data(Qt.UserRole)
 
 
 class FileInfo:
-    def __init__(self, ca: ComicArchive):
-        self.ca: ComicArchive = ca
+    def __init__(self, ca):
+        self.ca = ca
 
 
-class FileSelectionList(QtWidgets.QWidget):
-    selectionChanged = QtCore.pyqtSignal(QtCore.QVariant)
-    listCleared = QtCore.pyqtSignal()
+class FileSelectionList(QWidget):
+
+    selectionChanged = pyqtSignal(QVariant)
+    listCleared = pyqtSignal()
 
     fileColNum = 0
     CRFlagColNum = 1
@@ -50,77 +58,77 @@ class FileSelectionList(QtWidgets.QWidget):
     folderColNum = 5
     dataColNum = fileColNum
 
-    def __init__(self, parent, settings, dirty_flag_verification):
-        super().__init__(parent)
+    def __init__(self, parent, settings):
+        super(FileSelectionList, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("fileselectionlist.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("fileselectionlist.ui"), self)
 
         self.settings = settings
 
-        reduce_widget_font_size(self.twList)
+        reduceWidgetFontSize(self.twList)
 
         self.twList.setColumnCount(6)
-        self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+        # self.twlist.setHorizontalHeaderLabels (["File", "Folder", "CR", "CBL", ""])
+        # self.twList.horizontalHeader().setStretchLastSection(True)
+        self.twList.currentItemChanged.connect(self.currentItemChangedCB)
 
         self.currentItem = None
-        self.setContextMenuPolicy(QtCore.Qt.ContextMenuPolicy.ActionsContextMenu)
-        self.dirty_flag = False
+        self.setContextMenuPolicy(Qt.ActionsContextMenu)
+        self.modifiedFlag = False
 
-        select_all_action = QtWidgets.QAction("Select All", self)
-        remove_action = QtWidgets.QAction("Remove Selected Items", self)
-        self.separator = QtWidgets.QAction("", self)
+        selectAllAction = QAction("Select All", self)
+        removeAction = QAction("Remove Selected Items", self)
+        self.separator = QAction("", self)
         self.separator.setSeparator(True)
 
-        select_all_action.setShortcut("Ctrl+A")
-        remove_action.setShortcut("Ctrl+X")
+        selectAllAction.setShortcut("Ctrl+A")
+        removeAction.setShortcut("Ctrl+X")
 
-        select_all_action.triggered.connect(self.select_all)
-        remove_action.triggered.connect(self.remove_selection)
+        selectAllAction.triggered.connect(self.selectAll)
+        removeAction.triggered.connect(self.removeSelection)
 
-        self.addAction(select_all_action)
-        self.addAction(remove_action)
+        self.addAction(selectAllAction)
+        self.addAction(removeAction)
         self.addAction(self.separator)
 
-        self.dirty_flag_verification = dirty_flag_verification
-
-    def get_sorting(self) -> (int, int):
+    def getSorting(self):
         col = self.twList.horizontalHeader().sortIndicatorSection()
         order = self.twList.horizontalHeader().sortIndicatorOrder()
-        return int(col), int(order)
+        return col, order
 
-    def set_sorting(self, col: int, order: QtCore.Qt.SortOrder):
-        self.twList.horizontalHeader().setSortIndicator(col, order)
+    def setSorting(self, col, order):
+        col = self.twList.horizontalHeader().setSortIndicator(col, order)
 
-    def add_app_action(self, action):
-        self.insertAction(QtWidgets.QAction(), action)
+    def addAppAction(self, action):
+        self.insertAction(None, action)
 
-    def set_modified_flag(self, modified):
-        self.dirty_flag = modified
+    def setModifiedFlag(self, modified):
+        self.modifiedFlag = modified
 
-    def select_all(self):
-        self.twList.setRangeSelected(QtWidgets.QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, 5), True)
+    def selectAll(self):
+        self.twList.setRangeSelected(QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, 5), True)
 
-    def deselect_all(self):
-        self.twList.setRangeSelected(QtWidgets.QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, 5), False)
+    def deselectAll(self):
+        self.twList.setRangeSelected(QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, 5), False)
 
-    def remove_archive_list(self, ca_list):
+    def removeArchiveList(self, ca_list):
         self.twList.setSortingEnabled(False)
         for ca in ca_list:
             for row in range(self.twList.rowCount()):
-                row_ca = self.get_archive_by_row(row)
+                row_ca = self.getArchiveByRow(row)
                 if row_ca == ca:
                     self.twList.removeRow(row)
                     break
         self.twList.setSortingEnabled(True)
 
-    def get_archive_by_row(self, row):
-        fi = self.twList.item(row, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
+    def getArchiveByRow(self, row):
+        fi = self.twList.item(row, FileSelectionList.dataColNum).data(Qt.UserRole)
         return fi.ca
 
-    def get_current_archive(self):
-        return self.get_archive_by_row(self.twList.currentRow())
+    def getCurrentArchive(self):
+        return self.getArchiveByRow(self.twList.currentRow())
 
-    def remove_selection(self):
+    def removeSelection(self):
         row_list = []
         for item in self.twList.selectedItems():
             if item.column() == 0:
@@ -130,71 +138,95 @@ class FileSelectionList(QtWidgets.QWidget):
             return
 
         if self.twList.currentRow() in row_list:
-            if not self.dirty_flag_verification(
-                "Remove Archive", "If you close this archive, data in the form will be lost.  Are you sure?"
-            ):
+            if not self.modifiedFlagVerification("Remove Archive", "If you close this archive, data in the form will be lost.  Are you sure?"):
                 return
 
         row_list.sort()
         row_list.reverse()
 
-        self.twList.currentItemChanged.disconnect(self.current_item_changed_cb)
+        self.twList.currentItemChanged.disconnect(self.currentItemChangedCB)
         self.twList.setSortingEnabled(False)
 
         for i in row_list:
             self.twList.removeRow(i)
 
         self.twList.setSortingEnabled(True)
-        self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+        self.twList.currentItemChanged.connect(self.currentItemChangedCB)
 
         if self.twList.rowCount() > 0:
             # since on a removal, we select row 0, make sure callback occurs if
             # we're already there
             if self.twList.currentRow() == 0:
-                self.current_item_changed_cb(self.twList.currentItem(), None)
+                self.currentItemChangedCB(self.twList.currentItem(), None)
             self.twList.selectRow(0)
         else:
             self.listCleared.emit()
 
-    def add_path_list(self, pathlist):
+    def addPathList(self, pathlist):
 
         filelist = utils.get_recursive_filelist(pathlist)
         # we now have a list of files to add
 
         # Prog dialog on Linux flakes out for small range, so scale up
-        progdialog = QtWidgets.QProgressDialog("", "Cancel", 0, len(filelist), parent=self)
+        progdialog = QProgressDialog("", "Cancel", 0, len(filelist), parent=self)
         progdialog.setWindowTitle("Adding Files")
-        progdialog.setWindowModality(QtCore.Qt.WindowModality.ApplicationModal)
+        progdialog.setWindowModality(Qt.ApplicationModal)
         progdialog.setMinimumDuration(300)
-        center_window_on_parent(progdialog)
+        centerWindowOnParent(progdialog)
+        # QCoreApplication.processEvents()
+        # progdialog.show()
 
-        QtCore.QCoreApplication.processEvents()
-        first_added = None
+        QCoreApplication.processEvents()
+        firstAdded = None
         self.twList.setSortingEnabled(False)
         for idx, f in enumerate(filelist):
-            QtCore.QCoreApplication.processEvents()
+            QCoreApplication.processEvents()
             if progdialog.wasCanceled():
                 break
             progdialog.setValue(idx + 1)
             progdialog.setLabelText(f)
-            center_window_on_parent(progdialog)
-            QtCore.QCoreApplication.processEvents()
-            row = self.add_path_item(f)
-            if first_added is None and row is not None:
-                first_added = row
+            centerWindowOnParent(progdialog)
+            QCoreApplication.processEvents()
+            row = self.addPathItem(f)
+            if firstAdded is None and row is not None:
+                firstAdded = row
 
         progdialog.hide()
-        QtCore.QCoreApplication.processEvents()
+        QCoreApplication.processEvents()
 
-        if first_added is not None:
-            self.twList.selectRow(first_added)
+        if self.settings.show_no_unrar_warning and self.settings.unrar_lib_path == "" and not ComicTaggerSettings.haveOwnUnrarLib():
+            for f in filelist:
+                ext = os.path.splitext(f)[1].lower()
+                if ext == ".rar" or ext == ".cbr":
+                    checked = OptionalMessageDialog.msg(
+                        self,
+                        "No UnRAR Ability",
+                        """
+                            It looks like you've tried to open at least one CBR or RAR file.<br><br>
+                            In order for ComicTagger to read this kind of file, you will have to configure
+                            the location of the unrar library in the settings.  Until then, ComicTagger
+                            will not be able read these kind of files. See the "RAR Tools" tab in the
+                            settings/preferences for more info.
+                            """,
+                    )
+                    self.settings.show_no_unrar_warning = not checked
+                    break
+
+        if firstAdded is not None:
+            self.twList.selectRow(firstAdded)
         else:
             if len(pathlist) == 1 and os.path.isfile(pathlist[0]):
-                QtWidgets.QMessageBox.information(
-                    self, "File Open", "Selected file doesn't seem to be a comic archive."
-                )
+                ext = os.path.splitext(pathlist[0])[1].lower()
+                if ext == ".rar" or ext == ".cbr" and self.settings.unrar_lib_path == "":
+                    QMessageBox.information(
+                        self,
+                        self.tr("File Open"),
+                        self.tr("Selected file seems to be a rar file, " "and can't be read until the unrar library is configured."),
+                    )
+                else:
+                    QMessageBox.information(self, self.tr("File Open"), self.tr("Selected file doesn't seem to be a comic archive."))
             else:
-                QtWidgets.QMessageBox.information(self, "File/Folder Open", "No readable comic archives were found.")
+                QMessageBox.information(self, self.tr("File/Folder Open"), self.tr("No readable comic archives were found."))
 
         self.twList.setSortingEnabled(True)
 
@@ -209,78 +241,77 @@ class FileSelectionList(QtWidgets.QWidget):
         if self.twList.columnWidth(FileSelectionList.folderColNum) > 200:
             self.twList.setColumnWidth(FileSelectionList.folderColNum, 200)
 
-    def is_list_dupe(self, path):
+    def isListDupe(self, path):
         r = 0
         while r < self.twList.rowCount():
-            ca = self.get_archive_by_row(r)
+            ca = self.getArchiveByRow(r)
             if ca.path == path:
                 return True
             r = r + 1
 
         return False
 
-    def get_current_list_row(self, path):
+    def getCurrentListRow(self, path):
         r = 0
         while r < self.twList.rowCount():
-            ca = self.get_archive_by_row(r)
+            ca = self.getArchiveByRow(r)
             if ca.path == path:
                 return r
             r = r + 1
 
         return -1
 
-    def add_path_item(self, path):
+    def addPathItem(self, path):
         path = str(path)
         path = os.path.abspath(path)
         # print "processing", path
 
-        if self.is_list_dupe(path):
-            return self.get_current_list_row(path)
+        if self.isListDupe(path):
+            return self.getCurrentListRow(path)
 
-        ca = ComicArchive(path, self.settings.rar_exe_path, ComicTaggerSettings.get_graphic("nocover.png"))
+        ca = ComicArchive(path, self.settings.rar_exe_path, ComicTaggerSettings.getGraphic("nocover.png"))
 
-        if ca.seems_to_be_a_comic_archive():
+        if ca.seemsToBeAComicArchive():
             row = self.twList.rowCount()
             self.twList.insertRow(row)
 
             fi = FileInfo(ca)
 
-            filename_item = QtWidgets.QTableWidgetItem()
-            folder_item = QtWidgets.QTableWidgetItem()
+            filename_item = QTableWidgetItem()
+            folder_item = QTableWidgetItem()
             cix_item = FileTableWidgetItem()
             cbi_item = FileTableWidgetItem()
             readonly_item = FileTableWidgetItem()
-            type_item = QtWidgets.QTableWidgetItem()
+            type_item = QTableWidgetItem()
 
-            filename_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
-            filename_item.setData(QtCore.Qt.ItemDataRole.UserRole, fi)
+            filename_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            filename_item.setData(Qt.UserRole, fi)
             self.twList.setItem(row, FileSelectionList.fileColNum, filename_item)
 
-            folder_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            folder_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
             self.twList.setItem(row, FileSelectionList.folderColNum, folder_item)
 
-            type_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            type_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
             self.twList.setItem(row, FileSelectionList.typeColNum, type_item)
 
-            cix_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
-            cix_item.setTextAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+            cix_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            cix_item.setTextAlignment(Qt.AlignHCenter)
             self.twList.setItem(row, FileSelectionList.CRFlagColNum, cix_item)
 
-            cbi_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
-            cbi_item.setTextAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+            cbi_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            cbi_item.setTextAlignment(Qt.AlignHCenter)
             self.twList.setItem(row, FileSelectionList.CBLFlagColNum, cbi_item)
 
-            readonly_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
-            readonly_item.setTextAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+            readonly_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            readonly_item.setTextAlignment(Qt.AlignHCenter)
             self.twList.setItem(row, FileSelectionList.readonlyColNum, readonly_item)
 
-            self.update_row(row)
+            self.updateRow(row)
 
             return row
-        return -1
 
-    def update_row(self, row):
-        fi: FileInfo = self.twList.item(row, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
+    def updateRow(self, row):
+        fi = self.twList.item(row, FileSelectionList.dataColNum).data(Qt.UserRole)  # .toPyObject()
 
         filename_item = self.twList.item(row, FileSelectionList.fileColNum)
         folder_item = self.twList.item(row, FileSelectionList.folderColNum)
@@ -291,93 +322,113 @@ class FileSelectionList(QtWidgets.QWidget):
 
         item_text = os.path.split(fi.ca.path)[0]
         folder_item.setText(item_text)
-        folder_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+        folder_item.setData(Qt.ToolTipRole, item_text)
 
         item_text = os.path.split(fi.ca.path)[1]
         filename_item.setText(item_text)
-        filename_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+        filename_item.setData(Qt.ToolTipRole, item_text)
 
-        if fi.ca.is_sevenzip():
-            item_text = "7Z"
-        elif fi.ca.is_zip():
+        if fi.ca.isZip():
             item_text = "ZIP"
-        elif fi.ca.is_rar():
+        elif fi.ca.isRar():
             item_text = "RAR"
+        elif fi.ca.isTar():
+            item_text = "TAR"
         else:
             item_text = ""
         type_item.setText(item_text)
-        type_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+        type_item.setData(Qt.ToolTipRole, item_text)
 
-        if fi.ca.has_cix():
-            cix_item.setCheckState(QtCore.Qt.CheckState.Checked)
-            cix_item.setData(QtCore.Qt.ItemDataRole.UserRole, True)
+        if fi.ca.hasCIX():
+            cix_item.setCheckState(Qt.Checked)
+            cix_item.setData(Qt.UserRole, True)
         else:
-            cix_item.setData(QtCore.Qt.ItemDataRole.UserRole, False)
-            cix_item.setCheckState(QtCore.Qt.CheckState.Unchecked)
+            cix_item.setData(Qt.UserRole, False)
+            cix_item.setCheckState(Qt.Unchecked)
 
-        if fi.ca.has_cbi():
-            cbi_item.setCheckState(QtCore.Qt.CheckState.Checked)
-            cbi_item.setData(QtCore.Qt.ItemDataRole.UserRole, True)
+        if fi.ca.hasCBI():
+            cbi_item.setCheckState(Qt.Checked)
+            cbi_item.setData(Qt.UserRole, True)
         else:
-            cbi_item.setData(QtCore.Qt.ItemDataRole.UserRole, False)
-            cbi_item.setCheckState(QtCore.Qt.CheckState.Unchecked)
+            cbi_item.setData(Qt.UserRole, False)
+            cbi_item.setCheckState(Qt.Unchecked)
 
-        if not fi.ca.is_writable():
-            readonly_item.setCheckState(QtCore.Qt.CheckState.Checked)
-            readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, True)
+        if not fi.ca.isWritable():
+            readonly_item.setCheckState(Qt.Checked)
+            readonly_item.setData(Qt.UserRole, True)
         else:
-            readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, False)
-            readonly_item.setCheckState(QtCore.Qt.CheckState.Unchecked)
+            readonly_item.setData(Qt.UserRole, False)
+            readonly_item.setCheckState(Qt.Unchecked)
 
         # Reading these will force them into the ComicArchive's cache
-        fi.ca.read_cix()
-        fi.ca.has_cbi()
+        fi.ca.readCIX()
+        fi.ca.hasCBI()
 
-    def get_selected_archive_list(self) -> List[ComicArchive]:
-        ca_list: List[ComicArchive] = []
+    def getSelectedArchiveList(self):
+        ca_list = []
         for r in range(self.twList.rowCount()):
             item = self.twList.item(r, FileSelectionList.dataColNum)
             if item.isSelected():
-                fi: FileInfo = item.data(QtCore.Qt.ItemDataRole.UserRole)
+                fi = item.data(Qt.UserRole)
                 ca_list.append(fi.ca)
 
         return ca_list
 
-    def update_current_row(self):
-        self.update_row(self.twList.currentRow())
+    def updateCurrentRow(self):
+        self.updateRow(self.twList.currentRow())
 
-    def update_selected_rows(self):
+    def updateSelectedRows(self):
         self.twList.setSortingEnabled(False)
         for r in range(self.twList.rowCount()):
             item = self.twList.item(r, FileSelectionList.dataColNum)
             if item.isSelected():
-                self.update_row(r)
+                self.updateRow(r)
         self.twList.setSortingEnabled(True)
 
-    def current_item_changed_cb(self, curr, prev):
+    def currentItemChangedCB(self, curr, prev):
 
         new_idx = curr.row()
         old_idx = -1
         if prev is not None:
             old_idx = prev.row()
+        # print("old {0} new {1}".format(old_idx, new_idx))
 
         if old_idx == new_idx:
             return
 
         # don't allow change if modified
         if prev is not None and new_idx != old_idx:
-            if not self.dirty_flag_verification(
-                "Change Archive", "If you change archives now, data in the form will be lost.  Are you sure?"
-            ):
-                self.twList.currentItemChanged.disconnect(self.current_item_changed_cb)
+            if not self.modifiedFlagVerification("Change Archive", "If you change archives now, data in the form will be lost.  Are you sure?"):
+                self.twList.currentItemChanged.disconnect(self.currentItemChangedCB)
                 self.twList.setCurrentItem(prev)
-                self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+                self.twList.currentItemChanged.connect(self.currentItemChangedCB)
                 # Need to defer this revert selection, for some reason
-                QtCore.QTimer.singleShot(1, self.revert_selection)
+                QTimer.singleShot(1, self.revertSelection)
                 return
 
-        fi = self.twList.item(new_idx, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
-        self.selectionChanged.emit(QtCore.QVariant(fi))
+        fi = self.twList.item(new_idx, FileSelectionList.dataColNum).data(Qt.UserRole)  # .toPyObject()
+        self.selectionChanged.emit(QVariant(fi))
 
-    def revert_selection(self):
+    def revertSelection(self):
         self.twList.selectRow(self.twList.currentRow())
+
+    def modifiedFlagVerification(self, title, desc):
+        if self.modifiedFlag:
+            reply = QMessageBox.question(self, self.tr(title), self.tr(desc), QMessageBox.Yes, QMessageBox.No)
+
+            if reply != QMessageBox.Yes:
+                return False
+        return True
+
+
+# Attempt to use a special checkbox widget in the cell.
+# Couldn't figure out how to disable it with "enabled" colors
+# w = QWidget()
+# cb = QCheckBox(w)
+# cb.setCheckState(Qt.Checked)
+# layout = QHBoxLayout()
+# layout.addWidget(cb)
+# layout.setAlignment(Qt.AlignHCenter)
+# layout.setMargin(2)
+# w.setLayout(layout)
+# self.twList.setCellWidget(row, 2, w)

comictaggerlib/genericmetadata.py

@@ -0,0 +1 @@
+from comicapi.genericmetadata import *

comictaggerlib/imagefetcher.py

@@ -22,55 +22,54 @@ import tempfile
 
 import requests
 
+from . import _version
+from .settings import ComicTaggerSettings
+
 try:
-    from PyQt5 import QtCore, QtNetwork
-
-    qt_available = True
+    from PyQt5 import QtGui
+    from PyQt5.QtCore import QByteArray, QObject, QUrl, pyqtSignal
+    from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest
 except ImportError:
-    qt_available = False
+    # No Qt, so define a few dummy QObjects to help us compile
+    class QObject:
+        def __init__(self, *args):
+            pass
 
+    class QByteArray:
+        pass
 
-import logging
+    class pyqtSignal:
+        def __init__(self, *args):
+            pass
 
-from comictaggerlib import ctversion
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+        def emit(a, b, c):
+            pass
 
 
 class ImageFetcherException(Exception):
     pass
 
 
-def fetch_complete(this, image_data):
-    ...
+class ImageFetcher(QObject):
 
-
-class ImageFetcher:
-
-    image_fetch_complete = fetch_complete
+    fetchComplete = pyqtSignal(QByteArray, int)
 
     def __init__(self):
+        QObject.__init__(self)
 
-        self.settings_folder = ComicTaggerSettings.get_settings_folder()
+        self.settings_folder = ComicTaggerSettings.getSettingsFolder()
         self.db_file = os.path.join(self.settings_folder, "image_url_cache.db")
         self.cache_folder = os.path.join(self.settings_folder, "image_cache")
 
-        self.user_data = None
-        self.fetched_url = ""
-
         if not os.path.exists(self.db_file):
             self.create_image_db()
 
-        if qt_available:
-            self.nam = QtNetwork.QNetworkAccessManager()
-
-    def clear_cache(self):
+    def clearCache(self):
         os.unlink(self.db_file)
         if os.path.isdir(self.cache_folder):
             shutil.rmtree(self.cache_folder)
 
-    def fetch(self, url, blocking=False):
+    def fetch(self, url, user_data=None, blocking=False):
         """
         If called with blocking=True, this will block until the image is
         fetched.
@@ -78,44 +77,47 @@ class ImageFetcher:
         background, and emit a signal when done
         """
 
+        self.user_data = user_data
         self.fetched_url = url
 
         # first look in the DB
         image_data = self.get_image_from_cache(url)
-        if blocking or not qt_available:
+        if blocking:
             if image_data is None:
                 try:
-                    image_data = requests.get(url, headers={"user-agent": "comictagger/" + ctversion.version}).content
+                    print(url)
+                    image_data = requests.get(url, headers={"user-agent": "comictagger/" + _version.version}).content
                 except Exception as e:
-                    logger.exception("Fetching url failed: %s")
-                    raise ImageFetcherException("Network Error!") from e
+                    print(e)
+                    raise ImageFetcherException("Network Error!")
 
             # save the image to the cache
             self.add_image_to_cache(self.fetched_url, image_data)
             return image_data
 
-        if qt_available:
+        else:
+
             # if we found it, just emit the signal asap
             if image_data is not None:
-                self.image_fetch_complete(QtCore.QByteArray(image_data))
-                return bytes()
+                self.fetchComplete.emit(QByteArray(image_data), self.user_data)
+                return
 
             # didn't find it.  look online
-            self.nam.finished.connect(self.finish_request)
-            self.nam.get(QtNetwork.QNetworkRequest(QtCore.QUrl(url)))
+            self.nam = QNetworkAccessManager()
+            self.nam.finished.connect(self.finishRequest)
+            self.nam.get(QNetworkRequest(QUrl(url)))
 
             # we'll get called back when done...
-        return bytes()
 
-    def finish_request(self, reply):
+    def finishRequest(self, reply):
+
         # read in the image data
-        logger.debug("request finished")
         image_data = reply.readAll()
 
         # save the image to the cache
         self.add_image_to_cache(self.fetched_url, image_data)
 
-        self.image_fetch_complete(image_data)
+        self.fetchComplete.emit(QByteArray(image_data), self.user_data)
 
     def create_image_db(self):
 
@@ -131,15 +133,17 @@ class ImageFetcher:
 
         # create tables
         with con:
+
             cur = con.cursor()
 
-            cur.execute("CREATE TABLE Images(url TEXT,filename TEXT,timestamp TEXT,PRIMARY KEY (url))")
+            cur.execute("CREATE TABLE Images(" + "url TEXT," + "filename TEXT," + "timestamp TEXT," + "PRIMARY KEY (url))")
 
     def add_image_to_cache(self, url, image_data):
 
         con = lite.connect(self.db_file)
 
         with con:
+
             cur = con.cursor()
 
             timestamp = datetime.datetime.now()
@@ -162,15 +166,15 @@ class ImageFetcher:
 
             if row is None:
                 return None
+            else:
+                filename = row[0]
+                image_data = None
 
-            filename = row[0]
-            image_data = None
+                try:
+                    with open(filename, "rb") as f:
+                        image_data = f.read()
+                        f.close()
+                except IOError as e:
+                    pass
 
-            try:
-                with open(filename, "rb") as f:
-                    image_data = f.read()
-                    f.close()
-            except IOError:
-                pass
-
-            return image_data
+                return image_data

comictaggerlib/imagehasher.py

@@ -15,41 +15,41 @@
 # limitations under the License.
 
 import io
-import logging
+import sys
 from functools import reduce
 
 try:
-    from PIL import Image
+    from PIL import Image, WebPImagePlugin
 
     pil_available = True
 except ImportError:
     pil_available = False
-logger = logging.getLogger(__name__)
 
 
-class ImageHasher:
+class ImageHasher(object):
     def __init__(self, path=None, data=None, width=8, height=8):
+        # self.hash_size = size
         self.width = width
         self.height = height
 
         if path is None and data is None:
             raise IOError
-
-        try:
-            if path is not None:
-                self.image = Image.open(path)
-            else:
-                self.image = Image.open(io.BytesIO(data))
-        except Exception:
-            logger.exception("Image data seems corrupted!")
-            # just generate a bogus image
-            self.image = Image.new("L", (1, 1))
+        else:
+            try:
+                if path is not None:
+                    self.image = Image.open(path)
+                else:
+                    self.image = Image.open(io.BytesIO(data))
+            except Exception as e:
+                print("Image data seems corrupted! [{}]".format(e))
+                # just generate a bogus image
+                self.image = Image.new("L", (1, 1))
 
     def average_hash(self):
         try:
             image = self.image.resize((self.width, self.height), Image.ANTIALIAS).convert("L")
-        except Exception:
-            logger.exception("average_hash error")
+        except Exception as e:
+            print("average_hash error:", e)
             return int(0)
 
         pixels = list(image.getdata())
@@ -71,6 +71,7 @@ class ImageHasher:
         return result
 
     def average_hash2(self):
+        pass
         """
         # Got this one from somewhere on the net.  Not a clue how the 'convolve2d'
         # works!
@@ -92,6 +93,7 @@ class ImageHasher:
         """
 
     def dct_average_hash(self):
+        pass
         """
         # Algorithm source: http://syntaxcandy.blogspot.com/2012/08/perceptual-hash.html
 
@@ -129,8 +131,8 @@ class ImageHasher:
 
         7. Construct the hash. Set the 64 bits into a 64-bit integer. The order does not
         matter, just as long as you are consistent.
-
-
+        """
+        """
         import numpy
         import scipy.fftpack
         numpy.set_printoptions(threshold=10000, linewidth=200, precision=2, suppress=True)
@@ -173,7 +175,7 @@ class ImageHasher:
 
     @staticmethod
     def hamming_distance(h1, h2):
-        if isinstance(h1, int) or isinstance(h2, int):
+        if isinstance(h1, int) or isinstance(h1, int):
             n1 = h1
             n2 = h2
         else:

comictaggerlib/imagepopup.py

@@ -14,62 +14,57 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-import logging
-
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class ImagePopup(QtWidgets.QDialog):
     def __init__(self, parent, image_pixmap):
         super(ImagePopup, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("imagepopup.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("imagepopup.ui"), self)
 
-        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.CursorShape.WaitCursor))
+        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
 
-        self.setWindowFlags(QtCore.Qt.WindowType.Popup)
-        self.setWindowState(QtCore.Qt.WindowState.WindowFullScreen)
+        # self.setWindowModality(QtCore.Qt.WindowModal)
+        self.setWindowFlags(QtCore.Qt.Popup)
+        self.setWindowState(QtCore.Qt.WindowFullScreen)
 
         self.imagePixmap = image_pixmap
 
-        screen_size = QtGui.QGuiApplication.primaryScreen().geometry()
-        QtWidgets.QApplication.primaryScreen()
+        screen_size = QtWidgets.QDesktopWidget().screenGeometry()
         self.resize(screen_size.width(), screen_size.height())
         self.move(0, 0)
 
         # This is a total hack.  Uses a snapshot of the desktop, and overlays a
-        # translucent screen over it.  Probably can do it better by setting opacity of a widget
-        # TODO: macOS denies this
+        # translucent screen over it.  Probably can do it better by setting opacity of a
+        # widget
         screen = QtWidgets.QApplication.primaryScreen()
-        self.desktopBg = screen.grabWindow(0, 0, 0, screen_size.width(), screen_size.height())
-        bg = QtGui.QPixmap(ComicTaggerSettings.get_graphic("popup_bg.png"))
-        self.clientBgPixmap = bg.scaled(screen_size.width(), screen_size.height())
+        self.desktopBg = screen.grabWindow(QtWidgets.QApplication.desktop().winId(), 0, 0, screen_size.width(), screen_size.height())
+        bg = QtGui.QPixmap(ComicTaggerSettings.getGraphic("popup_bg.png"))
+        self.clientBgPixmap = bg.scaled(screen_size.width(), screen_size.height(), QtCore.Qt.IgnoreAspectRatio, QtCore.Qt.SmoothTransformation)
         self.setMask(self.clientBgPixmap.mask())
 
-        self.apply_image_pixmap()
+        self.applyImagePixmap()
         self.showFullScreen()
         self.raise_()
         QtWidgets.QApplication.restoreOverrideCursor()
 
     def paintEvent(self, event):
-        painter = QtGui.QPainter(self)
-        painter.setRenderHint(QtGui.QPainter.RenderHint.Antialiasing)
-        painter.drawPixmap(0, 0, self.desktopBg)
-        painter.drawPixmap(0, 0, self.clientBgPixmap)
-        painter.end()
+        self.painter = QtGui.QPainter(self)
+        self.painter.setRenderHint(QtGui.QPainter.Antialiasing)
+        self.painter.drawPixmap(0, 0, self.desktopBg)
+        self.painter.drawPixmap(0, 0, self.clientBgPixmap)
+        self.painter.end()
 
-    def apply_image_pixmap(self):
+    def applyImagePixmap(self):
         win_h = self.height()
         win_w = self.width()
 
         if self.imagePixmap.width() > win_w or self.imagePixmap.height() > win_h:
             # scale the pixmap to fit in the frame
-            display_pixmap = self.imagePixmap.scaled(win_w, win_h, QtCore.Qt.AspectRatioMode.KeepAspectRatio)
+            display_pixmap = self.imagePixmap.scaled(win_w, win_h, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation)
             self.lblImage.setPixmap(display_pixmap)
         else:
             display_pixmap = self.imagePixmap
@@ -79,7 +74,7 @@ class ImagePopup(QtWidgets.QDialog):
         img_w = display_pixmap.width()
         img_h = display_pixmap.height()
         self.lblImage.resize(img_w, img_h)
-        self.lblImage.move(int((win_w - img_w) / 2), int((win_h - img_h) / 2))
+        self.lblImage.move((win_w - img_w) / 2, (win_h - img_h) / 2)
 
     def mousePressEvent(self, event):
         self.close()

comictaggerlib/issueidentifier.py

@@ -15,36 +15,23 @@
 # limitations under the License.
 
 import io
-import logging
 import sys
-from typing import List, TypedDict
 
-from comicapi import utils
-from comicapi.comicarchive import ComicArchive
-from comicapi.genericmetadata import GenericMetadata
-from comicapi.issuestring import IssueString
-from comictaggerlib.comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from comictaggerlib.imagefetcher import ImageFetcher, ImageFetcherException
-from comictaggerlib.imagehasher import ImageHasher
-from comictaggerlib.resulttypes import IssueResult
-
-logger = logging.getLogger(__name__)
+from . import utils
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .genericmetadata import GenericMetadata
+from .imagefetcher import ImageFetcher, ImageFetcherException
+from .imagehasher import ImageHasher
+from .issuestring import IssueString
 
 try:
-    from PIL import Image
+    from PIL import Image, WebPImagePlugin
 
     pil_available = True
 except ImportError:
     pil_available = False
 
 
-class SearchKeys(TypedDict):
-    series: str
-    issue_number: str
-    month: int
-    year: int
-    issue_count: int
-
 
 class IssueIdentifierNetworkError(Exception):
     pass
@@ -55,21 +42,22 @@ class IssueIdentifierCancelled(Exception):
 
 
 class IssueIdentifier:
-    result_no_matches = 0
-    result_found_match_but_bad_cover_score = 1
-    result_found_match_but_not_first_page = 2
-    result_multiple_matches_with_bad_image_scores = 3
-    result_one_good_match = 4
-    result_multiple_good_matches = 5
 
-    def __init__(self, comic_archive: ComicArchive, settings):
-        self.comic_archive: ComicArchive = comic_archive
+    ResultNoMatches = 0
+    ResultFoundMatchButBadCoverScore = 1
+    ResultFoundMatchButNotFirstPage = 2
+    ResultMultipleMatchesWithBadImageScores = 3
+    ResultOneGoodMatch = 4
+    ResultMultipleGoodMatches = 5
+
+    def __init__(self, comic_archive, settings):
+        self.comic_archive = comic_archive
         self.image_hasher = 1
 
-        self.only_use_additional_meta_data = False
+        self.onlyUseAdditionalMetaData = False
 
         # a decent hamming score, good enough to call it a match
-        self.min_score_thresh: int = 16
+        self.min_score_thresh = 16
 
         # for alternate covers, be more stringent, since we're a bit more
         # scattershot in comparisons
@@ -87,84 +75,84 @@ class IssueIdentifier:
         self.length_delta_thresh = settings.id_length_delta_thresh
 
         # used to eliminate unlikely publishers
-        self.publisher_filter = [s.strip().lower() for s in settings.id_publisher_filter.split(",")]
+        self.publisher_blacklist = [s.strip().lower() for s in settings.id_publisher_blacklist.split(",")]
 
         self.additional_metadata = GenericMetadata()
-        self.output_function = IssueIdentifier.default_write_output
+        self.output_function = IssueIdentifier.defaultWriteOutput
         self.callback = None
-        self.cover_url_callback = None
-        self.search_result = self.result_no_matches
+        self.coverUrlCallback = None
+        self.search_result = self.ResultNoMatches
         self.cover_page_index = 0
         self.cancel = False
-        self.wait_and_retry_on_rate_limit = False
+        self.waitAndRetryOnRateLimit = False
 
-        self.match_list = []
-
-    def set_score_min_threshold(self, thresh: int):
+    def setScoreMinThreshold(self, thresh):
         self.min_score_thresh = thresh
 
-    def set_score_min_distance(self, distance):
+    def setScoreMinDistance(self, distance):
         self.min_score_distance = distance
 
-    def set_additional_metadata(self, md):
+    def setAdditionalMetadata(self, md):
         self.additional_metadata = md
 
-    def set_name_length_delta_threshold(self, delta):
+    def setNameLengthDeltaThreshold(self, delta):
         self.length_delta_thresh = delta
 
-    def set_publisher_filter(self, filter):
-        self.publisher_filter = filter
+    def setPublisherBlackList(self, blacklist):
+        self.publisher_blacklist = blacklist
 
-    def set_hasher_algorithm(self, algo):
+    def setHasherAlgorithm(self, algo):
         self.image_hasher = algo
+        pass
 
-    def set_output_function(self, func):
+    def setOutputFunction(self, func):
         self.output_function = func
+        pass
 
-    def calculate_hash(self, image_data):
+    def calculateHash(self, image_data):
         if self.image_hasher == "3":
             return ImageHasher(data=image_data).dct_average_hash()
-        if self.image_hasher == "2":
+        elif self.image_hasher == "2":
             return ImageHasher(data=image_data).average_hash2()
+        else:
+            return ImageHasher(data=image_data).average_hash()
 
-        return ImageHasher(data=image_data).average_hash()
-
-    def get_aspect_ratio(self, image_data):
+    def getAspectRatio(self, image_data):
         try:
-            im = Image.open(io.BytesIO(image_data))
+            im = Image.open(io.StringIO(image_data))
             w, h = im.size
             return float(h) / float(w)
         except:
             return 1.5
 
-    def crop_cover(self, image_data):
+    def cropCover(self, image_data):
 
-        im = Image.open(io.BytesIO(image_data))
+        im = Image.open(io.StringIO(image_data))
         w, h = im.size
 
         try:
             cropped_im = im.crop((int(w / 2), 0, w, h))
-        except:
-            logger.exception("cropCover() error")
+        except Exception as e:
+            print("cropCover() error:", e)
             return None
 
-        output = io.BytesIO()
+        output = io.StringIO()
         cropped_im.save(output, format="PNG")
         cropped_image_data = output.getvalue()
         output.close()
 
         return cropped_image_data
 
-    def set_progress_callback(self, cb_func):
+    def setProgressCallback(self, cb_func):
         self.callback = cb_func
 
-    def set_cover_url_callback(self, cb_func):
-        self.cover_url_callback = cb_func
+    def setCoverURLCallback(self, cb_func):
+        self.coverUrlCallback = cb_func
 
-    def get_search_keys(self):
+    def getSearchKeys(self):
 
         ca = self.comic_archive
-        search_keys: SearchKeys = {}
+        search_keys = dict()
         search_keys["series"] = None
         search_keys["issue_number"] = None
         search_keys["month"] = None
@@ -172,26 +160,26 @@ class IssueIdentifier:
         search_keys["issue_count"] = None
 
         if ca is None:
-            return None
+            return
 
-        if self.only_use_additional_meta_data:
+        if self.onlyUseAdditionalMetaData:
             search_keys["series"] = self.additional_metadata.series
             search_keys["issue_number"] = self.additional_metadata.issue
             search_keys["year"] = self.additional_metadata.year
             search_keys["month"] = self.additional_metadata.month
-            search_keys["issue_count"] = self.additional_metadata.issue_count
+            search_keys["issue_count"] = self.additional_metadata.issueCount
             return search_keys
 
         # see if the archive has any useful meta data for searching with
-        if ca.has_cix():
-            internal_metadata = ca.read_cix()
-        elif ca.has_cbi():
-            internal_metadata = ca.read_cbi()
+        if ca.hasCIX():
+            internal_metadata = ca.readCIX()
+        elif ca.hasCBI():
+            internal_metadata = ca.readCBI()
         else:
-            internal_metadata = ca.read_cbi()
+            internal_metadata = ca.readCBI()
 
         # try to get some metadata from filename
-        md_from_filename = ca.metadata_from_filename()
+        md_from_filename = ca.metadataFromFilename()
 
         # preference order:
         # 1. Additional metadata
@@ -226,104 +214,95 @@ class IssueIdentifier:
         else:
             search_keys["month"] = md_from_filename.month
 
-        if self.additional_metadata.issue_count is not None:
-            search_keys["issue_count"] = self.additional_metadata.issue_count
-        elif internal_metadata.issue_count is not None:
-            search_keys["issue_count"] = internal_metadata.issue_count
+        if self.additional_metadata.issueCount is not None:
+            search_keys["issue_count"] = self.additional_metadata.issueCount
+        elif internal_metadata.issueCount is not None:
+            search_keys["issue_count"] = internal_metadata.issueCount
         else:
-            search_keys["issue_count"] = md_from_filename.issue_count
+            search_keys["issue_count"] = md_from_filename.issueCount
 
         return search_keys
 
     @staticmethod
-    def default_write_output(text):
+    def defaultWriteOutput(text):
         sys.stdout.write(text)
         sys.stdout.flush()
 
-    def log_msg(self, msg: str, newline=True):
-        msg = str(msg)
-        if newline:
-            msg += "\n"
+    def log_msg(self, msg, newline=True):
         self.output_function(msg)
+        if newline:
+            self.output_function("\n")
 
-    def get_issue_cover_match_score(
-        self,
-        comic_vine,
-        issue_id,
-        primary_img_url,
-        primary_thumb_url,
-        page_url,
-        local_cover_hash_list,
-        use_remote_alternates=False,
-        use_log=True,
+    def getIssueCoverMatchScore(
+        self, comicVine, issue_id, primary_img_url, primary_thumb_url, page_url, localCoverHashList, useRemoteAlternates=False, useLog=True
     ):
-        # local_cover_hash_list is a list of pre-calculated hashs.
-        # use_remote_alternates - indicates to use alternate covers from CV
+        # localHashes is a list of pre-calculated hashs.
+        # useRemoteAlternates - indicates to use alternate covers from CV
 
         try:
             url_image_data = ImageFetcher().fetch(primary_thumb_url, blocking=True)
-        except ImageFetcherException as e:
+        except ImageFetcherException:
             self.log_msg("Network issue while fetching cover image from Comic Vine. Aborting...")
-            raise IssueIdentifierNetworkError from e
+            raise IssueIdentifierNetworkError
 
         if self.cancel:
             raise IssueIdentifierCancelled
 
         # alert the GUI, if needed
-        if self.cover_url_callback is not None:
-            self.cover_url_callback(url_image_data)
+        if self.coverUrlCallback is not None:
+            self.coverUrlCallback(url_image_data)
 
         remote_cover_list = []
-        item = {}
+        item = dict()
         item["url"] = primary_img_url
 
-        item["hash"] = self.calculate_hash(url_image_data)
+        item["hash"] = self.calculateHash(url_image_data)
         remote_cover_list.append(item)
 
         if self.cancel:
             raise IssueIdentifierCancelled
 
-        if use_remote_alternates:
-            alt_img_url_list = comic_vine.fetch_alternate_cover_urls(issue_id, page_url)
+        if useRemoteAlternates:
+            alt_img_url_list = comicVine.fetchAlternateCoverURLs(issue_id, page_url)
             for alt_url in alt_img_url_list:
                 try:
                     alt_url_image_data = ImageFetcher().fetch(alt_url, blocking=True)
-                except ImageFetcherException as e:
+                except ImageFetcherException:
                     self.log_msg("Network issue while fetching alt. cover image from Comic Vine. Aborting...")
-                    raise IssueIdentifierNetworkError from e
+                    raise IssueIdentifierNetworkError
 
                 if self.cancel:
                     raise IssueIdentifierCancelled
 
                 # alert the GUI, if needed
-                if self.cover_url_callback is not None:
-                    self.cover_url_callback(alt_url_image_data)
+                if self.coverUrlCallback is not None:
+                    self.coverUrlCallback(alt_url_image_data)
 
-                item = {}
+                item = dict()
                 item["url"] = alt_url
-                item["hash"] = self.calculate_hash(alt_url_image_data)
+                item["hash"] = self.calculateHash(alt_url_image_data)
                 remote_cover_list.append(item)
 
                 if self.cancel:
                     raise IssueIdentifierCancelled
 
-        if use_log and use_remote_alternates:
-            self.log_msg(f"[{len(remote_cover_list) - 1} alt. covers]", False)
-        if use_log:
+        if useLog and useRemoteAlternates:
+            self.log_msg("[{0} alt. covers]".format(len(remote_cover_list) - 1), False)
+        if useLog:
             self.log_msg("[ ", False)
 
         score_list = []
         done = False
-        for local_cover_hash in local_cover_hash_list:
+        for local_cover_hash in localCoverHashList:
             for remote_cover_item in remote_cover_list:
                 score = ImageHasher.hamming_distance(local_cover_hash, remote_cover_item["hash"])
-                score_item = {}
+                score_item = dict()
                 score_item["score"] = score
                 score_item["url"] = remote_cover_item["url"]
                 score_item["hash"] = remote_cover_item["hash"]
                 score_list.append(score_item)
-                if use_log:
-                    self.log_msg(score, False)
+                if useLog:
+                    self.log_msg("{0}".format(score), False)
 
                 if score <= self.strong_score_thresh:
                     # such a good score, we can quit now, since for sure we
@@ -333,43 +312,54 @@ class IssueIdentifier:
             if done:
                 break
 
-        if use_log:
+        if useLog:
             self.log_msg(" ]", False)
 
         best_score_item = min(score_list, key=lambda x: x["score"])
 
         return best_score_item
 
-    def search(self) -> List[IssueResult]:
+    # def validate(self, issue_id):
+    # create hash list
+    #    score = self.getIssueMatchScore(issue_id, hash_list, useRemoteAlternates = True)
+    #    if score < 20:
+    #        return True
+    #    else:
+    #        return False
+
+    def search(self):
+
         ca = self.comic_archive
-        self.match_list: List[IssueResult] = []
+        self.match_list = []
         self.cancel = False
-        self.search_result = self.result_no_matches
+        self.search_result = self.ResultNoMatches
 
         if not pil_available:
             self.log_msg("Python Imaging Library (PIL) is not available and is needed for issue identification.")
             return self.match_list
 
-        if not ca.seems_to_be_a_comic_archive():
-            self.log_msg("Sorry, but " + ca.path + " is not a comic archive!")
+        if not ca.seemsToBeAComicArchive():
+            self.log_msg("Sorry, but " + opts.filename + " is not a comic archive!")
             return self.match_list
 
-        cover_image_data = ca.get_page(self.cover_page_index)
-        cover_hash = self.calculate_hash(cover_image_data)
+        cover_image_data = ca.getPage(self.cover_page_index)
+        cover_hash = self.calculateHash(cover_image_data)
 
         # check the aspect ratio
         # if it's wider than it is high, it's probably a two page spread
         # if so, crop it and calculate a second hash
         narrow_cover_hash = None
-        aspect_ratio = self.get_aspect_ratio(cover_image_data)
+        aspect_ratio = self.getAspectRatio(cover_image_data)
         if aspect_ratio < 1.0:
-            right_side_image_data = self.crop_cover(cover_image_data)
+            right_side_image_data = self.cropCover(cover_image_data)
             if right_side_image_data is not None:
-                narrow_cover_hash = self.calculate_hash(right_side_image_data)
+                narrow_cover_hash = self.calculateHash(right_side_image_data)
 
-        keys = self.get_search_keys()
+        # self.log_msg("Cover hash = {0:016x}".format(cover_hash))
+
+        keys = self.getSearchKeys()
         # normalize the issue number
-        keys["issue_number"] = IssueString(keys["issue_number"]).as_string()
+        keys["issue_number"] = IssueString(keys["issue_number"]).asString()
 
         # we need, at minimum, a series and issue number
         if keys["series"] is None or keys["issue_number"] is None:
@@ -386,18 +376,21 @@ class IssueIdentifier:
         if keys["month"] is not None:
             self.log_msg("\tMonth:  " + str(keys["month"]))
 
-        comic_vine = ComicVineTalker()
-        comic_vine.wait_for_rate_limit = self.wait_and_retry_on_rate_limit
+        # self.log_msg("Publisher Blacklist: " + str(self.publisher_blacklist))
+        comicVine = ComicVineTalker()
+        comicVine.wait_for_rate_limit = self.waitAndRetryOnRateLimit
 
-        comic_vine.set_log_func(self.output_function)
+        comicVine.setLogFunc(self.output_function)
 
-        self.log_msg(f"Searching for {keys['series']} #{keys['issue_number']} ...")
+        # self.log_msg(("Searching for " + keys['series'] + "...")
+        self.log_msg("Searching for  {0} #{1} ...".format(keys["series"], keys["issue_number"]))
         try:
-            cv_search_results = comic_vine.search_for_series(keys["series"])
+            cv_search_results = comicVine.searchForSeries(keys["series"])
         except ComicVineTalkerException:
             self.log_msg("Network issue while searching for series. Aborting...")
             return []
 
+        # self.log_msg("Found " + str(len(cv_search_results)) + " initial results")
         if self.cancel:
             return []
 
@@ -406,34 +399,28 @@ class IssueIdentifier:
 
         series_second_round_list = []
 
+        # self.log_msg("Removing results with too long names, banned publishers, or future start dates")
         for item in cv_search_results:
             length_approved = False
             publisher_approved = True
             date_approved = True
 
             # remove any series that starts after the issue year
-            if (
-                keys["year"] is not None
-                and str(keys["year"]).isdigit()
-                and item["start_year"] is not None
-                and str(item["start_year"]).isdigit()
-            ):
+            if keys["year"] is not None and str(keys["year"]).isdigit() and item["start_year"] is not None and str(item["start_year"]).isdigit():
                 if int(keys["year"]) < int(item["start_year"]):
                     date_approved = False
 
             # assume that our search name is close to the actual name, say
             # within ,e.g. 5 chars
-            # sanitize both the search string and the result so that
-            # we are comparing the same type of data
-            shortened_key = utils.sanitize_title(keys["series"])
-            shortened_item_name = utils.sanitize_title(item["name"])
+            shortened_key = utils.removearticles(keys["series"])
+            shortened_item_name = utils.removearticles(item["name"])
             if len(shortened_item_name) < (len(shortened_key) + self.length_delta_thresh):
                 length_approved = True
 
-            # remove any series from publishers on the filter
+            # remove any series from publishers on the blacklist
             if item["publisher"] is not None:
                 publisher = item["publisher"]["name"]
-                if publisher is not None and publisher.lower() in self.publisher_filter:
+                if publisher is not None and publisher.lower() in self.publisher_blacklist:
                     publisher_approved = False
 
             if length_approved and publisher_approved and date_approved:
@@ -448,16 +435,12 @@ class IssueIdentifier:
         series_second_round_list.sort(key=lambda x: len(x["name"]), reverse=False)
 
         # build a list of volume IDs
-        volume_id_list = []
+        volume_id_list = list()
         for series in series_second_round_list:
             volume_id_list.append(series["id"])
 
-        issue_list = None
         try:
-            if len(volume_id_list) > 0:
-                issue_list = comic_vine.fetch_issues_by_volume_issue_num_and_year(
-                    volume_id_list, keys["issue_number"], keys["year"]
-                )
+            issue_list = comicVine.fetchIssuesByVolumeIssueNumAndYear(volume_id_list, keys["issue_number"], keys["year"])
 
         except ComicVineTalkerException:
             self.log_msg("Network issue while searching for series details. Aborting...")
@@ -466,7 +449,7 @@ class IssueIdentifier:
         if issue_list is None:
             return []
 
-        shortlist = []
+        shortlist = list()
         # now re-associate the issues and volumes
         for issue in issue_list:
             for series in series_second_round_list:
@@ -475,11 +458,9 @@ class IssueIdentifier:
                     break
 
         if keys["year"] is None:
-            self.log_msg(f"Found {len(shortlist)} series that have an issue #{keys['issue_number']}")
+            self.log_msg("Found {0} series that have an issue #{1}".format(len(shortlist), keys["issue_number"]))
         else:
-            self.log_msg(
-                f"Found {len(shortlist)} series that have an issue #{keys['issue_number']} from {keys['year']}"
-            )
+            self.log_msg("Found {0} series that have an issue #{1} from {2}".format(len(shortlist), keys["issue_number"], keys["year"]))
 
         # now we have a shortlist of volumes with the desired issue number
         # Do first round of cover matching
@@ -489,13 +470,10 @@ class IssueIdentifier:
                 self.callback(counter, len(shortlist) * 3)
                 counter += 1
 
-            self.log_msg(
-                f"Examining covers for  ID: {series['id']} {series['name']} ({series['start_year']}) ...",
-                newline=False,
-            )
+            self.log_msg("Examining covers for  ID: {0} {1} ({2}) ...".format(series["id"], series["name"], series["start_year"]), newline=False)
 
             # parse out the cover date
-            _, month, year = comic_vine.parse_date_str(issue["cover_date"])
+            day, month, year = comicVine.parseDateStr(issue["cover_date"])
 
             # Now check the cover match against the primary image
             hash_list = [cover_hash]
@@ -507,21 +485,15 @@ class IssueIdentifier:
                 thumb_url = issue["image"]["thumb_url"]
                 page_url = issue["site_detail_url"]
 
-                score_item = self.get_issue_cover_match_score(
-                    comic_vine,
-                    issue["id"],
-                    image_url,
-                    thumb_url,
-                    page_url,
-                    hash_list,
-                    use_remote_alternates=False,
+                score_item = self.getIssueCoverMatchScore(
+                    comicVine, issue["id"], image_url, thumb_url, page_url, hash_list, useRemoteAlternates=False
                 )
             except:
                 self.match_list = []
                 return self.match_list
 
-            match: IssueResult = {}
-            match["series"] = f"{series['name']} ({series['start_year']})"
+            match = dict()
+            match["series"] = "{0} ({1})".format(series["name"], series["start_year"])
             match["distance"] = score_item["score"]
             match["issue_number"] = keys["issue_number"]
             match["cv_issue_count"] = series["count_of_issues"]
@@ -541,49 +513,45 @@ class IssueIdentifier:
 
             self.match_list.append(match)
 
-            self.log_msg(f" --> {match['distance']}", newline=False)
+            self.log_msg(" --> {0}".format(match["distance"]), newline=False)
 
             self.log_msg("")
 
         if len(self.match_list) == 0:
             self.log_msg(":-(no matches!")
-            self.search_result = self.result_no_matches
+            self.search_result = self.ResultNoMatches
             return self.match_list
 
         # sort list by image match scores
         self.match_list.sort(key=lambda k: k["distance"])
 
-        lst = []
+        l = []
         for i in self.match_list:
-            lst.append(i["distance"])
+            l.append(i["distance"])
 
-        self.log_msg(f"Compared to covers in {len(self.match_list)} issue(s):", newline=False)
-        self.log_msg(str(lst))
+        self.log_msg("Compared to covers in {0} issue(s):".format(len(self.match_list)), newline=False)
+        self.log_msg(str(l))
 
         def print_match(item):
             self.log_msg(
                 "-----> {0} #{1} {2} ({3}/{4}) -- score: {5}".format(
-                    item["series"],
-                    item["issue_number"],
-                    item["issue_title"],
-                    item["month"],
-                    item["year"],
-                    item["distance"],
+                    item["series"], item["issue_number"], item["issue_title"], item["month"], item["year"], item["distance"]
                 )
             )
 
-        best_score: int = self.match_list[0]["distance"]
+        best_score = self.match_list[0]["distance"]
 
         if best_score >= self.min_score_thresh:
             # we have 1 or more low-confidence matches (all bad cover scores)
-            # look at a few more pages in the archive, and also alternate covers online
+            # look at a few more pages in the archive, and also alternate
+            # covers online
             self.log_msg("Very weak scores for the cover. Analyzing alternate pages and covers...")
             hash_list = [cover_hash]
             if narrow_cover_hash is not None:
                 hash_list.append(narrow_cover_hash)
-            for i in range(1, min(3, ca.get_number_of_pages())):
-                image_data = ca.get_page(i)
-                page_hash = self.calculate_hash(image_data)
+            for i in range(1, min(3, ca.getNumberOfPages())):
+                image_data = ca.getPage(i)
+                page_hash = self.calculateHash(image_data)
                 hash_list.append(page_hash)
 
             second_match_list = []
@@ -592,21 +560,15 @@ class IssueIdentifier:
                 if self.callback is not None:
                     self.callback(counter, len(self.match_list) * 3)
                     counter += 1
-                self.log_msg(f"Examining alternate covers for ID: {m['volume_id']} {m['series']} ...", newline=False)
+                self.log_msg("Examining alternate covers for ID: {0} {1} ...".format(m["volume_id"], m["series"]), newline=False)
                 try:
-                    score_item = self.get_issue_cover_match_score(
-                        comic_vine,
-                        m["issue_id"],
-                        m["image_url"],
-                        m["thumb_url"],
-                        m["page_url"],
-                        hash_list,
-                        use_remote_alternates=True,
+                    score_item = self.getIssueCoverMatchScore(
+                        comicVine, m["issue_id"], m["image_url"], m["thumb_url"], m["page_url"], hash_list, useRemoteAlternates=True
                     )
                 except:
                     self.match_list = []
                     return self.match_list
-                self.log_msg(f"--->{score_item['score']}")
+                self.log_msg("--->{0}".format(score_item["score"]))
                 self.log_msg("")
 
                 if score_item["score"] < self.min_alternate_score_thresh:
@@ -619,43 +581,43 @@ class IssueIdentifier:
                     self.log_msg("--------------------------------------------------------------------------")
                     print_match(self.match_list[0])
                     self.log_msg("--------------------------------------------------------------------------")
-                    self.search_result = self.result_found_match_but_bad_cover_score
+                    self.search_result = self.ResultFoundMatchButBadCoverScore
                 else:
                     self.log_msg("--------------------------------------------------------------------------")
                     self.log_msg("Multiple bad cover matches!  Need to use other info...")
                     self.log_msg("--------------------------------------------------------------------------")
-                    self.search_result = self.result_multiple_matches_with_bad_image_scores
+                    self.search_result = self.ResultMultipleMatchesWithBadImageScores
                 return self.match_list
+            else:
+                # We did good, found something!
+                self.log_msg("Success in secondary/alternate cover matching!")
 
-            # We did good, found something!
-            self.log_msg("Success in secondary/alternate cover matching!")
-
-            self.match_list = second_match_list
-            # sort new list by image match scores
-            self.match_list.sort(key=lambda k: k["distance"])
-            best_score = self.match_list[0]["distance"]
-            self.log_msg("[Second round cover matching: best score = {best_score}]")
-            # now drop down into the rest of the processing
+                self.match_list = second_match_list
+                # sort new list by image match scores
+                self.match_list.sort(key=lambda k: k["distance"])
+                best_score = self.match_list[0]["distance"]
+                self.log_msg("[Second round cover matching: best score = {0}]".format(best_score))
+                # now drop down into the rest of the processing
 
         if self.callback is not None:
             self.callback(99, 100)
 
-        # now pare down list, remove any item more than specified distant from the top scores
+        # now pare down list, remove any item more than specified distant from
+        # the top scores
         for item in reversed(self.match_list):
             if item["distance"] > best_score + self.min_score_distance:
                 self.match_list.remove(item)
 
         # One more test for the case choosing limited series first issue vs a trade with the same cover:
-        # if we have a given issue count > 1 and the volume from CV has count==1, remove it from match list
+        # if we have a given issue count > 1 and the volume from CV has
+        # count==1, remove it from match list
         if len(self.match_list) >= 2 and keys["issue_count"] is not None and keys["issue_count"] != 1:
-            new_list = []
+            new_list = list()
             for match in self.match_list:
                 if match["cv_issue_count"] != 1:
                     new_list.append(match)
                 else:
-                    self.log_msg(
-                        f"Removing volume {match['series']} [{match['volume_id']}] from consideration (only 1 issue)"
-                    )
+                    self.log_msg("Removing volume {0} [{1}] from consideration (only 1 issue)".format(match["series"], match["volume_id"]))
 
             if len(new_list) > 0:
                 self.match_list = new_list
@@ -664,17 +626,17 @@ class IssueIdentifier:
             self.log_msg("--------------------------------------------------------------------------")
             print_match(self.match_list[0])
             self.log_msg("--------------------------------------------------------------------------")
-            self.search_result = self.result_one_good_match
+            self.search_result = self.ResultOneGoodMatch
 
         elif len(self.match_list) == 0:
             self.log_msg("--------------------------------------------------------------------------")
             self.log_msg("No matches found :(")
             self.log_msg("--------------------------------------------------------------------------")
-            self.search_result = self.result_no_matches
+            self.search_result = self.ResultNoMatches
         else:
             # we've got multiple good matches:
             self.log_msg("More than one likely candidate.")
-            self.search_result = self.result_multiple_good_matches
+            self.search_result = self.ResultMultipleGoodMatches
             self.log_msg("--------------------------------------------------------------------------")
             for item in self.match_list:
                 print_match(item)

comictaggerlib/issueselectionwindow.py

@@ -15,55 +15,45 @@
 # limitations under the License.
 
 
-import logging
-
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comicapi.issuestring import IssueString
-from comictaggerlib.comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
 
-logger = logging.getLogger(__name__)
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .coverimagewidget import CoverImageWidget
+from .issuestring import IssueString
+from .settings import ComicTaggerSettings
 
 
 class IssueNumberTableWidgetItem(QtWidgets.QTableWidgetItem):
     def __lt__(self, other):
-        self_str = self.data(QtCore.Qt.ItemDataRole.DisplayRole)
-        other_str = other.data(QtCore.Qt.ItemDataRole.DisplayRole)
-        return IssueString(self_str).as_float() < IssueString(other_str).as_float()
+        selfStr = self.data(QtCore.Qt.DisplayRole)
+        otherStr = other.data(QtCore.Qt.DisplayRole)
+        return IssueString(selfStr).asFloat() < IssueString(otherStr).asFloat()
 
 
 class IssueSelectionWindow(QtWidgets.QDialog):
+
     volume_id = 0
 
     def __init__(self, parent, settings, series_id, issue_number):
-        super().__init__(parent)
+        super(IssueSelectionWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("issueselectionwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("issueselectionwindow.ui"), self)
 
         self.coverWidget = CoverImageWidget(self.coverImageContainer, CoverImageWidget.AltCoverMode)
         gridlayout = QtWidgets.QGridLayout(self.coverImageContainer)
         gridlayout.addWidget(self.coverWidget)
         gridlayout.setContentsMargins(0, 0, 0, 0)
 
-        reduce_widget_font_size(self.twList)
-        reduce_widget_font_size(self.teDescription, 1)
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
         self.series_id = series_id
-        self.issue_id = None
         self.settings = settings
         self.url_fetch_thread = None
-        self.issue_list = []
 
         if issue_number is None or issue_number == "":
             self.issue_number = 1
@@ -71,11 +61,11 @@ class IssueSelectionWindow(QtWidgets.QDialog):
             self.issue_number = issue_number
 
         self.initial_id = None
-        self.perform_query()
+        self.performQuery()
 
         self.twList.resizeColumnsToContents()
-        self.twList.currentItemChanged.connect(self.current_item_changed)
-        self.twList.cellDoubleClicked.connect(self.cell_double_clicked)
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
 
         # now that the list has been sorted, find the initial record, and
         # select it
@@ -83,25 +73,25 @@ class IssueSelectionWindow(QtWidgets.QDialog):
             self.twList.selectRow(0)
         else:
             for r in range(0, self.twList.rowCount()):
-                issue_id = self.twList.item(r, 0).data(QtCore.Qt.ItemDataRole.UserRole)
+                issue_id = self.twList.item(r, 0).data(QtCore.Qt.UserRole)
                 if issue_id == self.initial_id:
                     self.twList.selectRow(r)
                     break
 
-    def perform_query(self):
+    def performQuery(self):
 
-        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.CursorShape.WaitCursor))
+        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
 
         try:
-            comic_vine = ComicVineTalker()
-            comic_vine.fetch_volume_data(self.series_id)
-            self.issue_list = comic_vine.fetch_issues_by_volume(self.series_id)
+            comicVine = ComicVineTalker()
+            volume_data = comicVine.fetchVolumeData(self.series_id)
+            self.issue_list = comicVine.fetchIssuesByVolume(self.series_id)
         except ComicVineTalkerException as e:
             QtWidgets.QApplication.restoreOverrideCursor()
             if e.code == ComicVineTalkerException.RateLimit:
-                QtWidgets.QMessageBox.critical(self, "Comic Vine Error", ComicVineTalker.get_rate_limit_message())
+                QtWidgets.QMessageBox.critical(self, self.tr("Comic Vine Error"), ComicVineTalker.getRateLimitMessage())
             else:
-                QtWidgets.QMessageBox.critical(self, "Network Issue", "Could not connect to Comic Vine to list issues!")
+                QtWidgets.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to Comic Vine to list issues!"))
             return
 
         while self.twList.rowCount() > 0:
@@ -115,10 +105,10 @@ class IssueSelectionWindow(QtWidgets.QDialog):
 
             item_text = record["issue_number"]
             item = IssueNumberTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setData(QtCore.Qt.ItemDataRole.UserRole, record["id"])
-            item.setData(QtCore.Qt.ItemDataRole.DisplayRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, record["id"])
+            item.setData(QtCore.Qt.DisplayRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 0, item)
 
             item_text = record["cover_date"]
@@ -130,48 +120,45 @@ class IssueSelectionWindow(QtWidgets.QDialog):
                 item_text = parts[0] + "-" + parts[1]
 
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 1, item)
 
             item_text = record["name"]
             if item_text is None:
                 item_text = ""
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 2, item)
 
-            if (
-                IssueString(record["issue_number"]).as_string().lower()
-                == IssueString(self.issue_number).as_string().lower()
-            ):
+            if IssueString(record["issue_number"]).asString().lower() == IssueString(self.issue_number).asString().lower():
                 self.initial_id = record["id"]
 
             row += 1
 
         self.twList.setSortingEnabled(True)
-        self.twList.sortItems(0, QtCore.Qt.SortOrder.AscendingOrder)
+        self.twList.sortItems(0, QtCore.Qt.AscendingOrder)
 
         QtWidgets.QApplication.restoreOverrideCursor()
 
-    def cell_double_clicked(self, r, c):
+    def cellDoubleClicked(self, r, c):
         self.accept()
 
-    def current_item_changed(self, curr, prev):
+    def currentItemChanged(self, curr, prev):
 
         if curr is None:
             return
         if prev is not None and prev.row() == curr.row():
             return
 
-        self.issue_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.ItemDataRole.UserRole)
+        self.issue_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.UserRole)
 
         # list selection was changed, update the the issue cover
         for record in self.issue_list:
             if record["id"] == self.issue_id:
                 self.issue_number = record["issue_number"]
-                self.coverWidget.set_issue_id(int(self.issue_id))
+                self.coverWidget.setIssueID(int(self.issue_id))
                 if record["description"] is None:
                     self.teDescription.setText("")
                 else:

comictaggerlib/issuestring.py

@@ -0,0 +1 @@
+from comicapi.issuestring import *

comictaggerlib/logwindow.py

@@ -14,31 +14,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-import logging
-
-from PyQt5 import QtCore, QtWidgets, uic
-
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class LogWindow(QtWidgets.QDialog):
     def __init__(self, parent):
-        super().__init__(parent)
+        super(LogWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("logwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("logwindow.ui"), self)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
-    def set_text(self, text):
+    def setText(self, text):
         try:
             text = text.decode()
         except:

comictaggerlib/main.py

@@ -14,63 +14,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
-import logging.handlers
 import os
-import pathlib
 import platform
 import signal
 import sys
 import traceback
 
-import pkg_resources
+from . import cli, utils
+from .comicvinetalker import ComicVineTalker
+from .options import Options
+from .settings import ComicTaggerSettings
 
-from comictaggerlib import cli
-from comictaggerlib.comicvinetalker import ComicVineTalker
-from comictaggerlib.ctversion import version
-from comictaggerlib.options import Options
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger("comictagger")
-logging.getLogger("comicapi").setLevel(logging.DEBUG)
-logger.setLevel(logging.DEBUG)
+# Need to load setting before anything else
+SETTINGS = ComicTaggerSettings()
 
 try:
     qt_available = True
-    from PyQt5 import QtGui, QtWidgets
+    from PyQt5 import QtCore, QtGui, QtWidgets
 
-    from comictaggerlib.taggerwindow import TaggerWindow
+    from .taggerwindow import TaggerWindow
 except ImportError as e:
-    logging.debug(e)
     qt_available = False
 
 
-def rotate(handler: logging.handlers.RotatingFileHandler, filename: pathlib.Path):
-    if filename.is_file() and filename.stat().st_size > 0:
-        handler.doRollover()
-
-
 def ctmain():
-    stream_handler = logging.StreamHandler()
-    stream_handler.setLevel(logging.WARNING)
-    file_handler = logging.handlers.RotatingFileHandler(
-        ComicTaggerSettings.get_settings_folder() / "logs" / "ComicTagger.log", encoding="utf-8", backupCount=10
-    )
-    rotate(file_handler, ComicTaggerSettings.get_settings_folder() / "logs" / "ComicTagger.log")
-    logging.basicConfig(
-        handlers=[
-            stream_handler,
-            file_handler,
-        ],
-        level=logging.WARNING,
-        format="%(asctime)s | %(name)s | %(levelname)s | %(message)s",
-        datefmt="%Y-%m-%dT%H:%M:%S",
-    )
     opts = Options()
-    opts.parse_cmd_line_args()
-
-    # Need to load setting before anything else
-    SETTINGS = ComicTaggerSettings()
+    opts.parseCmdLineArgs()
 
     # manage the CV API key
     if opts.cv_api_key:
@@ -85,53 +54,36 @@ def ctmain():
 
     signal.signal(signal.SIGINT, signal.SIG_DFL)
 
-    logger.info(
-        "ComicTagger Version: %s running on: %s PyInstaller: %s",
-        version,
-        platform.system(),
-        "Yes" if getattr(sys, "frozen", None) else "No",
-    )
-
-    logger.debug("Installed Packages")
-    for pkg in sorted(pkg_resources.working_set, key=lambda x: x.project_name):
-        logger.debug("%s\t%s", pkg.project_name, pkg.version)
-
     if not qt_available and not opts.no_gui:
         opts.no_gui = True
-        print("PyQt5 is not available. ComicTagger is limited to command-line mode.")
-        logger.info("PyQt5 is not available. ComicTagger is limited to command-line mode.")
+        print("PyQt5 is not available.  ComicTagger is limited to command-line mode.", file=sys.stderr)
 
     if opts.no_gui:
-        try:
-            cli.cli_mode(opts, SETTINGS)
-        except:
-            logger.exception()
+        cli.cli_mode(opts, SETTINGS)
     else:
-        os.environ["QtWidgets.QT_AUTO_SCREEN_SCALE_FACTOR"] = "1"
-        args = []
-        if opts.darkmode:
-            args.extend(["-platform", "windows:darkmode=2"])
-        args.extend(sys.argv)
-        app = QtWidgets.QApplication(args)
+
+        os.environ["QT_AUTO_SCREEN_SCALE_FACTOR"] = "1"
+
+        # if platform.system() == "Darwin":
+        #    QtWidgets.QApplication.setStyle("macintosh")
+        # else:
+        #    QtWidgets.QApplication.setStyle("Fusion")
+
+        app = QtWidgets.QApplication(sys.argv)
         if platform.system() == "Darwin":
             # Set the MacOS dock icon
-            app.setWindowIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("app.png")))
+            app.setWindowIcon(QtGui.QIcon(ComicTaggerSettings.getGraphic("app.png")))
 
         if platform.system() == "Windows":
             # For pure python, tell windows that we're not python,
             # so we can have our own taskbar icon
             import ctypes
 
-            myappid = "comictagger"  # arbitrary string
+            myappid = u"comictagger"  # arbitrary string
             ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
-            # force close of console window
-            swp_hidewindow = 0x0080
-            console_wnd = ctypes.windll.kernel32.GetConsoleWindow()
-            if console_wnd != 0:
-                ctypes.windll.user32.SetWindowPos(console_wnd, None, 0, 0, 0, 0, swp_hidewindow)
 
         if platform.system() != "Linux":
-            img = QtGui.QPixmap(ComicTaggerSettings.get_graphic("tags.png"))
+            img = QtGui.QPixmap(ComicTaggerSettings.getGraphic("tags.png"))
 
             splash = QtWidgets.QSplashScreen(img)
             splash.show()
@@ -140,15 +92,12 @@ def ctmain():
 
         try:
             tagger_window = TaggerWindow(opts.file_list, SETTINGS, opts=opts)
-            tagger_window.setWindowIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("app.png")))
+            tagger_window.setWindowIcon(QtGui.QIcon(ComicTaggerSettings.getGraphic("app.png")))
             tagger_window.show()
 
             if platform.system() != "Linux":
                 splash.finish(tagger_window)
 
-            sys.exit(app.exec())
-        except Exception:
-            logger.exception()
-            QtWidgets.QMessageBox.critical(
-                QtWidgets.QMainWindow(), "Error", "Unhandled exception in app:\n" + traceback.format_exc()
-            )
+            sys.exit(app.exec_())
+        except Exception as e:
+            QtWidgets.QMessageBox.critical(QtWidgets.QMainWindow(), "Error", "Unhandled exception in app:\n" + traceback.format_exc())

comictaggerlib/matchselectionwindow.py

@@ -14,25 +14,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import os
 
-from PyQt5 import QtCore, QtWidgets, uic
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
 
-logger = logging.getLogger(__name__)
+from .coverimagewidget import CoverImageWidget
+from .settings import ComicTaggerSettings
 
 
 class MatchSelectionWindow(QtWidgets.QDialog):
+
     volume_id = 0
 
     def __init__(self, parent, matches, comic_archive):
-        super().__init__(parent)
+        super(MatchSelectionWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("matchselectionwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("matchselectionwindow.ui"), self)
 
         self.altCoverWidget = CoverImageWidget(self.altCoverContainer, CoverImageWidget.AltCoverMode)
         gridlayout = QtWidgets.QGridLayout(self.altCoverContainer)
@@ -44,36 +43,30 @@ class MatchSelectionWindow(QtWidgets.QDialog):
         gridlayout.addWidget(self.archiveCoverWidget)
         gridlayout.setContentsMargins(0, 0, 0, 0)
 
-        reduce_widget_font_size(self.twList)
-        reduce_widget_font_size(self.teDescription, 1)
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
         self.matches = matches
         self.comic_archive = comic_archive
 
-        self.twList.currentItemChanged.connect(self.current_item_changed)
-        self.twList.cellDoubleClicked.connect(self.cell_double_clicked)
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
 
-        self.update_data()
+        self.updateData()
 
-    def update_data(self):
+    def updateData(self):
 
-        self.set_cover_image()
-        self.populate_table()
+        self.setCoverImage()
+        self.populateTable()
         self.twList.resizeColumnsToContents()
         self.twList.selectRow(0)
 
         path = self.comic_archive.path
-        self.setWindowTitle(f"Select correct match: {os.path.split(path)[1]}")
+        self.setWindowTitle("Select correct match: {0}".format(os.path.split(path)[1]))
 
-    def populate_table(self):
+    def populateTable(self):
 
         while self.twList.rowCount() > 0:
             self.twList.removeRow(0)
@@ -86,70 +79,70 @@ class MatchSelectionWindow(QtWidgets.QDialog):
 
             item_text = match["series"]
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setData(QtCore.Qt.ItemDataRole.UserRole, (match,))
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, (match,))
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 0, item)
 
             if match["publisher"] is not None:
-                item_text = str(match["publisher"])
+                item_text = "{0}".format(match["publisher"])
             else:
                 item_text = "Unknown"
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 1, item)
 
             month_str = ""
             year_str = "????"
             if match["month"] is not None:
-                month_str = f"-{int(match['month']):02d}"
+                month_str = "-{0:02d}".format(int(match["month"]))
             if match["year"] is not None:
-                year_str = str(match["year"])
+                year_str = "{0}".format(match["year"])
 
             item_text = year_str + month_str
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 2, item)
 
             item_text = match["issue_title"]
             if item_text is None:
                 item_text = ""
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 3, item)
 
             row += 1
 
         self.twList.resizeColumnsToContents()
         self.twList.setSortingEnabled(True)
-        self.twList.sortItems(2, QtCore.Qt.SortOrder.AscendingOrder)
+        self.twList.sortItems(2, QtCore.Qt.AscendingOrder)
         self.twList.selectRow(0)
         self.twList.resizeColumnsToContents()
         self.twList.horizontalHeader().setStretchLastSection(True)
 
-    def cell_double_clicked(self, r, c):
+    def cellDoubleClicked(self, r, c):
         self.accept()
 
-    def current_item_changed(self, curr, prev):
+    def currentItemChanged(self, curr, prev):
 
         if curr is None:
             return
         if prev is not None and prev.row() == curr.row():
             return
 
-        self.altCoverWidget.set_issue_id(self.current_match()["issue_id"])
-        if self.current_match()["description"] is None:
+        self.altCoverWidget.setIssueID(self.currentMatch()["issue_id"])
+        if self.currentMatch()["description"] is None:
             self.teDescription.setText("")
         else:
-            self.teDescription.setText(self.current_match()["description"])
+            self.teDescription.setText(self.currentMatch()["description"])
 
-    def set_cover_image(self):
-        self.archiveCoverWidget.set_archive(self.comic_archive)
+    def setCoverImage(self):
+        self.archiveCoverWidget.setArchive(self.comic_archive)
 
-    def current_match(self):
+    def currentMatch(self):
         row = self.twList.currentRow()
-        match = self.twList.item(row, 0).data(QtCore.Qt.ItemDataRole.UserRole)[0]
+        match = self.twList.item(row, 0).data(QtCore.Qt.UserRole)[0]
         return match

comictaggerlib/optionalmsgdialog.py

@@ -6,7 +6,7 @@ checked = OptionalMessageDialog.msg(self, "Disclaimer",
                             "This is beta software, and you are using it at your own risk!",
                          )
 
-said_yes, checked = OptionalMessageDialog.question(self, "QtWidgets.Question",
+said_yes, checked = OptionalMessageDialog.question(self, "Question",
                             "Are you sure you wish to do this?",
                          )
 """
@@ -25,36 +25,31 @@ said_yes, checked = OptionalMessageDialog.question(self, "QtWidgets.Question",
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
-
-from PyQt5 import QtCore, QtWidgets
-
-logger = logging.getLogger(__name__)
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
 
 StyleMessage = 0
 StyleQuestion = 1
 
 
-class OptionalMessageDialog(QtWidgets.QDialog):
-    def __init__(self, parent, style, title, msg, check_state=QtCore.Qt.CheckState.Unchecked, check_text=None):
-        super().__init__(parent)
+class OptionalMessageDialog(QDialog):
+    def __init__(self, parent, style, title, msg, check_state=Qt.Unchecked, check_text=None):
+        QDialog.__init__(self, parent)
 
         self.setWindowTitle(title)
         self.was_accepted = False
-        layout = QtWidgets.QVBoxLayout(self)
 
-        self.theLabel = QtWidgets.QLabel(msg)
+        l = QVBoxLayout(self)
+
+        self.theLabel = QLabel(msg)
         self.theLabel.setWordWrap(True)
-        self.theLabel.setTextFormat(QtCore.Qt.TextFormat.RichText)
+        self.theLabel.setTextFormat(Qt.RichText)
         self.theLabel.setOpenExternalLinks(True)
-        self.theLabel.setTextInteractionFlags(
-            QtCore.Qt.TextInteractionFlag.TextSelectableByMouse
-            | QtCore.Qt.TextInteractionFlag.LinksAccessibleByMouse
-            | QtCore.Qt.TextInteractionFlag.LinksAccessibleByKeyboard
-        )
+        self.theLabel.setTextInteractionFlags(Qt.TextSelectableByMouse | Qt.LinksAccessibleByMouse | Qt.LinksAccessibleByKeyboard)
 
-        layout.addWidget(self.theLabel)
-        layout.insertSpacing(-1, 10)
+        l.addWidget(self.theLabel)
+        l.insertSpacing(-1, 10)
 
         if check_text is None:
             if style == StyleQuestion:
@@ -62,46 +57,41 @@ class OptionalMessageDialog(QtWidgets.QDialog):
             else:
                 check_text = "Don't show this message again"
 
-        self.theCheckBox = QtWidgets.QCheckBox(check_text)
+        self.theCheckBox = QCheckBox(check_text)
 
         self.theCheckBox.setCheckState(check_state)
 
-        layout.addWidget(self.theCheckBox)
+        l.addWidget(self.theCheckBox)
 
-        btnbox_style = QtWidgets.QDialogButtonBox.StandardButton.Ok
+        btnbox_style = QDialogButtonBox.Ok
         if style == StyleQuestion:
-            btnbox_style = QtWidgets.QDialogButtonBox.StandardButton.Yes | QtWidgets.QDialogButtonBox.StandardButton.No
+            btnbox_style = QDialogButtonBox.Yes | QDialogButtonBox.No
 
-        self.theButtonBox = QtWidgets.QDialogButtonBox(
-            btnbox_style,
-            parent=self,
-            accepted=self.accept,
-            rejected=self.reject,
-        )
+        self.theButtonBox = QDialogButtonBox(btnbox_style, parent=self, accepted=self.accept, rejected=self.reject)
 
-        layout.addWidget(self.theButtonBox)
+        l.addWidget(self.theButtonBox)
 
     def accept(self):
         self.was_accepted = True
-        QtWidgets.QDialog.accept(self)
+        QDialog.accept(self)
 
     def reject(self):
         self.was_accepted = False
-        QtWidgets.QDialog.reject(self)
+        QDialog.reject(self)
 
     @staticmethod
-    def msg(parent, title, msg, check_state=QtCore.Qt.CheckState.Unchecked, check_text=None):
+    def msg(parent, title, msg, check_state=Qt.Unchecked, check_text=None):
 
         d = OptionalMessageDialog(parent, StyleMessage, title, msg, check_state=check_state, check_text=check_text)
 
-        d.exec()
+        d.exec_()
         return d.theCheckBox.isChecked()
 
     @staticmethod
-    def question(parent, title, msg, check_state=QtCore.Qt.CheckState.Unchecked, check_text=None):
+    def question(parent, title, msg, check_state=Qt.Unchecked, check_text=None):
 
         d = OptionalMessageDialog(parent, StyleQuestion, title, msg, check_state=check_state, check_text=check_text)
 
-        d.exec()
+        d.exec_()
 
         return d.was_accepted, d.theCheckBox.isChecked()

comictaggerlib/options.py

@@ -15,17 +15,20 @@
 # limitations under the License.
 
 import getopt
-import logging
 import os
 import platform
 import sys
+import traceback
 
-from comicapi import utils
-from comicapi.comicarchive import MetaDataStyle
-from comicapi.genericmetadata import GenericMetadata
-from comictaggerlib import ctversion
+from . import _version, utils
+from .comicarchive import MetaDataStyle
+from .genericmetadata import GenericMetadata
+from .versionchecker import VersionChecker
 
-logger = logging.getLogger(__name__)
+try:
+    import argparse
+except ImportError:
+    pass
 
 
 class Options:
@@ -96,13 +99,11 @@ If no options are given, {0} will run in windowed mode.
                             error, wait and retry query.
 -v, --verbose               Be noisy when doing what it does.
     --terse                 Don't say much (for print mode).
-    --darkmode              Windows only. Force a dark pallet
-    --config=CONFIG_DIR     Config directory defaults to ~/.ComicTagger
     --version               Display version.
 -h, --help                  Display this message.
 
-For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
-"""
+For more help visit the wiki at: http://code.google.com/p/comictagger/
+    """
 
     def __init__(self):
         self.data_style = None
@@ -110,6 +111,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
         self.filename = None
         self.verbose = False
         self.terse = False
+        self.auto_imprint = False
         self.metadata = None
         self.print_tags = False
         self.copy_tags = False
@@ -136,9 +138,6 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
         self.wait_and_retry_on_rate_limit = False
         self.assume_issue_is_one_if_not_set = False
         self.file_list = []
-        self.darkmode = False
-        self.copy_source = None
-        self.config_path = ""
 
     def display_msg_and_quit(self, msg, code, show_help=False):
         appname = os.path.basename(sys.argv[0])
@@ -150,7 +149,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
             print("For more help, run with '--help'")
         sys.exit(code)
 
-    def parse_metadata_from_string(self, mdstr):
+    def parseMetadataFromString(self, mdstr):
         """The metadata string is a comma separated list of name-value pairs
         The names match the attributes of the internal metadata struct (for now)
         The caret is the special "escape character", since it's not common in
@@ -165,7 +164,8 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
 
         md = GenericMetadata()
 
-        # First, replace escaped commas with with a unique token (to be changed back later)
+        # First, replace escaped commas with with a unique token (to be changed
+        # back later)
         mdstr = mdstr.replace(escaped_comma, replacement_token)
         tmp_list = mdstr.split(",")
         md_list = []
@@ -174,7 +174,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
             md_list.append(item)
 
         # Now build a nice dict from the list
-        md_dict = {}
+        md_dict = dict()
         for item in md_list:
             # Make sure to fix any escaped equal signs
             i = item.replace(escaped_equals, replacement_token)
@@ -185,25 +185,27 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                 cred_attribs = value.split(":")
                 role = cred_attribs[0]
                 person = cred_attribs[1] if len(cred_attribs) > 1 else ""
-                primary = len(cred_attribs) > 2
-                md.add_credit(person.strip(), role.strip(), primary)
+                primary = cred_attribs[2] if len(cred_attribs) > 2 else None
+                md.addCredit(person.strip(), role.strip(), True if primary is not None else False)
             else:
                 md_dict[key] = value
 
         # Map the dict to the metadata object
-        for key, value in md_dict.items():
+        for key in md_dict:
             if not hasattr(md, key):
-                logger.warning("'%s' is not a valid tag name", key)
+                print("Warning: '{0}' is not a valid tag name".format(key))
             else:
-                md.is_empty = False
-                setattr(md, key, value)
+                md.isEmpty = False
+                setattr(md, key, md_dict[key])
+        # print(md)
         return md
 
     def launch_script(self, scriptfile):
         # we were given a script.  special case for the args:
         # 1. ignore everything before the -S,
-        # 2. pass all the ones that follow (including script name) to the script
-        script_args = []
+        # 2. pass all the ones that follow (including script name) to the
+        # script
+        script_args = list()
         for idx, arg in enumerate(sys.argv):
             if arg in ["-S", "--script"]:
                 # found script!
@@ -211,11 +213,12 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                 break
         sys.argv = script_args
         if not os.path.exists(scriptfile):
-            logger.error("Can't find %s", scriptfile)
+            print("Can't find {0}".format(scriptfile))
         else:
             # I *think* this makes sense:
-            # assume the base name of the file is the module name
-            # add the folder of the given file to the python path import module
+            #  assume the base name of the file is the module name
+            #  add the folder of the given file to the python path
+            #  import module
             dirname = os.path.dirname(scriptfile)
             module_name = os.path.splitext(os.path.basename(scriptfile))[0]
             sys.path = [dirname] + sys.path
@@ -226,16 +229,17 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                 if "main" in dir(script):
                     script.main()
                 else:
-                    logger.error("Can't find entry point 'main()' in module '%s'", module_name)
-            except Exception:
-                logger.exception("Script: %s raised an unhandled exception: ", module_name)
+                    print('Can\'t find entry point "main()" in module "{0}"'.format(module_name))
+            except Exception as e:
+                print("Script raised an unhandled exception: ", e)
+                print((traceback.format_exc()))
 
         sys.exit(0)
 
-    def parse_cmd_line_args(self):
+    def parseCmdLineArgs(self):
 
         if platform.system() == "Darwin" and hasattr(sys, "frozen") and sys.frozen == 1:
-            # remove the PSN (process serial number) argument from OS/X
+            # remove the PSN ("process serial number") argument from OS/X
             input_args = [a for a in sys.argv[1:] if "-psn_0_" not in a]
         else:
             input_args = sys.argv[1:]
@@ -283,8 +287,6 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                     "cv-api-key=",
                     "only-set-cv-key",
                     "wait-on-cv-rate-limit",
-                    "darkmode",
-                    "config=",
                 ],
             )
 
@@ -308,9 +310,10 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                 self.delete_tags = True
             if o in ("-i", "--interactive"):
                 self.interactive = True
+            if o in ("-a", "--auto-imprint"):
+                self.auto_imprint = True
             if o in ("-c", "--copy"):
                 self.copy_tags = True
-
                 if a.lower() == "cr":
                     self.copy_source = MetaDataStyle.CIX
                 elif a.lower() == "cbl":
@@ -324,7 +327,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
             if o in ("-n", "--dryrun"):
                 self.dryrun = True
             if o in ("-m", "--metadata"):
-                self.metadata = self.parse_metadata_from_string(a)
+                self.metadata = self.parseMetadataFromString(a)
             if o in ("-s", "--save"):
                 self.save_tags = True
             if o in ("-r", "--rename"):
@@ -339,8 +342,6 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                 self.parse_filename = True
             if o in ("-w", "--wait-on-cv-rate-limit"):
                 self.wait_and_retry_on_rate_limit = True
-            if o == "--config":
-                self.config_path = os.path.abspath(a)
             if o == "--id":
                 self.issue_id = a
             if o == "--raw":
@@ -360,7 +361,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
             if o == "--only-set-cv-key":
                 self.only_set_key = True
             if o == "--version":
-                print(f"ComicTagger {ctversion.version}:  Copyright (c) 2012-2022 ComicTagger Team")
+                print("ComicTagger {0}:  Copyright (c) 2012-2014 Anthony Beville".format(_version.version))
                 print("Distributed under Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)")
                 sys.exit(0)
             if o in ("-t", "--type"):
@@ -372,20 +373,8 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
                     self.data_style = MetaDataStyle.COMET
                 else:
                     self.display_msg_and_quit("Invalid tag type", 1)
-            if o == "--darkmode":
-                self.darkmode = True
 
-        if any(
-            [
-                self.print_tags,
-                self.delete_tags,
-                self.save_tags,
-                self.copy_tags,
-                self.rename_file,
-                self.export_to_zip,
-                self.only_set_key,
-            ]
-        ):
+        if self.print_tags or self.delete_tags or self.save_tags or self.copy_tags or self.rename_file or self.export_to_zip or self.only_set_key:
             self.no_gui = True
 
         count = 0
@@ -407,9 +396,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
             count += 1
 
         if count > 1:
-            self.display_msg_and_quit(
-                "Must choose only one action of print, delete, save, copy, rename, export, set key, or run script", 1
-            )
+            self.display_msg_and_quit("Must choose only one action of print, delete, save, copy, rename, export, set key, or run script", 1)
 
         if self.script is not None:
             self.launch_script(self.script)
@@ -431,7 +418,7 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
         if self.only_set_key and self.cv_api_key is None:
             self.display_msg_and_quit("Key not given!", 1)
 
-        if not self.only_set_key and self.no_gui and self.filename is None:
+        if (self.only_set_key == False) and self.no_gui and (self.filename is None):
             self.display_msg_and_quit("Command requires at least one filename!", 1)
 
         if self.delete_tags and self.data_style is None:
@@ -443,5 +430,8 @@ For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
         if self.copy_tags and self.data_style is None:
             self.display_msg_and_quit("Please specify the type to copy to with -t", 1)
 
+        # if self.rename_file and self.data_style is None:
+        #    self.display_msg_and_quit("Please specify the type to use for renaming with -t", 1)
+
         if self.recursive:
             self.file_list = utils.get_recursive_filelist(self.file_list)

comictaggerlib/pagebrowser.py

@@ -14,23 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import platform
 
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comicapi.comicarchive import ComicArchive
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .coverimagewidget import CoverImageWidget
+from .settings import ComicTaggerSettings
 
 
 class PageBrowserWindow(QtWidgets.QDialog):
     def __init__(self, parent, metadata):
-        super().__init__(parent)
+        super(PageBrowserWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("pagebrowser.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("pagebrowser.ui"), self)
 
         self.pageWidget = CoverImageWidget(self.pageContainer, CoverImageWidget.ArchiveMode)
         gridlayout = QtWidgets.QGridLayout(self.pageContainer)
@@ -38,29 +34,23 @@ class PageBrowserWindow(QtWidgets.QDialog):
         gridlayout.setContentsMargins(0, 0, 0, 0)
         self.pageWidget.showControls = False
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
         self.comic_archive = None
         self.page_count = 0
         self.current_page_num = 0
         self.metadata = metadata
 
-        self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Close).setDefault(True)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Close).setDefault(True)
         if platform.system() == "Darwin":
             self.btnPrev.setText("<<")
             self.btnNext.setText(">>")
         else:
-            self.btnPrev.setIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("left.png")))
-            self.btnNext.setIcon(QtGui.QIcon(ComicTaggerSettings.get_graphic("right.png")))
+            self.btnPrev.setIcon(QtGui.QIcon(ComicTaggerSettings.getGraphic("left.png")))
+            self.btnNext.setIcon(QtGui.QIcon(ComicTaggerSettings.getGraphic("right.png")))
 
-        self.btnNext.clicked.connect(self.next_page)
-        self.btnPrev.clicked.connect(self.prev_page)
+        self.btnNext.clicked.connect(self.nextPage)
+        self.btnPrev.clicked.connect(self.prevPage)
         self.show()
 
         self.btnNext.setEnabled(False)
@@ -76,39 +66,39 @@ class PageBrowserWindow(QtWidgets.QDialog):
         self.btnPrev.setEnabled(False)
         self.pageWidget.clear()
 
-    def set_comic_archive(self, ca: ComicArchive):
+    def setComicArchive(self, ca):
 
         self.comic_archive = ca
-        self.page_count = ca.get_number_of_pages()
+        self.page_count = ca.getNumberOfPages()
         self.current_page_num = 0
-        self.pageWidget.set_archive(self.comic_archive)
-        self.set_page()
+        self.pageWidget.setArchive(self.comic_archive)
+        self.setPage()
 
         if self.page_count > 1:
             self.btnNext.setEnabled(True)
             self.btnPrev.setEnabled(True)
 
-    def next_page(self):
+    def nextPage(self):
 
         if self.current_page_num + 1 < self.page_count:
             self.current_page_num += 1
         else:
             self.current_page_num = 0
-        self.set_page()
+        self.setPage()
 
-    def prev_page(self):
+    def prevPage(self):
 
         if self.current_page_num - 1 >= 0:
             self.current_page_num -= 1
         else:
             self.current_page_num = self.page_count - 1
-        self.set_page()
+        self.setPage()
 
-    def set_page(self):
+    def setPage(self):
         if self.metadata is not None:
-            archive_page_index = self.metadata.get_archive_page_index(self.current_page_num)
+            archive_page_index = self.metadata.getArchivePageIndex(self.current_page_num)
         else:
             archive_page_index = self.current_page_num
 
-        self.pageWidget.set_page(archive_page_index)
-        self.setWindowTitle(f"Page Browser - Page {self.current_page_num + 1} (of {self.page_count}) ")
+        self.pageWidget.setPage(archive_page_index)
+        self.setWindowTitle("Page Browser - Page {0} (of {1}) ".format(self.current_page_num + 1, self.page_count))

comictaggerlib/pagelisteditor.py

@@ -14,47 +14,49 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
-from typing import Optional
+import sys
+from operator import attrgetter, itemgetter
 
-from PyQt5 import QtCore, QtGui, QtWidgets, uic
+from PyQt5 import uic
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
 
-from comicapi.comicarchive import ComicArchive, MetaDataStyle
-from comicapi.genericmetadata import PageType
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from .comicarchive import MetaDataStyle
+from .coverimagewidget import CoverImageWidget
+from .genericmetadata import GenericMetadata, PageType
+from .settings import ComicTaggerSettings
 
 
-def item_move_events(widget):
-    class Filter(QtCore.QObject):
+def itemMoveEvents(widget):
+    class Filter(QObject):
 
-        mysignal = QtCore.pyqtSignal(str)
+        mysignal = pyqtSignal(str)
 
         def eventFilter(self, obj, event):
 
             if obj == widget:
                 # print(event.type())
-                if event.type() == QtCore.QEvent.Type.ChildRemoved:
+                if event.type() == QEvent.ChildRemoved:
                     # print("ChildRemoved")
                     self.mysignal.emit("finish")
-                if event.type() == QtCore.QEvent.Type.ChildAdded:
+                if event.type() == QEvent.ChildAdded:
                     # print("ChildAdded")
                     self.mysignal.emit("start")
                     return True
 
             return False
 
-    filt = Filter(widget)
-    widget.installEventFilter(filt)
-    return filt.mysignal
+    filter = Filter(widget)
+    widget.installEventFilter(filter)
+    return filter.mysignal
 
 
-class PageListEditor(QtWidgets.QWidget):
-    firstFrontCoverChanged = QtCore.pyqtSignal(int)
-    listOrderChanged = QtCore.pyqtSignal()
-    modified = QtCore.pyqtSignal()
+class PageListEditor(QWidget):
+
+    firstFrontCoverChanged = pyqtSignal(int)
+    listOrderChanged = pyqtSignal()
+    modified = pyqtSignal()
 
     pageTypeNames = {
         PageType.FrontCover: "Front Cover",
@@ -71,17 +73,18 @@ class PageListEditor(QtWidgets.QWidget):
     }
 
     def __init__(self, parent):
-        super().__init__(parent)
+        super(PageListEditor, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("pagelisteditor.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("pagelisteditor.ui"), self)
 
+        self.setEnabled(True)
         self.pageWidget = CoverImageWidget(self.pageContainer, CoverImageWidget.ArchiveMode)
-        gridlayout = QtWidgets.QGridLayout(self.pageContainer)
+        gridlayout = QGridLayout(self.pageContainer)
         gridlayout.addWidget(self.pageWidget)
         gridlayout.setContentsMargins(0, 0, 0, 0)
         self.pageWidget.showControls = False
 
-        self.reset_page()
+        self.resetPage()
 
         # Add the entries to the manga combobox
         self.comboBox.addItem("", "")
@@ -97,44 +100,50 @@ class PageListEditor(QtWidgets.QWidget):
         self.comboBox.addItem(self.pageTypeNames[PageType.Other], PageType.Other)
         self.comboBox.addItem(self.pageTypeNames[PageType.Deleted], PageType.Deleted)
 
-        self.listWidget.itemSelectionChanged.connect(self.change_page)
-        item_move_events(self.listWidget).connect(self.item_move_event)
-        self.comboBox.activated.connect(self.change_page_type)
-        self.leBookmark.editingFinished.connect(self.save_bookmark)
-        self.btnUp.clicked.connect(self.move_current_up)
-        self.btnDown.clicked.connect(self.move_current_down)
+        self.listWidget.itemSelectionChanged.connect(self.changePage)
+        itemMoveEvents(self.listWidget).connect(self.itemMoveEvent)
+        self.comboBox.activated.connect(self.changePageType)
+        self.btnUp.clicked.connect(self.moveCurrentUp)
+        self.btnDown.clicked.connect(self.moveCurrentDown)
         self.pre_move_row = -1
         self.first_front_page = None
 
-        self.comic_archive: Optional[ComicArchive] = None
-        self.pages_list = []
+    def toggleAd(self):
+        ad = self.comboBox.findData(PageType.Advertisement)
+        if self.comboBox.currentIndex() == ad:
+            self.comboBox.setCurrentIndex(0)
+            self.changePageType(0)
+        else:
+            self.comboBox.setCurrentIndex(ad)
+            self.changePageType(ad)
 
-    def reset_page(self):
+    def resetPage(self):
         self.pageWidget.clear()
         self.comboBox.setDisabled(True)
-        self.leBookmark.setDisabled(True)
         self.comic_archive = None
-        self.pages_list = []
+        self.pages_list = None
 
-    def get_new_indexes(self, movement):
+    def getNewIndexes(self, movement):
         selection = self.listWidget.selectionModel().selectedRows()
         selection.sort(reverse=movement > 0)
+        current = 0
         newindexes = []
         oldindexes = []
         for x in selection:
             current = x.row()
             oldindexes.append(current)
-            if 0 <= current + movement <= self.listWidget.count() - 1:
+            if current + movement >= 0 and current + movement <= self.listWidget.count() - 1:
                 if len(newindexes) < 1 or current + movement != newindexes[-1]:
                     current += movement
-
+            else:
+                prev = current
             newindexes.append(current)
         oldindexes.sort()
         newindexes.sort()
         return list(zip(newindexes, oldindexes))
 
-    def set_selection(self, indexes):
-        selection_ranges = []
+    def SetSelection(self, indexes):
+        selectionRanges = []
         first = 0
         for i, selection in enumerate(indexes):
             if i == 0:
@@ -142,37 +151,36 @@ class PageListEditor(QtWidgets.QWidget):
                 continue
 
             if selection != indexes[i - 1][0] + 1:
-                selection_ranges.append((first, indexes[i - 1][0]))
+                selectionRanges.append((first, indexes[i - 1][0]))
                 first = selection[0]
 
-        selection_ranges.append((first, indexes[-1][0]))
-        selection = QtCore.QItemSelection()
-        for x in selection_ranges:
+        selectionRanges.append((first, indexes[-1][0]))
+        selection = QItemSelection()
+        for x in selectionRanges:
             selection.merge(
-                QtCore.QItemSelection(self.listWidget.model().index(x[0], 0), self.listWidget.model().index(x[1], 0)),
-                QtCore.QItemSelectionModel.SelectionFlag.Select,
+                QItemSelection(self.listWidget.model().index(x[0], 0), self.listWidget.model().index(x[1], 0)), QItemSelectionModel.Select
             )
 
-        self.listWidget.selectionModel().select(selection, QtCore.QItemSelectionModel.SelectionFlag.ClearAndSelect)
-        return selection_ranges
+        self.listWidget.selectionModel().select(selection, QItemSelectionModel.ClearAndSelect)
+        return selectionRanges
 
-    def move_current_up(self):
+    def moveCurrentUp(self):
         row = self.listWidget.currentRow()
-        selection = self.get_new_indexes(-1)
+        selection = self.getNewIndexes(-1)
         for sel in selection:
             item = self.listWidget.takeItem(sel[1])
             self.listWidget.insertItem(sel[0], item)
 
         if row > 0:
             self.listWidget.setCurrentRow(row - 1)
-        self.set_selection(selection)
+        self.SetSelection(selection)
         self.listOrderChanged.emit()
-        self.emit_front_cover_change()
+        self.emitFrontCoverChange()
         self.modified.emit()
 
-    def move_current_down(self):
+    def moveCurrentDown(self):
         row = self.listWidget.currentRow()
-        selection = self.get_new_indexes(1)
+        selection = self.getNewIndexes(1)
         selection.sort(reverse=True)
         for sel in selection:
             item = self.listWidget.takeItem(sel[1])
@@ -181,64 +189,61 @@ class PageListEditor(QtWidgets.QWidget):
         if row < self.listWidget.count() - 1:
             self.listWidget.setCurrentRow(row + 1)
         self.listOrderChanged.emit()
-        self.emit_front_cover_change()
-        self.set_selection(selection)
+        self.emitFrontCoverChange()
+        self.SetSelection(selection)
         self.modified.emit()
 
-    def item_move_event(self, s):
+    def itemMoveEvent(self, s):
+        # print "move event: ", s, self.listWidget.currentRow()
         if s == "start":
             self.pre_move_row = self.listWidget.currentRow()
         if s == "finish":
             if self.pre_move_row != self.listWidget.currentRow():
                 self.listOrderChanged.emit()
-                self.emit_front_cover_change()
+                self.emitFrontCoverChange()
                 self.modified.emit()
 
-    def change_page_type(self, i):
+    def changePageType(self, i):
         new_type = self.comboBox.itemData(i)
-        if self.get_current_page_type() != new_type:
-            self.set_current_page_type(new_type)
-            self.emit_front_cover_change()
+        if self.getCurrentPageType() != new_type:
+            self.setCurrentPageType(new_type)
+            self.emitFrontCoverChange()
             self.modified.emit()
 
-    def change_page(self):
+    def changePage(self):
         row = self.listWidget.currentRow()
-        pagetype = self.get_current_page_type()
+        pagetype = self.getCurrentPageType()
 
         i = self.comboBox.findData(pagetype)
         self.comboBox.setCurrentIndex(i)
 
-        if "Bookmark" in self.listWidget.item(row).data(QtCore.Qt.UserRole)[0]:
-            self.leBookmark.setText(self.listWidget.item(row).data(QtCore.Qt.UserRole)[0]["Bookmark"])
-        else:
-            self.leBookmark.setText("")
-
-        idx = int(self.listWidget.item(row).data(QtCore.Qt.ItemDataRole.UserRole)[0]["Image"])
+        # idx = int(str (self.listWidget.item(row).text()))
+        idx = int(self.listWidget.item(row).data(Qt.UserRole)[0]["Image"])
 
         if self.comic_archive is not None:
-            self.pageWidget.set_archive(self.comic_archive, idx)
+            self.pageWidget.setArchive(self.comic_archive, idx)
 
-    def get_first_front_cover(self):
-        front_cover = 0
+    def getFirstFrontCover(self):
+        frontCover = 0
         for i in range(self.listWidget.count()):
             item = self.listWidget.item(i)
-            page_dict = item.data(QtCore.Qt.ItemDataRole.UserRole)[0]  # .toPyObject()[0]
+            page_dict = item.data(Qt.UserRole)[0]  # .toPyObject()[0]
             if "Type" in page_dict and page_dict["Type"] == PageType.FrontCover:
-                front_cover = int(page_dict["Image"])
+                frontCover = int(page_dict["Image"])
                 break
-        return front_cover
+        return frontCover
 
-    def get_current_page_type(self):
+    def getCurrentPageType(self):
         row = self.listWidget.currentRow()
-        page_dict = self.listWidget.item(row).data(QtCore.Qt.ItemDataRole.UserRole)[0]  # .toPyObject()[0]
+        page_dict = self.listWidget.item(row).data(Qt.UserRole)[0]  # .toPyObject()[0]
         if "Type" in page_dict:
             return page_dict["Type"]
+        else:
+            return ""
 
-        return ""
-
-    def set_current_page_type(self, t):
+    def setCurrentPageType(self, t):
         row = self.listWidget.currentRow()
-        page_dict = self.listWidget.item(row).data(QtCore.Qt.ItemDataRole.UserRole)[0]  # .toPyObject()[0]
+        page_dict = self.listWidget.item(row).data(Qt.UserRole)[0]  # .toPyObject()[0]
 
         if t == "":
             if "Type" in page_dict:
@@ -246,111 +251,77 @@ class PageListEditor(QtWidgets.QWidget):
         else:
             page_dict["Type"] = str(t)
 
-        item = self.listWidget.item(row)
-        # wrap the dict in a tuple to keep from being converted to QtWidgets.QStrings
-        item.setData(QtCore.Qt.ItemDataRole.UserRole, (page_dict,))
-        item.setText(self.list_entry_text(page_dict))
-
-    def save_bookmark(self):
-        row = self.listWidget.currentRow()
-        page_dict = self.listWidget.item(row).data(QtCore.Qt.UserRole)[0]
-
-        current_bookmark = ""
-        if "Bookmark" in page_dict:
-            current_bookmark = page_dict["Bookmark"]
-
-        if self.leBookmark.text().strip():
-            new_bookmark = str(self.leBookmark.text().strip())
-            if current_bookmark != new_bookmark:
-                page_dict["Bookmark"] = new_bookmark
-                self.modified.emit()
-        elif current_bookmark != "":
-            del page_dict["Bookmark"]
-            self.modified.emit()
-
         item = self.listWidget.item(row)
         # wrap the dict in a tuple to keep from being converted to QStrings
-        item.setData(QtCore.Qt.UserRole, (page_dict,))
-        item.setText(self.list_entry_text(page_dict))
+        item.setData(Qt.UserRole, (page_dict,))
+        item.setText(self.listEntryText(page_dict))
 
-        self.listWidget.setFocus()
-
-    def set_data(self, comic_archive: ComicArchive, pages_list: list):
+    def setData(self, comic_archive, pages_list):
         self.comic_archive = comic_archive
         self.pages_list = pages_list
         if pages_list is not None and len(pages_list) > 0:
             self.comboBox.setDisabled(False)
-            self.leBookmark.setDisabled(False)
 
-        self.listWidget.itemSelectionChanged.disconnect(self.change_page)
+        self.listWidget.itemSelectionChanged.disconnect(self.changePage)
 
         self.listWidget.clear()
         for p in pages_list:
-            item = QtWidgets.QListWidgetItem(self.list_entry_text(p))
-            # wrap the dict in a tuple to keep from being converted to QtWidgets.QStrings
-            item.setData(QtCore.Qt.ItemDataRole.UserRole, (p,))
+            item = QListWidgetItem(self.listEntryText(p))
+            # wrap the dict in a tuple to keep from being converted to QStrings
+            item.setData(Qt.UserRole, (p,))
 
             self.listWidget.addItem(item)
-        self.first_front_page = self.get_first_front_cover()
-        self.listWidget.itemSelectionChanged.connect(self.change_page)
+        self.first_front_page = self.getFirstFrontCover()
+        self.listWidget.itemSelectionChanged.connect(self.changePage)
         self.listWidget.setCurrentRow(0)
 
-    def list_entry_text(self, page_dict):
+    def listEntryText(self, page_dict):
         text = str(int(page_dict["Image"]) + 1)
         if "Type" in page_dict:
-            if page_dict["Type"] in self.pageTypeNames.keys():
-                text += " (" + self.pageTypeNames[page_dict["Type"]] + ")"
-            else:
-                text += " (Error: " + page_dict["Type"] + ")"
-        if "Bookmark" in page_dict:
-            text += " " + "\U0001F516"
+            text += " (" + self.pageTypeNames[page_dict["Type"]] + ")"
         return text
 
-    def get_page_list(self):
+    def getPageList(self):
         page_list = []
         for i in range(self.listWidget.count()):
             item = self.listWidget.item(i)
-            page_list.append(item.data(QtCore.Qt.ItemDataRole.UserRole)[0])  # .toPyObject()[0]
+            page_list.append(item.data(Qt.UserRole)[0])  # .toPyObject()[0]
         return page_list
 
-    def emit_front_cover_change(self):
-        if self.first_front_page != self.get_first_front_cover():
-            self.first_front_page = self.get_first_front_cover()
+    def emitFrontCoverChange(self):
+        if self.first_front_page != self.getFirstFrontCover():
+            self.first_front_page = self.getFirstFrontCover()
             self.firstFrontCoverChanged.emit(self.first_front_page)
 
-    def set_metadata_style(self, data_style):
+    def setMetadataStyle(self, data_style):
+
         # depending on the current data style, certain fields are disabled
 
-        inactive_color = QtGui.QColor(255, 170, 150)
+        inactive_color = QColor(255, 170, 150)
         active_palette = self.comboBox.palette()
 
         inactive_palette3 = self.comboBox.palette()
-        inactive_palette3.setColor(QtGui.QPalette.ColorRole.Base, inactive_color)
+        inactive_palette3.setColor(QPalette.Base, inactive_color)
 
         if data_style == MetaDataStyle.CIX:
             self.btnUp.setEnabled(True)
             self.btnDown.setEnabled(True)
             self.comboBox.setEnabled(True)
-            self.leBookmark.setEnabled(True)
             self.listWidget.setEnabled(True)
 
-            self.leBookmark.setPalette(active_palette)
             self.listWidget.setPalette(active_palette)
 
         elif data_style == MetaDataStyle.CBI:
             self.btnUp.setEnabled(False)
             self.btnDown.setEnabled(False)
             self.comboBox.setEnabled(False)
-            self.leBookmark.setEnabled(False)
             self.listWidget.setEnabled(False)
 
-            self.leBookmark.setPalette(inactive_palette3)
             self.listWidget.setPalette(inactive_palette3)
 
-        elif data_style == MetaDataStyle.COMET:
+        elif data_style == MetaDataStyle.CoMet:
             pass
 
         # make sure combo is disabled when no list
         if self.comic_archive is None:
             self.comboBox.setEnabled(False)
-            self.leBookmark.setEnabled(False)

comictaggerlib/pageloader.py

@@ -14,16 +14,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
+from PyQt5 import QtCore, QtGui, uic
+from PyQt5.QtCore import pyqtSignal
 
-from PyQt5 import QtCore
-
-from comicapi.comicarchive import ComicArchive
-
-logger = logging.getLogger(__name__)
+from comictaggerlib.ui.qtutils import getQImageFromData
 
 
 class PageLoader(QtCore.QThread):
+
     """
     This class holds onto a reference of each instance in a list since
     problems occur if the ref count goes to zero and the GC tries to reap
@@ -32,36 +30,39 @@ class PageLoader(QtCore.QThread):
     "abandoned", and no signals will be issued.
     """
 
-    loadComplete = QtCore.pyqtSignal(bytes)
+    loadComplete = pyqtSignal(QtGui.QImage)
 
     instanceList = []
     mutex = QtCore.QMutex()
 
     # Remove all finished threads from the list
     @staticmethod
-    def reap_instances():
+    def reapInstances():
         for obj in reversed(PageLoader.instanceList):
             if obj.isFinished():
                 PageLoader.instanceList.remove(obj)
 
-    def __init__(self, ca: ComicArchive, page_num):
+    def __init__(self, ca, page_num):
         QtCore.QThread.__init__(self)
-        self.ca: ComicArchive = ca
-        self.page_num: int = page_num
+        self.ca = ca
+        self.page_num = page_num
         self.abandoned = False
 
         # remove any old instances, and then add ourself
         PageLoader.mutex.lock()
-        PageLoader.reap_instances()
+        PageLoader.reapInstances()
         PageLoader.instanceList.append(self)
         PageLoader.mutex.unlock()
 
     def run(self):
-        image_data = self.ca.get_page(self.page_num)
+        image_data = self.ca.getPage(self.page_num)
         if self.abandoned:
             return
 
         if image_data is not None:
+            img = getQImageFromData(image_data)
+
             if self.abandoned:
                 return
-            self.loadComplete.emit(image_data)
+
+            self.loadComplete.emit(img)

comictaggerlib/progresswindow.py

@@ -1,4 +1,4 @@
-"""A PyQt5 dialog to show ID log and progress"""
+"""A PyQT5 dialog to show ID log and progress"""
 
 # Copyright 2012-2014 Anthony Beville
 
@@ -15,28 +15,19 @@
 # limitations under the License.
 
 
-import logging
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from PyQt5 import QtCore, QtWidgets, uic
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
 
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
-
-logger = logging.getLogger(__name__)
+from .settings import ComicTaggerSettings
 
 
 class IDProgressWindow(QtWidgets.QDialog):
     def __init__(self, parent):
-        super().__init__(parent)
+        super(IDProgressWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("progresswindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("progresswindow.ui"), self)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
-        reduce_widget_font_size(self.textEdit)
+        reduceWidgetFontSize(self.textEdit)

comictaggerlib/renamewindow.py

@@ -14,54 +14,44 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import os
-from typing import List
 
-from PyQt5 import QtCore, QtWidgets, uic
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-import comicapi.comicarchive
-from comicapi import utils
-from comicapi.comicarchive import MetaDataStyle
-from comictaggerlib.filerenamer import FileRenamer
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.settingswindow import SettingsWindow
-from comictaggerlib.ui.qtutils import center_window_on_parent
+from comictaggerlib.ui.qtutils import centerWindowOnParent
 
-logger = logging.getLogger(__name__)
+from . import utils
+from .comicarchive import MetaDataStyle
+from .filerenamer import FileRenamer
+from .settings import ComicTaggerSettings
+from .settingswindow import SettingsWindow
 
 
 class RenameWindow(QtWidgets.QDialog):
-    def __init__(self, parent, comic_archive_list: List[comicapi.comicarchive.ComicArchive], data_style, settings):
-        super().__init__(parent)
+    def __init__(self, parent, comic_archive_list, data_style, settings):
+        super(RenameWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("renamewindow.ui"), self)
-        self.label.setText(f"Preview (based on {MetaDataStyle.name[data_style]} tags):")
+        uic.loadUi(ComicTaggerSettings.getUIFile("renamewindow.ui"), self)
+        self.label.setText("Preview (based on {0} tags):".format(MetaDataStyle.name[data_style]))
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
         self.settings = settings
         self.comic_archive_list = comic_archive_list
         self.data_style = data_style
-        self.rename_list = []
 
-        self.btnSettings.clicked.connect(self.modify_settings)
+        self.btnSettings.clicked.connect(self.modifySettings)
+        self.configRenamer()
+        self.doPreview()
+
+    def configRenamer(self):
         self.renamer = FileRenamer(None)
-        self.config_renamer()
-        self.do_preview()
+        self.renamer.setTemplate(self.settings.rename_template)
+        self.renamer.setIssueZeroPadding(self.settings.rename_issue_number_padding)
+        self.renamer.setSmartCleanup(self.settings.rename_use_smart_string_cleanup)
 
-    def config_renamer(self):
-        self.renamer.set_template(self.settings.rename_template)
-        self.renamer.set_issue_zero_padding(self.settings.rename_issue_number_padding)
-        self.renamer.set_smart_cleanup(self.settings.rename_use_smart_string_cleanup)
-
-    def do_preview(self):
+    def doPreview(self):
+        self.rename_list = []
         while self.twList.rowCount() > 0:
             self.twList.removeRow(0)
 
@@ -71,18 +61,31 @@ class RenameWindow(QtWidgets.QDialog):
 
             new_ext = None  # default
             if self.settings.rename_extension_based_on_archive:
-                if ca.is_sevenzip():
-                    new_ext = ".cb7"
-                elif ca.is_zip():
+                if ca.isZip():
                     new_ext = ".cbz"
-                elif ca.is_rar():
+                elif ca.isRar():
                     new_ext = ".cbr"
 
-            md = ca.read_metadata(self.data_style)
-            if md.is_empty:
-                md = ca.metadata_from_filename(self.settings.parse_scan_info)
-            self.renamer.set_metadata(md)
-            new_name = self.renamer.determine_name(ca.path, ext=new_ext)
+            md = ca.readMetadata(self.data_style)
+            if md.isEmpty:
+                md = ca.metadataFromFilename(self.settings.parse_scan_info)
+            self.renamer.setMetadata(md)
+            self.renamer.move = self.settings.rename_move_dir
+
+            try:
+                new_name = self.renamer.determineName(ca.path, ext=new_ext)
+            except Exception as e:
+                QtWidgets.QMessageBox.critical(
+                    self,
+                    "Invalid format string!",
+                    "Your rename template is invalid!"
+                    "<br/><br/>{}<br/><br/>"
+                    "Please consult the template help in the "
+                    "settings and the documentation on the format at "
+                    "<a href='https://docs.python.org/3/library/string.html#format-string-syntax'>"
+                    "https://docs.python.org/3/library/string.html#format-string-syntax</a>".format(e),
+                )
+                return
 
             row = self.twList.rowCount()
             self.twList.insertRow(row)
@@ -91,23 +94,23 @@ class RenameWindow(QtWidgets.QDialog):
             new_name_item = QtWidgets.QTableWidgetItem()
 
             item_text = os.path.split(ca.path)[0]
-            folder_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            folder_item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 0, folder_item)
             folder_item.setText(item_text)
-            folder_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            folder_item.setData(QtCore.Qt.ToolTipRole, item_text)
 
             item_text = os.path.split(ca.path)[1]
-            old_name_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            old_name_item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 1, old_name_item)
             old_name_item.setText(item_text)
-            old_name_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            old_name_item.setData(QtCore.Qt.ToolTipRole, item_text)
 
-            new_name_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            new_name_item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 2, new_name_item)
             new_name_item.setText(new_name)
-            new_name_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, new_name)
+            new_name_item.setData(QtCore.Qt.ToolTipRole, new_name)
 
-            dict_item = {}
+            dict_item = dict()
             dict_item["archive"] = ca
             dict_item["new_name"] = new_name
             self.rename_list.append(dict_item)
@@ -121,51 +124,55 @@ class RenameWindow(QtWidgets.QDialog):
 
         self.twList.setSortingEnabled(True)
 
-    def modify_settings(self):
+    def modifySettings(self):
         settingswin = SettingsWindow(self, self.settings)
         settingswin.setModal(True)
-        settingswin.show_rename_tab()
-        settingswin.exec()
+        settingswin.showRenameTab()
+        settingswin.exec_()
         if settingswin.result():
-            self.config_renamer()
-            self.do_preview()
+            self.configRenamer()
+            self.doPreview()
 
     def accept(self):
 
-        prog_dialog = QtWidgets.QProgressDialog("", "Cancel", 0, len(self.rename_list), self)
-        prog_dialog.setWindowTitle("Renaming Archives")
-        prog_dialog.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
-        prog_dialog.setMinimumDuration(100)
-        center_window_on_parent(prog_dialog)
+        progdialog = QtWidgets.QProgressDialog("", "Cancel", 0, len(self.rename_list), self)
+        progdialog.setWindowTitle("Renaming Archives")
+        progdialog.setWindowModality(QtCore.Qt.WindowModal)
+        progdialog.setMinimumDuration(100)
+        centerWindowOnParent(progdialog)
+        # progdialog.show()
         QtCore.QCoreApplication.processEvents()
 
         for idx, item in enumerate(self.rename_list):
 
             QtCore.QCoreApplication.processEvents()
-            if prog_dialog.wasCanceled():
+            if progdialog.wasCanceled():
                 break
             idx += 1
-            prog_dialog.setValue(idx)
-            prog_dialog.setLabelText(item["new_name"])
-            center_window_on_parent(prog_dialog)
+            progdialog.setValue(idx)
+            progdialog.setLabelText(item["new_name"])
+            centerWindowOnParent(progdialog)
             QtCore.QCoreApplication.processEvents()
 
-            if item["new_name"] == os.path.basename(item["archive"].path):
-                print(item["new_name"], "Filename is already good!")
-                logger.info(item["new_name"], "Filename is already good!")
-                continue
-
-            if not item["archive"].is_writable(check_rar_status=False):
-                continue
-
             folder = os.path.dirname(os.path.abspath(item["archive"].path))
+            if self.settings.rename_move_dir and len(self.settings.rename_dir.strip()) > 3:
+                folder = self.settings.rename_dir.strip()
+
             new_abs_path = utils.unique_file(os.path.join(folder, item["new_name"]))
 
+            if os.path.join(folder, item["new_name"]) == item["archive"].path:
+                print(item["new_name"], "Filename is already good!")
+                continue
+
+            if not item["archive"].isWritable(check_rar_status=False):
+                continue
+
+            os.makedirs(os.path.dirname(new_abs_path), 0o777, True)
             os.rename(item["archive"].path, new_abs_path)
 
             item["archive"].rename(new_abs_path)
 
-        prog_dialog.hide()
+        progdialog.hide()
         QtCore.QCoreApplication.processEvents()
 
         QtWidgets.QDialog.accept(self)

comictaggerlib/resulttypes.py

@@ -1,37 +0,0 @@
-from typing import List, TypedDict
-
-from comicapi.comicarchive import ComicArchive
-
-
-class IssueResult(TypedDict):
-    series: str
-    distance: int
-    issue_number: str
-    cv_issue_count: int
-    url_image_hash: str
-    issue_title: str
-    issue_id: str  # int?
-    volume_id: str  # int?
-    month: int
-    year: int
-    publisher: str
-    image_url: str
-    thumb_url: str
-    page_url: str
-    description: str
-
-
-class OnlineMatchResults:
-    def __init__(self):
-        self.good_matches: List[str] = []
-        self.no_matches: List[str] = []
-        self.multiple_matches: List[MultipleMatch] = []
-        self.low_confidence_matches: List[MultipleMatch] = []
-        self.write_failures: List[str] = []
-        self.fetch_data_failures: List[str] = []
-
-
-class MultipleMatch:
-    def __init__(self, ca: ComicArchive, match_list: List[IssueResult]):
-        self.ca: ComicArchive = ca
-        self.matches = match_list

comictaggerlib/settings.py

@@ -14,48 +14,57 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import codecs
 import configparser
-import logging
 import os
-import pathlib
 import platform
 import sys
 import uuid
 
-from comicapi import utils
-
-logger = logging.getLogger(__name__)
+from . import utils
 
 
 class ComicTaggerSettings:
     @staticmethod
-    def get_settings_folder():
+    def getSettingsFolder():
+        filename_encoding = sys.getfilesystemencoding()
         if platform.system() == "Windows":
             folder = os.path.join(os.environ["APPDATA"], "ComicTagger")
         else:
             folder = os.path.join(os.path.expanduser("~"), ".ComicTagger")
-        return pathlib.Path(folder)
+        if folder is not None:
+            folder = folder
+        return folder
 
     @staticmethod
-    def base_dir():
+    def defaultLibunrarPath():
+        return ComicTaggerSettings.baseDir() + "/libunrar.so"
+
+    @staticmethod
+    def haveOwnUnrarLib():
+        return os.path.exists(ComicTaggerSettings.defaultLibunrarPath())
+
+    @staticmethod
+    def baseDir():
         if getattr(sys, "frozen", None):
             return sys._MEIPASS
-
-        return pathlib.Path(__file__).parent
+        else:
+            return os.path.dirname(os.path.abspath(__file__))
 
     @staticmethod
-    def get_graphic(filename):
-        graphic_folder = pathlib.Path(os.path.join(ComicTaggerSettings.base_dir(), "graphics"))
+    def getGraphic(filename):
+        graphic_folder = os.path.join(ComicTaggerSettings.baseDir(), "graphics")
         return os.path.join(graphic_folder, filename)
 
     @staticmethod
-    def get_ui_file(filename):
-        ui_folder = os.path.join(ComicTaggerSettings.base_dir(), "ui")
+    def getUIFile(filename):
+        ui_folder = os.path.join(ComicTaggerSettings.baseDir(), "ui")
         return os.path.join(ui_folder, filename)
 
-    def set_default_values(self):
+    def setDefaultValues(self):
         # General Settings
         self.rar_exe_path = ""
+        self.unrar_lib_path = ""
         self.allow_cbi_in_rar = True
         self.check_for_new_version = False
         self.send_usage_stats = False
@@ -76,13 +85,14 @@ class ComicTaggerSettings:
 
         # identifier settings
         self.id_length_delta_thresh = 5
-        self.id_publisher_filter = "Panini Comics, Abril, Planeta DeAgostini, Editorial Televisa, Dino Comics"
+        self.id_publisher_blacklist = "Panini Comics, Abril, Planeta DeAgostini, Editorial Televisa, Dino Comics"
 
         # Show/ask dialog flags
         self.ask_about_cbi_in_rar = True
         self.show_disclaimer = True
         self.dont_notify_about_this_version = ""
         self.ask_about_usage_stats = True
+        self.show_no_unrar_warning = True
 
         # filename parsing settings
         self.parse_scan_info = True
@@ -92,10 +102,7 @@ class ComicTaggerSettings:
         self.clear_form_before_populating_from_cv = False
         self.remove_html_tables = False
         self.cv_api_key = ""
-
-        self.sort_series_by_year = True
-        self.exact_series_matches_first = True
-        self.always_use_publisher_filter = False
+        self.auto_imprint = False
 
         # CBL Tranform settings
 
@@ -110,10 +117,12 @@ class ComicTaggerSettings:
         self.apply_cbl_transform_on_bulk_operation = False
 
         # Rename settings
-        self.rename_template = "%series% #%issue% (%year%)"
+        self.rename_template = "{publisher}/{series}/{series} #{issue} - {title} ({year})"
         self.rename_issue_number_padding = 3
         self.rename_use_smart_string_cleanup = True
         self.rename_extension_based_on_archive = True
+        self.rename_dir = ""
+        self.rename_move_dir = False
 
         # Auto-tag stickies
         self.save_on_low_confidence = False
@@ -127,77 +136,10 @@ class ComicTaggerSettings:
 
         self.settings_file = ""
         self.folder = ""
-        # General Settings
-        self.rar_exe_path = ""
-        self.allow_cbi_in_rar = True
-        self.check_for_new_version = False
-        self.send_usage_stats = False
-
-        # automatic settings
-        self.install_id = uuid.uuid4().hex
-        self.last_selected_save_data_style = 0
-        self.last_selected_load_data_style = 0
-        self.last_opened_folder = ""
-        self.last_main_window_width = 0
-        self.last_main_window_height = 0
-        self.last_main_window_x = 0
-        self.last_main_window_y = 0
-        self.last_form_side_width = -1
-        self.last_list_side_width = -1
-        self.last_filelist_sorted_column = -1
-        self.last_filelist_sorted_order = 0
-
-        # identifier settings
-        self.id_length_delta_thresh = 5
-        self.id_publisher_filter = "Panini Comics, Abril, Planeta DeAgostini, Editorial Televisa, Dino Comics"
-
-        # Show/ask dialog flags
-        self.ask_about_cbi_in_rar = True
-        self.show_disclaimer = True
-        self.dont_notify_about_this_version = ""
-        self.ask_about_usage_stats = True
-
-        # filename parsing settings
-        self.parse_scan_info = True
-
-        # Comic Vine settings
-        self.use_series_start_as_volume = False
-        self.clear_form_before_populating_from_cv = False
-        self.remove_html_tables = False
-        self.cv_api_key = ""
-
-        self.sort_series_by_year = True
-        self.exact_series_matches_first = True
-        self.always_use_publisher_filter = False
-
-        # CBL Tranform settings
-
-        self.assume_lone_credit_is_primary = False
-        self.copy_characters_to_tags = False
-        self.copy_teams_to_tags = False
-        self.copy_locations_to_tags = False
-        self.copy_storyarcs_to_tags = False
-        self.copy_notes_to_comments = False
-        self.copy_weblink_to_comments = False
-        self.apply_cbl_transform_on_cv_import = False
-        self.apply_cbl_transform_on_bulk_operation = False
-
-        # Rename settings
-        self.rename_template = "%series% #%issue% (%year%)"
-        self.rename_issue_number_padding = 3
-        self.rename_use_smart_string_cleanup = True
-        self.rename_extension_based_on_archive = True
-
-        # Auto-tag stickies
-        self.save_on_low_confidence = False
-        self.dont_use_year_when_identifying = False
-        self.assume_1_if_no_issue_num = False
-        self.ignore_leading_numbers_in_filename = False
-        self.remove_archive_after_successful_match = False
-        self.wait_and_retry_on_rate_limit = False
+        self.setDefaultValues()
 
         self.config = configparser.RawConfigParser()
-        self.folder = ComicTaggerSettings.get_settings_folder()
+        self.folder = ComicTaggerSettings.getSettingsFolder()
 
         if not os.path.exists(self.folder):
             os.makedirs(self.folder)
@@ -214,10 +156,10 @@ class ComicTaggerSettings:
         if self.rar_exe_path == "":
             if platform.system() == "Windows":
                 # look in some likely places for Windows machines
-                if os.path.exists(r"C:\Program Files\WinRAR\Rar.exe"):
-                    self.rar_exe_path = r"C:\Program Files\WinRAR\Rar.exe"
-                elif os.path.exists(r"C:\Program Files (x86)\WinRAR\Rar.exe"):
-                    self.rar_exe_path = r"C:\Program Files (x86)\WinRAR\Rar.exe"
+                if os.path.exists("C:\Program Files\WinRAR\Rar.exe"):
+                    self.rar_exe_path = "C:\Program Files\WinRAR\Rar.exe"
+                elif os.path.exists("C:\Program Files (x86)\WinRAR\Rar.exe"):
+                    self.rar_exe_path = "C:\Program Files (x86)\WinRAR\Rar.exe"
             else:
                 # see if it's in the path of unix user
                 if utils.which("rar") is not None:
@@ -226,7 +168,45 @@ class ComicTaggerSettings:
                 self.save()
         if self.rar_exe_path != "":
             # make sure rar program is now in the path for the rar class
-            utils.add_to_path(os.path.dirname(self.rar_exe_path))
+            utils.addtopath(os.path.dirname(self.rar_exe_path))
+
+        if self.haveOwnUnrarLib():
+            # We have a 'personal' copy of the unrar lib in the basedir, so
+            # don't search and change the setting
+            # NOTE: a manual edit of the settings file overrides this below
+            os.environ["UNRAR_LIB_PATH"] = self.defaultLibunrarPath()
+
+        elif self.unrar_lib_path == "":
+            # Priority is for unrar lib search is:
+            #    1. explicit setting in settings file
+            #    2. UNRAR_LIB_PATH in environment
+            #    3. check some likely platform specific places
+            if "UNRAR_LIB_PATH" in os.environ:
+                self.unrar_lib_path = os.environ["UNRAR_LIB_PATH"]
+            else:
+                # look in some platform specific places:
+                if platform.system() == "Windows":
+                    # Default location for the RARLab DLL installer
+                    if platform.architecture()[0] == "64bit" and os.path.exists("C:\\Program Files (x86)\\UnrarDLL\\x64\\UnRAR64.dll"):
+                        self.unrar_lib_path = "C:\\Program Files (x86)\\UnrarDLL\\x64\\UnRAR64.dll"
+                    elif platform.architecture()[0] == "32bit" and os.path.exists("C:\\Program Files\\UnrarDLL\\UnRAR.dll"):
+                        self.unrar_lib_path = "C:\\Program Files\\UnrarDLL\\UnRAR.dll"
+                elif platform.system() == "Darwin":
+                    # Look for the brew unrar library
+                    if os.path.exists("/usr/local/lib/libunrar.dylib"):
+                        self.unrar_lib_path = "/usr/local/lib/libunrar.dylib"
+                elif platform.system() == "Linux":
+                    if os.path.exists("/usr/local/lib/libunrar.so"):
+                        self.unrar_lib_path = "/usr/local/lib/libunrar.so"
+                    elif os.path.exists("/usr/lib/libunrar.so"):
+                        self.unrar_lib_path = "/usr/lib/libunrar.so"
+
+            if self.unrar_lib_path != "":
+                self.save()
+
+        if self.unrar_lib_path != "":
+            # This needs to occur before the unrar module is loaded for the first time
+            os.environ["UNRAR_LIB_PATH"] = self.unrar_lib_path
 
     def reset(self):
         os.unlink(self.settings_file)
@@ -239,10 +219,12 @@ class ComicTaggerSettings:
                 yield line
                 line = f.readline()
 
-        with open(self.settings_file, "r") as f:
-            self.config.read_file(readline_generator(f))
+        # self.config.readfp(codecs.open(self.settings_file, "r", "utf8"))
+        self.config.read_file(readline_generator(codecs.open(self.settings_file, "r", "utf8")))
 
         self.rar_exe_path = self.config.get("settings", "rar_exe_path")
+        if self.config.has_option("settings", "unrar_lib_path"):
+            self.unrar_lib_path = self.config.get("settings", "unrar_lib_path")
         if self.config.has_option("settings", "check_for_new_version"):
             self.check_for_new_version = self.config.getboolean("settings", "check_for_new_version")
         if self.config.has_option("settings", "send_usage_stats"):
@@ -275,8 +257,8 @@ class ComicTaggerSettings:
 
         if self.config.has_option("identifier", "id_length_delta_thresh"):
             self.id_length_delta_thresh = self.config.getint("identifier", "id_length_delta_thresh")
-        if self.config.has_option("identifier", "id_publisher_filter"):
-            self.id_publisher_filter = self.config.get("identifier", "id_publisher_filter")
+        if self.config.has_option("identifier", "id_publisher_blacklist"):
+            self.id_publisher_blacklist = self.config.get("identifier", "id_publisher_blacklist")
 
         if self.config.has_option("filenameparser", "parse_scan_info"):
             self.parse_scan_info = self.config.getboolean("filenameparser", "parse_scan_info")
@@ -289,30 +271,20 @@ class ComicTaggerSettings:
             self.dont_notify_about_this_version = self.config.get("dialogflags", "dont_notify_about_this_version")
         if self.config.has_option("dialogflags", "ask_about_usage_stats"):
             self.ask_about_usage_stats = self.config.getboolean("dialogflags", "ask_about_usage_stats")
+        if self.config.has_option("dialogflags", "show_no_unrar_warning"):
+            self.show_no_unrar_warning = self.config.getboolean("dialogflags", "show_no_unrar_warning")
 
         if self.config.has_option("comicvine", "use_series_start_as_volume"):
             self.use_series_start_as_volume = self.config.getboolean("comicvine", "use_series_start_as_volume")
         if self.config.has_option("comicvine", "clear_form_before_populating_from_cv"):
-            self.clear_form_before_populating_from_cv = self.config.getboolean(
-                "comicvine", "clear_form_before_populating_from_cv"
-            )
+            self.clear_form_before_populating_from_cv = self.config.getboolean("comicvine", "clear_form_before_populating_from_cv")
         if self.config.has_option("comicvine", "remove_html_tables"):
             self.remove_html_tables = self.config.getboolean("comicvine", "remove_html_tables")
-
-        if self.config.has_option("comicvine", "sort_series_by_year"):
-            self.sort_series_by_year = self.config.getboolean("comicvine", "sort_series_by_year")
-        if self.config.has_option("comicvine", "exact_series_matches_first"):
-            self.exact_series_matches_first = self.config.getboolean("comicvine", "exact_series_matches_first")
-        if self.config.has_option("comicvine", "always_use_publisher_filter"):
-            self.always_use_publisher_filter = self.config.getboolean("comicvine", "always_use_publisher_filter")
-
         if self.config.has_option("comicvine", "cv_api_key"):
             self.cv_api_key = self.config.get("comicvine", "cv_api_key")
 
         if self.config.has_option("cbl_transform", "assume_lone_credit_is_primary"):
-            self.assume_lone_credit_is_primary = self.config.getboolean(
-                "cbl_transform", "assume_lone_credit_is_primary"
-            )
+            self.assume_lone_credit_is_primary = self.config.getboolean("cbl_transform", "assume_lone_credit_is_primary")
         if self.config.has_option("cbl_transform", "copy_characters_to_tags"):
             self.copy_characters_to_tags = self.config.getboolean("cbl_transform", "copy_characters_to_tags")
         if self.config.has_option("cbl_transform", "copy_teams_to_tags"):
@@ -326,13 +298,9 @@ class ComicTaggerSettings:
         if self.config.has_option("cbl_transform", "copy_weblink_to_comments"):
             self.copy_weblink_to_comments = self.config.getboolean("cbl_transform", "copy_weblink_to_comments")
         if self.config.has_option("cbl_transform", "apply_cbl_transform_on_cv_import"):
-            self.apply_cbl_transform_on_cv_import = self.config.getboolean(
-                "cbl_transform", "apply_cbl_transform_on_cv_import"
-            )
+            self.apply_cbl_transform_on_cv_import = self.config.getboolean("cbl_transform", "apply_cbl_transform_on_cv_import")
         if self.config.has_option("cbl_transform", "apply_cbl_transform_on_bulk_operation"):
-            self.apply_cbl_transform_on_bulk_operation = self.config.getboolean(
-                "cbl_transform", "apply_cbl_transform_on_bulk_operation"
-            )
+            self.apply_cbl_transform_on_bulk_operation = self.config.getboolean("cbl_transform", "apply_cbl_transform_on_bulk_operation")
 
         if self.config.has_option("rename", "rename_template"):
             self.rename_template = self.config.get("rename", "rename_template")
@@ -341,9 +309,11 @@ class ComicTaggerSettings:
         if self.config.has_option("rename", "rename_use_smart_string_cleanup"):
             self.rename_use_smart_string_cleanup = self.config.getboolean("rename", "rename_use_smart_string_cleanup")
         if self.config.has_option("rename", "rename_extension_based_on_archive"):
-            self.rename_extension_based_on_archive = self.config.getboolean(
-                "rename", "rename_extension_based_on_archive"
-            )
+            self.rename_extension_based_on_archive = self.config.getboolean("rename", "rename_extension_based_on_archive")
+        if self.config.has_option("rename", "rename_dir"):
+            self.rename_dir = self.config.get("rename", "rename_dir")
+        if self.config.has_option("rename", "rename_move_dir"):
+            self.rename_move_dir = self.config.getboolean("rename", "rename_move_dir")
 
         if self.config.has_option("autotag", "save_on_low_confidence"):
             self.save_on_low_confidence = self.config.getboolean("autotag", "save_on_low_confidence")
@@ -352,15 +322,13 @@ class ComicTaggerSettings:
         if self.config.has_option("autotag", "assume_1_if_no_issue_num"):
             self.assume_1_if_no_issue_num = self.config.getboolean("autotag", "assume_1_if_no_issue_num")
         if self.config.has_option("autotag", "ignore_leading_numbers_in_filename"):
-            self.ignore_leading_numbers_in_filename = self.config.getboolean(
-                "autotag", "ignore_leading_numbers_in_filename"
-            )
+            self.ignore_leading_numbers_in_filename = self.config.getboolean("autotag", "ignore_leading_numbers_in_filename")
         if self.config.has_option("autotag", "remove_archive_after_successful_match"):
-            self.remove_archive_after_successful_match = self.config.getboolean(
-                "autotag", "remove_archive_after_successful_match"
-            )
+            self.remove_archive_after_successful_match = self.config.getboolean("autotag", "remove_archive_after_successful_match")
         if self.config.has_option("autotag", "wait_and_retry_on_rate_limit"):
             self.wait_and_retry_on_rate_limit = self.config.getboolean("autotag", "wait_and_retry_on_rate_limit")
+        if self.config.has_option("autotag", "auto_imprint"):
+            self.auto_imprint = self.config.getboolean("autotag", "auto_imprint")
 
     def save(self):
 
@@ -369,6 +337,7 @@ class ComicTaggerSettings:
 
         self.config.set("settings", "check_for_new_version", self.check_for_new_version)
         self.config.set("settings", "rar_exe_path", self.rar_exe_path)
+        self.config.set("settings", "unrar_lib_path", self.unrar_lib_path)
         self.config.set("settings", "send_usage_stats", self.send_usage_stats)
 
         if not self.config.has_section("auto"):
@@ -391,7 +360,7 @@ class ComicTaggerSettings:
             self.config.add_section("identifier")
 
         self.config.set("identifier", "id_length_delta_thresh", self.id_length_delta_thresh)
-        self.config.set("identifier", "id_publisher_filter", self.id_publisher_filter)
+        self.config.set("identifier", "id_publisher_blacklist", self.id_publisher_blacklist)
 
         if not self.config.has_section("dialogflags"):
             self.config.add_section("dialogflags")
@@ -400,6 +369,7 @@ class ComicTaggerSettings:
         self.config.set("dialogflags", "show_disclaimer", self.show_disclaimer)
         self.config.set("dialogflags", "dont_notify_about_this_version", self.dont_notify_about_this_version)
         self.config.set("dialogflags", "ask_about_usage_stats", self.ask_about_usage_stats)
+        self.config.set("dialogflags", "show_no_unrar_warning", self.show_no_unrar_warning)
 
         if not self.config.has_section("filenameparser"):
             self.config.add_section("filenameparser")
@@ -412,11 +382,6 @@ class ComicTaggerSettings:
         self.config.set("comicvine", "use_series_start_as_volume", self.use_series_start_as_volume)
         self.config.set("comicvine", "clear_form_before_populating_from_cv", self.clear_form_before_populating_from_cv)
         self.config.set("comicvine", "remove_html_tables", self.remove_html_tables)
-
-        self.config.set("comicvine", "sort_series_by_year", self.sort_series_by_year)
-        self.config.set("comicvine", "exact_series_matches_first", self.exact_series_matches_first)
-        self.config.set("comicvine", "always_use_publisher_filter", self.always_use_publisher_filter)
-
         self.config.set("comicvine", "cv_api_key", self.cv_api_key)
 
         if not self.config.has_section("cbl_transform"):
@@ -430,9 +395,7 @@ class ComicTaggerSettings:
         self.config.set("cbl_transform", "copy_notes_to_comments", self.copy_notes_to_comments)
         self.config.set("cbl_transform", "copy_weblink_to_comments", self.copy_weblink_to_comments)
         self.config.set("cbl_transform", "apply_cbl_transform_on_cv_import", self.apply_cbl_transform_on_cv_import)
-        self.config.set(
-            "cbl_transform", "apply_cbl_transform_on_bulk_operation", self.apply_cbl_transform_on_bulk_operation
-        )
+        self.config.set("cbl_transform", "apply_cbl_transform_on_bulk_operation", self.apply_cbl_transform_on_bulk_operation)
 
         if not self.config.has_section("rename"):
             self.config.add_section("rename")
@@ -441,6 +404,8 @@ class ComicTaggerSettings:
         self.config.set("rename", "rename_issue_number_padding", self.rename_issue_number_padding)
         self.config.set("rename", "rename_use_smart_string_cleanup", self.rename_use_smart_string_cleanup)
         self.config.set("rename", "rename_extension_based_on_archive", self.rename_extension_based_on_archive)
+        self.config.set("rename", "rename_dir", self.rename_dir)
+        self.config.set("rename", "rename_move_dir", self.rename_move_dir)
 
         if not self.config.has_section("autotag"):
             self.config.add_section("autotag")
@@ -450,6 +415,12 @@ class ComicTaggerSettings:
         self.config.set("autotag", "ignore_leading_numbers_in_filename", self.ignore_leading_numbers_in_filename)
         self.config.set("autotag", "remove_archive_after_successful_match", self.remove_archive_after_successful_match)
         self.config.set("autotag", "wait_and_retry_on_rate_limit", self.wait_and_retry_on_rate_limit)
+        self.config.set("autotag", "auto_imprint", self.auto_imprint)
 
-        with open(self.settings_file, "w") as configfile:
+        with codecs.open(self.settings_file, "wb", "utf8") as configfile:
             self.config.write(configfile)
+
+
+# make sure the basedir is cached, in case we're on Windows running a
+# script from frozen binary
+ComicTaggerSettings.baseDir()

comictaggerlib/settingswindow.py

@@ -14,19 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import os
 import platform
+import sys
 
 from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-from comicapi import utils
-from comictaggerlib.comicvinecacher import ComicVineCacher
-from comictaggerlib.comicvinetalker import ComicVineTalker
-from comictaggerlib.imagefetcher import ImageFetcher
-from comictaggerlib.settings import ComicTaggerSettings
-
-logger = logging.getLogger(__name__)
+from . import utils
+from .comicvinecacher import ComicVineCacher
+from .comicvinetalker import ComicVineTalker
+from .filerenamer import FileRenamer
+from .genericmetadata import GenericMetadata
+from .imagefetcher import ImageFetcher
+from .settings import ComicTaggerSettings
 
 windowsRarHelp = """
                  <html><head/><body><p>To write to CBR/RAR archives,
@@ -54,50 +54,85 @@ macRarHelp = """
                  </p>Once homebrew is installed, run: <b>brew install caskroom/cask/rar</b></body></html>
                 """
 
+windowsUnrarHelp = """
+                 <html><head/><body><p>To read CBR/RAR archives,
+                 you will need to have the unrar DLL from
+                 <span style=" text-decoration: underline; color:#0000ff;">
+                 <a href="https://www.rarlab.com/rar_add.htm">
+                 RARLab</a></span> installed. </p></body></html>
+                """
+
+linuxUnrarHelp = """
+               <html><head/><body><p>To read CBR/RAR archives,
+               you will need to have the unrar library from RARLab installed.
+               Look <span style=" text-decoration: underline; color:#0000ff;">
+               <a href="https://github.com/beville/libunrar-binaries/releases">here</a></span>
+               for pre-compiled binaries, or <span style=" text-decoration: underline; color:#0000ff;">
+               <a href="https://www.rarlab.com/rar_add.htm">here</a></span>
+               for the UnRAR source (which is easy to compile on Linux). </p></body></html>
+               """
+
+macUnrarHelp = """
+                 <html><head/><body><p>To read CBR/RAR archives,
+                 you will need the unrar library.  The easiest way to get this is
+                 to install <span style=" text-decoration: underline; color:#0000ff;">
+                 <a href="https://brew.sh/homebrew">homebrew</a></span>.
+                 </p>Once homebrew is installed, run: <b>brew install unrar</b></body></html>
+                """
+
 
 class SettingsWindow(QtWidgets.QDialog):
     def __init__(self, parent, settings):
-        super().__init__(parent)
+        super(SettingsWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("settingswindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("settingswindow.ui"), self)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(self.windowFlags() & ~QtCore.Qt.WindowType.WindowContextHelpButtonHint)
-        )
+        self.setWindowFlags(self.windowFlags() & ~QtCore.Qt.WindowContextHelpButtonHint)
 
         self.settings = settings
         self.name = "Settings"
 
+        self.priorUnrarLibPath = self.settings.unrar_lib_path
+
+        if self.settings.haveOwnUnrarLib():
+            # We have our own unrarlib, so no need for this GUI
+            self.grpBoxUnrar.hide()
+
         if platform.system() == "Windows":
             self.lblRarHelp.setText(windowsRarHelp)
+            self.lblUnrarHelp.setText(windowsUnrarHelp)
 
         elif platform.system() == "Linux":
             self.lblRarHelp.setText(linuxRarHelp)
+            self.lblUnrarHelp.setText(linuxUnrarHelp)
 
         elif platform.system() == "Darwin":
+            # Mac file dialog hides "/usr" and others, so allow user to type
+            self.leUnrarLibPath.setReadOnly(False)
             self.leRarExePath.setReadOnly(False)
 
             self.lblRarHelp.setText(macRarHelp)
+            self.lblUnrarHelp.setText(macUnrarHelp)
             self.name = "Preferences"
 
         self.setWindowTitle("ComicTagger " + self.name)
         self.lblDefaultSettings.setText("Revert to default " + self.name.lower())
         self.btnResetSettings.setText("Default " + self.name)
 
-        nldt_tip = """<html>The <b>Default Name Length Match Tolerance</b> is for eliminating automatic
+        nldtTip = """<html>The <b>Default Name Length Match Tolerance</b> is for eliminating automatic
                 search matches that are too long compared to your series name search. The higher
                 it is, the more likely to have a good match, but each search will take longer and
                 use more bandwidth. Too low, and only the very closest lexical matches will be
                 explored.</html>"""
 
-        self.leNameLengthDeltaThresh.setToolTip(nldt_tip)
+        self.leNameLengthDeltaThresh.setToolTip(nldtTip)
 
-        pbl_tip = """<html>
-            The <b>Publisher Filter</b> is for eliminating automatic matches to certain publishers
+        pblTip = """<html>
+            The <b>Publisher Blacklist</b> is for eliminating automatic matches to certain publishers
             that you know are incorrect. Useful for avoiding international re-prints with same
             covers or series names. Enter publisher names separated by commas.
             </html>"""
-        self.tePublisherFilter.setToolTip(pbl_tip)
+        self.tePublisherBlacklist.setToolTip(pblTip)
 
         validator = QtGui.QIntValidator(1, 4, self)
         self.leIssueNumPadding.setValidator(validator)
@@ -105,76 +140,158 @@ class SettingsWindow(QtWidgets.QDialog):
         validator = QtGui.QIntValidator(0, 99, self)
         self.leNameLengthDeltaThresh.setValidator(validator)
 
-        self.settings_to_form()
+        self.settingsToForm()
 
-        self.btnBrowseRar.clicked.connect(self.select_rar)
-        self.btnClearCache.clicked.connect(self.clear_cache)
-        self.btnResetSettings.clicked.connect(self.reset_settings)
-        self.btnTestKey.clicked.connect(self.test_api_key)
+        self.btnBrowseRar.clicked.connect(self.selectRar)
+        self.btnBrowseUnrar.clicked.connect(self.selectUnrar)
+        self.btnClearCache.clicked.connect(self.clearCache)
+        self.btnResetSettings.clicked.connect(self.resetSettings)
+        self.btnTestKey.clicked.connect(self.testAPIKey)
+        self.btnTemplateHelp.clicked.connect(self.showTemplateHelp)
 
-    def settings_to_form(self):
+    def configRenamer(self):
+        md = GenericMetadata()
+        md.isEmpty = False
+        md.tagOrigin = "testing"
+
+        md.series = "series name"
+        md.issue = "1"
+        md.title = "issue title"
+        md.publisher = "lordwelch"
+        md.month = 4
+        md.year = 1998
+        md.day = 4
+        md.issueCount = 1
+        md.volume = 256
+        md.genre = "test"
+        md.language = "en"  # 2 letter iso code
+        md.comments = "This is definitly not something you want to read."  # use same way as Summary in CIX
+
+        md.volumeCount = 4096
+        md.criticalRating = "Worst Comic Ever"
+        md.country = "US"
+
+        md.alternateSeries = "None"
+        md.alternateNumber = 4.4
+        md.alternateCount = 4444
+        md.imprint = "Welch Publishing"
+        md.notes = "This doesn't actually exist"
+        md.webLink = "https://example.com/series name/1"
+        md.format = "Box Set"
+        md.manga = "Yes"
+        md.blackAndWhite = False
+        md.pageCount = 4
+        md.maturityRating = "Everyone"
+
+        md.storyArc = "None of your buisness"
+        md.seriesGroup = "Advertures of buisness"
+        md.scanInfo = "(lordwelch)"
+
+        md.characters = "lordwelch, Welch"
+        md.teams = "None"
+        md.locations = "Earth, 444 B.C."
+
+        md.credits = [dict({"role": "Everything", "person": "lordwelch", "primary": True})]
+        md.tags = ["testing", "not testing", "fake"]
+        md.pages = [dict({"Image": "0", "Type": "Front Cover"}), dict({"Image": "1", "Type": "Story"})]
+
+        # Some CoMet-only items
+        md.price = 0.00
+        md.isVersionOf = "SERIES #1"
+        md.rights = "None"
+        md.identifier = "LW4444-Comic"
+        md.lastMark = "0"
+        md.coverImage = "https://example.com/series name/1/cover"
+
+        self.renamer = FileRenamer(md)
+        self.renamer.setTemplate(str(self.leRenameTemplate.text()))
+        self.renamer.setIssueZeroPadding(self.settings.rename_issue_number_padding)
+        self.renamer.setSmartCleanup(self.settings.rename_use_smart_string_cleanup)
+
+    def settingsToForm(self):
 
         # Copy values from settings to form
         self.leRarExePath.setText(self.settings.rar_exe_path)
+        self.leUnrarLibPath.setText(self.settings.unrar_lib_path)
         self.leNameLengthDeltaThresh.setText(str(self.settings.id_length_delta_thresh))
-        self.tePublisherFilter.setPlainText(self.settings.id_publisher_filter)
+        self.tePublisherBlacklist.setPlainText(self.settings.id_publisher_blacklist)
 
         if self.settings.check_for_new_version:
-            self.cbxCheckForNewVersion.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCheckForNewVersion.setCheckState(QtCore.Qt.Checked)
 
         if self.settings.parse_scan_info:
-            self.cbxParseScanInfo.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxParseScanInfo.setCheckState(QtCore.Qt.Checked)
 
         if self.settings.use_series_start_as_volume:
-            self.cbxUseSeriesStartAsVolume.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxUseSeriesStartAsVolume.setCheckState(QtCore.Qt.Checked)
         if self.settings.clear_form_before_populating_from_cv:
-            self.cbxClearFormBeforePopulating.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxClearFormBeforePopulating.setCheckState(QtCore.Qt.Checked)
         if self.settings.remove_html_tables:
-            self.cbxRemoveHtmlTables.setCheckState(QtCore.Qt.CheckState.Checked)
-
-        if self.settings.always_use_publisher_filter:
-            self.cbxUseFilter.setCheckState(QtCore.Qt.CheckState.Checked)
-        if self.settings.sort_series_by_year:
-            self.cbxSortByYear.setCheckState(QtCore.Qt.CheckState.Checked)
-        if self.settings.exact_series_matches_first:
-            self.cbxExactMatches.setCheckState(QtCore.Qt.CheckState.Checked)
-
+            self.cbxRemoveHtmlTables.setCheckState(QtCore.Qt.Checked)
         self.leKey.setText(str(self.settings.cv_api_key))
 
         if self.settings.assume_lone_credit_is_primary:
-            self.cbxAssumeLoneCreditIsPrimary.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxAssumeLoneCreditIsPrimary.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_characters_to_tags:
-            self.cbxCopyCharactersToTags.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyCharactersToTags.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_teams_to_tags:
-            self.cbxCopyTeamsToTags.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyTeamsToTags.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_locations_to_tags:
-            self.cbxCopyLocationsToTags.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyLocationsToTags.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_storyarcs_to_tags:
-            self.cbxCopyStoryArcsToTags.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyStoryArcsToTags.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_notes_to_comments:
-            self.cbxCopyNotesToComments.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyNotesToComments.setCheckState(QtCore.Qt.Checked)
         if self.settings.copy_weblink_to_comments:
-            self.cbxCopyWebLinkToComments.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxCopyWebLinkToComments.setCheckState(QtCore.Qt.Checked)
         if self.settings.apply_cbl_transform_on_cv_import:
-            self.cbxApplyCBLTransformOnCVIMport.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxApplyCBLTransformOnCVIMport.setCheckState(QtCore.Qt.Checked)
         if self.settings.apply_cbl_transform_on_bulk_operation:
-            self.cbxApplyCBLTransformOnBatchOperation.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxApplyCBLTransformOnBatchOperation.setCheckState(QtCore.Qt.Checked)
 
         self.leRenameTemplate.setText(self.settings.rename_template)
         self.leIssueNumPadding.setText(str(self.settings.rename_issue_number_padding))
         if self.settings.rename_use_smart_string_cleanup:
-            self.cbxSmartCleanup.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxSmartCleanup.setCheckState(QtCore.Qt.Checked)
         if self.settings.rename_extension_based_on_archive:
-            self.cbxChangeExtension.setCheckState(QtCore.Qt.CheckState.Checked)
+            self.cbxChangeExtension.setCheckState(QtCore.Qt.Checked)
+        if self.settings.rename_move_dir:
+            self.cbxMoveFiles.setCheckState(QtCore.Qt.Checked)
+        self.leDirectory.setText(self.settings.rename_dir)
 
     def accept(self):
 
+        self.configRenamer()
+
+        try:
+            new_name = self.renamer.determineName("test.cbz")
+        except Exception as e:
+            QtWidgets.QMessageBox.critical(
+                self,
+                "Invalid format string!",
+                "Your rename template is invalid!"
+                "<br/><br/>{}<br/><br/>"
+                "Please consult the template help in the "
+                "settings and the documentation on the format at "
+                "<a href='https://docs.python.org/3/library/string.html#format-string-syntax'>"
+                "https://docs.python.org/3/library/string.html#format-string-syntax</a>".format(e),
+            )
+            return
+
         # Copy values from form to settings and save
         self.settings.rar_exe_path = str(self.leRarExePath.text())
 
+        # Don't accept the form info if we have our own unrar lib
+        if not self.settings.haveOwnUnrarLib():
+            self.settings.unrar_lib_path = str(self.leUnrarLibPath.text())
+
         # make sure rar program is now in the path for the rar class
         if self.settings.rar_exe_path:
-            utils.add_to_path(os.path.dirname(self.settings.rar_exe_path))
+            utils.addtopath(os.path.dirname(self.settings.rar_exe_path))
+
+        if self.settings.unrar_lib_path:
+            os.environ["UNRAR_LIB_PATH"] = self.settings.unrar_lib_path
+            # This doesn't do anything... we need to restart!
 
         if not str(self.leNameLengthDeltaThresh.text()).isdigit():
             self.leNameLengthDeltaThresh.setText("0")
@@ -185,18 +302,13 @@ class SettingsWindow(QtWidgets.QDialog):
         self.settings.check_for_new_version = self.cbxCheckForNewVersion.isChecked()
 
         self.settings.id_length_delta_thresh = int(self.leNameLengthDeltaThresh.text())
-        self.settings.id_publisher_filter = str(self.tePublisherFilter.toPlainText())
+        self.settings.id_publisher_blacklist = str(self.tePublisherBlacklist.toPlainText())
 
         self.settings.parse_scan_info = self.cbxParseScanInfo.isChecked()
 
         self.settings.use_series_start_as_volume = self.cbxUseSeriesStartAsVolume.isChecked()
         self.settings.clear_form_before_populating_from_cv = self.cbxClearFormBeforePopulating.isChecked()
         self.settings.remove_html_tables = self.cbxRemoveHtmlTables.isChecked()
-
-        self.settings.always_use_publisher_filter = self.cbxUseFilter.isChecked()
-        self.settings.sort_series_by_year = self.cbxSortByYear.isChecked()
-        self.settings.exact_series_matches_first = self.cbxExactMatches.isChecked()
-
         self.settings.cv_api_key = str(self.leKey.text())
         ComicVineTalker.api_key = self.settings.cv_api_key.strip()
         self.settings.assume_lone_credit_is_primary = self.cbxAssumeLoneCreditIsPrimary.isChecked()
@@ -213,42 +325,52 @@ class SettingsWindow(QtWidgets.QDialog):
         self.settings.rename_issue_number_padding = int(self.leIssueNumPadding.text())
         self.settings.rename_use_smart_string_cleanup = self.cbxSmartCleanup.isChecked()
         self.settings.rename_extension_based_on_archive = self.cbxChangeExtension.isChecked()
+        self.settings.rename_move_dir = self.cbxMoveFiles.isChecked()
+        self.settings.rename_dir = self.leDirectory.text()
 
         self.settings.save()
         QtWidgets.QDialog.accept(self)
 
-    def select_rar(self):
-        self.select_file(self.leRarExePath, "RAR")
+        if self.priorUnrarLibPath != self.settings.unrar_lib_path:
+            QtWidgets.QMessageBox.information(self, "UnRar Library Change", "ComicTagger will need to be restarted for changes to take effect.")
 
-    def clear_cache(self):
-        ImageFetcher().clear_cache()
-        ComicVineCacher().clear_cache()
+    def selectRar(self):
+        self.selectFile(self.leRarExePath, "RAR")
+
+    def selectUnrar(self):
+        self.selectFile(self.leUnrarLibPath, "UnRAR")
+
+    def clearCache(self):
+        ImageFetcher().clearCache()
+        ComicVineCacher().clearCache()
         QtWidgets.QMessageBox.information(self, self.name, "Cache has been cleared.")
 
-    def test_api_key(self):
-        if ComicVineTalker().test_key(str(self.leKey.text()).strip()):
+    def testAPIKey(self):
+        if ComicVineTalker().testKey(str(self.leKey.text()).strip()):
             QtWidgets.QMessageBox.information(self, "API Key Test", "Key is valid!")
         else:
             QtWidgets.QMessageBox.warning(self, "API Key Test", "Key is NOT valid.")
 
-    def reset_settings(self):
+    def resetSettings(self):
         self.settings.reset()
-        self.settings_to_form()
+        self.settingsToForm()
         QtWidgets.QMessageBox.information(self, self.name, self.name + " have been returned to default values.")
 
-    def select_file(self, control: QtWidgets.QLineEdit, name):
+    def selectFile(self, control, name):
 
         dialog = QtWidgets.QFileDialog(self)
-        dialog.setFileMode(QtWidgets.QFileDialog.FileMode.ExistingFile)
+        dialog.setFileMode(QtWidgets.QFileDialog.ExistingFile)
 
         if platform.system() == "Windows":
             if name == "RAR":
-                flt = "Rar Program (Rar.exe)"
+                filter = self.tr("Rar Program (Rar.exe)")
             else:
-                flt = "Libraries (*.dll)"
-            dialog.setNameFilter(flt)
+                filter = self.tr("Libraries (*.dll)")
+            dialog.setNameFilter(filter)
         else:
-            dialog.setFilter(QtCore.QDir.Filter.Files)
+            # QtCore.QDir.Executable | QtCore.QDir.Files)
+            dialog.setFilter(QtCore.QDir.Files)
+            pass
 
         dialog.setDirectory(os.path.dirname(str(control.text())))
         if name == "RAR":
@@ -256,9 +378,21 @@ class SettingsWindow(QtWidgets.QDialog):
         else:
             dialog.setWindowTitle("Find " + name + " library")
 
-        if dialog.exec():
-            file_list = dialog.selectedFiles()
-            control.setText(str(file_list[0]))
+        if dialog.exec_():
+            fileList = dialog.selectedFiles()
+            control.setText(str(fileList[0]))
 
-    def show_rename_tab(self):
+    def showRenameTab(self):
         self.tabWidget.setCurrentIndex(5)
+
+    def showTemplateHelp(self):
+        TemplateHelpWin = TemplateHelpWindow(self)
+        TemplateHelpWin.setModal(False)
+        TemplateHelpWin.show()
+
+
+class TemplateHelpWindow(QtWidgets.QDialog):
+    def __init__(self, parent):
+        super(TemplateHelpWindow, self).__init__(parent)
+
+        uic.loadUi(ComicTaggerSettings.getUIFile("TemplateHelp.ui"), self)

comictaggerlib/ui/TemplateHelp.ui

@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Dialog</class>
+ <widget class="QDialog" name="Dialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>702</width>
+    <height>452</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Template Help</string>
+  </property>
+  <property name="sizeGripEnabled">
+   <bool>true</bool>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <property name="spacing">
+    <number>0</number>
+   </property>
+   <property name="leftMargin">
+    <number>2</number>
+   </property>
+   <property name="topMargin">
+    <number>2</number>
+   </property>
+   <item>
+    <widget class="QTextBrowser" name="textBrowser">
+     <property name="html">
+      <string>&lt;html&gt;
+	&lt;head/&gt;
+	&lt;body&gt;
+		&lt;h1 style=&quot;text-align: center&quot;&gt;Template help&lt;/h1&gt;
+		&lt;p&gt;The template uses Python format strings, in the simplest use it replaces the field (e.g. {issue}) with the value for that particular comic (e.g. 1) for advanced formatting please reference the
+
+			&lt;a href=&quot;https://docs.python.org/3/library/string.html#format-string-syntax&quot;&gt;Python 3 documentation&lt;/a&gt;&lt;/p&gt;
+		&lt;pre&gt;Accepts the following variables:
+{isEmpty}&#009;&#009;(boolean)
+{tagOrigin}&#009;&#009;(string)
+{series}&#009;&#009;(string)
+{issue}&#009;&#009;(string)
+{title}&#009;&#009;(string)
+{publisher}&#009;&#009;(string)
+{month}&#009;&#009;(integer)
+{year}&#009;&#009;(integer)
+{day}&#009;&#009;(integer)
+{issueCount}&#009;(integer)
+{volume}&#009;&#009;(integer)
+{genre}&#009;&#009;(string)
+{language}&#009;&#009;(string)
+{comments}&#009;&#009;(string)
+{volumeCount}&#009;(integer)
+{criticalRating}&#009;(string)
+{country}&#009;&#009;(string)
+{alternateSeries}&#009;(string)
+{alternateNumber}&#009;(string)
+{alternateCount}&#009;(integer)
+{imprint}&#009;&#009;(string)
+{notes}&#009;&#009;(string)
+{webLink}&#009;&#009;(string)
+{format}&#009;&#009;(string)
+{manga}&#009;&#009;(string)
+{blackAndWhite}&#009;(boolean)
+{pageCount}&#009;&#009;(integer)
+{maturityRating}&#009;(string)
+{storyArc}&#009;&#009;(string)
+{seriesGroup}&#009;(string)
+{scanInfo}&#009;&#009;(string)
+{characters}&#009;(string)
+{teams}&#009;&#009;(string)
+{locations}&#009;&#009;(string)
+{credits}&#009;&#009;(list of dict({&apos;role&apos;: &apos;str&apos;, &apos;person&apos;: &apos;str&apos;, &apos;primary&apos;: boolean}))
+{tags}&#009;&#009;(list of str)
+{pages}&#009;&#009;(list of dict({&apos;Image&apos;: &apos;str(int)&apos;, &apos;Type&apos;: &apos;str&apos;}))
+
+CoMet-only items:
+{price}&#009;&#009;(float)
+{isVersionOf}&#009;(string)
+{rights}&#009;&#009;(string)
+{identifier}&#009;(string)
+{lastMark}&#009;&#009;(string)
+{coverImage}&#009;(string)
+
+Examples:
+
+{series} {issue} ({year})
+Spider-Geddon 1 (2018)
+
+{series} #{issue} - {title}
+Spider-Geddon #1 - New Players; Check In
+&lt;/pre&gt;
+	&lt;/body&gt;
+&lt;/html&gt;</string>
+     </property>
+     <property name="openExternalLinks">
+      <bool>true</bool>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

comictaggerlib/ui/autotagstartwindow.ui

@@ -44,7 +44,7 @@
    </item>
    <item row="1" column="0">
     <layout class="QGridLayout" name="gridLayout">
-     <item row="6" column="0">
+     <item row="7" column="0">
       <widget class="QCheckBox" name="cbxSpecifySearchString">
        <property name="sizePolicy">
         <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
@@ -129,6 +129,16 @@
        </property>
       </widget>
      </item>
+     <item row="6" column="0">
+      <widget class="QCheckBox" name="cbxAutoImprint">
+       <property name="toolTip">
+        <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Checks the publisher against a list of imprints.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+       </property>
+       <property name="text">
+        <string>Auto Imprint</string>
+       </property>
+      </widget>
+     </item>
      <item row="10" column="0">
       <widget class="QLineEdit" name="leNameLengthMatchTolerance">
        <property name="sizePolicy">
@@ -145,7 +155,7 @@
        </property>
       </widget>
      </item>
-     <item row="7" column="0">
+     <item row="8" column="0">
       <widget class="QLineEdit" name="leSearchString">
        <property name="sizePolicy">
         <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
@@ -155,7 +165,7 @@
        </property>
       </widget>
      </item>
-     <item row="8" column="0">
+     <item row="9" column="0">
       <widget class="QLabel" name="label_3">
        <property name="sizePolicy">
         <sizepolicy hsizetype="Preferred" vsizetype="Fixed">

comictaggerlib/ui/pagelisteditor.ui

@@ -100,24 +100,6 @@
        </item>
       </layout>
      </item>
-     <item>
-      <layout class="QFormLayout" name="formLayout_2">
-       <item row="0" column="0">
-        <widget class="QLabel" name="label_3">
-         <property name="text">
-          <string>Bookmark:</string>
-         </property>
-        </widget>
-       </item>
-       <item row="0" column="1">
-        <widget class="QLineEdit" name="leBookmark">
-         <property name="acceptDrops">
-          <bool>false</bool>
-         </property>
-        </widget>
-       </item>
-      </layout>
-     </item>
      <item>
       <widget class="QWidget" name="pageContainer" native="true">
        <property name="sizePolicy">

comictaggerlib/ui/qtutils.py

@@ -1,12 +1,11 @@
 """Some utilities for the GUI"""
 
-import io
-import logging
+# import StringIO
+
+# from PIL import Image
 
 from comictaggerlib.settings import ComicTaggerSettings
 
-logger = logging.getLogger(__name__)
-
 try:
     from PyQt5 import QtGui
 
@@ -15,35 +14,32 @@ except ImportError:
     qt_available = False
 
 if qt_available:
-    try:
-        from PIL import Image, ImageQt
 
-        pil_available = True
-    except ImportError:
-        pil_available = False
-
-    def reduce_widget_font_size(widget, delta=2):
+    def reduceWidgetFontSize(widget, delta=2):
         f = widget.font()
         if f.pointSize() > 10:
             f.setPointSize(f.pointSize() - delta)
         widget.setFont(f)
 
-    def center_window_on_screen(window):
+    def centerWindowOnScreen(window):
         """Center the window on screen.
 
         This implementation will handle the window
         being resized or the screen resolution changing.
         """
         # Get the current screens' dimensions...
-        screen = QtGui.QGuiApplication.primaryScreen().geometry()
-        # The horizontal position is calculated as (screen width - window width) / 2
-        hpos = int((screen.width() - window.width()) / 2)
+        screen = QtGui.QDesktopWidget().screenGeometry()
+        # ... and get this windows' dimensions
+        mysize = window.geometry()
+        # The horizontal position is calculated as screen width - window width
+        # / 2
+        hpos = (screen.width() - window.width()) / 2
         # And vertical position the same, but with the height dimensions
-        vpos = int((screen.height() - window.height()) / 2)
+        vpos = (screen.height() - window.height()) / 2
         # And the move call repositions the window
         window.move(hpos, vpos)
 
-    def center_window_on_parent(window):
+    def centerWindowOnParent(window):
 
         top_level = window
         while top_level.parent() is not None:
@@ -52,25 +48,40 @@ if qt_available:
         # Get the current screens' dimensions...
         main_window_size = top_level.geometry()
         # ... and get this windows' dimensions
-        # The horizontal position is calculated as (screen width - window width) / 2
-        hpos = int((main_window_size.width() - window.width()) / 2)
+        mysize = window.geometry()
+        # The horizontal position is calculated as screen width - window width
+        # /2
+        hpos = (main_window_size.width() - window.width()) / 2
         # And vertical position the same, but with the height dimensions
-        vpos = int((main_window_size.height() - window.height()) / 2)
+        vpos = (main_window_size.height() - window.height()) / 2
         # And the move call repositions the window
         window.move(hpos + main_window_size.left(), vpos + main_window_size.top())
 
-    def get_qimage_from_data(image_data):
+    try:
+        import io
+
+        from PIL import Image, WebPImagePlugin
+
+        pil_available = True
+    except ImportError:
+        pil_available = False
+
+    def getQImageFromData(image_data):
         img = QtGui.QImage()
         success = img.loadFromData(image_data)
         if not success:
             try:
                 if pil_available:
-                    # Qt doesn't understand the format, but maybe PIL does
-                    img = ImageQt.ImageQt(Image.open(io.BytesIO(image_data)))
-                    success = True
-            except Exception:
+                    #  Qt doesn't understand the format, but maybe PIL does
+                    # so try to convert the image data to uncompressed tiff
+                    # format
+                    im = Image.open(io.StringIO(image_data))
+                    output = io.StringIO()
+                    im.save(output, format="PNG")
+                    success = img.loadFromData(output.getvalue())
+            except Exception as e:
                 pass
         # if still nothing, go with default image
         if not success:
-            img.load(ComicTaggerSettings.get_graphic("nocover.png"))
+            img.load(ComicTaggerSettings.getGraphic("nocover.png"))
         return img

comictaggerlib/ui/settingswindow.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>702</width>
-    <height>478</height>
+    <height>432</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -28,7 +28,7 @@
         </sizepolicy>
        </property>
        <property name="currentIndex">
-        <number>1</number>
+        <number>0</number>
        </property>
        <widget class="QWidget" name="tab">
         <attribute name="title">
@@ -133,7 +133,7 @@
        </widget>
        <widget class="QWidget" name="tab_2">
         <attribute name="title">
-         <string>Searching</string>
+         <string>Identifier</string>
         </attribute>
         <layout class="QGridLayout" name="gridLayout_3">
          <item row="0" column="0">
@@ -187,15 +187,15 @@
              </property>
             </widget>
            </item>
-           <item row="2" column="0">
+           <item row="1" column="0">
             <widget class="QLabel" name="label_4">
              <property name="text">
-              <string>Publisher Filter:</string>
+              <string>Publisher Blacklist:</string>
              </property>
             </widget>
            </item>
-           <item row="2" column="1">
-            <widget class="QPlainTextEdit" name="tePublisherFilter">
+           <item row="1" column="1">
+            <widget class="QPlainTextEdit" name="tePublisherBlacklist">
              <property name="sizePolicy">
               <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
                <horstretch>0</horstretch>
@@ -204,23 +204,6 @@
              </property>
             </widget>
            </item>
-           <item row="1" column="1">
-            <widget class="QCheckBox" name="cbxUseFilter">
-             <property name="toolTip">
-              <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Applies the &lt;span style=&quot; font-weight:600;&quot;&gt;Publisher Filter&lt;/span&gt; on all searches.&lt;br/&gt;The search window has a dynamic toggle to show the unfiltered results.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
-             </property>
-             <property name="text">
-              <string/>
-             </property>
-            </widget>
-           </item>
-           <item row="1" column="0">
-            <widget class="QLabel" name="label_9">
-             <property name="text">
-              <string>Always use Publisher Filter on &quot;manual&quot; searches:</string>
-             </property>
-            </widget>
-           </item>
           </layout>
          </item>
         </layout>
@@ -280,33 +263,6 @@
                 </property>
                </widget>
               </item>
-              <item>
-               <widget class="Line" name="line_4">
-                <property name="sizePolicy">
-                 <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
-                  <horstretch>0</horstretch>
-                  <verstretch>0</verstretch>
-                 </sizepolicy>
-                </property>
-                <property name="orientation">
-                 <enum>Qt::Horizontal</enum>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <widget class="QCheckBox" name="cbxSortByYear">
-                <property name="text">
-                 <string>Initally sort Series search results by Starting Year instead of No. Issues</string>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <widget class="QCheckBox" name="cbxExactMatches">
-                <property name="text">
-                 <string>Initally show Series Name exact matches first</string>
-                </property>
-               </widget>
-              </item>
              </layout>
             </item>
            </layout>
@@ -403,7 +359,7 @@
             <item row="1" column="2">
              <widget class="QPushButton" name="btnTestKey">
               <property name="text">
-               <string>Test Key</string>
+               <string>Tesk Key</string>
               </property>
              </widget>
             </item>
@@ -547,7 +503,7 @@
             <enum>QFormLayout::AllNonFixedFieldsGrow</enum>
            </property>
            <item row="1" column="0">
-            <widget class="QLabel" name="label">
+            <widget class="QLabel" name="lblTemplate">
              <property name="text">
               <string>Template:</string>
              </property>
@@ -556,31 +512,78 @@
            <item row="1" column="1">
             <widget class="QLineEdit" name="leRenameTemplate">
              <property name="toolTip">
-              <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;The template for the new filename. Accepts the following variables:&lt;/p&gt;&lt;p&gt;%series%&lt;br/&gt;%issue%&lt;br/&gt;%volume%&lt;br/&gt;%issuecount%&lt;br/&gt;%year%&lt;br/&gt;%month%&lt;br/&gt;%month_name%&lt;br/&gt;%publisher%&lt;br/&gt;%title%&lt;br/&gt;
-%genre%&lt;br/&gt;
-%language_code%&lt;br/&gt;
-%criticalrating%&lt;br/&gt;
-%alternateseries%&lt;br/&gt;
-%alternatenumber%&lt;br/&gt;
-%alternatecount%&lt;br/&gt;
-%imprint%&lt;br/&gt;
-%format%&lt;br/&gt;
-%maturityrating%&lt;br/&gt;
-%storyarc%&lt;br/&gt;
-%seriesgroup%&lt;br/&gt;
-%scaninfo%
-&lt;/p&gt;&lt;p&gt;Examples:&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-style:italic;&quot;&gt;%series% %issue% (%year%)&lt;/span&gt;&lt;br/&gt;&lt;span style=&quot; font-style:italic;&quot;&gt;%series% #%issue% - %title%&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+              <string>&lt;pre&gt;The template for the new filename. Uses python format strings https://docs.python.org/3/library/string.html#format-string-syntax
+Accepts the following variables:
+{isEmpty}	(boolean)
+{tagOrigin}	(string)
+{series}		(string)
+{issue}		(string)
+{title}		(string)
+{publisher}	(string)
+{month}		(integer)
+{year}		(integer)
+{day}		(integer)
+{issueCount}	(integer)
+{volume}	(integer)
+{genre}		(string)
+{language}	(string)
+{comments}	(string)
+{volumeCount}	(integer)
+{criticalRating}	(string)
+{country}	(string)
+{alternateSeries}	(string)
+{alternateNumber}	(string)
+{alternateCount}	(integer)
+{imprint}		(string)
+{notes}		(string)
+{webLink}	(string)
+{format}		(string)
+{manga}		(string)
+{blackAndWhite}	(boolean)
+{pageCount}	(integer)
+{maturityRating}	(string)
+{storyArc}	(string)
+{seriesGroup}	(string)
+{scanInfo}	(string)
+{characters}	(string)
+{teams}		(string)
+{locations}	(string)
+{credits}		(list of dict({'role': 'str', 'person': 'str', 'primary': boolean}))
+{tags}		(list of str)
+{pages}		(list of dict({'Image': 'str(int)', 'Type': 'str'}))
+
+CoMet-only items:
+{price}		(float)
+{isVersionOf}	(string)
+{rights}		(string)
+{identifier}	(string)
+{lastMark}	(string)
+{coverImage}	(string)
+
+Examples:
+
+{series} {issue} ({year})
+
+{series} #{issue} - {title}
+&lt;/pre&gt;</string>
              </property>
             </widget>
            </item>
            <item row="2" column="0">
-            <widget class="QLabel" name="label_6">
+            <widget class="QPushButton" name="btnTemplateHelp">
+             <property name="text">
+              <string>Template Help</string>
+             </property>
+            </widget>
+           </item>
+           <item row="3" column="0">
+            <widget class="QLabel" name="lblPadding">
              <property name="text">
               <string>Issue # Zero Padding</string>
              </property>
             </widget>
            </item>
-           <item row="2" column="1">
+           <item row="3" column="1">
             <widget class="QLineEdit" name="leIssueNumPadding">
              <property name="sizePolicy">
               <sizepolicy hsizetype="Maximum" vsizetype="Fixed">
@@ -599,7 +602,7 @@
              </property>
             </widget>
            </item>
-           <item row="3" column="0" colspan="2">
+           <item row="4" column="0" colspan="2">
             <widget class="QCheckBox" name="cbxSmartCleanup">
              <property name="toolTip">
               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;&amp;quot;Smart Text Cleanup&amp;quot; &lt;/span&gt;will attempt to clean up the new filename if there are missing fields from the template.  For example, removing empty braces, repeated spaces and dashes, and more.  Experimental feature.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
@@ -609,13 +612,33 @@
              </property>
             </widget>
            </item>
-           <item row="4" column="0" colspan="2">
+           <item row="5" column="0" colspan="2">
             <widget class="QCheckBox" name="cbxChangeExtension">
              <property name="text">
               <string>Change Extension Based On Archive Type</string>
              </property>
             </widget>
            </item>
+           <item row="6" column="0">
+            <widget class="QCheckBox" name="cbxMoveFiles">
+             <property name="toolTip">
+              <string>If checked moves files to specified folder</string>
+             </property>
+             <property name="text">
+              <string>Move files when renaming</string>
+             </property>
+            </widget>
+           </item>
+           <item row="7" column="0">
+            <widget class="QLabel" name="lblDirectory">
+             <property name="text">
+              <string>Destination Directory:</string>
+             </property>
+            </widget>
+           </item>
+           <item row="7" column="1">
+            <widget class="QLineEdit" name="leDirectory"/>
+           </item>
           </layout>
          </item>
         </layout>
@@ -625,6 +648,67 @@
          <string>RAR Tools</string>
         </attribute>
         <layout class="QVBoxLayout" name="verticalLayout_2">
+         <item>
+          <widget class="QGroupBox" name="grpBoxUnrar">
+           <layout class="QGridLayout" name="gridLayout">
+            <item row="1" column="0">
+             <widget class="QLabel" name="lblUnrar">
+              <property name="minimumSize">
+               <size>
+                <width>120</width>
+                <height>0</height>
+               </size>
+              </property>
+              <property name="text">
+               <string>UnRAR library</string>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="1">
+             <widget class="QLineEdit" name="leUnrarLibPath">
+              <property name="readOnly">
+               <bool>true</bool>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="2">
+             <widget class="QPushButton" name="btnBrowseUnrar">
+              <property name="text">
+               <string>...</string>
+              </property>
+             </widget>
+            </item>
+            <item row="0" column="0" colspan="3">
+             <widget class="QLabel" name="lblUnrarHelp">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Preferred" vsizetype="Expanding">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="text">
+               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;In order to read CBR/RAR archives, you will need to have the unrar library from &lt;a href=&quot;www.win-rar.com/download.html&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;WinRAR&lt;/span&gt;&lt;/a&gt; installed. &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+              </property>
+              <property name="textFormat">
+               <enum>Qt::RichText</enum>
+              </property>
+              <property name="alignment">
+               <set>Qt::AlignBottom|Qt::AlignLeading|Qt::AlignLeft</set>
+              </property>
+              <property name="wordWrap">
+               <bool>true</bool>
+              </property>
+              <property name="openExternalLinks">
+               <bool>true</bool>
+              </property>
+              <property name="textInteractionFlags">
+               <set>Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse</set>
+              </property>
+             </widget>
+            </item>
+           </layout>
+          </widget>
+         </item>
          <item>
           <widget class="QGroupBox" name="grpBoxRar">
            <layout class="QGridLayout" name="gridLayout">
@@ -682,7 +766,7 @@
             <item row="0" column="0" colspan="3">
              <widget class="QLabel" name="lblRarHelp">
               <property name="sizePolicy">
-               <sizepolicy hsizetype="Preferred" vsizetype="Minimum">
+               <sizepolicy hsizetype="Preferred" vsizetype="Expanding">
                 <horstretch>0</horstretch>
                 <verstretch>0</verstretch>
                </sizepolicy>

comictaggerlib/ui/taggerwindow.ui

@@ -512,6 +512,26 @@
                         </property>
                        </widget>
                       </item>
+                       <item row="10" column="1">
+                       <widget class="QLineEdit" name="leSeriesPubYear"/>
+                      </item>
+                      <item row="9" column="1">
+                       <widget class="QLabel" name="label_7">
+                        <property name="text">
+                         <string>Series Year</string>
+                        </property>
+                       </widget>
+                      </item>
+                      <item row="11" column="1">
+                       <widget class="QPushButton" name="btnAutoImprint">
+                        <property name="toolTip">
+                         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Checks the publisher against a list of imprints.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+                        </property>
+                        <property name="text">
+                         <string>Auto Imprint</string>
+                        </property>
+                       </widget>
+                      </item>
                      </layout>
                     </item>
                     <item>
@@ -929,31 +949,11 @@
                  </widget>
                 </item>
                 <item row="2" column="1">
-                  <layout class="QGridLayout" name="gridLayout_7">
-                   <item row="0" column="0">
-                    <widget class="QLineEdit" name="leWebLink">
-                     <property name="acceptDrops">
-                      <bool>false</bool>
-                     </property>
-                    </widget>
-                   </item>
-                   <item row="0" column="1">
-                    <widget class="QPushButton" name="btnOpenWebLink">
-                     <property name="sizePolicy">
-                      <sizepolicy hsizetype="Maximum" vsizetype="Fixed">
-                       <horstretch>0</horstretch>
-                       <verstretch>0</verstretch>
-                      </sizepolicy>
-                     </property>
-                     <property name="maximumSize">
-                      <size>
-                       <width>40</width>
-                       <height>16777215</height>
-                      </size>
-                     </property>
-                    </widget>
-                   </item>
-                  </layout>
+                 <widget class="QLineEdit" name="leWebLink">
+                  <property name="acceptDrops">
+                   <bool>false</bool>
+                  </property>
+                 </widget>
                 </item>
                 <item row="3" column="0">
                  <widget class="QLabel" name="userRatingLabel">
@@ -1196,8 +1196,10 @@
     <addaction name="actionParse_Filename"/>
     <addaction name="actionSearchOnline"/>
     <addaction name="actionAutoIdentify"/>
+    <addaction name="actionLiteralSearch"/>
     <addaction name="separator"/>
     <addaction name="actionApplyCBLTransform"/>
+    <addaction name="actionMarkAd"/>
    </widget>
    <widget class="QMenu" name="menuWindow">
     <property name="title">
@@ -1393,6 +1395,22 @@
     <string>Search online for tags,auto-identify best match, and save to archive</string>
    </property>
   </action>
+  <action name="actionLiteralSearch">
+   <property name="text">
+    <string>Literal Search</string>
+   </property>
+   <property name="toolTip">
+    <string>perform a literal search on the series and return the first 50 results</string>
+   </property>
+  </action>
+  <action name="actionMarkAd">
+   <property name="text">
+    <string>Mark Advertisement</string>
+   </property>
+   <property name="toolTip">
+    <string>mark the current page as an advertisement</string>
+   </property>
+  </action>
  </widget>
  <layoutdefault spacing="6" margin="11"/>
  <resources/>

comictaggerlib/ui/volumeselectionwindow.ui

@@ -148,16 +148,6 @@
            </property>
           </widget>
          </item>
-        <item>
-         <widget class="QCheckBox" name="cbxFilter">
-          <property name="text">
-           <string>Filter Publishers</string>
-          </property>
-          <property name="toolTip">
-           <string>Filter the publishers based on the publisher filter.</string>
-          </property>
-         </widget>
-        </item>
          <item>
           <widget class="QDialogButtonBox" name="buttonBox">
            <property name="orientation">

comictaggerlib/utils.py

@@ -0,0 +1 @@
+from comicapi.utils import *

comictaggerlib/versionchecker.py

@@ -14,24 +14,39 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
 import platform
 import sys
+import urllib.parse
 
 import requests
 
-from comictaggerlib import ctversion
+from . import _version
 
-logger = logging.getLogger(__name__)
+try:
+    from PyQt5.QtCore import QByteArray, QObject, QUrl, pyqtSignal
+    from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkReply, QNetworkRequest
+except ImportError:
+    # No Qt, so define a few dummy QObjects to help us compile
+    class QObject:
+        def __init__(self, *args):
+            pass
+
+    class pyqtSignal:
+        def __init__(self, *args):
+            pass
+
+        def emit(a, b, c):
+            pass
 
 
-class VersionChecker:
-    def get_request_url(self, uuid, use_stats):
+class VersionChecker(QObject):
+    def getRequestUrl(self, uuid, use_stats):
 
         base_url = "http://comictagger1.appspot.com/latest"
-        params = {}
+        args = ""
+        params = dict()
         if use_stats:
-            params = {"uuid": uuid, "version": ctversion.version}
+            params = {"uuid": uuid, "version": _version.version}
             if platform.system() == "Windows":
                 params["platform"] = "win"
             elif platform.system() == "Linux":
@@ -44,15 +59,36 @@ class VersionChecker:
             if not getattr(sys, "frozen", None):
                 params["src"] = "T"
 
-        return base_url, params
+        return (base_url, params)
 
-    def get_latest_version(self, uuid, use_stats=True):
+    def getLatestVersion(self, uuid, use_stats=True):
         try:
-            url, params = self.get_request_url(uuid, use_stats)
+            url, params = self.getRequestUrl(uuid, use_stats)
             new_version = requests.get(url, params=params).text
-        except Exception:
+        except Exception as e:
             return None
 
         if new_version is None or new_version == "":
             return None
         return new_version.strip()
+
+    versionRequestComplete = pyqtSignal(str)
+
+    def asyncGetLatestVersion(self, uuid, use_stats):
+        url, params = self.getRequestUrl(uuid, use_stats)
+
+        self.nam = QNetworkAccessManager()
+        self.nam.finished.connect(self.asyncGetLatestVersionComplete)
+        self.nam.get(QNetworkRequest(QUrl(str(url + "?" + urllib.parse.urlencode(params)))))
+
+    def asyncGetLatestVersionComplete(self, reply):
+        if reply.error() != QNetworkReply.NoError:
+            return
+
+        # read in the response
+        new_version = str(reply.readAll())
+
+        if new_version is None or new_version == "":
+            return
+
+        self.versionRequestComplete.emit(new_version.strip())

comictaggerlib/volumeselectionwindow.py

@@ -14,44 +14,41 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+from PyQt5.QtCore import QUrl, pyqtSignal
 
-from PyQt5 import QtCore, QtWidgets, uic
-from PyQt5.QtCore import pyqtSignal
+from comictaggerlib.ui.qtutils import centerWindowOnParent, reduceWidgetFontSize
 
-from comicapi import utils
-from comicapi.genericmetadata import GenericMetadata
-from comictaggerlib.comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from comictaggerlib.coverimagewidget import CoverImageWidget
-from comictaggerlib.issueidentifier import IssueIdentifier
-from comictaggerlib.issueselectionwindow import IssueSelectionWindow
-from comictaggerlib.matchselectionwindow import MatchSelectionWindow
-from comictaggerlib.progresswindow import IDProgressWindow
-from comictaggerlib.settings import ComicTaggerSettings
-from comictaggerlib.ui.qtutils import reduce_widget_font_size
-
-logger = logging.getLogger(__name__)
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .coverimagewidget import CoverImageWidget
+from .genericmetadata import GenericMetadata
+from .issueidentifier import IssueIdentifier
+from .issueselectionwindow import IssueSelectionWindow
+from .matchselectionwindow import MatchSelectionWindow
+from .progresswindow import IDProgressWindow
+from .settings import ComicTaggerSettings
 
 
 class SearchThread(QtCore.QThread):
+
     searchComplete = pyqtSignal()
     progressUpdate = pyqtSignal(int, int)
 
-    def __init__(self, series_name, refresh):
+    def __init__(self, series_name, refresh, literal=False):
         QtCore.QThread.__init__(self)
         self.series_name = series_name
         self.refresh = refresh
         self.error_code = None
-        self.cv_error = False
-        self.cv_search_results = []
+        self.literal = literal
 
     def run(self):
-        comic_vine = ComicVineTalker()
+        comicVine = ComicVineTalker()
         try:
             self.cv_error = False
-            self.cv_search_results = comic_vine.search_for_series(
-                self.series_name, callback=self.prog_callback, refresh_cache=self.refresh
-            )
+            if self.literal:
+                self.cv_search_results = comicVine.literalSearchForSeries(self.series_name, callback=self.prog_callback)
+            else:
+                self.cv_search_results = comicVine.searchForSeries(self.series_name, callback=self.prog_callback, refresh_cache=self.refresh)
         except ComicVineTalkerException as e:
             self.cv_search_results = []
             self.cv_error = True
@@ -65,59 +62,45 @@ class SearchThread(QtCore.QThread):
 
 
 class IdentifyThread(QtCore.QThread):
+
     identifyComplete = pyqtSignal()
     identifyLogMsg = pyqtSignal(str)
     identifyProgress = pyqtSignal(int, int)
 
-    def __init__(self, identifier: IssueIdentifier):
+    def __init__(self, identifier):
         QtCore.QThread.__init__(self)
         self.identifier = identifier
-        self.identifier.set_output_function(self.log_output)
-        self.identifier.set_progress_callback(self.progress_callback)
+        self.identifier.setOutputFunction(self.logOutput)
+        self.identifier.setProgressCallback(self.progressCallback)
 
-    def log_output(self, text: str):
-        self.identifyLogMsg.emit(str(text))
+    def logOutput(self, text):
+        self.identifyLogMsg.emit(text)
 
-    def progress_callback(self, cur, total):
+    def progressCallback(self, cur, total):
         self.identifyProgress.emit(cur, total)
 
     def run(self):
-        self.identifier.search()
+        matches = self.identifier.search()
         self.identifyComplete.emit()
 
 
 class VolumeSelectionWindow(QtWidgets.QDialog):
     def __init__(
-        self,
-        parent,
-        series_name,
-        issue_number,
-        year,
-        issue_count,
-        cover_index_list,
-        comic_archive,
-        settings,
-        autoselect=False,
+        self, parent, series_name, issue_number, year, issue_count, cover_index_list, comic_archive, settings, autoselect=False, literal=False
     ):
-        super().__init__(parent)
+        super(VolumeSelectionWindow, self).__init__(parent)
 
-        uic.loadUi(ComicTaggerSettings.get_ui_file("volumeselectionwindow.ui"), self)
+        uic.loadUi(ComicTaggerSettings.getUIFile("volumeselectionwindow.ui"), self)
 
         self.imageWidget = CoverImageWidget(self.imageContainer, CoverImageWidget.URLMode)
         gridlayout = QtWidgets.QGridLayout(self.imageContainer)
         gridlayout.addWidget(self.imageWidget)
         gridlayout.setContentsMargins(0, 0, 0, 0)
 
-        reduce_widget_font_size(self.teDetails, 1)
-        reduce_widget_font_size(self.twList)
+        reduceWidgetFontSize(self.teDetails, 1)
+        reduceWidgetFontSize(self.twList)
 
-        self.setWindowFlags(
-            QtCore.Qt.WindowType(
-                self.windowFlags()
-                | QtCore.Qt.WindowType.WindowSystemMenuHint
-                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
-            )
-        )
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowMaximizeButtonHint)
 
         self.settings = settings
         self.parent = parent
@@ -130,40 +113,35 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
         self.immediate_autoselect = autoselect
         self.cover_index_list = cover_index_list
         self.cv_search_results = None
-
-        self.use_filter = self.settings.always_use_publisher_filter
+        self.literal = literal
 
         self.twList.resizeColumnsToContents()
-        self.twList.currentItemChanged.connect(self.current_item_changed)
-        self.twList.cellDoubleClicked.connect(self.cell_double_clicked)
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
         self.btnRequery.clicked.connect(self.requery)
-        self.btnIssues.clicked.connect(self.show_issues)
-        self.btnAutoSelect.clicked.connect(self.auto_select)
+        self.btnIssues.clicked.connect(self.showIssues)
+        self.btnAutoSelect.clicked.connect(self.autoSelect)
 
-        self.cbxFilter.setChecked(self.use_filter)
-        self.cbxFilter.toggled.connect(self.filter_toggled)
-
-        self.update_buttons()
-        self.perform_query()
+        self.updateButtons()
+        self.performQuery()
         self.twList.selectRow(0)
 
-    def update_buttons(self):
-        enabled = self.cv_search_results is not None and len(self.cv_search_results) > 0
+    def updateButtons(self):
+        if self.cv_search_results is not None and len(self.cv_search_results) > 0:
+            enabled = True
+        else:
+            enabled = False
 
         self.btnRequery.setEnabled(enabled)
         self.btnIssues.setEnabled(enabled)
         self.btnAutoSelect.setEnabled(enabled)
-        self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Ok).setEnabled(enabled)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setEnabled(enabled)
 
     def requery(self):
-        self.perform_query(refresh=True)
+        self.performQuery(refresh=True)
         self.twList.selectRow(0)
 
-    def filter_toggled(self):
-        self.use_filter = not self.use_filter
-        self.perform_query(refresh=False)
-
-    def auto_select(self):
+    def autoSelect(self):
 
         if self.comic_archive is None:
             QtWidgets.QMessageBox.information(self, "Auto-Select", "You need to load a comic first!")
@@ -175,7 +153,7 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
 
         self.iddialog = IDProgressWindow(self)
         self.iddialog.setModal(True)
-        self.iddialog.rejected.connect(self.identify_cancel)
+        self.iddialog.rejected.connect(self.identifyCancel)
         self.iddialog.show()
 
         self.ii = IssueIdentifier(self.comic_archive, self.settings)
@@ -184,83 +162,78 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
         md.series = self.series_name
         md.issue = self.issue_number
         md.year = self.year
-        md.issue_count = self.issue_count
+        md.issueCount = self.issue_count
 
-        self.ii.set_additional_metadata(md)
-        self.ii.only_use_additional_meta_data = True
+        self.ii.setAdditionalMetadata(md)
+        self.ii.onlyUseAdditionalMetaData = True
 
         self.ii.cover_page_index = int(self.cover_index_list[0])
 
         self.id_thread = IdentifyThread(self.ii)
-        self.id_thread.identifyComplete.connect(self.identify_complete)
-        self.id_thread.identifyLogMsg.connect(self.log_id_output)
-        self.id_thread.identifyProgress.connect(self.identify_progress)
+        self.id_thread.identifyComplete.connect(self.identifyComplete)
+        self.id_thread.identifyLogMsg.connect(self.logIDOutput)
+        self.id_thread.identifyProgress.connect(self.identifyProgress)
 
         self.id_thread.start()
 
-        self.iddialog.exec()
+        self.iddialog.exec_()
 
-    def log_id_output(self, text):
+    def logIDOutput(self, text):
         print(str(text), end=" ")
         self.iddialog.textEdit.ensureCursorVisible()
         self.iddialog.textEdit.insertPlainText(text)
 
-    def identify_progress(self, cur, total):
+    def identifyProgress(self, cur, total):
         self.iddialog.progressBar.setMaximum(total)
         self.iddialog.progressBar.setValue(cur)
 
-    def identify_cancel(self):
+    def identifyCancel(self):
         self.ii.cancel = True
 
-    def identify_complete(self):
+    def identifyComplete(self):
 
         matches = self.ii.match_list
         result = self.ii.search_result
+        match_index = 0
 
         found_match = None
         choices = False
-        if result == self.ii.result_no_matches:
+        if result == self.ii.ResultNoMatches:
             QtWidgets.QMessageBox.information(self, "Auto-Select Result", " No matches found :-(")
-        elif result == self.ii.result_found_match_but_bad_cover_score:
+        elif result == self.ii.ResultFoundMatchButBadCoverScore:
             QtWidgets.QMessageBox.information(
                 self, "Auto-Select Result", " Found a match, but cover doesn't seem the same.  Verify before commiting!"
             )
             found_match = matches[0]
-        elif result == self.ii.result_found_match_but_not_first_page:
-            QtWidgets.QMessageBox.information(
-                self, "Auto-Select Result", " Found a match, but not with the first page of the archive."
-            )
+        elif result == self.ii.ResultFoundMatchButNotFirstPage:
+            QtWidgets.QMessageBox.information(self, "Auto-Select Result", " Found a match, but not with the first page of the archive.")
             found_match = matches[0]
-        elif result == self.ii.result_multiple_matches_with_bad_image_scores:
-            QtWidgets.QMessageBox.information(
-                self, "Auto-Select Result", " Found some possibilities, but no confidence. Proceed manually."
-            )
+        elif result == self.ii.ResultMultipleMatchesWithBadImageScores:
+            QtWidgets.QMessageBox.information(self, "Auto-Select Result", " Found some possibilities, but no confidence. Proceed manually.")
             choices = True
-        elif result == self.ii.result_one_good_match:
+        elif result == self.ii.ResultOneGoodMatch:
             found_match = matches[0]
-        elif result == self.ii.result_multiple_good_matches:
-            QtWidgets.QMessageBox.information(
-                self, "Auto-Select Result", " Found multiple likely matches.  Please select."
-            )
+        elif result == self.ii.ResultMultipleGoodMatches:
+            QtWidgets.QMessageBox.information(self, "Auto-Select Result", " Found multiple likely matches.  Please select.")
             choices = True
 
         if choices:
             selector = MatchSelectionWindow(self, matches, self.comic_archive)
             selector.setModal(True)
-            selector.exec()
+            selector.exec_()
             if selector.result():
                 # we should now have a list index
-                found_match = selector.current_match()
+                found_match = selector.currentMatch()
 
         if found_match is not None:
             self.iddialog.accept()
 
             self.volume_id = found_match["volume_id"]
             self.issue_number = found_match["issue_number"]
-            self.select_by_id()
-            self.show_issues()
+            self.selectByID()
+            self.showIssues()
 
-    def show_issues(self):
+    def showIssues(self):
         selector = IssueSelectionWindow(self, self.settings, self.volume_id, self.issue_number)
         title = ""
         for record in self.cv_search_results:
@@ -272,111 +245,63 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
 
         selector.setWindowTitle(title + "Select Issue")
         selector.setModal(True)
-        selector.exec()
+        selector.exec_()
         if selector.result():
             # we should now have a volume ID
             self.issue_number = selector.issue_number
             self.accept()
+        return
 
-    def select_by_id(self):
+    def selectByID(self):
         for r in range(0, self.twList.rowCount()):
-            volume_id = self.twList.item(r, 0).data(QtCore.Qt.ItemDataRole.UserRole)
+            volume_id = self.twList.item(r, 0).data(QtCore.Qt.UserRole)
             if volume_id == self.volume_id:
                 self.twList.selectRow(r)
                 break
 
-    def perform_query(self, refresh=False):
+    def performQuery(self, refresh=False):
 
         self.progdialog = QtWidgets.QProgressDialog("Searching Online", "Cancel", 0, 100, self)
         self.progdialog.setWindowTitle("Online Search")
-        self.progdialog.canceled.connect(self.search_canceled)
+        self.progdialog.canceled.connect(self.searchCanceled)
         self.progdialog.setModal(True)
         self.progdialog.setMinimumDuration(300)
-        self.search_thread = SearchThread(self.series_name, refresh)
-        self.search_thread.searchComplete.connect(self.search_complete)
-        self.search_thread.progressUpdate.connect(self.search_progress_update)
+        QtCore.QCoreApplication.processEvents()
+        self.search_thread = SearchThread(self.series_name, refresh, self.literal)
+        self.search_thread.searchComplete.connect(self.searchComplete)
+        self.search_thread.progressUpdate.connect(self.searchProgressUpdate)
         self.search_thread.start()
-        self.progdialog.exec()
+        self.progdialog.exec_()
 
-    def search_canceled(self):
-        logger.info("query cancelled")
-        self.search_thread.searchComplete.disconnect(self.search_complete)
-        self.search_thread.progressUpdate.disconnect(self.search_progress_update)
-        self.progdialog.canceled.disconnect(self.search_canceled)
+    def searchCanceled(self):
+        print("query cancelled")
+        self.search_thread.searchComplete.disconnect(self.searchComplete)
+        self.search_thread.progressUpdate.disconnect(self.searchProgressUpdate)
+        self.progdialog.canceled.disconnect(self.searchCanceled)
         self.progdialog.reject()
-        QtCore.QTimer.singleShot(200, self.close_me)
+        QtCore.QTimer.singleShot(200, self.closeMe)
 
-    def close_me(self):
+    def closeMe(self):
+        print("closeme")
         self.reject()
 
-    def search_progress_update(self, current, total):
+    def searchProgressUpdate(self, current, total):
         self.progdialog.setMaximum(total)
         self.progdialog.setValue(current + 1)
 
-    def search_complete(self):
+    def searchComplete(self):
         self.progdialog.accept()
         del self.progdialog
+        QtCore.QCoreApplication.processEvents()
         if self.search_thread.cv_error:
             if self.search_thread.error_code == ComicVineTalkerException.RateLimit:
-                QtWidgets.QMessageBox.critical(self, "Comic Vine Error", ComicVineTalker.get_rate_limit_message())
+                QtWidgets.QMessageBox.critical(self, self.tr("Comic Vine Error"), ComicVineTalker.getRateLimitMessage())
             else:
-                QtWidgets.QMessageBox.critical(
-                    self, "Network Issue", "Could not connect to Comic Vine to search for series!"
-                )
+                QtWidgets.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to Comic Vine to search for series!"))
             return
 
         self.cv_search_results = self.search_thread.cv_search_results
-        # filter the publishers if enabled set
-        if self.use_filter:
-            try:
-                publisher_filter = {s.strip().lower() for s in self.settings.id_publisher_filter.split(",")}
-                # use '' as publisher name if None
-                self.cv_search_results = list(
-                    filter(
-                        lambda d: ("" if d["publisher"] is None else str(d["publisher"]["name"]).lower())
-                        not in publisher_filter,
-                        self.cv_search_results,
-                    )
-                )
-            except:
-                logger.exception("bad data error filtering filter publishers")
-
-        # pre sort the data - so that we can put exact matches first afterwards
-        # compare as str incase extra chars ie. '1976?'
-        # - missing (none) values being converted to 'None' - consistant with prior behaviour in v1.2.3
-        # sort by start_year if set
-        if self.settings.sort_series_by_year:
-            try:
-                self.cv_search_results = sorted(
-                    self.cv_search_results,
-                    key=lambda i: (str(i["start_year"]), str(i["count_of_issues"])),
-                    reverse=True,
-                )
-            except:
-                logger.exception("bad data error sorting results by start_year,count_of_issues")
-        else:
-            try:
-                self.cv_search_results = sorted(
-                    self.cv_search_results, key=lambda i: str(i["count_of_issues"]), reverse=True
-                )
-            except:
-                logger.exception("bad data error sorting results by count_of_issues")
-
-        # move sanitized matches to the front
-        if self.settings.exact_series_matches_first:
-            try:
-                sanitized = utils.sanitize_title(self.series_name)
-                exact_matches = list(
-                    filter(lambda d: utils.sanitize_title(str(d["name"])) in sanitized, self.cv_search_results)
-                )
-                non_matches = list(
-                    filter(lambda d: utils.sanitize_title(str(d["name"])) not in sanitized, self.cv_search_results)
-                )
-                self.cv_search_results = exact_matches + non_matches
-            except:
-                logger.exception("bad data error filtering exact/near matches")
-
-        self.update_buttons()
+        self.updateButtons()
 
         self.twList.setSortingEnabled(False)
 
@@ -389,62 +314,63 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
 
             item_text = record["name"]
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setData(QtCore.Qt.ItemDataRole.UserRole, record["id"])
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, record["id"])
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 0, item)
 
             item_text = str(record["start_year"])
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 1, item)
 
             item_text = record["count_of_issues"]
             item = QtWidgets.QTableWidgetItem(item_text)
-            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
-            item.setData(QtCore.Qt.ItemDataRole.DisplayRole, record["count_of_issues"])
-            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.DisplayRole, record["count_of_issues"])
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
             self.twList.setItem(row, 2, item)
 
             if record["publisher"] is not None:
                 item_text = record["publisher"]["name"]
-                item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+                item.setData(QtCore.Qt.ToolTipRole, item_text)
                 item = QtWidgets.QTableWidgetItem(item_text)
-                item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+                item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
                 self.twList.setItem(row, 3, item)
 
             row += 1
 
+        self.twList.resizeColumnsToContents()
         self.twList.setSortingEnabled(True)
+        self.twList.sortItems(2, QtCore.Qt.DescendingOrder)
         self.twList.selectRow(0)
         self.twList.resizeColumnsToContents()
 
         if len(self.cv_search_results) == 0:
             QtCore.QCoreApplication.processEvents()
             QtWidgets.QMessageBox.information(self, "Search Result", "No matches found!")
-            QtCore.QTimer.singleShot(200, self.close_me)
 
         if self.immediate_autoselect and len(self.cv_search_results) > 0:
             # defer the immediate autoselect so this dialog has time to pop up
             QtCore.QCoreApplication.processEvents()
-            QtCore.QTimer.singleShot(10, self.do_immediate_autoselect)
+            QtCore.QTimer.singleShot(10, self.doImmediateAutoselect)
 
-    def do_immediate_autoselect(self):
+    def doImmediateAutoselect(self):
         self.immediate_autoselect = False
-        self.auto_select()
+        self.autoSelect()
 
-    def cell_double_clicked(self, r, c):
-        self.show_issues()
+    def cellDoubleClicked(self, r, c):
+        self.showIssues()
 
-    def current_item_changed(self, curr, prev):
+    def currentItemChanged(self, curr, prev):
 
         if curr is None:
             return
         if prev is not None and prev.row() == curr.row():
             return
 
-        self.volume_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.ItemDataRole.UserRole)
+        self.volume_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.UserRole)
 
         # list selection was changed, update the info on the volume
         for record in self.cv_search_results:
@@ -453,5 +379,5 @@ class VolumeSelectionWindow(QtWidgets.QDialog):
                     self.teDetails.setText("")
                 else:
                     self.teDetails.setText(record["description"])
-                self.imageWidget.set_url(record["image"]["super_url"])
+                self.imageWidget.setURL(record["image"]["super_url"])
                 break

desktop-integration/mac/main.sh

@@ -5,7 +5,7 @@
 # binary to call the CT script.  This is all so that the
 # Mac menu doesn't say "Python".
 
-realpath()
+realpath() 
 {
     [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
 }

file_version_info.py

@@ -0,0 +1,52 @@
+# UTF-8
+#
+# For more details about fixed file info 'ffi' see:
+# http://msdn.microsoft.com/en-us/library/ms646997.aspx
+exec(
+    '''
+with open("comictaggerlib/_version.py") as file:
+    exec(file.read())
+version_tuple = version_tuple + (0,) if len(version_tuple) < 4 else version_tuple
+version_tuple = version_tuple if str(version_tuple[3]).isnumeric() else version_tuple[:3] + (int(version_tuple[3].replace("dev","")),)
+'''
+) or VSVersionInfo(
+    ffi=FixedFileInfo(
+        # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
+        # Set not needed items to zero 0.
+        filevers=version_tuple,
+        prodvers=version_tuple,
+        # Contains a bitmask that specifies the valid bits 'flags'r
+        mask=0x3F,
+        # Contains a bitmask that specifies the Boolean attributes of the file.
+        flags=0x0,
+        # The operating system for which this file was designed.
+        # 0x4 - NT and there is no need to change it.
+        OS=0x40004,
+        # The general type of file.
+        # 0x1 - the file is an application.
+        fileType=0x1,
+        # The function of the file.
+        # 0x0 - the function is not defined for this fileType
+        subtype=0x0,
+        # Creation date and time stamp.
+        date=(0, 0),
+    ),
+    kids=[
+        StringFileInfo(
+            [
+                StringTable(
+                    "040904B0",
+                    [
+                        StringStruct("CompanyName", "ComicTagger team"),
+                        StringStruct("FileDescription", "A cross-platform GUI/CLI app for writing metadata to comic archives"),
+                        StringStruct("FileVersion", version),
+                        StringStruct("OriginalFilename", "comictagger.exe"),
+                        StringStruct("ProductName", "ComicTagger"),
+                        StringStruct("ProductVersion", version),
+                    ],
+                )
+            ]
+        ),
+        VarFileInfo([VarStruct("Translation", [1033, 1200])]),
+    ],
+)

localefix.py

@@ -1,48 +0,0 @@
-import locale
-import logging
-import os
-import subprocess
-import sys
-
-
-def _lang_code_mac():
-    """
-    stolen from https://github.com/mu-editor/mu
-    Returns the user's language preference as defined in the Language & Region
-    preference pane in macOS's System Preferences.
-    """
-
-    # Uses the shell command `defaults read -g AppleLocale` that prints out a
-    # language code to standard output. Assumptions about the command:
-    # - It exists and is in the shell's PATH.
-    # - It accepts those arguments.
-    # - It returns a usable language code.
-    #
-    # Reference documentation:
-    # - The man page for the `defaults` command on macOS.
-    # - The macOS underlying API:
-    #   https://developer.apple.com/documentation/foundation/nsuserdefaults.
-
-    LANG_DETECT_COMMAND = "defaults read -g AppleLocale"
-
-    status, output = subprocess.getstatusoutput(LANG_DETECT_COMMAND)
-    if status == 0:
-        # Command was successful.
-        lang_code = output
-    else:
-        logging.warning("Language detection command failed: %r", output)
-        lang_code = ""
-
-    return lang_code
-
-
-def configure_locale():
-    if sys.platform == "darwin" and "LANG" not in os.environ:
-        code = _lang_code_mac()
-        if code != "":
-            os.environ["LANG"] = f"{code}.utf-8"
-
-    locale.setlocale(locale.LC_ALL, "")
-    sys.stdout.reconfigure(encoding=sys.getdefaultencoding())
-    sys.stderr.reconfigure(encoding=sys.getdefaultencoding())
-    sys.stdin.reconfigure(encoding=sys.getdefaultencoding())

mac/Makefile

@@ -1,9 +1,11 @@
+#PYINSTALLER_CMD := VERSIONER_PYTHON_PREFER_32_BIT=yes arch -i386 python $(HOME)/pyinstaller-2.0/pyinstaller.py
+#PYINSTALLER_CMD := python $(HOME)/pyinstaller-2.0/pyinstaller.py
 PYINSTALLER_CMD := pyinstaller
 TAGGER_BASE ?= ../
 TAGGER_SRC := $(TAGGER_BASE)/comictaggerlib
 
 APP_NAME := ComicTagger
-VERSION_STR := $(shell cd .. && python setup.py --version)
+VERSION_STR := $(shell grep version $(TAGGER_SRC)/ctversion.py| cut -d= -f2 | sed 's/\"//g')
 
 MAC_BASE := $(TAGGER_BASE)/mac
 DIST_DIR := $(MAC_BASE)/dist
@@ -15,12 +17,22 @@ DMG_FILE := $(VOLUME_NAME).dmg
 all: clean dist diskimage
 
 dist:
-	$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py  -w -n $(APP_NAME) -s
+	#$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py -o $(MAC_BASE) -w -n $(APP_NAME) -s 
+	$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py  -w -n $(APP_NAME) -s 
 	cp -a $(TAGGER_SRC)/ui $(APP_BUNDLE)/Contents/MacOS
 	cp -a $(TAGGER_SRC)/graphics $(APP_BUNDLE)/Contents/MacOS
+	cp $(MAC_BASE)/libunrar.so $(APP_BUNDLE)/Contents/MacOS
 	cp $(MAC_BASE)/app.icns $(APP_BUNDLE)/Contents/Resources/icon-windowed.icns
 	# fix the version string in the Info.plist
 	sed -i -e 's/0\.0\.0/$(VERSION_STR)/' $(MAC_BASE)/dist/ComicTagger.app/Contents/Info.plist
+	# strip out PPC/x64
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/accessible
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/bearer
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/codecs
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/graphicssystems
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/iconengines
+	#./make_thin.sh dist/ComicTagger.app/Contents/MacOS/qt4_plugins/imageformats
 
 clean:
 	rm -rf $(DIST_DIR) $(MAC_BASE)/build
@@ -30,7 +42,7 @@ clean:
 	rm -f raw*.dmg
 	echo $(VERSION_STR)
 diskimage:
-	# Set up disk image staging folder
+	#Set up disk image staging folder
 	rm -rf $(STAGING)
 	mkdir $(STAGING)
 	cp $(TAGGER_BASE)/release_notes.txt $(STAGING)
@@ -39,28 +51,28 @@ diskimage:
 	cp $(MAC_BASE)/volume.icns $(STAGING)/.VolumeIcon.icns
 	SetFile -c icnC $(STAGING)/.VolumeIcon.icns
 
-	# generate raw disk image
+	##generate raw disk image
 	rm -f $(DMG_FILE)
-	hdiutil create -srcfolder $(STAGING) -volname $(VOLUME_NAME) -format UDRW -ov raw-$(DMG_FILE)
+	hdiutil create -srcfolder $(STAGING) -volname $(VOLUME_NAME) -format UDRW -ov raw-$(DMG_FILE)	
 
-	# remove working files and folders
+	#remove working files and folders
 	rm -rf $(STAGING)
-
+	
 	# we now have a raw DMG file.
-
+	
 	# remount it so we can set the volume icon properly
 	mkdir -p $(STAGING)
 	hdiutil attach raw-$(DMG_FILE) -mountpoint $(STAGING)
 	SetFile -a C $(STAGING)
 	hdiutil detach $(STAGING)
 	rm -rf $(STAGING)
-
+	
 	# convert the raw image
 	rm -f $(DMG_FILE)
 	hdiutil convert raw-$(DMG_FILE) -format UDZO -o $(DMG_FILE)
 	rm -f raw-$(DMG_FILE)
-
-	# move finished product to release folder
+	
+	#move finished product to release folder
 	mkdir -p $(TAGGER_BASE)/release
 	mv $(DMG_FILE) $(TAGGER_BASE)/release
-
+	

mac/make_thin.sh

@@ -8,12 +8,12 @@ do
 	then
 		echo "Fat Binary:  $FILE"
 		mkdir -p thin
-		lipo -thin i386 -output thin/$FILE $BINFOLDER/$FILE
+		lipo -thin i386 -output thin/$FILE $BINFOLDER/$FILE 
 	fi
 done
 
 if [ -d thin ]
-then
+then 
 	mv thin/* $BINFOLDER
 else
 	echo No files to lipo

pyproject.toml

@@ -1,25 +1,14 @@
 [tool.black]
-line-length = 120
-extend-exclude = "scripts/"
+line-length = 150
 
 [tool.isort]
-line_length = 120
-extend_skip = ["scripts"]
-profile = "black"
+line_length = 150
 
 [build-system]
 requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "comictaggerlib/ctversion.py"
+write_to = "comictaggerlib/_version.py"
 local_scheme = "no-local-version"
-
-[tool.pylint.messages_control]
-disable = "C0330, C0326, C0115, C0116, C0103"
-
-[tool.pylint.format]
-max-line-length=120
-
-[tool.pylint.master]
-extension-pkg-whitelist="PyQt5"
+version_scheme = "python-simplified-semver"

release_notes.txt

@@ -1,221 +1,221 @@
----------------------------------
-1.1.16-beta-rc - 07-Apr-2017
----------------------------------
- * Fix ComicVine SSL problems (issue #87)
-
----------------------------------
-1.1.15-beta - 13-Jun-2014
----------------------------------
- * WebP support
- * Added user-configurable API key for Comic Vine access
- * Experimental option to wait and retry after exceeding Comic Vine rate limit
-
----------------------------------
-1.1.14-beta - 13-Apr-2014
----------------------------------
- * Make sure app gets raised when enforcing single instance
- * Added warning dialog for when opening rar files, and no (un)rar tool
- * remove pil from python package requirements
-
----------------------------------
-1.1.13-beta - 9-Apr-2014
----------------------------------
- * Handle non-ascii user names properly
- * better parsing of html table in summary text, and optional removal
- * Python package should auto-install requirements
- * Specify default GUI tag style on command-line
- * enforce single GUI instance
- * new CBL transform to copy story arcs to generic tags
- * Persist some auto-tag settings
-
----------------------------------
-1.1.12-beta - 23-Mar-2014
----------------------------------
- * Fixed noisy version update error
-
----------------------------------
-1.1.11-beta - 23-Mar-2014
----------------------------------
- * Updated unrar library to hand Rar tools 5.0 and greater
- * Other misc bug fixes
-
----------------------------------
-1.1.10-beta - 30-Jan-2014
----------------------------------
- * Updated series query to match changes on Comic Vine side
- * Added a message when not able to open a file or folder
- * Fixed an issue where series names with periods would fail on search
- * Other misc bug fixes
-
----------------------------------
-1.1.9-beta - 8-May-2013
----------------------------------
- * Filename parser and identification enhancements
- * Misc bug fixes
-
----------------------------------
-1.1.8-beta - 21-Apr-2013
----------------------------------
- * Handle occasional error 500 from Comic Vine by retrying a few times
- * Nicer handling of colon (":") in file rename
- * Fixed command-line option parsing issue for add-on scripts
- * Misc bug fixes
-
----------------------------------
-1.1.7-beta - 12-Apr-2013
----------------------------------
- * Added description and cover date to issue selection dialogs
- * Added notification of new version
- * Added setting to attempt to parse scan info from file name
- * Last sorted column in the file list is now remembered
- * Added CLI option ('-1') to assume issue #1 if not found/parsed
- * Misc bug fixes
-
----------------------------------
-1.1.6-beta - 3-Apr-2013
----------------------------------
- * More ComicVine API-related fixes
- * More efficient automated search using new CV API issue filters
- * Minor bug fixes
-
----------------------------------
-1.1.5-beta - 30-Mar-2013
----------------------------------
- * More updates for handling changes to ComicVine API and result sets
- * Even better handling of non-numeric issue "numbers" ("½", "X")
-
----------------------------------
-1.1.4-beta - 27-Mar-2013
----------------------------------
- * Updated to match the changes to the ComicVine API and result sets
- * Better handling of weird issue numbers ("0.1", "6au")
-
----------------------------------
-1.1.3-beta - 25-Feb-2013
----------------------------------
-Bug Fixes:
-	* Fixed a bug when renaming on non-English systems
-	* Fixed issue when saving settings on non-English systems
-	* Fixed a bug when comic contains non-RGB images
-	* Fixed a rare crash when comic image is not-RGB format
-	* Fixed sequence order of ComicInfo.xml items
-
-Note:
-  New requirement for users of the python package: "configparser"
-
----------------------------------
-1.1.2-beta - 14-Feb-2013
----------------------------------
-Changes:
-	* Source is now packaged using Python distutils
-	* Recursive mode for CLI
-	* Run custom add-on scripts from CLI
-	* Minor UI tweaks
-	* Misc bug fixes
-
----------------------------------
-1.1.0-beta - 06-Feb-2013
----------------------------------
-Changes:
-	* Enhanced identification process to use alternative covers from ComicVine
-	* Post auto-tag manual matching now includes single low-confidence matches (CLI & GUI)
-	* Page and cover view mini-browser available throughout app.  Most images can be
-         double-clicked for enlarged view
-	* Export-to-zip in CLI (very handy in scripts!)
-	* More rename template variables
-	* Misc GUI & CLI Tweaks
-
----------------------------------
-1.0.3-beta - 31-Jan-2013
----------------------------------
-Changes:
-	Misc bug fixes and enhancements
-
----------------------------------
-1.0.2-beta - 25-Jan-2013
----------------------------------
-Changes:
-	More verbose logging during auto-tag
-	Added %month% and %month_name% for renaming
-	Better parsing of volume numbers in file name
-Bugs:
-	Better exception handling with corrupted image data
-	Fixed issues with RAR reading on OS X
-	Other minor bug fixes
-
----------------------------------
-1.0.1-beta - 24-Jan-2013
----------------------------------
-Bug Fix:
-	Fixed an issue where unicode strings can't be printed to OS X Console
-
----------------------------------
-1.0.0-beta - 23-Jan-2013
----------------------------------
-Version 1!  New multi-file processing in GUI!
-
-GUI Changes:
-  Open multiple files and/or folders via drag/drop or file dialog
-  File management list for easy viewing and selection
-  Batch tag remove
-  Batch export as zip
-  Batch rename
-  Batch tag copy
-  Batch auto-tag (automatic identification and save!)
-
----------------------------------
-0.9.5-beta - 16-Jan-2013
----------------------------------
-Changes:
-  Added CLI option to search by Comic Vine issue ID
-  Some image loading optimizations
-  Bug Fix: Some CBL fields that should have been ints were written as strings
-
----------------------------------
-0.9.4-beta - 7-Jan-2013
----------------------------------
-Changes:
-  Better handling of non-ascii characters in file names and data
-  Add CBL Transform to copy Web Link and Notes to comments
-  Minor bug fixes
-
----------------------------------
-0.9.3-beta - 19-Dec-2012
----------------------------------
-Changes:
-  File rename in GUI
-  Setting for file rename
-  Option to use series start year as volume
-  Added "CBL Transform" to handle primary credits copying data into the generic tags field
-  Bug Fix: unicode characters in credits caused crash
-  Bug Fix: bad or non-image data in file caused crash
-
-Note:
-  The user should clear the cache and delete the existing settings when first running this version.
-
----------------------------------
-0.9.2-beta - 13-Dec-2012
----------------------------------
-  Page List/Type editing in GUI
-  File globbing for windows CLI (i.e. use of wildcards like '*.cbz')
-  Fixed RAR writing bug on windows
-  Minor bug and crash fixes
-
----------------------------------
-0.9.1-beta - 07-Dec-2012
----------------------------------
-  Export as ZIP Archive
-  Added help menu option for websites
-  Added Primary Credit Flag editing
-  Menu enhancements
-  CLI Enhancements:
-	Interactive selection of matches
-	Tag copy
-	Better output
-	CoMet support
-  Minor bug and crash fixes
-
----------------------------------
-0.9.0-beta - 30-Nov-2012
----------------------------------
-Initial beta release
+---------------------------------  
+1.1.16-beta-rc - 07-Apr-2017
+---------------------------------
+ * Fix ComicVine SSL problems (issue #87)
+ 
+---------------------------------  
+1.1.15-beta - 13-Jun-2014
+---------------------------------
+ * WebP support
+ * Added user-configurable API key for Comic Vine access 
+ * Experimental option to wait and retry after exceeding Comic Vine rate limit
+
+---------------------------------  
+1.1.14-beta - 13-Apr-2014
+---------------------------------
+ * Make sure app gets raised when enforcing single instance
+ * Added warning dialog for when opening rar files, and no (un)rar tool 
+ * remove pil from python package requirements
+
+---------------------------------  
+1.1.13-beta - 9-Apr-2014
+---------------------------------
+ * Handle non-ascii user names properly
+ * better parsing of html table in summary text, and optional removal
+ * Python package should auto-install requirements
+ * Specify default GUI tag style on command-line
+ * enforce single GUI instance
+ * new CBL transform to copy story arcs to generic tags
+ * Persist some auto-tag settings
+
+---------------------------------  
+1.1.12-beta - 23-Mar-2014
+---------------------------------
+ * Fixed noisy version update error
+
+---------------------------------  
+1.1.11-beta - 23-Mar-2014
+---------------------------------
+ * Updated unrar library to hand Rar tools 5.0 and greater
+ * Other misc bug fixes
+
+---------------------------------  
+1.1.10-beta - 30-Jan-2014
+---------------------------------
+ * Updated series query to match changes on Comic Vine side
+ * Added a message when not able to open a file or folder
+ * Fixed an issue where series names with periods would fail on search 
+ * Other misc bug fixes
+
+---------------------------------  
+1.1.9-beta - 8-May-2013
+---------------------------------
+ * Filename parser and identification enhancements
+ * Misc bug fixes
+
+---------------------------------  
+1.1.8-beta - 21-Apr-2013
+---------------------------------
+ * Handle occasional error 500 from Comic Vine by retrying a few times
+ * Nicer handling of colon (":") in file rename
+ * Fixed command-line option parsing issue for add-on scripts
+ * Misc bug fixes
+
+---------------------------------  
+1.1.7-beta - 12-Apr-2013
+---------------------------------
+ * Added description and cover date to issue selection dialogs
+ * Added notification of new version
+ * Added setting to attempt to parse scan info from file name
+ * Last sorted column in the file list is now remembered
+ * Added CLI option ('-1') to assume issue #1 if not found/parsed
+ * Misc bug fixes
+
+---------------------------------  
+1.1.6-beta - 3-Apr-2013
+---------------------------------
+ * More ComicVine API-related fixes
+ * More efficient automated search using new CV API issue filters
+ * Minor bug fixes
+ 
+---------------------------------  
+1.1.5-beta - 30-Mar-2013
+---------------------------------
+ * More updates for handling changes to ComicVine API and result sets
+ * Even better handling of non-numeric issue "numbers" ("½", "X")
+
+---------------------------------  
+1.1.4-beta - 27-Mar-2013
+---------------------------------
+ * Updated to match the changes to the ComicVine API and result sets
+ * Better handling of weird issue numbers ("0.1", "6au")
+
+---------------------------------  
+1.1.3-beta - 25-Feb-2013
+---------------------------------
+Bug Fixes:
+	* Fixed a bug when renaming on non-English systems
+	* Fixed issue when saving settings on non-English systems
+	* Fixed a bug when comic contains non-RGB images
+	* Fixed a rare crash when comic image is not-RGB format
+	* Fixed sequence order of ComicInfo.xml items
+
+Note:
+  New requirement for users of the python package: "configparser"
+
+---------------------------------  
+1.1.2-beta - 14-Feb-2013
+---------------------------------
+Changes:
+	* Source is now packaged using Python distutils
+	* Recursive mode for CLI
+	* Run custom add-on scripts from CLI
+	* Minor UI tweaks
+	* Misc bug fixes
+
+---------------------------------  
+1.1.0-beta - 06-Feb-2013
+---------------------------------
+Changes:
+	* Enhanced identification process to use alternative covers from ComicVine
+	* Post auto-tag manual matching now includes single low-confidence matches (CLI & GUI)
+	* Page and cover view mini-browser available throughout app.  Most images can be
+         double-clicked for enlarged view
+	* Export-to-zip in CLI (very handy in scripts!)
+	* More rename template variables
+	* Misc GUI & CLI Tweaks
+
+---------------------------------  
+1.0.3-beta - 31-Jan-2013
+---------------------------------
+Changes:
+	Misc bug fixes and enhancements
+	
+---------------------------------  
+1.0.2-beta - 25-Jan-2013
+---------------------------------
+Changes:
+	More verbose logging during auto-tag
+	Added %month% and %month_name% for renaming
+	Better parsing of volume numbers in file name
+Bugs:
+	Better exception handling with corrupted image data
+	Fixed issues with RAR reading on OS X
+	Other minor bug fixes
+	
+---------------------------------  
+1.0.1-beta - 24-Jan-2013
+---------------------------------
+Bug Fix:
+	Fixed an issue where unicode strings can't be printed to OS X Console
+
+---------------------------------  
+1.0.0-beta - 23-Jan-2013
+---------------------------------
+Version 1!  New multi-file processing in GUI!
+
+GUI Changes:
+  Open multiple files and/or folders via drag/drop or file dialog
+  File management list for easy viewing and selection
+  Batch tag remove
+  Batch export as zip
+  Batch rename
+  Batch tag copy
+  Batch auto-tag (automatic identification and save!)
+  
+---------------------------------  
+0.9.5-beta - 16-Jan-2013
+---------------------------------
+Changes:
+  Added CLI option to search by Comic Vine issue ID
+  Some image loading optimizations
+  Bug Fix: Some CBL fields that should have been ints were written as strings
+
+---------------------------------  
+0.9.4-beta - 7-Jan-2013
+---------------------------------
+Changes:
+  Better handling of non-ascii characters in file names and data
+  Add CBL Transform to copy Web Link and Notes to comments
+  Minor bug fixes
+
+---------------------------------  
+0.9.3-beta - 19-Dec-2012
+---------------------------------
+Changes:
+  File rename in GUI
+  Setting for file rename
+  Option to use series start year as volume
+  Added "CBL Transform" to handle primary credits copying data into the generic tags field
+  Bug Fix: unicode characters in credits caused crash
+  Bug Fix: bad or non-image data in file caused crash
+
+Note:
+  The user should clear the cache and delete the existing settings when first running this version.
+  
+---------------------------------  
+0.9.2-beta - 13-Dec-2012
+---------------------------------
+  Page List/Type editing in GUI
+  File globbing for windows CLI (i.e. use of wildcards like '*.cbz')
+  Fixed RAR writing bug on windows
+  Minor bug and crash fixes
+
+---------------------------------  
+0.9.1-beta - 07-Dec-2012
+---------------------------------
+  Export as ZIP Archive
+  Added help menu option for websites
+  Added Primary Credit Flag editing
+  Menu enhancements
+  CLI Enhancements:
+	Interactive selection of matches
+	Tag copy
+	Better output
+	CoMet support
+  Minor bug and crash fixes
+
+---------------------------------  
+0.9.0-beta - 30-Nov-2012
+---------------------------------
+Initial beta release

requirements-CBR.txt

@@ -1 +1 @@
-unrar-cffi>=0.2.2
+comicapi[CBR] @ git+https://github.com/lordwelch/comicapi

requirements-GUI.txt

@@ -1 +1 @@
-PyQt5
+pyqt5

requirements-scripts.txt

@@ -0,0 +1 @@
+filetype

requirements.txt

@@ -1,6 +1,7 @@
 beautifulsoup4 >= 4.1
-natsort>=8.1.0
+configparser
+natsort
+pathvalidate
 pillow>=4.3.0
-requests==2.*
-pycountry
-py7zr
+requests
+comicapi @ git+https://github.com/lordwelch/comicapi

requirements_dev.txt

@@ -1,7 +1,4 @@
-pyinstaller>=4.10
+pyinstaller
 setuptools>=42
 setuptools_scm[toml]>=3.4
 wheel
-black>=22
-flake8==4.*
-isort>=5.10

scripts/README.txt

@@ -1,28 +1,28 @@
-This folder contains a set of example scripts that be used to extend the
-capabilities of the ComicTagger app.  They can be run either directly through
-the python interpreter, or via the ComicTagger app.
-
-To run via python directly, install ComicTagger source on your system using
-the setup.py file.
-
-To run via the ComicTagger app, invoke:
-
-$ comictagger.py -S script.py [script args]
-
-(This will work also for binary distributions on Mac and Windows.  No need for
-an extra python install.)
-
-The script must have an entry point function called "main()" to be invoked
-via the app.
-
------------------------------------------------------------------------------
-
-This feature is UNSUPPORTED, and is for the convenience of development-minded
-users of ComicTagger.  The comictaggerlib module will remain largely
-undocumented, and it will be up to the crafty script developer to look through
-the code to discern APIs and such.
-
-That said, if there are questions, please post in the forums, and hopefully we
-can get your add-on scripts working!
-
-http://comictagger.forumotion.com/
+This folder contains a set of example scripts that be used to extend the
+capabilities of the ComicTagger app.  They can be run either directly through
+the python interpreter, or via the ComicTagger app.
+
+To run via python directly, install ComicTagger source on your system using
+the setup.py file.
+
+To run via the ComicTagger app, invoke:
+
+$ comictagger.py -S script.py [script args]
+
+(This will work also for binary distributions on Mac and Windows.  No need for
+an extra python install.)
+
+The script must have an entry point function called "main()" to be invoked
+via the app.
+
+-----------------------------------------------------------------------------
+
+This feature is UNSUPPORTED, and is for the convenience of development-minded
+users of ComicTagger.  The comictaggerlib module will remain largely
+undocumented, and it will be up to the crafty script developer to look through
+the code to discern APIs and such.
+
+That said, if there are questions, please post in the forums, and hopefully we
+can get your add-on scripts working!
+
+http://comictagger.forumotion.com/

scripts/dupe.ui

@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Form</class>
+ <widget class="QWidget" name="Form">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>729</width>
+    <height>406</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QHBoxLayout" name="horizontalLayout">
+   <property name="sizeConstraint">
+    <enum>QLayout::SetMinAndMaxSize</enum>
+   </property>
+   <item>
+    <widget class="QListWidget" name="dupeList">
+     <property name="sizePolicy">
+      <sizepolicy hsizetype="Minimum" vsizetype="Minimum">
+       <horstretch>0</horstretch>
+       <verstretch>0</verstretch>
+      </sizepolicy>
+     </property>
+     <property name="selectionMode">
+      <enum>QAbstractItemView::ExtendedSelection</enum>
+     </property>
+     <property name="selectionBehavior">
+      <enum>QAbstractItemView::SelectRows</enum>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QSplitter" name="splitter">
+     <property name="enabled">
+      <bool>true</bool>
+     </property>
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+     <property name="childrenCollapsible">
+      <bool>false</bool>
+     </property>
+     <widget class="QTableWidget" name="pageList">
+      <property name="sizePolicy">
+       <sizepolicy hsizetype="Preferred" vsizetype="Expanding">
+        <horstretch>0</horstretch>
+        <verstretch>0</verstretch>
+       </sizepolicy>
+      </property>
+      <property name="editTriggers">
+       <set>QAbstractItemView::NoEditTriggers</set>
+      </property>
+      <property name="showDropIndicator" stdset="0">
+       <bool>false</bool>
+      </property>
+      <property name="selectionMode">
+       <enum>QAbstractItemView::SingleSelection</enum>
+      </property>
+      <property name="selectionBehavior">
+       <enum>QAbstractItemView::SelectRows</enum>
+      </property>
+      <property name="sortingEnabled">
+       <bool>true</bool>
+      </property>
+      <property name="columnCount">
+       <number>3</number>
+      </property>
+      <column>
+       <property name="text">
+        <string>name</string>
+       </property>
+      </column>
+      <column>
+       <property name="text">
+        <string>score</string>
+       </property>
+      </column>
+      <column>
+       <property name="text">
+        <string>dupe name</string>
+       </property>
+      </column>
+     </widget>
+     <widget class="QFrame" name="comicData">
+      <property name="frameShape">
+       <enum>QFrame::StyledPanel</enum>
+      </property>
+      <property name="frameShadow">
+       <enum>QFrame::Raised</enum>
+      </property>
+      <layout class="QHBoxLayout" name="horizontalLayout_2">
+       <item>
+        <widget class="QFrame" name="comic1Data">
+         <property name="frameShape">
+          <enum>QFrame::StyledPanel</enum>
+         </property>
+         <property name="frameShadow">
+          <enum>QFrame::Raised</enum>
+         </property>
+         <layout class="QVBoxLayout" name="verticalLayout" stretch="0,0">
+          <item>
+           <widget class="QWidget" name="comic1Image" native="true">
+            <layout class="QVBoxLayout" name="verticalLayout_3"/>
+           </widget>
+          </item>
+          <item>
+           <widget class="QPushButton" name="comic1Delete">
+            <property name="toolTip">
+             <string>Delete Comic 1</string>
+            </property>
+            <property name="text">
+             <string>Delete</string>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </widget>
+       </item>
+       <item>
+        <widget class="QFrame" name="comic2Data">
+         <property name="frameShape">
+          <enum>QFrame::StyledPanel</enum>
+         </property>
+         <property name="frameShadow">
+          <enum>QFrame::Raised</enum>
+         </property>
+         <layout class="QVBoxLayout" name="verticalLayout_2">
+          <item>
+           <widget class="QWidget" name="comic2Image" native="true">
+            <layout class="QVBoxLayout" name="verticalLayout_4"/>
+           </widget>
+          </item>
+          <item>
+           <widget class="QPushButton" name="comic2Delete">
+            <property name="toolTip">
+             <string>Delete Comic 2</string>
+            </property>
+            <property name="text">
+             <string>Delete</string>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </widget>
+       </item>
+      </layout>
+     </widget>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

scripts/find_dupes.py

@@ -1,86 +1,687 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 """Find all duplicate comics"""
 
-# import sys
+import argparse
+import hashlib
+import shutil
+import signal
+from pathlib import Path
+from operator import itemgetter
+from typing import Dict, List
+
+import filetype
+import typing
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from comictaggerlib.ui.qtutils import centerWindowOnParent
 
 from comictaggerlib.comicarchive import *
 from comictaggerlib.settings import *
+from comictaggerlib.imagehasher import ImageHasher
+from comictaggerlib.filerenamer import FileRenamer
 
-# from comictaggerlib.issuestring import *
-# import comictaggerlib.utils
+root = 1 << 31 - 1
+something = 1 << 31 - 1
+
+
+class ImageMeta:
+    def __init__(self, name, file_hash, image_hash, image_type, score=-1, score_file_hash=""):
+        self.name = name
+        self.file_hash = file_hash
+        self.image_hash = image_hash
+        self.type = image_type
+        self.score = score
+        self.score_file_hash = score_file_hash
+
+
+class Duplicate:
+    """docstring for Duplicate"""
+    imageHashes: Dict[str, ImageMeta]
+
+    def __init__(self, path, metadata: GenericMetadata, ca: ComicArchive, cover):
+        self.path = path
+        self.digest = ""
+        self.ca = ca
+        self.metadata = metadata
+        self.imageHashes = dict()
+        self.duplicateImages = set()
+        self.extras = set()
+        self.extractedPath = ""
+        self.deletable = False
+        self.keeping = False
+        self.fileCount = 0  # Excluding comicinfo.xml
+        self.imageCount = 0
+        self.cover = cover
+        blake2b = hashlib.blake2b(digest_size=16)
+        for f in open(self.path, "rb"):
+            blake2b.update(f)
+
+        self.digest = blake2b.hexdigest()
+
+    def extract(self, directory):
+        if self.ca.seemsToBeAComicArchive():
+            self.extractedPath = directory
+            for filepath in self.ca.archiver.getArchiveFilenameList():
+                filename = os.path.basename(filepath)
+                if filename.lower() in ["comicinfo.xml"]:
+                    continue
+
+                self.fileCount += 1
+                archived_file = self.ca.archiver.readArchiveFile(filepath)
+
+                image_type = filetype.image_match(archived_file)
+                if image_type is not None:
+                    self.imageCount += 1
+                    file_hash = hashlib.blake2b(archived_file, digest_size=16).hexdigest().upper()
+                    if file_hash in self.imageHashes.keys():
+                        self.duplicateImages.add(filename)
+                    else:
+                        image_hash = ImageHasher(data=archived_file, width=12, height=12).average_hash()
+                        self.imageHashes[file_hash] = ImageMeta(os.path.join(self.extractedPath, filename), file_hash,
+                                                                image_hash, image_type.extension)
+                else:
+                    self.extras.add(filename)
+
+                os.makedirs(self.extractedPath, 0o777, True)
+
+                unarchived_file = Path(os.path.join(self.extractedPath, filename))
+                unarchived_file.write_bytes(archived_file)
+
+    def clean(self):
+        shutil.rmtree(self.extractedPath, ignore_errors=True)
+
+    def delete(self):
+        if not self.keeping:
+            self.clean()
+            try:
+                os.remove(self.path)
+            except Exception:
+                pass
+        return not (os.path.exists(self.path) or os.path.exists(self.extractedPath))
+
+
+class Tree(QtCore.QAbstractListModel):
+    def __init__(self, item: List[List[Duplicate]]):
+        super(Tree, self).__init__()
+        self.rootItem = item
+
+    def rowCount(self, index: QtCore.QModelIndex = ...) -> int:
+        if not index.isValid():
+            return len(self.rootItem)
+
+        return 0
+
+    def columnCount(self, index: QtCore.QModelIndex = ...) -> int:
+        if index.isValid():
+            return 1
+
+        return 0
+
+    def data(self, index: QtCore.QModelIndex, role: int = ...) -> typing.Any:
+        if not index.isValid():
+            return QtCore.QVariant()
+
+        f = FileRenamer(self.rootItem[index.row()][0].metadata)
+        f.setTemplate("{series} #{issue} - {title} ({year})")
+        if role == QtCore.Qt.DisplayRole:
+            return f.determineName('')
+        elif role == QtCore.Qt.UserRole:
+            return f.determineName('')
+        return QtCore.QVariant()
+
+
+class MainWindow(QtWidgets.QMainWindow):
+    def __init__(self, file_list, style, work_path, parent=None):
+        super().__init__(parent)
+        uic.loadUi(ComicTaggerSettings.getUIFile("../../scripts/mainwindow.ui"), self)
+        self.dupes = []
+        self.firstRun = 0
+        self.dupe_set_list: List[List[Duplicate]] = list()
+        self.style = style
+        if work_path == "":
+            work_path = tempfile.mkdtemp()
+        self.work_path = work_path
+        self.initFiles = file_list
+        self.dupe_set_qlist.clicked.connect(self.dupe_set_clicked)
+        self.dupe_set_qlist.doubleClicked.connect(self.dupe_set_double_clicked)
+        self.actionCompare_Comic.triggered.connect(self.compare_action)
+
+    def comic_deleted(self, archive_path):
+        self.update_dupes()
+
+    def update_dupes(self):
+        # print("updating duplicates")
+        new_set_list = list()
+        for dupe in self.dupe_set_list:
+            dupe_list = list()
+            for d in dupe:
+                QtCore.QCoreApplication.processEvents()
+                if os.path.exists(d.path):
+                    dupe_list.append(d)
+                else:
+                    d.clean()
+
+            if len(dupe_list) > 1:
+                new_set_list.append(dupe_list)
+            else:
+                dupe_list[0].clean()
+        self.dupe_set_list: List[List[Duplicate]] = new_set_list
+        self.dupe_set_qlist.setModel(Tree(self.dupe_set_list))
+
+        self.dupe_set_qlist.setSelection(QtCore.QRect(0, 0, 0, 1), QtCore.QItemSelectionModel.ClearAndSelect)
+        self.dupe_set_clicked(self.dupe_set_qlist.model().index(0, 0))
+
+    def compare(self, i):
+        if len(self.dupe_set_list) > i:
+            dw = DupeWindow(self.dupe_set_list[i], self.work_path, self)
+            dw.closed.connect(self.update_dupes)
+            dw.show()
+
+    def compare_action(self, b):
+        selection = self.dupe_set_qlist.selectedIndexes()
+        if len(selection) > 0:
+            self.compare(selection[0].row())
+
+    def dupe_set_double_clicked(self, index: QtCore.QModelIndex):
+        self.compare(index.row())
+
+    def dupe_set_clicked(self, index: QtCore.QModelIndex):
+        for f in self.dupe_list.children():
+            f.deleteLater()
+        self.dupe_set_list[index.row()].sort(key=lambda k: k.digest)
+        for i, f in enumerate(self.dupe_set_list[index.row()]):
+            color = "black"
+            if i > 0:
+                if self.dupe_set_list[index.row()][i - 1].digest == f.digest:
+                    color = "green"
+            elif i == 0:
+                if len(self.dupe_set_list[index.row()]) > 1:
+                    if self.dupe_set_list[index.row()][i + 1].digest == f.digest:
+                        color = "green"
+            ql = DupeImage(duplicate=f, style=f".path {{color: black;}}.hash {{color: {color};}}",
+                           parent=self.dupe_list)
+            ql.deleted.connect(self.update_dupes)
+            ql.setMinimumWidth(300)
+            ql.setMinimumHeight(500)
+            self.dupe_list.layout().addWidget(ql)
+
+    def showEvent(self, event: QtGui.QShowEvent):
+        if self.firstRun == 0:
+            self.firstRun = 1
+
+            self.load_files(self.initFiles)
+        if len(self.dupe_set_list) < 1:
+            dialog = QtWidgets.QMessageBox(QtWidgets.QMessageBox.NoIcon, "ComicTagger Duplicate finder",
+                                           "No duplicate comics found", QtWidgets.QMessageBox.Ok, parent=self)
+            dialog.setWindowModality(QtCore.Qt.ApplicationModal)
+            qw = QtWidgets.QWidget()
+            qw.setFixedWidth(90)
+            dialog.layout().addWidget(qw, 3, 2, 1, 3)
+            dialog.exec()
+            QtWidgets.QApplication.quit()
+            sys.exit(0)
+        self.dupe_set_qlist.setSelection(QtCore.QRect(0, 0, 0, 1), QtCore.QItemSelectionModel.ClearAndSelect)
+        self.dupe_set_clicked(self.dupe_set_qlist.model().index(0, 0))
+
+    def load_files(self, file_list):
+        # Progress dialog on Linux flakes out for small range, so scale up
+        dialog = QtWidgets.QProgressDialog("", "Cancel", 0, len(file_list), parent=self)
+        dialog.setWindowTitle("Reading Comics")
+        dialog.setWindowModality(QtCore.Qt.ApplicationModal)
+        dialog.setMinimumDuration(300)
+        dialog.setMinimumWidth(400)
+        centerWindowOnParent(dialog)
+
+        comic_list = []
+        max_name_len = 2
+        for filename in file_list:
+            QtCore.QCoreApplication.processEvents()
+            if dialog.wasCanceled():
+                break
+            dialog.setValue(dialog.value() + 1)
+            dialog.setLabelText(filename)
+            ca = ComicArchive(path=filename, rar_exe_path=settings.rar_exe_path,
+                              default_image_path=ComicTaggerSettings.getGraphic('nocover.png'))
+            if ca.seemsToBeAComicArchive() and ca.hasMetadata(self.style):
+                # fmt_str = "{{0:{0}}}".format(max_name_len)
+                # print(fmt_str.format(filename) + "\r", end='', file=sys.stderr)
+                # sys.stderr.flush()
+                md = ca.readMetadata(self.style)
+                cover = ca.getPage(0)
+                comic_list.append((make_key(md), filename, ca, md, cover))
+                # max_name_len = len(filename)
+
+        comic_list.sort(key=itemgetter(0), reverse=False)
+
+        # look for duplicate blocks
+        dupe_set = list()
+        prev_key = ""
+
+        dialog.setWindowTitle("Finding Duplicates")
+        dialog.setMaximum(len(comic_list))
+        dialog.setValue(dialog.minimum())
+
+        set_list = list()
+        for new_key, filename, ca, md, cover in comic_list:
+            dialog.setValue(dialog.value() + 1)
+            QtCore.QCoreApplication.processEvents()
+            if dialog.wasCanceled():
+                break
+            dialog.setLabelText(filename)
+
+            # if the new key same as the last, add to to dupe set
+            if new_key == prev_key:
+                dupe_set.append((filename, ca, md, cover))
+            # else we're on a new potential block
+            else:
+                # only add if the dupe list has 2 or more
+                if len(dupe_set) > 1:
+                    set_list.append(dupe_set)
+                dupe_set = list()
+                dupe_set.append((filename, ca, md, cover))
+
+            prev_key = new_key
+
+        # Final dupe_set
+        if len(dupe_set) > 1:
+            set_list.append(dupe_set)
+
+        for d_set in set_list:
+            new_set = list()
+            for filename, ca, md, cover in d_set:
+                new_set.append(Duplicate(filename, md, ca, cover))
+            self.dupe_set_list.append(new_set)
+
+        self.dupe_set_qlist.setModel(Tree(self.dupe_set_list))
+        # print()
+        dialog.close()
+
+    # def delete_hashes(self):
+    #     working_dir = os.path.join(self.tmp, "working")
+    #     s = False
+    #     # while working and len(dupe_set) > 1:
+    #     remaining = list()
+    #     for dupe_set in self.dupe_set_list:
+    #         not_deleted = True
+    #         if os.path.exists(working_dir):
+    #             shutil.rmtree(working_dir, ignore_errors=True)
+    #
+    #         os.mkdir(working_dir)
+    #         extract(dupe_set, working_dir)
+    #         if mark_hashes(dupe_set):
+    #             if s:  # Auto delete if s flag or if there are not any non image extras
+    #                 dupe_set.sort(key=attrgetter("fileCount"))
+    #                 dupe_set.sort(key=lambda x: len(x.duplicateImages))
+    #                 dupe_set[0].keeping = True
+    #             else:
+    #                 dupe_set[select_archive("Select archive to keep: ", dupe_set)].keeping = True
+    #         else:
+    #             # app.exec_()
+    #             compare_dupe(dupe_set[0], dupe_set[1])
+    #         for i, dupe in enumerate(dupe_set):
+    #             print("{0}. {1}: {2.series} #{2.issue:0>3} {2.year}; extras: {3}; deletable: {4}".format(
+    #                 i,
+    #                 dupe.path,
+    #                 dupe.metadata,
+    #                 ", ".join(sorted(dupe.extras)), dupe.deletable))
+    #         dupe_set = delete(dupe_set)
+    #         if not_deleted:
+    #             remaining.append(dupe_set)
+    #     self.dupe_set_list = remaining
+
+
+class DupeWindow(QtWidgets.QWidget):
+    closed = QtCore.pyqtSignal()
+
+    def __init__(self, duplicates: List[Duplicate], tmp, parent=None):
+        super().__init__(parent, QtCore.Qt.Window)
+        uic.loadUi(ComicTaggerSettings.getUIFile("../../scripts/dupe.ui"), self)
+
+        for f in self.comic1Image.children():
+            f.deleteLater()
+        for f in self.comic2Image.children():
+            f.deleteLater()
+        self.deleting = -1
+        self.duplicates = duplicates
+        self.dupe1 = -1
+        self.dupe2 = -1
+
+        self.tmp = tmp
+
+        self.setWindowTitle("ComicTagger Duplicate compare")
+
+        self.pageList.currentItemChanged.connect(self.current_item_changed)
+        self.comic1Delete.clicked.connect(self.delete_1)
+        self.comic2Delete.clicked.connect(self.delete_2)
+        self.dupeList.itemSelectionChanged.connect(self.show_dupe_list)
+        # self.dupeList = QtWidgets.QListWidget()
+        self.dupeList.setIconSize(QtCore.QSize(100, 50))
+
+        while self.pageList.rowCount() > 0:
+            self.pageList.removeRow(0)
+
+        self.pageList.setSortingEnabled(False)
+
+        if len(duplicates) < 2:
+            return
+        extract(duplicates, tmp)
+
+        tmp1 = DupeImage(self.duplicates[0])
+        tmp2 = DupeImage(self.duplicates[1])
+        self.comic1Data.layout().replaceWidget(self.comic1Image, tmp1)
+        self.comic2Data.layout().replaceWidget(self.comic2Image, tmp2)
+        self.comic1Image = tmp1
+        self.comic2Image = tmp2
+        self.comic1Image.deleted.connect(self.update_dupes)
+        self.comic2Image.deleted.connect(self.update_dupes)
+
+    def showEvent(self, event: QtGui.QShowEvent) -> None:
+        self.update_dupes()
+
+    def closeEvent(self, event: QtGui.QCloseEvent) -> None:
+        self.closed.emit()
+        event.accept()
+
+    def show_dupe_list(self):
+        dupes = self.dupeList.selectedItems()
+        if len(dupes) != 2:
+            return
+        self.dupe1 = int(dupes[0].data(QtCore.Qt.UserRole))
+        self.dupe2 = int(dupes[1].data(QtCore.Qt.UserRole))
+        if len(self.duplicates[self.dupe2].imageHashes) > len(self.duplicates[self.dupe1].imageHashes):
+            self.dupe1, self.dupe2 = self.dupe2, self.dupe1
+        compare_dupe(self.duplicates[self.dupe1].imageHashes, self.duplicates[self.dupe2].imageHashes)
+        self.display_dupe()
+
+    def update_dupes(self):
+        dupes: List[Duplicate] = list()
+        for f in self.duplicates:
+            if os.path.exists(f.path):
+                dupes.append(f)
+            else:
+                f.clean()
+        self.duplicates = dupes
+        if len(self.duplicates) < 2:
+            self.close()
+
+        for i, dupe in enumerate(self.duplicates):
+            item = QtWidgets.QListWidgetItem()
+            item.setText(dupe.path)
+            item.setToolTip(dupe.path)
+            pm = QtGui.QPixmap()
+            pm.loadFromData(dupe.cover)
+            item.setIcon(QtGui.QIcon(pm))
+            item.setData(QtCore.Qt.UserRole, i)
+            self.dupeList.addItem(item)
+        self.dupeList.setCurrentRow(0)
+        self.dupeList.setCurrentRow(1, QtCore.QItemSelectionModel.Select)
+
+    def delete_1(self):
+        self.duplicates[self.dupe1].delete()
+        self.update_dupes()
+
+    def delete_2(self):
+        self.duplicates[self.dupe2].delete()
+        self.update_dupes()
+
+    def display_dupe(self):
+        for f in range(self.pageList.rowCount()):
+            self.pageList.removeRow(0)
+        for h in self.duplicates[self.dupe1].imageHashes.values():
+            row = self.pageList.rowCount()
+            self.pageList.insertRow(row)
+            name = QtWidgets.QTableWidgetItem()
+            score = QtWidgets.QTableWidgetItem()
+            dupe_name = QtWidgets.QTableWidgetItem()
+
+            item_text = os.path.basename(h.name)
+            name.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            name.setText(item_text)
+            name.setData(QtCore.Qt.UserRole, h.file_hash)
+            name.setData(QtCore.Qt.ToolTipRole, item_text)
+            self.pageList.setItem(row, 0, name)
+
+            item_text = str(h.score)
+            score.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            score.setText(item_text)
+            score.setData(QtCore.Qt.UserRole, h.file_hash)
+            score.setData(QtCore.Qt.ToolTipRole, item_text)
+            self.pageList.setItem(row, 1, score)
+
+            item_text = os.path.basename(self.duplicates[self.dupe2].imageHashes[h.score_file_hash].name)
+            dupe_name.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            dupe_name.setText(item_text)
+            dupe_name.setData(QtCore.Qt.UserRole, h.file_hash)
+            dupe_name.setData(QtCore.Qt.ToolTipRole, item_text)
+            self.pageList.setItem(row, 2, dupe_name)
+
+        self.pageList.resizeColumnsToContents()
+        self.pageList.selectRow(0)
+
+    def current_item_changed(self, curr, prev):
+
+        if curr is None:
+            return
+        if prev is not None and prev.row() == curr.row():
+            return
+
+        file_hash = str(self.pageList.item(curr.row(), 0).data(QtCore.Qt.UserRole))
+        image_hash = self.duplicates[self.dupe1].imageHashes[file_hash]
+        score_hash = self.duplicates[self.dupe2].imageHashes[image_hash.score_file_hash]
+
+        image1 = QtGui.QPixmap(image_hash.name)
+        image2 = QtGui.QPixmap(score_hash.name)
+
+        page_color = "red"
+        size_color = "red"
+        type_color = "red"
+        file_color = "black"
+        image_color = "black"
+        if image1.width() == image2.width() and image2.height() == image1.height():
+            size_color = "green"
+        if len(self.duplicates[self.dupe1].imageHashes) == len(self.duplicates[self.dupe2].imageHashes):
+            page_color = "green"
+        if image_hash.type == score_hash.type:
+            type_color = "green"
+        if image_hash.image_hash == score_hash.image_hash:
+            image_color = "green"
+        if image_hash.file_hash == score_hash.file_hash:
+            file_color = "green"
+        style = f"""
+.page {{
+color: {page_color};
+}}
+.size {{
+color: {size_color};
+}}
+.type {{
+color: {type_color};
+}}
+.file {{
+color: {file_color};
+}}
+.image {{
+color: {image_color};
+}}
+"""
+        text = "name: {{duplicate.path}}<br/>" \
+               "page count: <span class='page'>{len}</span><br/>" \
+               "size/type: <span class='size'>{{width}}x{{height}}</span>/<span class='type'>{meta.type}</span><br/>" \
+               "file_hash: <span class='file'>{meta.file_hash}</span><br/>" \
+               "image_hash: <span class='image'>{meta.image_hash}</span>" \
+            .format(meta=image_hash, style=style, len=len(self.duplicates[self.dupe1].imageHashes))
+        self.comic1Image.setDuplicate(self.duplicates[self.dupe1])
+        self.comic1Image.setImage(image_hash.name)
+        self.comic1Image.setText(text)
+        self.comic1Image.setLabelStyle(style)
+
+        text = "name: {{duplicate.path}}<br/>" \
+               "page count: <span class='page'>{len}</span><br/>" \
+               "size/type: <span class='size'>{{width}}x{{height}}</span>/<span class='type'>{score.type}</span><br/>" \
+               "file_hash: <span class='file'>{score.file_hash}</span><br/>" \
+               "image_hash: <span class='image'>{score.image_hash}</span>" \
+            .format(score=score_hash, style=style, len=len(self.duplicates[self.dupe2].imageHashes))
+        self.comic2Image.setDuplicate(self.duplicates[self.dupe2])
+        self.comic2Image.setImage(score_hash.name)
+        self.comic2Image.setText(text)
+        self.comic2Image.setLabelStyle(style)
+
+
+class QQlabel(QtWidgets.QLabel):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.image = None
+        self.setMinimumSize(1, 1)
+        self.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+
+    def setPixmap(self, pixmap: QtGui.QPixmap) -> None:
+        self.image = pixmap
+        self.setMaximumWidth(pixmap.width())
+        self.setMaximumHeight(pixmap.height())
+        super().setPixmap(
+            self.image.scaled(self.width(), self.height(), QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation))
+
+    def resizeEvent(self, a0: QtGui.QResizeEvent) -> None:
+        if self.image is not None:
+            super().setPixmap(self.image.scaled(self.width(), self.height(), QtCore.Qt.KeepAspectRatio,
+                                                QtCore.Qt.SmoothTransformation))
+
+
+class DupeImage(QtWidgets.QWidget):
+    deleted = QtCore.pyqtSignal(str)
+
+    def __init__(self, duplicate: Duplicate, style=".path {color: black;}.hash {color: black;}",
+                 text="path: <span class='path'>{duplicate.path}</span><br/>hash: <span class='hash'>{duplicate.digest}</span>",
+                 image="cover", parent=None):
+        super().__init__(parent)
+        self.setLayout(QtWidgets.QVBoxLayout())
+        self.image = QQlabel()
+        self.label = QtWidgets.QLabel()
+        self.duplicate = duplicate
+        self.text = text
+        self.labelStyle = style
+
+        self.iHeight = 0
+        self.iWidth = 0
+        self.setStyleSheet("color: black;")
+        self.label.setWordWrap(True)
+
+        self.setImage(image)
+        self.setLabelStyle(self.labelStyle)
+        self.setText(self.text)
+
+        # label.setSizePolicy(QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Minimum)
+        self.layout().addWidget(self.image)
+        self.layout().addWidget(self.label)
+
+    def contextMenuEvent(self, event: QtGui.QContextMenuEvent):
+        menu = QtWidgets.QMenu()
+        delete_action = menu.addAction("delete")
+        action = menu.exec(self.mapToGlobal(event.pos()))
+        if action == delete_action:
+            if self.duplicate.delete():
+                self.hide()
+                self.deleteLater()
+                # print("signal emitted")
+                self.deleted.emit(self.duplicate.path)
+
+    def setDuplicate(self, duplicate: Duplicate):
+        self.duplicate = duplicate
+        self.setImage("cover")
+        self.label.setText(
+            f"<style>{self.labelStyle}</style>" + self.text.format(duplicate=self.duplicate, width=self.iWidth,
+                                                                   height=self.iHeight))
+
+    def setText(self, text):
+        self.text = text
+        self.label.setText(
+            f"<style>{self.labelStyle}</style>" + self.text.format(duplicate=self.duplicate, width=self.iWidth,
+                                                                   height=self.iHeight))
+
+    def setImage(self, image):
+        if self.duplicate is not None:
+            pm = QtGui.QPixmap()
+            if image == "cover":
+                pm.loadFromData(self.duplicate.cover)
+            else:
+                pm.load(image)
+            self.iHeight = pm.height()
+            self.iWidth = pm.width()
+            self.image.setPixmap(pm)
+
+    def setLabelStyle(self, style):
+        self.labelStyle = style
+        self.label.setText(
+            f"<style>{self.labelStyle}</style>" + self.text.format(duplicate=self.duplicate, width=self.iWidth,
+                                                                   height=self.iHeight))
+
+
+def extract(dupe_set, directory):
+    for dupe in dupe_set:
+        dupe.extract(unique_dir(os.path.join(directory, os.path.basename(dupe.path))))
+
+
+def compare_dupe(dupe1: Dict[str, ImageMeta], dupe2: Dict[str, ImageMeta]):
+    for k, image1 in dupe1.items():
+        score = sys.maxsize
+        file_hash = ""
+        for k2, image2 in dupe2.items():
+            tmp = ImageHasher.hamming_distance(image1.image_hash, image2.image_hash)
+            if tmp < score:
+                score = tmp
+                file_hash = image2.file_hash
+
+        dupe1[k].score = score
+        dupe1[k].score_file_hash = file_hash
+
+
+def make_key(x):
+    return "<" + str(x.series) + " #" + str(x.issue) + " - " + str(x.title) + " - " + str(x.year) + ">"
+
+
+def unique_dir(file_name):
+    counter = 1
+    file_name_parts = os.path.splitext(file_name)
+    while True:
+        if not os.path.lexists(file_name):
+            return file_name
+        file_name = file_name_parts[0] + ' (' + str(counter) + ')' + file_name_parts[1]
+        counter += 1
+
+
+app = None
+settings = ComicTaggerSettings()
 
 
 def main():
-    utils.fix_output_encoding()
-    settings = ComicTaggerSettings()
+    signal.signal(signal.SIGINT, sigint_handler)
+
+    parser = argparse.ArgumentParser(description='ComicTagger Duplicate comparison script')
+    parser.add_argument('-w', metavar='workdir', type=str, nargs=1, default=tempfile.mkdtemp(), help='work directory')
+    parser.add_argument('paths', metavar='PATH', type=str, nargs='+', help='Path(s) to search for duplicates')
+    args = parser.parse_args()
 
     style = MetaDataStyle.CIX
+    global app
+    workdir = args.w
+    app = QtWidgets.QApplication(sys.argv)
+    file_list = utils.get_recursive_filelist(args.paths)
 
-    if len(sys.argv) < 2:
-        print >> sys.stderr, "Usage:  {0} [comic_folder]".format(sys.argv[0])
-        return
+    timer = QtCore.QTimer()
+    timer.start(50)  # You may change this if you wish.
+    timer.timeout.connect(lambda: None)  # Let the interpreter run each 500 ms.
 
-    filelist = utils.get_recursive_filelist(sys.argv[1:])
-
-    # first find all comics with metadata
-    print >> sys.stderr, "Reading in all comics..."
-    comic_list = []
-    fmt_str = ""
-    max_name_len = 2
-    for filename in filelist:
-        ca = ComicArchive(filename, settings.rar_exe_path)
-        if ca.seemsToBeAComicArchive() and ca.hasMetadata(style):
-            max_name_len = max(max_name_len, len(filename))
-            fmt_str = u"{{0:{0}}}".format(max_name_len)
-            print >> sys.stderr, fmt_str.format(filename) + "\r",
-            sys.stderr.flush()
-            comic_list.append((filename, ca.readMetadata(style)))
-
-    print >> sys.stderr, fmt_str.format("") + "\r",
-    print "--------------------------------------------------------------------------"
-    print "Found {0} comics with {1} tags".format(len(comic_list), MetaDataStyle.name[style])
-    print "--------------------------------------------------------------------------"
-
-    # sort the list by series+issue+year, to put all the dupes together
-    def makeKey(x):
-        return "<" + unicode(x[1].series) + u" #" + unicode(x[1].issue) + u" - " + unicode(x[1].year) + ">"
-
-    comic_list.sort(key=makeKey, reverse=False)
-
-    # look for duplicate blocks
-    dupe_set_list = []
-    dupe_set = []
-    prev_key = ""
-    for filename, md in comic_list:
-        print >> sys.stderr, fmt_str.format(filename) + "\r",
-        sys.stderr.flush()
-
-        new_key = makeKey((filename, md))
-
-        # if the new key same as the last, add to to dupe set
-        if new_key == prev_key:
-            dupe_set.append(filename)
-
-        # else we're on a new potential block
-        else:
-            # only add if the dupe list has 2 or more
-            if len(dupe_set) > 1:
-                dupe_set_list.append(dupe_set)
-            dupe_set = []
-            dupe_set.append(filename)
-
-        prev_key = new_key
-
-    print >> sys.stderr, fmt_str.format("") + "\r",
-    print "Found {0} duplicate sets".format(len(dupe_set_list))
-
-    for dupe_set in dupe_set_list:
-        ca = ComicArchive(dupe_set[0], settings.rar_exe_path)
-        md = ca.readMetadata(style)
-        print "{0} #{1} ({2})".format(md.series, md.issue, md.year)
-        for filename in dupe_set:
-            print "------>{0}".format(filename)
+    window = MainWindow(file_list, style, workdir)
+    window.show()
+    app.exec()
+    shutil.rmtree(workdir, True)
 
 
-if __name__ == "__main__":
+def sigint_handler(*args):
+    """Handler for the SIGINT signal."""
+    sys.stderr.write('\r')
+    QtWidgets.QApplication.quit()
+
+
+if __name__ == '__main__':
     main()

scripts/mainwindow.ui

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>800</width>
+    <height>600</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>ComicTagger Duplicate finder</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <layout class="QHBoxLayout" name="horizontalLayout">
+    <property name="sizeConstraint">
+     <enum>QLayout::SetMinAndMaxSize</enum>
+    </property>
+    <item>
+     <widget class="QSplitter" name="splitter">
+      <property name="enabled">
+       <bool>true</bool>
+      </property>
+      <property name="acceptDrops">
+       <bool>true</bool>
+      </property>
+      <property name="orientation">
+       <enum>Qt::Horizontal</enum>
+      </property>
+      <property name="childrenCollapsible">
+       <bool>false</bool>
+      </property>
+      <widget class="QTreeView" name="dupe_set_qlist"/>
+      <widget class="QScrollArea" name="dupe_list_p">
+       <property name="minimumSize">
+        <size>
+         <width>400</width>
+         <height>0</height>
+        </size>
+       </property>
+       <property name="widgetResizable">
+        <bool>true</bool>
+       </property>
+       <widget class="QWidget" name="dupe_list">
+        <property name="geometry">
+         <rect>
+          <x>0</x>
+          <y>0</y>
+          <width>396</width>
+          <height>520</height>
+         </rect>
+        </property>
+        <layout class="QVBoxLayout" name="verticalLayout"/>
+       </widget>
+      </widget>
+     </widget>
+    </item>
+   </layout>
+  </widget>
+  <widget class="QMenuBar" name="menubar">
+   <property name="geometry">
+    <rect>
+     <x>0</x>
+     <y>0</y>
+     <width>800</width>
+     <height>30</height>
+    </rect>
+   </property>
+  </widget>
+  <widget class="QToolBar" name="toolBar">
+   <property name="windowTitle">
+    <string>toolBar</string>
+   </property>
+   <attribute name="toolBarArea">
+    <enum>TopToolBarArea</enum>
+   </attribute>
+   <attribute name="toolBarBreak">
+    <bool>false</bool>
+   </attribute>
+   <addaction name="actionCompare_Comic"/>
+  </widget>
+  <action name="actionCompare_Comic">
+   <property name="text">
+    <string>Compare Comic</string>
+   </property>
+  </action>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

scripts/move2folder.py

@@ -20,6 +20,7 @@
 import shutil
 
 from comicapi.comicarchive import *
+
 from comictaggerlib.settings import *
 
 # import sys
@@ -108,9 +109,7 @@ def main():
             series_name = series_name.replace(":", " -")
             series_name = series_name.replace("/", "-")
             series_name = series_name.replace("?", "")
-        series_folder = os.path.join(
-            tree_root, unicode(publisher_name), unicode(series_name) + " (" + unicode(start_year) + ")"
-        )
+        series_folder = os.path.join(tree_root, unicode(publisher_name), unicode(series_name) + " (" + unicode(start_year) + ")")
         make_folder(series_folder)
         move_file(filename, os.path.join(series_folder, os.path.basename(filename)))
 

scripts/name_fixer.py

@@ -116,7 +116,7 @@ def main():
     print >> sys.stderr, fmt_str.format("")
     print "Found {0} comics.".format(len(comic_list))
 
-    modify_list = []
+    modify_list = list()
     # walk through the comic list fix the file names
     for ca in comic_list:
 

scripts/remove_ads.py

@@ -34,116 +34,51 @@ unwanted_types = ["Deleted", "Advertisement"]
 
 
 def main():
-    utils.fix_output_encoding()
+    # utils.fix_output_encoding()
     settings = ComicTaggerSettings()
 
     # this can only work with files with ComicRack tags
     style = MetaDataStyle.CIX
 
     if len(sys.argv) < 2:
-        print >> sys.stderr, "Usage: {0} [comic_folder]".format(sys.argv[0])
+        print("Usage: {0} [comic_folder]".format(sys.argv[0]), file=sys.stderr)
         return
 
-    filelist = utils.get_recursive_filelist(sys.argv[1:])
+    if sys.argv[1] == "-n":
+        filelist = utils.get_recursive_filelist(sys.argv[2:])
+    else:
+        filelist = utils.get_recursive_filelist(sys.argv[1:])
 
     # first read in CIX metadata from all files, make a list of candidates
     modify_list = []
     for filename in filelist:
+        print(filename, end="\n")
 
-        ca = ComicArchive(filename, settings.rar_exe_path)
+        ca = ComicArchive(
+            filename,
+            settings.rar_exe_path,
+            default_image_path="/home/timmy/build/source/comictagger-test/comictaggerlib/graphics/nocover.png",
+        )
         if (ca.isZip or ca.isRar()) and ca.hasMetadata(style):
             md = ca.readMetadata(style)
             if len(md.pages) != 0:
+                pgs = list()
+                mod = False
                 for p in md.pages:
                     if "Type" in p and p["Type"] in unwanted_types:
-                        # This one has pages to remove.  add to list!
-                        modify_list.append((filename, md))
-                        break
+                        # This one has pages to remove. Remove it!
+                        print("removing " + ca.getPageName(int(p["Image"])))
+                        if sys.argv[1] != "-n":
+                            mod = True
+                            ca.archiver.removeArchiveFile(ca.getPageName(int(p["Image"])))
+                    else:
+                        pgs.append(p)
 
-    # now actually process those files
-    for filename, md in modify_list:
-        ca = ComicArchive(filename, settings.rar_exe_path)
-        curr_folder = os.path.dirname(filename)
-        curr_subfolder = os.path.join(curr_folder, subfolder_name)
-
-        # skip any of our generated subfolders...
-        if os.path.basename(curr_folder) == subfolder_name:
-            continue
-        sys.stdout.write("Removing unwanted pages from " + filename)
-
-        # verify that we can write to current folder
-        if not os.access(filename, os.W_OK):
-            print "Can't move: {0}: skipped!".format(filename)
-            continue
-        if not os.path.exists(curr_subfolder) and not os.access(curr_folder, os.W_OK):
-            print "Can't create subfolder here: {0}: skipped!".format(filename)
-            continue
-        if not os.path.exists(curr_subfolder):
-            os.mkdir(curr_subfolder)
-        if not os.access(curr_subfolder, os.W_OK):
-            print "Can't write to the subfolder here: {0}: skipped!".format(filename)
-            continue
-
-        # generate a new file with temp name
-        tmp_fd, tmp_name = tempfile.mkstemp(dir=os.path.dirname(filename))
-        os.close(tmp_fd)
-
-        try:
-            zout = zipfile.ZipFile(tmp_name, "w")
-
-            # now read in all the pages from the old one, except the ones we
-            # want to skip
-            new_num = 0
-            new_pages = []
-            for p in md.pages:
-                if "Type" in p and p["Type"] in unwanted_types:
-                    continue
-                else:
-                    pageNum = int(p["Image"])
-                    name = ca.getPageName(pageNum)
-                    buffer = ca.getPage(pageNum)
-                    sys.stdout.write(".")
-                    sys.stdout.flush()
-
-                    # Generate a new name for the page file
-                    ext = os.path.splitext(name)[1]
-                    new_name = "page{0:04d}{1}".format(new_num, ext)
-                    zout.writestr(new_name, buffer)
-
-                    # create new page entry
-                    new_p = {}
-                    new_p["Image"] = str(new_num)
-                    if "Type" in p:
-                        new_p["Type"] = p["Type"]
-                    new_pages.append(new_p)
-                    new_num += 1
-
-            # preserve the old comment
-            comment = ca.archiver.getArchiveComment()
-            if comment is not None:
-                zout.comment = ca.archiver.getArchiveComment()
-
-        except Exception as e:
-            print "Failure creating new archive: {0}!".format(filename)
-            print e, sys.exc_info()[0]
-            zout.close()
-            os.unlink(tmp_name)
-        else:
-            zout.close()
-
-            # Success!  Now move the files
-            shutil.move(filename, curr_subfolder)
-            os.rename(tmp_name, filename)
-            # TODO: We might have converted a rar to a zip, and should probably change
-            #  the extension, as needed.
-
-            print "Done!".format(filename)
-
-            # Create a new archive object for the new file, and write the old
-            # CIX data, with new page info
-            ca = ComicArchive(filename, settings.rar_exe_path)
-            md.pages = new_pages
-            ca.writeMetadata(style, md)
+                if mod:
+                    for num, p in enumerate(pgs):
+                        p["Image"] = str(num)
+                    md.pages = pgs
+                    ca.writeCIX(md)
 
 
 if __name__ == "__main__":

scripts/shrink.py

@@ -22,12 +22,6 @@ import Image
 from comictaggerlib.comicarchive import *
 from comictaggerlib.settings import *
 
-# import sys
-# import os
-# import tempfile
-# import zipfile
-
-
 # import comictaggerlib.utils
 
 

setup.py

@@ -1,81 +1,97 @@
-# Setup file for comictagger python source  (no wheels yet)
-#
-# An entry point script called "comictagger" will be created
-#
-# Currently commented out, an experiment at desktop integration.
-# It seems that post installation tweaks are broken by wheel files.
-# Kept here for further research
-
-import glob
-import os
-
-from setuptools import setup
-
-
-def read(fname):
-    """
-    Read the contents of a file.
-    Parameters
-    ----------
-    fname : str
-        Path to file.
-    Returns
-    -------
-    str
-        File contents.
-    """
-    with open(os.path.join(os.path.dirname(__file__), fname)) as f:
-        return f.read()
-
-
-install_requires = read("requirements.txt").splitlines()
-
-# Dynamically determine extra dependencies
-extras_require = {}
-extra_req_files = glob.glob("requirements-*.txt")
-for extra_req_file in extra_req_files:
-    name = os.path.splitext(extra_req_file)[0].replace("requirements-", "", 1)
-    extras_require[name] = read(extra_req_file).splitlines()
-
-# If there are any extras, add a catch-all case that includes everything.
-# This assumes that entries in extras_require are lists (not single strings),
-# and that there are no duplicated packages across the extras.
-if extras_require:
-    extras_require["all"] = sorted({x for v in extras_require.values() for x in v})
-
-
-setup(
-    name="comictagger",
-    install_requires=install_requires,
-    extras_require=extras_require,
-    python_requires=">=3",
-    description="A cross-platform GUI/CLI app for writing metadata to comic archives",
-    author="ComicTagger team",
-    author_email="comictagger@gmail.com",
-    url="https://github.com/comictagger/comictagger",
-    packages=["comictaggerlib", "comicapi"],
-    package_data={
-        "comictaggerlib": ["ui/*", "graphics/*"],
-    },
-    entry_points=dict(console_scripts=["comictagger=comictaggerlib.main:ctmain"]),
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "Environment :: Console",
-        "Environment :: Win32 (MS Windows)",
-        "Environment :: MacOS X",
-        "Environment :: X11 Applications :: Qt",
-        "Intended Audience :: End Users/Desktop",
-        "License :: OSI Approved :: Apache Software License",
-        "Natural Language :: English",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-        "Topic :: Utilities",
-        "Topic :: Other/Nonlisted Topic",
-        "Topic :: Multimedia :: Graphics",
-    ],
-    keywords=["comictagger", "comics", "comic", "metadata", "tagging", "tagger"],
-    license="Apache License 2.0",
-    long_description=read("README.md"),
-    long_description_content_type="text/markdown",
-)
+# Setup file for comictagger python source  (no wheels yet)
+#
+# The install process will attempt to compile the unrar lib from source.
+# If it succeeds, the unrar lib binary will be installed with the python
+# source.  If it fails, install will just continue.  On most Linux systems it
+# should just work.  (Tested on a Mac system with homebrew, as well)
+#
+# An entry point script called "comictagger" will be created
+#
+# Currently commented out, an experiment at desktop integration.
+# It seems that post installation tweaks are broken by wheel files.
+# Kept here for further research
+
+import os
+import glob
+
+from setuptools import setup
+
+def read(fname):
+    """
+    Read the contents of a file.
+    Parameters
+    ----------
+    fname : str
+        Path to file.
+    Returns
+    -------
+    str
+        File contents.
+    """
+    with open(os.path.join(os.path.dirname(__file__), fname)) as f:
+        return f.read()
+
+
+install_requires = read("requirements.txt").splitlines()
+
+# Dynamically determine extra dependencies
+extras_require = {}
+extra_req_files = glob.glob("requirements-*.txt")
+for extra_req_file in extra_req_files:
+    name = os.path.splitext(extra_req_file)[0].replace("requirements-", "", 1)
+    extras_require[name] = read(extra_req_file).splitlines()
+
+# If there are any extras, add a catch-all case that includes everything.
+# This assumes that entries in extras_require are lists (not single strings),
+# and that there are no duplicated packages across the extras.
+if extras_require:
+    extras_require["all"] = sorted({x for v in extras_require.values() for x in v})
+
+
+setup(
+    name="comictagger",
+    install_requires=install_requires,
+    extras_require=extras_require,
+    python_requires=">=3",
+    description="A cross-platform GUI/CLI app for writing metadata to comic archives",
+    author="ComicTagger team",
+    author_email="comictagger@gmail.com",
+    url="https://github.com/comictagger/comictagger",
+    packages=["comictaggerlib"],
+    package_data={
+        "comictaggerlib": ["ui/*", "graphics/*"],
+    },
+    entry_points=dict(console_scripts=["comictagger=comictaggerlib.main:ctmain"]),
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Environment :: Win32 (MS Windows)",
+        "Environment :: MacOS X",
+        "Environment :: X11 Applications :: Qt",
+        "Intended Audience :: End Users/Desktop",
+        "License :: OSI Approved :: Apache Software License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Topic :: Utilities",
+        "Topic :: Other/Nonlisted Topic",
+        "Topic :: Multimedia :: Graphics",
+    ],
+    keywords=["comictagger", "comics", "comic", "metadata", "tagging", "tagger"],
+    license="Apache License 2.0",
+    long_description="""
+ComicTagger is a multi-platform app for writing metadata to digital comics, written in Python and PyQt.
+
+Features:
+
+* Runs on Mac OSX, Microsoft Windows, and Linux systems
+* Communicates with an online database (Comic Vine) for acquiring metadata
+* Uses image processing to automatically match a given archive with the correct issue data
+* Batch processing in the GUI for tagging hundreds or more comics at a time
+* Reads and writes multiple tagging schemes ( ComicBookLover and ComicRack).
+* Reads and writes rar, zip and tar archives (external tools needed for writing RAR)
+* Command line interface (CLI) on all platforms (including Windows), which supports batch operations, and which can be used in native scripts for complex operations.
+* Can run without PyQt5 installed
+""",
+)

todo.txt

@@ -1,102 +0,0 @@
-TOP!:
-		Does utils.get_actual_preferred_encoding() work on Mac python source version??
-				(And does it matter?)
-
------------------------------------------------------
-Features
------------------------------------------------------
-Rename dialog:
-	check-box for rows?
-	manual edit the preview?
-
-Maybe replace configparser  -- seems to be causing all sorts of problems
-
-Feature Requests:
-	Move CBR to other folder after conversion to ZIP
-	Pre-process series name before identification
-		(using a list of regex transforms)
-	(GC #24) Multiple options for -t i.e. "-t cr,cbl"
-	(GC #18 ) Option for handling colon in rename
-	(GC #31 ) Specify CV Series ID for auto-tag
-	Re-org - move to new folder based on template
-
-	Denied Requests (for now):
-		Auto-rename on auto-tag
-		Re-zip (to remove compression)
-
-
-	Selective fields on CLI print (use -m option.  Maybe internally remove all but specified fields in MD object before print )
-
-Docs:
-	Auto-Tagging Tips:
-		Multiple Passes with different options
-
------------------------------------------------------
-Bugs
------------------------------------------------------
-
-Zip flakes out when filename differs from index (or whatever)  i.e "\" vs "/". Python issue
-
-
-
------------------------------------------------------
-Big  Future Features
------------------------------------------------------
-Support for ACBF metadata in CBZ
-
-GCD scraper or DB reader
-
-(GC #29) Batch Edit
-	Form Mode:  Single vs Batch
-
------------------------------------------------------
-Small(er) Future Feature
------------------------------------------------------
-Parse out the rest of the scan info from filename
-
-Style sheets for windows/mac/linux
-
-CLI
-	explicit metadata settings option format
-		-- figure out how to add CBI "tags"
-		-- delete CBI "tags"
-		-- set primary credit flags
-		-- set frontcover and others?
-
-Archive function to  detect tag blocks out of sync
-
-Settings
-	Add setting to dis-allow writing CBI to RAR
-
-Google App engine to store hashes
-	Content Hashes, Image hashes, who knows?
-
-Filename parsing:
-	Rework how series name is separated from issue
-
-Internal GenericMetadata - Make Characters, Genre into lists?
-
------------------------------------------------------
-Config Mgmt check list
------------------------------------------------------
-
-Release Process
-    Optionally, make screen shots, upload to wiki
-    Update release notes and wiki
-	Update ctversion.py
-	Build packages
-	    Make exe on Windows
-		Make dmg on Mac
-		Make zip on Mac or Linux
-    Tag the repository
-	Manually upload release packages to Google Drive
-	Update the Downloads wiki page with direct links
-	"make upload" to the pypi site
-	Announce on Forum and Main Page and Twitter and Facebook
-	MacUpdate
-	Update appspot value
-
-----------------------------------------------
-
-
-rename 's/([A-Za-z]+)(\d+)(.cb[rz])/$1 $2$3/' *.cb?

windows/build.ps1

@@ -0,0 +1,16 @@
+# Script to be run inside appveyor for a full build
+python -m venv venv
+./venv/Scripts/Activate.ps1
+#pip install wheel
+pip install -r requirements-dev.txt
+pip install -r requirements.txt
+python ./setup.py --version
+pyinstaller.exe -y --name="comictagger" --add-data 'comictaggerlib/ui/*.ui;ui' --add-data 'comictaggerlib/graphics;graphics' -i windows/app.ico --version-file file_version_info.py comictagger.py
+pyinstaller.exe -F --name="comictagger" --add-data 'comictaggerlib/ui/*.ui;ui' --add-data 'comictaggerlib/graphics;graphics' -i windows/app.ico --version-file file_version_info.py comictagger.py
+
+mv -Force dist/comictagger.exe "comictagger-$([System.Diagnostics.FileVersionInfo]::GetVersionInfo("$pwd/dist/comictagger.exe").FileVersion).exe"
+
+rm -Force -ErrorAction SilentlyContinue "./comictagger-$([System.Diagnostics.FileVersionInfo]::GetVersionInfo("$pwd/dist/comictagger/comictagger.exe").FileVersion).zip"
+Compress-Archive -Path dist/comictagger -DestinationPath "./comictagger-$([System.Diagnostics.FileVersionInfo]::GetVersionInfo("$pwd/dist/comictagger/comictagger.exe").FileVersion).zip"
+
+deactivate

windows/env.ps1

@@ -0,0 +1,3 @@
+$env:PATH+=";C:\ProgramData\Miniconda2\Scripts;C:\ProgramData\Miniconda2"
+$env:PATH+=";C:\tools\mingw64\bin"
+Set-Alias make mingw32-make.exe -scope Global