[PATCH] fixup for PR #89 regressions and linting

Author: reactive-firewall

docs/conf.py

@@ -29,9 +29,9 @@
 Example:
 	>>> import conf
 	>>> conf.project
-	'python-repo'
+	'pythonrepo'
 	>>> conf.version
-	'1.1'
+	'2.0'
 """
 
 import sys
@@ -41,7 +41,7 @@
 from urllib.parse import quote
 
 # If you have custom documentation extensions, add them here
-sys.path.insert(0, os.path.abspath(".."))
+import docs.utils
 from docs.utils import (
 	_validate_git_ref,  # noqa
 	slugify_header,  # noqa
@@ -64,6 +64,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
+sys.path.insert(0, os.path.abspath(".."))
 # sys.path.insert(1, os.path.abspath("tests"))  # uncomment to add tests docs
 sys.path.insert(1, os.path.abspath("pythonrepo"))
 
@@ -151,9 +152,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "v2.0"
+version = "2.0"
 # The full version, including alpha/beta/rc tags.
-release = "v2.0.0b0"
+release = f"v${version}.0b0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -258,7 +259,7 @@
 # html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title =  "Project Docs"
+html_short_title = "Project Docs"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -472,7 +473,7 @@
 
 suffix: str = "/issues/%s"
 
-extlinks: dict[str,tuple] = {
+extlinks: dict[str, tuple] = {
 	"issue": (
 		f"{linkcode_url_prefix}/{suffix}",
 		"issue #%s"
@@ -481,17 +482,17 @@
 
 # try to link with official python3 documentation.
 # see https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html for more
-intersphinx_mapping = sanitize_intersphinx_mapping(
+intersphinx_mapping: dict[str, tuple] = sanitize_intersphinx_mapping(
 	{
 		"python": ("https://docs.python.org/3", (None, "python-inv.txt")),
 		"PEP": ("https://peps.python.org", (None, "pep-inv.txt")),
 	},
 )
 
 
-def linkcode_resolve(domain: Any, info: Any) -> str:
+def linkcode_resolve(domain: any, info: any) -> str:
 	"""
-	Resolves selectively linking to GitHub source-code for the multicast module.
+	Resolves selectively linking to GitHub source-code for the project module.
 
 	See https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html for more details.
 
@@ -506,7 +507,7 @@ def linkcode_resolve(domain: Any, info: Any) -> str:
 
 			>>> _conf.linkcode_resolve is not None
 			True
-			>>> test_text = "multicast.env"  # this is resolved
+			>>> test_text = "pythonrepo.env"  # this is resolved
 			>>> bad_input = False  # this is invalid
 			>>> res_text = _conf.linkcode_resolve("py", info={"module": test_text})
 			>>> res_text is not None

pythonrepo/__init__.py

@@ -35,7 +35,7 @@
 			os.path.dirname(__file__), "..",
 		)
 		if str(os.path.abspath(__parentPath)) not in sys.path:  # pragma: no branch
-			sys.path.insert(0, os.path.abspath(__parentPath))
+			sys.path.insert(0, os.path.abspath(__parentPath))  # pragma: no cover
 except ImportError as err:
 	baton = ImportError(err, str("[CWE-758] Module failed completely."))
 	baton.module = __module__

pythonrepo/pythonrepo.py

@@ -100,7 +100,7 @@ def parseArgs(arguments=None) -> argparse.Namespace:
 	return parser.parse_known_args(arguments)
 
 
-def useTool(tool, *arguments) -> Any:
+def useTool(tool, *arguments) -> any:
 	"""Handler for launching the functions."""
 	if (tool is not None) and (tool in TASK_OPTIONS):
 		try:
@@ -128,7 +128,7 @@ def main(*argv) -> None:
 			raise SystemExit(2) from _cause
 	except BaseException as _panic:  # nocq
 		e = str("CRITICAL - An error occurred while handling")
-		e += str("the cascading failure.")
+		e += str(" the cascading failure.")
 		print(e)
 		raise SystemExit(3) from _panic
 	sys.exit(0)

test-requirements.txt

@@ -13,25 +13,32 @@ tox>=3.0.0
 setuptools>=75.0
 # virtualenv - MIT license
 virtualenv>=20.26.6
-# pip - MIT license
-pip>=24.3.1
 # build - MIT license
 build>=1.1.1, !=1.2.2.post1
-# python-repo - MIT
-#-e git+https://github.com/reactive-firewall/python-repo.git#egg=python-repo
 # wheel - MIT license
-wheel>=0.44
+wheel>=0.45
+# pip - MIT license
+pip>=25.1.1
 #
 # TESTING ONLY - Do NOT report issues with these optionals on python-repo
 #
-flake8>=5.0
-pyflakes>=2.5.0
-pep8>=1.0
-pytest>=7
-pytest-checkdocs>=2.4
-pytest-cov>=4.0.0
+# flake8 - MIT license
+flake8>=7.2.0
+# flake8-comprehensions - MIT License
+flake8-comprehensions>=3.16.0
+# pyflakes - MIT license
+# pyflakes>=3.3.2
+# pep8 - MIT license
+pep8>=1.7
+# pytest - MIT license
+pytest>=7.0, !=8.1.0
+# pytest-doctestplus - BSD license
+pytest-doctestplus>=1.4.0
+# pytest-cov - MIT license
+pytest-cov>=6.1.1
+# pytest-enabler - MIT license
 pytest-enabler>=1.0.1
-pytest-flake8>=1.0
-coverage >= 6.3
-pytest-cov >= 4.0.0;
-pytest-enabler >= 1.0.1
+# pytest-flake8 - BSD license - removed from tests in v2.0.9a3
+# pytest-flake8>=1.0.7
+# coverage - Apache 2.0 license
+coverage>=7.2

tests/__init__.py

@@ -27,7 +27,7 @@
 		import sys
 		import os
 		sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), str('..'))))
-	except (ImportError,OSError,TypeError,ValueError,AttributeError,IndexError) as ImportErr:
+	except (ImportError, OSError, TypeError, ValueError, AttributeError, IndexError) as ImportErr:
 		raise ImportError("[CWE-758] Test module failed completely.") from ImportErr
 	from tests import context as context  # skipcq: PYL-C0414
 	if not hasattr(context, '__name__') or not context.__name__:  # pragma: no branch

tests/check_spelling

@@ -97,7 +97,7 @@ umask 137
 # force utf-8 for spelling
 export LC_CTYPE="${LC_CTYPE:-en_US.UTF-8}"
 
-LOCK_FILE="${TMPDIR:-/tmp}/org.pak.multicast.spell-check-shell"
+LOCK_FILE="${TMPDIR:-/tmp}/org.pak.pythonrepo.spell-check-shell"
 EXIT_CODE=1
 
 # Function to check if a command exists.