initial pre-commit

Author: penguinolog

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    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
+    hooks:
+      - id: isort
+        name: isort (python)
+      - id: isort
+        name: isort (cython)
+        types: [cython]
+      - id: isort
+        name: isort (pyi)
+        types: [pyi]
+
+  - repo: https://github.com/psf/black
+    rev: 21.10b0
+    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
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0  # Use the ref you want to point at
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-bugbear, pep8-naming, flake8-docstrings]
+        exclude: test
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v2.11.1
+    hooks:
+    - id: pylint
+      exclude: test

logwrap/log_wrap.py

@@ -684,7 +684,7 @@ def wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
                 raise
             return result
 
-        return async_wrapper if asyncio.iscoroutinefunction(func) else wrapper  # type: ignore
+        return async_wrapper if asyncio.iscoroutinefunction(func) else wrapper  # type: ignore[return-value]
 
     def __call__(self, func: _WrappedT) -> _WrappedT:
         """Callable instance.

logwrap/repr_utils.py

@@ -158,11 +158,11 @@ def _prepare_repr(func: typing.Union[types.FunctionType, types.MethodType]) -> t
     if not ismethod:
         real_func: typing.Callable[..., typing.Any] = func
     else:
-        real_func = func.__func__  # type: ignore
+        real_func = func.__func__  # type: ignore[union-attr]
 
     for param in inspect.signature(real_func).parameters.values():
-        if not self_processed and ismethod and func.__self__ is not None:  # type: ignore
-            result.append(ReprParameter(param, value=func.__self__))  # type: ignore
+        if not self_processed and ismethod and func.__self__ is not None:  # type: ignore[union-attr]
+            result.append(ReprParameter(param, value=func.__self__))  # type: ignore[union-attr]
             self_processed = True
         else:
             result.append(ReprParameter(param))
@@ -374,7 +374,7 @@ def process_element(
         """
         if hasattr(src, self._magic_method_name):
             result = getattr(src, self._magic_method_name)(self, indent=indent, no_indent_start=no_indent_start)
-            return result  # type: ignore
+            return result  # type: ignore[no-any-return]
 
         if _known_callable(src):
             return self._repr_callable(src=src, indent=indent)

logwrap/repr_utils.pyx

@@ -115,7 +115,7 @@ cdef:
         if not ismethod:
             real_func = func
         else:
-            real_func = func.__func__  # type: ignore
+            real_func = func.__func__
 
         for param in inspect.signature(real_func).parameters.values():
             if not self_processed and ismethod and func.__self__ is not None:
@@ -313,7 +313,7 @@ cdef class PrettyFormat:
 
         if hasattr(src, self._magic_method_name):
             result = getattr(src, self._magic_method_name)(self, indent=indent, no_indent_start=no_indent_start)
-            return result  # type: ignore
+            return result
 
         if _known_callable(src):
             return self._repr_callable(src=src, indent=indent)

test/test_log_wrap_py3.py

@@ -12,17 +12,17 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-# pylint: disable=missing-docstring, unused-argument
+# pylint: disable=unused-argument
 
-"""Python 3 specific tests"""
+"""Python 3 specific tests."""
 
 from __future__ import annotations
 
 # Standard Library
 import asyncio
 import io
 import logging
-import typing  # noqa # pylint: disable=unused-import
+import typing
 import unittest
 from unittest import mock
 
@@ -150,15 +150,15 @@ def tearDown(self):
 
     def test_01_annotation_args(self):
         @logwrap.logwrap
-        def func(a: typing.Optional[int] = None):
+        def func(arg: typing.Optional[int] = None):
             pass
 
         func()
         self.assertEqual(
             "DEBUG>Calling: \n"
             "func(\n"
             "    # POSITIONAL_OR_KEYWORD:\n"
-            "    a=None,  # type: typing.Optional[int]\n"
+            "    arg=None,  # type: typing.Optional[int]\n"
             ")\n"
             "DEBUG>Done: 'func' with result:\n"
             "None\n",
@@ -167,15 +167,15 @@ def func(a: typing.Optional[int] = None):
 
     def test_02_annotation_args(self):
         @logwrap.logwrap
-        def func(a: int = 0):
+        def func(arg: int = 0):
             pass
 
         func()
         self.assertEqual(
             "DEBUG>Calling: \n"
             "func(\n"
             "    # POSITIONAL_OR_KEYWORD:\n"
-            "    a=0,  # type: int\n"
+            "    arg=0,  # type: int\n"
             ")\n"
             "DEBUG>Done: 'func' with result:\n"
             "None\n",

tox.ini

@@ -101,7 +101,7 @@ deps =
   -r{toxinidir}/CI_REQUIREMENTS.txt
 commands =
   python setup.py --version clean
-  mypy --strict --xslt-html-report mypy_report -p logwrap
+  mypy --strict --show-error-codes --xslt-html-report mypy_report -p logwrap
 
 [testenv:isort]
 deps =