diff --git a/.github/workflows/test_tox.yml b/.github/workflows/test_tox.yml index cca23cc..25ece46 100644 --- a/.github/workflows/test_tox.yml +++ b/.github/workflows/test_tox.yml @@ -14,8 +14,6 @@ jobs: strategy: matrix: include: - - python-version: '3.7' - toxenv: 'py37,wheel' - python-version: '3.8' toxenv: 'py38,wheel' - python-version: '3.9' diff --git a/config/dpkg/changelog b/config/dpkg/changelog index 36a41a0..7a4f87a 100644 --- a/config/dpkg/changelog +++ b/config/dpkg/changelog @@ -1,5 +1,5 @@ -winreg-kb (20221228-1) unstable; urgency=low +winreg-kb (20240211-1) unstable; urgency=low * Auto-generated - -- Joachim Metz Wed, 28 Dec 2022 17:04:31 +0100 + -- Joachim Metz Sun, 11 Feb 2024 06:14:44 +0100 diff --git a/docs/conf.py b/docs/conf.py index 5c154a5..f89977c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,6 +52,7 @@ # docstrings. napoleon_google_docstring = True napoleon_numpy_docstring = False +napoleon_include_init_with_doc = True napoleon_include_private_with_doc = False napoleon_include_special_with_doc = True diff --git a/pyproject.toml b/pyproject.toml index 9787c3b..ee74093 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,10 @@ [build-system] requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" + +[tool.docformatter] +black = false +non-cap = ["dfDateTime", "dfImageTools", "dfVFS", "dfWinReg", "dtFabric", "iMessage", "iOS", "iPod", "mDNS"] +non-strict = false +wrap-summaries = 80 +wrap-descriptions = 80 diff --git a/setup.cfg b/setup.cfg index 7d847d6..13e41b7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = winregrc -version = 20240120 +version = 20240211 description = Windows Registry resources (winregrc) long_description = winregrc is a Python module part of winreg-kb to allow reuse of Windows Registry resources. long_description_content_type = text/plain @@ -22,7 +22,7 @@ install_requires = file:requirements.txt package_dir = winregrc = winregrc packages = find: -python_requires = >=3.7 +python_requires = >=3.8 scripts = scripts/appcompatcache.py scripts/application_identifiers.py diff --git a/tox.ini b/tox.ini index b23bb0e..fde90cf 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py3{7,8,9,10,11,12},coverage,docs,lint,wheel +envlist = py3{8,9,10,11,12},coverage,docformatter,docs,lint,wheel [testenv] allowlist_externals = ./run_tests.py @@ -19,12 +19,19 @@ deps = setuptools >= 65 wheel commands = - py3{7,8,9,10,11,12}: ./run_tests.py + py3{8,9,10,11,12}: ./run_tests.py coverage: coverage erase coverage: coverage run --source=winregrc --omit="*_test*,*__init__*,*test_lib*" run_tests.py coverage: coverage xml wheel: python -m build --no-isolation --wheel +[testenv:docformatter] +usedevelop = True +deps = + docformatter +commands = + docformatter --in-place --recursive winregrc tests + [testenv:docs] usedevelop = True deps = @@ -45,10 +52,14 @@ setenv = deps = -rrequirements.txt -rtest_requirements.txt + docformatter pylint >= 3.0.0, < 3.1.0 + setuptools yamllint >= 1.26.0 commands = + docformatter --version pylint --version yamllint -v + docformatter --check --diff --recursive scripts setup.py tests winregrc pylint --rcfile=.pylintrc scripts setup.py tests winregrc yamllint -c .yamllint.yaml winregrc diff --git a/utils/update_release.sh b/utils/update_release.sh index eee3b48..9b8f199 100755 --- a/utils/update_release.sh +++ b/utils/update_release.sh @@ -25,7 +25,7 @@ winreg-kb (${VERSION}-1) unstable; urgency=low EOT # Regenerate the API documentation. -tox -edocs +tox -edocformatter,docs exit ${EXIT_SUCCESS}; diff --git a/winregrc/__init__.py b/winregrc/__init__.py index 8043d5f..b3315a5 100644 --- a/winregrc/__init__.py +++ b/winregrc/__init__.py @@ -1,4 +1,4 @@ # -*- coding: utf-8 -*- """Windows Registry resources (winregrc).""" -__version__ = '20221228' +__version__ = '20240211' diff --git a/winregrc/filters.py b/winregrc/filters.py index 7886d18..3a38f03 100644 --- a/winregrc/filters.py +++ b/winregrc/filters.py @@ -87,7 +87,11 @@ def __init__(self, key_path): @property def key_paths(self): - """list[str]: key paths defined by the filter.""" + """Retrieves the key paths defined by the filter. + + Returns: + list[str]: key paths defined by the filter. + """ if self._wow64_key_path: return [self._key_path, self._wow64_key_path] return [self._key_path]