introduce pre-commit

Signed-off-by: oleg.hoefling <[email protected]>

Author: hoefling

.gitignore

@@ -5,6 +5,7 @@
 !.appveyor*
 !.git*
 !.readthedocs.yaml
+!.pre-commit-config.yaml
 
 # Python
 /dist

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: ".*.diff"  # exclude patches
+repos:
+-   repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+    -   id: black
+        types: []
+        files: ^.*.pyi?$
+        exclude: ^doc/
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: no-commit-to-branch
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-ast
+    -   id: check-merge-conflict
+    -   id: check-json
+    -   id: detect-private-key
+    -   id: mixed-line-ending
+    -   id: pretty-format-json
+        args: [--autofix]
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8
+        exclude: ^setup.py$
+        additional_dependencies: [flake8-docstrings, flake8-bugbear, flake8-logging-format, flake8-builtins, flake8-eradicate, flake8-fixme, pep8-naming, flake8-pep3101, flake8-annotations-complexity,flake8-pyi]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+    -   id: isort
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.971
+    hooks:
+    -   id: mypy
+        exclude: (setup.py|tests/.*.py|doc/.*)
+        types: []
+        files: ^.*.pyi?$
+        additional_dependencies: [lxml-stubs,types-docutils]
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+    -   id: rst-backticks

doc/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/source/conf.py

@@ -4,8 +4,11 @@
 import urllib.request
 
 import lxml
-from docutils.nodes import reference
-from packaging.version import parse
+from docutils.nodes import Text, reference
+from packaging.version import Version, parse
+from sphinx.addnodes import pending_xref
+from sphinx.application import Sphinx
+from sphinx.environment import BuildEnvironment
 from sphinx.errors import ExtensionError
 
 if sys.version_info >= (3, 8):
@@ -23,22 +26,22 @@
 master_doc = 'index'
 
 project = u'python-xmlsec'
-copyright = u'2020, Oleg Hoefling <[email protected]>'
+copyright = u'2020, Oleg Hoefling <[email protected]>'  # noqa: A001
 author = u'Bulat Gaifullin <[email protected]>'
 release = importlib_metadata.version('xmlsec')
-parsed = parse(release)
+parsed: Version = parse(release)
 version = '{}.{}'.format(parsed.major, parsed.minor)
 
 language = None
-exclude_patterns = []
+exclude_patterns: list[str] = []
 pygments_style = 'sphinx'
 todo_include_todos = False
 
 html_theme = 'furo'
-html_static_path = []
+html_static_path: list[str] = []
 htmlhelp_basename = 'python-xmlsecdoc'
 
