Due to difficulty making plantuml produce exact same output between d…

…ifference OS's, strip out svg elements when comparing html output

.pylint.ini

@@ -87,6 +87,7 @@ disable=
     logging-fstring-interpolation,
     unnecessary-dunder-call,
     deprecated-module,
+    deprecated-argument,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -418,5 +419,5 @@ known-third-party=enchant
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
+# "builtin.Exception"
+overgeneral-exceptions=builtin.Exception

.verchew.ini

@@ -5,18 +5,18 @@ version = GNU Make
 
 [Python]
 
-cli = python
+cli = python3
 version = 3.9 || 3.10 || 3.11 || 3.12
 
 [Poetry]
 
 cli = poetry
-version = 1.7
+version = 1.7 || 1.8
 
 [Graphviz]
 
 cli = dot
 cli_version_arg = -V
-version = 9 || 10
+version = 9 || 10 || 11 || 12
 optional = true
 message = This is only needed to generate UML diagrams for documentation.

Makefile

@@ -46,27 +46,26 @@ DEPENDENCIES := $(VIRTUAL_ENV)/.poetry-$(shell bin/checksum pyproject.toml poetr
 install: $(DEPENDENCIES) .cache
 
 $(DEPENDENCIES): poetry.lock
-	@ rm -rf ~/Library/Preferences/pypoetry
-	@ poetry config virtualenvs.in-project true
+	poetry config virtualenvs.in-project true
 	poetry install
-	@ touch $@
+	touch $@
 
 ifndef CI
 poetry.lock: pyproject.toml
 	poetry lock --no-update
-	@ touch $@
+	touch $@
 endif
 
 .cache:
-	@ mkdir -p .cache
+	mkdir -p .cache
 
 # CHECKS ######################################################################
 
 .PHONY: format
 format: install
 	poetry run isort $(PACKAGES)
 	poetry run black $(PACKAGES)
-	@ echo
+	echo
 
 .PHONY: check
 check: install format  ## Run formaters, linters, and static analysis
@@ -96,7 +95,7 @@ test: test-all ## Run unit and integration tests
 test-unit: install
 	poetry run pytest $(PACKAGE) $(PYTEST_OPTIONS)
 ifndef DISABLE_COVERAGE
-	@ echo
+	echo
 	poetry run coveragespace update unit
 endif
 
@@ -107,7 +106,7 @@ test-int: test-all
 test-all: install
 	TEST_INTEGRATION=true poetry run pytest $(PACKAGES) $(PYTEST_OPTIONS)
 ifndef DISABLE_COVERAGE
-	@ echo
+	echo
 	poetry run coveragespace update overall
 endif
 
@@ -132,16 +131,16 @@ docs: mkdocs uml ## Generate documentation and UML
 .PHONY: mkdocs
 mkdocs: install $(MKDOCS_INDEX)
 $(MKDOCS_INDEX): docs/requirements.txt mkdocs.yml docs/*.md
-	@ mkdir -p docs/about
-	@ cd docs && ln -sf ../README.md index.md
-	@ cd docs/about && ln -sf ../../CHANGELOG.md changelog.md
-	@ cd docs/about && ln -sf ../../CONTRIBUTING.md contributing.md
-	@ cd docs/about && ln -sf ../../LICENSE.md license.md
+	mkdir -p docs/about
+	cd docs && ln -sf ../README.md index.md
+	cd docs/about && ln -sf ../../CHANGELOG.md changelog.md
+	cd docs/about && ln -sf ../../CONTRIBUTING.md contributing.md
+	cd docs/about && ln -sf ../../LICENSE.md license.md
 	poetry run mkdocs build --clean --strict
 
 docs/requirements.txt: poetry.lock
-	@ poetry run pip list --format=freeze | grep mkdocs > $@
-	@ poetry run pip list --format=freeze | grep Pygments >> $@
+	poetry run pip list --format=freeze | grep mkdocs > $@
+	poetry run pip list --format=freeze | grep Pygments >> $@
 
 .PHONY: uml
 uml: install docs/*.png
@@ -262,6 +261,6 @@ clean-all: clean
 
 .PHONY: help
 help: install
-	@ grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 .DEFAULT_GOAL := help

bin/checksum

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 import hashlib

bin/verchew

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # The MIT License (MIT)

doorstop/cli/commands.py

@@ -502,6 +502,8 @@ def run_export(args, cwd, error, catch=True, auto=False, _tree=None):
     ext = utilities.get_ext(args, error, ".yml", ".csv", whole_tree=whole_tree)
 
     # Get the tree or document
+    document = None
+
     with utilities.capture(catch=catch) as success:
         exporter.check(ext)
         tree = _tree or _get_tree(args, cwd, load=whole_tree)
@@ -547,6 +549,7 @@ def run_publish(args, cwd, error, catch=True):
     ext = utilities.get_ext(args, error, ".txt", ".html", whole_tree)
 
     # Get the tree or document
+    document = None
     with utilities.capture(catch=catch) as success:
         publisher.check(ext)
         tree = _get_tree(args, cwd, load=whole_tree)
@@ -665,12 +668,10 @@ def _iter_items(args, tree, error):
     if item:
         yield item
     elif document:
-        for item in document:
-            yield item
+        yield from document
     else:
         for document in tree:
-            for item in document:
-                yield item
+            yield from document
 
 
 def _export_import(args, cwd, error, document, ext):

doorstop/cli/main.py

@@ -179,12 +179,12 @@ def main(args=None):  # pylint: disable=R0915
         log.error(exc)
         success = False
     except KeyboardInterrupt:
-        log.debug("command cancelled")
+        log.debug(f"command cancelled: {args}")
         success = False
     if success:
-        log.debug("command succeeded")
+        log.debug("command succeeded: {args}")
     else:
-        log.debug("command failed")
+        log.debug(f"command failed: {args}")
         sys.exit(1)
 
 

doorstop/common.py

@@ -107,8 +107,7 @@ def read_lines(path, encoding="utf-8"):
     """
     log.trace("reading lines from '{}'...".format(path))  # type: ignore
     with open(path, "r", encoding=encoding) as stream:
-        for line in stream:
-            yield line
+        yield from stream
 
 
 def read_text(path):

doorstop/core/editor.py

@@ -94,6 +94,10 @@ def launch(path, tool=None):
             args = ["start", path]
     elif os.name == "posix":
         args = ["xdg-open", path]
+    else:
+        raise DoorstopError(
+            "unknown operating system, unable to determine launch command"
+        )
 
     # Launch the editor
     try: