Maintenance: update type annotations, migrate build system to the newer version

Author: penguinolog

.github/workflows/pythonpackage.yml

@@ -6,9 +6,9 @@ jobs:
   PEP8:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -22,9 +22,9 @@ jobs:
   PyLint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: '3.7'
       - name: Install dependencies
@@ -42,9 +42,9 @@ jobs:
   MyPy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -62,9 +62,9 @@ jobs:
   Black:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -82,12 +82,12 @@ jobs:
       max-parallel: 6
       matrix:
         os: ["ubuntu-latest", "windows-latest"]
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -97,7 +97,7 @@ jobs:
           pip install --upgrade -r pytest_requirements.txt
       - name: Build package and install develop
         run: |
-          python setup.py develop -v clean
+          pip install -e .
       - name: Test with pytest
         run: |
           py.test --cov-report= --cov=advanced_descriptors test
@@ -108,19 +108,18 @@ jobs:
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3.2.0
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.3.1
         with:
           python-version: '3.x'
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip wheel
-          pip install --upgrade -r CI_REQUIREMENTS.txt
-          pip install --upgrade twine
+          python -m pip install --upgrade pip
+          pip install --upgrade twine build
       - name: Build package
         run: |
-          python setup.py sdist bdist_wheel clean
+          python -m build
       - name: Deploy
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.3.0
     hooks:
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
     - id: mixed-line-ending
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.9.3
+    rev: 5.11.2
     hooks:
     - id: isort
       name: isort (python)
@@ -20,15 +20,14 @@ repos:
       types: [pyi]
 
   - repo: https://github.com/psf/black
-    rev: 21.10b0
+    rev: 22.12.0
     hooks:
     - id: black
       # It is recommended to specify the latest version of Python
       # supported by your project here, or alternatively use
       # pre-commit's default_language_version, see
       # https://pre-commit.com/#top_level-default_language_version
-      language_version: python3.7
-      always_run: true
+      language_version: python3.9
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.9.0  # Use the ref you want to point at
@@ -38,8 +37,8 @@ repos:
     - id: rst-directive-colons
     - id: rst-inline-touching-normal
 
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
     hooks:
     - id: flake8
       additional_dependencies: [flake8-bugbear, pep8-naming, flake8-docstrings]

.pylintrc

@@ -7,11 +7,11 @@ extension-pkg-whitelist=lxml.etree
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS,.git
+ignore=CVS,.git,_version.py
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=_version.py
+ignore-patterns=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
@@ -28,12 +28,13 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=pylint.extensions.docparams,
-             pylint.extensions.docstyle,
+load-plugins=pylint.extensions.docstyle,
+             pylint.extensions.docparams,
              pylint.extensions.overlapping_exceptions,
              pylint.extensions.emptystring,
              pylint.extensions.comparetozero,
              pylint.extensions.check_elif,
+             pylint.extensions.for_any_all,
              pylint.extensions.code_style,
              pylint.extensions.redefined_variable_type,
              pylint.extensions.typing,
@@ -85,7 +86,6 @@ disable=locally-disabled,
         too-many-statements,
         too-many-instance-attributes,
         too-many-lines,
-        misplaced-comparison-constant,
         broad-except,
         logging-fstring-interpolation,
         logging-format-interpolation
@@ -299,13 +299,6 @@ max-line-length=120
 # Maximum number of lines in a module.
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no

.readthedocs.yaml

@@ -0,0 +1,27 @@
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+     - method: pip
+       path: .
+     - requirements: CI_REQUIREMENTS.txt

CI_REQUIREMENTS.txt

@@ -1 +1,2 @@
 -r requirements.txt
+setuptools_scm

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2017-2020 Alexey Stepanov aka penguinolog
+   Copyright 2016-2022 Alexey Stepanov aka penguinolog
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

MANIFEST.in

@@ -1,4 +1,4 @@
-include *.rst LICENSE requirements.txt
+include *.rst LICENSE requirements.txt classifiers.txt
 global-include *.pyx *.pxd
 global-exclude *.c
 exclude Makefile
@@ -9,5 +9,6 @@ exclude .gitignore .dockerignore
 prune test
 prune .github
 prune .azure_pipelines
-prune docs
+prune .tox
+prune doc
 exclude CODEOWNERS CODE_OF_CONDUCT.md _config.yml

advanced_descriptors/__init__.py

@@ -1,4 +1,4 @@
-#    Copyright 2017 - 2021 Alexey Stepanov aka penguinolog
+#    Copyright 2017 - 2022 Alexey Stepanov aka penguinolog
 #    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

advanced_descriptors/advanced_property.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-#    Copyright 2016 - 2021 Alexey Stepanov aka penguinolog
+#    Copyright 2016 - 2022 Alexey Stepanov aka penguinolog
 #    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
@@ -20,6 +20,10 @@
 # Standard Library
 import typing
 
+if typing.TYPE_CHECKING:
+    # Standard Library
+    from collections.abc import Callable
+
 __all__ = ("AdvancedProperty",)
 
 _OwnerClassT = typing.TypeVar("_OwnerClassT")