-latex_elements = {}
+latex_elements: dict[str, str] = {}
 latex_documents = [
     (
         master_doc,
@@ -72,7 +75,7 @@
 lxml_element_cls_doc_uri = 'https://lxml.de/api/lxml.etree._Element-class.html'
 
 
-def lxml_element_doc_reference(app, env, node, contnode):
+def lxml_element_doc_reference(app: Sphinx, env: BuildEnvironment, node: pending_xref, contnode: Text) -> reference:
     """
     Handle a missing reference only if it is a ``lxml.etree._Element`` ref.
 
@@ -83,13 +86,13 @@ def lxml_element_doc_reference(app, env, node, contnode):
         and node.get('reftarget', None) == 'lxml.etree._Element'
         and contnode.astext() in ('lxml.etree._Element', '_Element')
     ):
-        reftitle = '(in lxml v{})'.format(lxml.__version__)
+        reftitle = '(in lxml v{})'.format(lxml.__version__)  # type: ignore[attr-defined]
         newnode = reference('', '', internal=False, refuri=lxml_element_cls_doc_uri, reftitle=reftitle)
         newnode.append(contnode)
         return newnode
 
 
-def setup(app):
+def setup(app: Sphinx) -> None:
     # first, check whether the doc URL is still valid
     if urllib.request.urlopen(lxml_element_cls_doc_uri).getcode() != 200:
         raise ExtensionError('URL to `lxml.etree._Element` docs is not accesible.')

mypy.ini

@@ -1,3 +1,24 @@
+[tool.mypy]
+files = ['src']
+ignore_missing_imports = false
+warn_unused_configs = true
+disallow_subclassing_any = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+disallow_any_unimported = true
+strict_optional = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_no_return = true
+no_implicit_reexport = true
+show_error_codes = true
+
 [tool.black]
 line_length = 130
 skip-string-normalization = true

pyproject.toml

@@ -10,8 +10,8 @@
 import tarfile
 import zipfile
 from distutils import log
-from distutils.version import StrictVersion as Version
 from distutils.errors import DistutilsError
+from distutils.version import StrictVersion as Version
 from pathlib import Path
 from urllib.request import urlcleanup, urljoin, urlopen, urlretrieve
 
@@ -59,33 +59,23 @@ def latest_release_from_gnome_org_cache(url, lib_name):
 
 
 def latest_zlib_release():
-    return latest_release_from_html(
-        'https://zlib.net/fossils', re.compile('zlib-(?P<version>.*).tar.gz')
-    )
+    return latest_release_from_html('https://zlib.net/fossils', re.compile('zlib-(?P<version>.*).tar.gz'))
 
 
 def latest_libiconv_release():
-    return latest_release_from_html(
-        'https://ftp.gnu.org/pub/gnu/libiconv', re.compile('libiconv-(?P<version>.*).tar.gz')
-    )
+    return latest_release_from_html('https://ftp.gnu.org/pub/gnu/libiconv', re.compile('libiconv-(?P<version>.*).tar.gz'))
 
 
 def latest_libxml2_release():
-    return latest_release_from_gnome_org_cache(
-        'https://download.gnome.org/sources/libxml2', 'libxml2'
-    )
+    return latest_release_from_gnome_org_cache('https://download.gnome.org/sources/libxml2', 'libxml2')
 
 
 def latest_libxslt_release():
-    return latest_release_from_gnome_org_cache(
-        'https://download.gnome.org/sources/libxslt', 'libxslt'
-    )
+    return latest_release_from_gnome_org_cache('https://download.gnome.org/sources/libxslt', 'libxslt')
 
 
 def latest_xmlsec_release():
-    return latest_release_from_html(
-        'https://www.aleksey.com/xmlsec/download/', re.compile('xmlsec1-(?P<version>.*).tar.gz')
-    )
+    return latest_release_from_html('https://www.aleksey.com/xmlsec/download/', re.compile('xmlsec1-(?P<version>.*).tar.gz'))
 
 
 class build_ext(build_ext_orig):
@@ -265,7 +255,9 @@ def prepare_static_build_linux(self):
                 self.info('{:10}: {}'.format('zlib', 'PYXMLSEC_ZLIB_VERSION unset, downloading latest from {}'.format(url)))
             else:
                 url = 'https://zlib.net/fossils/zlib-{}.tar.gz'.format(self.zlib_version)
-                self.info('{:10}: {}'.format('zlib', 'PYXMLSEC_ZLIB_VERSION={}, downloading from {}'.format(self.zlib_version, url)))
+                self.info(
+                    '{:10}: {}'.format('zlib', 'PYXMLSEC_ZLIB_VERSION={}, downloading from {}'.format(self.zlib_version, url))
+                )
             urlretrieve(url, str(zlib_tar))
 
         # fetch libiconv
@@ -278,7 +270,11 @@ def prepare_static_build_linux(self):
                 self.info('{:10}: {}'.format('zlib', 'PYXMLSEC_LIBICONV_VERSION unset, downloading latest from {}'.format(url)))
             else:
                 url = 'https://ftp.gnu.org/pub/gnu/libiconv/libiconv-{}.tar.gz'.format(self.libiconv_version)
-                self.info('{:10}: {}'.format('zlib', 'PYXMLSEC_LIBICONV_VERSION={}, downloading from {}'.format(self.libiconv_version, url)))
+                self.info(
+                    '{:10}: {}'.format(
+                        'zlib', 'PYXMLSEC_LIBICONV_VERSION={}, downloading from {}'.format(self.libiconv_version, url)
+                    )
+                )
             urlretrieve(url, str(libiconv_tar))
 
         # fetch libxml2
@@ -290,8 +286,14 @@ def prepare_static_build_linux(self):
                 self.info('{:10}: {}'.format('libxml2', 'PYXMLSEC_LIBXML2_VERSION unset, downloading latest from {}'.format(url)))
             else:
                 version_prefix, _ = self.libxml2_version.split('.', -1)
-                url = 'https://download.gnome.org/sources/libxml2/{}/libxml2-{}.tar.xz'.format(version_prefix, self.libxml2_version)
-                self.info('{:10}: {}'.format('libxml2', 'PYXMLSEC_LIBXML2_VERSION={}, downloading from {}'.format(self.libxml2_version, url)))
+                url = 'https://download.gnome.org/sources/libxml2/{}/libxml2-{}.tar.xz'.format(
+                    version_prefix, self.libxml2_version
+                )
+                self.info(
+                    '{:10}: {}'.format(
+                        'libxml2', 'PYXMLSEC_LIBXML2_VERSION={}, downloading from {}'.format(self.libxml2_version, url)
+                    )
+                )
             libxml2_tar = self.libs_dir / 'libxml2.tar.xz'
             urlretrieve(url, str(libxml2_tar))
 
@@ -304,8 +306,14 @@ def prepare_static_build_linux(self):
                 self.info('{:10}: {}'.format('libxslt', 'PYXMLSEC_LIBXSLT_VERSION unset, downloading latest from {}'.format(url)))
             else:
                 version_prefix, _ = self.libxslt_version.split('.', -1)
-                url = 'https://download.gnome.org/sources/libxslt/{}/libxslt-{}.tar.xz'.format(version_prefix, self.libxslt_version)
-                self.info('{:10}: {}'.format('libxslt', 'PYXMLSEC_LIBXSLT_VERSION={}, downloading from {}'.format(self.libxslt_version, url)))
+                url = 'https://download.gnome.org/sources/libxslt/{}/libxslt-{}.tar.xz'.format(
+                    version_prefix, self.libxslt_version
+                )
+                self.info(
+                    '{:10}: {}'.format(
+                        'libxslt', 'PYXMLSEC_LIBXSLT_VERSION={}, downloading from {}'.format(self.libxslt_version, url)
+                    )
+                )
             libxslt_tar = self.libs_dir / 'libxslt.tar.gz'
             urlretrieve(url, str(libxslt_tar))
 
@@ -318,7 +326,11 @@ def prepare_static_build_linux(self):
                 self.info('{:10}: {}'.format('xmlsec1', 'PYXMLSEC_XMLSEC1_VERSION unset, downloading latest from {}'.format(url)))
             else:
                 url = 'https://www.aleksey.com/xmlsec/download/xmlsec1-{}.tar.gz'.format(self.xmlsec1_version)
-                self.info('{:10}: {}'.format('xmlsec1', 'PYXMLSEC_XMLSEC1_VERSION={}, downloading from {}'.format(self.xmlsec1_version, url)))
+                self.info(
+                    '{:10}: {}'.format(
+                        'xmlsec1', 'PYXMLSEC_XMLSEC1_VERSION={}, downloading from {}'.format(self.xmlsec1_version, url)
+                    )
+                )
             xmlsec1_tar = self.libs_dir / 'xmlsec1.tar.gz'
             urlretrieve(url, str(xmlsec1_tar))
 

setup.py

@@ -1,11 +1,13 @@
 from collections.abc import Callable, Iterable
-from typing import Any, AnyStr, IO, TypeVar, overload
-from _typeshed import GenericPath, Self, StrOrBytesPath
+from typing import IO, Any, AnyStr, TypeVar, overload
 
+from _typeshed import GenericPath, Self, StrOrBytesPath
 from lxml.etree import _Element
 
-from xmlsec import constants as constants, tree as tree
-from xmlsec.constants import __KeyData as KeyData, __Transform as Transform
+from xmlsec import constants as constants
+from xmlsec import tree as tree
+from xmlsec.constants import __KeyData as KeyData
+from xmlsec.constants import __Transform as Transform
 
 _E = TypeVar('_E', bound=_Element)
 
@@ -44,12 +46,12 @@ class Key:
     @classmethod
     def from_binary_file(cls: type[Self], klass: KeyData, filename: StrOrBytesPath) -> Self: ...
     @classmethod
-    def from_file(cls: type[Self], file: GenericPath | IO[AnyStr], format: int, password: str | None = ...) -> Self: ...
+    def from_file(cls: type[Self], file: GenericPath[AnyStr] | IO[AnyStr], format: int, password: str | None = ...) -> Self: ...
     @classmethod
     def from_memory(cls: type[Self], data: AnyStr, format: int, password: str | None = ...) -> Self: ...
     @classmethod
     def generate(cls: type[Self], klass: KeyData, size: int, type: int) -> Self: ...
-    def load_cert_from_file(self, file: GenericPath | IO[AnyStr], format: int) -> None: ...
+    def load_cert_from_file(self, file: GenericPath[AnyStr] | IO[AnyStr], format: int) -> None: ...
     def load_cert_from_memory(self, data: AnyStr, format: int) -> None: ...
     def __copy__(self: Self) -> Self: ...
     def __deepcopy__(self: Self) -> Self: ...