Merge pull request #8 from anikolaienko/feature/update-code-checking-tools

Update code checking tools and dev dependencies

Author: anikolaienko

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Coming in future, but not yet
+sphinx-docs/

.pre-commit-config.yaml

@@ -1,26 +1,55 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+files: ".py$"
+exclude: "sphinx-docs/"
 repos:
-    - repo: local
-      hooks:
-        - id: black
-          name: black
-          description: "Black: The uncompromising Python code formatter"
-          entry: black
-          language: python
-          require_serial: true
-          types_or: [python, pyi]
-        - id: flake8
-          name: flake8
-          description: '`flake8` is a command-line utility for enforcing style consistency across Python projects.'
-          entry: flake8
-          language: python
-          types: [python]
-          require_serial: true
-        - id: mypy
-          name: mypy
-          description: 'Mypy is a static type checker for Python 3'
-          entry: mypy
-          language: python
-          types: [python]
-          require_serial: true
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        name: black
+        description: "Black: The uncompromising Python code formatter"
+        entry: black
+        language: python
+        require_serial: true
+        types_or: [python, pyi]
+        args: [--config=code-checks/.black.cfg]
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: Run isort to sort imports in Python files
+        files: \.py$|\.pyi$
+        args: [--settings-path=code-checks/.isort.cfg]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-merge-conflict
+        name: Check that merge conflicts are not being committed
+      - id: trailing-whitespace
+        name: Remove trailing whitespace at end of line
+      - id: mixed-line-ending
+        name: Detect if mixed line ending is used (\r vs. \r\n)
+      - id: end-of-file-fixer
+        name: Make sure that there is an empty line at the end
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        name: flake8
+        description: '`flake8` is a command-line utility for enforcing style consistency across Python projects.'
+        entry: flake8
+        language: python
+        types: [python]
+        require_serial: true
+        args: [--config=code-checks/.flake8]
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        description: 'Optional static typing for Python (installed by Poetry)'
+        entry: mypy
+        language: python
+        require_serial: true
+        types_or: [python, pyi]
+        args: [--config-file=code-checks/.mypy.ini]

automapper/__init__.py

@@ -1,12 +1,10 @@
 # flake8: noqa: F401
-from .mapper import Mapper
-
 from .exceptions import (
+    CircularReferenceError,
     DuplicatedRegistrationError,
     MappingError,
-    CircularReferenceError,
 )
-
+from .mapper import Mapper
 from .mapper_initializer import create_mapper
 
 # Global mapper

automapper/extensions/default.py

@@ -1,8 +1,7 @@
-from typing import Type, TypeVar, Iterable
+from typing import Iterable, Type, TypeVar
 
 from automapper import Mapper
 
-
 T = TypeVar("T")
 _IGNORED_FIELDS = ("return", "args", "kwargs")
 

automapper/extensions/pydantic.py

@@ -1,8 +1,7 @@
-from typing import Type, Iterable
-
-from pydantic import BaseModel
+from typing import Iterable, Type
 
 from automapper import Mapper
+from pydantic import BaseModel
 
 
 def spec_function(target_cls: Type[BaseModel]) -> Iterable[str]:

automapper/extensions/sqlalchemy.py

@@ -1,8 +1,7 @@
-from sqlalchemy import inspect
-
-from typing import Type, Iterable
+from typing import Iterable, Type
 
 from automapper import Mapper
+from sqlalchemy import inspect
 
 
 def sqlalchemy_spec_decide(obj_type: Type[object]) -> bool:

automapper/extensions/tortoise.py

@@ -1,8 +1,7 @@
-from typing import Type, Iterable
-
-from tortoise import Model
+from typing import Iterable, Type
 
 from automapper import Mapper
+from tortoise import Model
 
 
 def spec_function(target_cls: Type[Model]) -> Iterable[str]:

automapper/mapper.py

@@ -1,20 +1,20 @@
+import inspect
+from copy import deepcopy
 from typing import (
     Any,
+    Callable,
+    Dict,
+    Generic,
+    Iterable,
     Optional,
+    Set,
     Tuple,
-    Union,
     Type,
     TypeVar,
-    Dict,
-    Set,
-    Callable,
-    Iterable,
-    Generic,
-    overload,
+    Union,
     cast,
+    overload,
 )
-from copy import deepcopy
-import inspect
 
 from .exceptions import (
     CircularReferenceError,
@@ -165,7 +165,7 @@ def map(
         *,
         skip_none_values: bool = False,
         fields_mapping: FieldsMap = None,
-    ) -> T:
+    ) -> T:  # type: ignore [type-var]
         """Produces output object mapped from source object and custom arguments"""
         obj_type = type(obj)
         if obj_type not in self._mappings:
@@ -301,7 +301,7 @@ def _map_common(
 
         _visited_stack.remove(obj_id)
 
-        return cast(target_cls, target_cls(**mapped_values))  # type: ignore [call-arg, redundant-cast, valid-type]
+        return cast(target_cls, target_cls(**mapped_values))  # type: ignore [valid-type]
 
     def to(self, target_cls: Type[T]) -> MappingWrapper[T]:
         """Specify target class to map source object to"""

automapper/mapper_initializer.py

@@ -1,8 +1,8 @@
-from os.path import dirname, join, isfile, basename
-import logging
+import glob
 import importlib
 import importlib.util
-import glob
+import logging
+from os.path import basename, dirname, isfile, join
 
 from . import Mapper
 
@@ -28,7 +28,7 @@ def create_mapper() -> Mapper:
                     extension_package = importlib.import_module(
                         __PACKAGE_PATH__ + "." + module_name
                     )
-                    extension_package.extend(mapper)  # type: ignore [attr-defined]
+                    extension_package.extend(mapper)
                 except Exception:
                     log.exception(
                         f"Found module {module_name} but could not load extension for it."

code-checks/.black.cfg

@@ -0,0 +1,4 @@
+[black]
+line-length = 120
+target-version = ['py38']
+include = '\.pyi?$'