@@ -121,27 +125,27 @@ class AdvancedProperty(property, typing.Generic[_OwnerClassT, _ReturnT, _ClassRe
 
     def __init__(
         self,
-        fget: typing.Callable[[_OwnerClassT], _ReturnT] | None = None,
-        fset: typing.Callable[[_OwnerClassT, _ReturnT], None] | None = None,
-        fdel: typing.Callable[[_OwnerClassT], None] | None = None,
-        fcget: typing.Callable[[type[_OwnerClassT]], _ClassReturnT] | None = None,
+        fget: Callable[[_OwnerClassT], _ReturnT] | None = None,
+        fset: Callable[[_OwnerClassT, _ReturnT], None] | None = None,
+        fdel: Callable[[_OwnerClassT], None] | None = None,
+        fcget: Callable[[type[_OwnerClassT]], _ClassReturnT] | None = None,
     ) -> None:
         """Advanced property main entry point.
 
         :param fget: normal getter.
-        :type fget: typing.Callable[[typing.Any, ], typing.Any] | None
+        :type fget: Callable[[typing.Any, ], typing.Any] | None
         :param fset: normal setter.
-        :type fset: typing.Callable[[typing.Any, typing.Any], None] | None
+        :type fset: Callable[[typing.Any, typing.Any], None] | None
         :param fdel: normal deleter.
-        :type fdel: typing.Callable[[typing.Any, ], None] | None
+        :type fdel: Callable[[typing.Any, ], None] | None
         :param fcget: class getter. Used as normal, if normal is None.
-        :type fcget: typing.Callable[[typing.Any, ], typing.Any] | None
+        :type fcget: Callable[[typing.Any, ], typing.Any] | None
 
         .. note:: doc argument is not supported due to class wide getter usage.
         """
         super().__init__(fget=fget, fset=fset, fdel=fdel)
 
-        self.__fcget: typing.Callable[[type[_OwnerClassT]], _ClassReturnT] | None = fcget
+        self.__fcget: Callable[[type[_OwnerClassT]], _ClassReturnT] | None = fcget
 
     @typing.overload
     def __get__(self, instance: None, owner: type[_OwnerClassT]) -> _ClassReturnT:
@@ -159,7 +163,7 @@ def __get__(
         """Get descriptor.
 
         :param instance: Owner class instance. Filled only if instance created, else None.
-        :type instance: typing.Optional[owner]
+        :type instance: owner | None
         :param owner: Owner class for property.
         :return: getter call result if getter presents
         :rtype: typing.Any
@@ -172,22 +176,22 @@ def __get__(
         return super().__get__(instance, owner)  # type: ignore[no-any-return]
 
     @property
-    def fcget(self) -> typing.Callable[[type[_OwnerClassT]], _ClassReturnT] | None:
+    def fcget(self) -> Callable[[type[_OwnerClassT]], _ClassReturnT] | None:
         """Class wide getter instance.
 
         :return: Class wide getter instance
-        :rtype: typing.Callable[[typing.Any, ], typing.Any] | None
+        :rtype: Callable[[typing.Any, ], typing.Any] | None
         """
         return self.__fcget
 
     def cgetter(
         self,
-        fcget: typing.Callable[[type[_OwnerClassT]], _ClassReturnT] | None,
+        fcget: Callable[[type[_OwnerClassT]], _ClassReturnT] | None,
     ) -> AdvancedProperty[_OwnerClassT, _ReturnT, _ClassReturnT]:
         """Descriptor to change the class wide getter on a property.
 
         :param fcget: new class-wide getter.
-        :type fcget: typing.Callable[[typing.Any, ], typing.Any] | None
+        :type fcget: Callable[[typing.Any, ], typing.Any] | None
         :return: AdvancedProperty
         :rtype: AdvancedProperty
         """

advanced_descriptors/log_on_access.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-#    Copyright 2016 - 2021 Alexey Stepanov aka penguinolog
+#    Copyright 2016 - 2022 Alexey Stepanov aka penguinolog
 #    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
@@ -28,6 +28,10 @@
 import typing
 import warnings
 
+if typing.TYPE_CHECKING:
+    # Standard Library
+    from collections.abc import Callable
+
 _LOGGER: logging.Logger = logging.getLogger(__name__)
 _CURRENT_FILE = os.path.abspath(__file__)
 _OwnerT = typing.TypeVar("_OwnerT")
@@ -45,9 +49,9 @@ class LogOnAccess(property, typing.Generic[_OwnerT, _ReturnT]):
 
     def __init__(
         self,
-        fget: typing.Callable[[_OwnerT], _ReturnT] | None = None,
-        fset: typing.Callable[[_OwnerT, _ReturnT], None] | None = None,
-        fdel: typing.Callable[[_OwnerT], None] | None = None,
+        fget: Callable[[_OwnerT], _ReturnT] | None = None,
+        fset: Callable[[_OwnerT, _ReturnT], None] | None = None,
+        fdel: Callable[[_OwnerT], None] | None = None,
         doc: str | None = None,
         *,
         # Extended settings start
@@ -63,11 +67,11 @@ def __init__(
         """Advanced property main entry point.
 
         :param fget: normal getter.
-        :type fget: typing.Callable[[_OwnerT], _ReturnT] | None
+        :type fget: Callable[[_OwnerT], _ReturnT] | None
         :param fset: normal setter.
-        :type fset: typing.Callable[[_OwnerT, _ReturnT], None] | None
+        :type fset: Callable[[_OwnerT, _ReturnT], None] | None
         :param fdel: normal deleter.
-        :type fdel: typing.Callable[[_OwnerT], None] | None
+        :type fdel: Callable[[_OwnerT], None] | None
         :param doc: docstring override
         :type doc: str | None
         :param logger: logger instance or name to use as override