Merge pull request #30 from nlesc-nano/310

TST: Add more python 3.10 tests

Author: BvB93

.github/workflows/pythonpackage.yml

@@ -17,18 +17,15 @@ jobs:
             fail-fast: False
             matrix:
                 os: [ubuntu-latest, macos-latest, windows-latest]
-                python-version: [3.6, 3.7, 3.8, 3.9]
+                python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
                 special: ['']
                 include:
                     -   os: ubuntu-latest
                         special: '; pre-release'
-                        python-version: 3.9
+                        python-version: "3.10"
                     -   os: ubuntu-latest
                         special: '; no-optional'
-                        python-version: 3.9
-                    -   os: ubuntu-latest
-                        special: '; no-optional'
-                        python-version: '3.10'
+                        python-version: "3.10"
 
         steps:
             -   name: Cancel Previous Runs
@@ -45,16 +42,15 @@ jobs:
 
             -   name: Install dependencies
                 shell: bash
-                env:
-                    SPECIAL: ${{ matrix.special }}
                 run: |
-                    if [[ $SPECIAL == '; no-optional' ]]; then
-                        pip install -e .[test_no_optional]
-                    elif [[ $SPECIAL == '; pre-release' ]]; then
-                        pip install --pre -e .[test] --upgrade --force-reinstall
-                    else
-                        pip install -e .[test]
-                    fi
+                    case "${{ matrix.special }}" in
+                        '; no-optional')
+                            pip install -e .[test_no_optional] ;;
+                        '; pre-release')
+                            pip install --pre -e .[test] --upgrade --force-reinstall ;;
+                        *)
+                            pip install -e .[test] ;;
+                    esac
 
             -   name: Python info
                 run: |
@@ -66,14 +62,13 @@ jobs:
 
             -   name: Test with pytest
                 shell: bash
-                env:
-                    SPECIAL: ${{ matrix.special }}
                 run: |
-                    if [[ $SPECIAL == '; no-optional' ]]; then
-                        pytest --mypy
-                    else
-                        pytest --mypy --doctest-modules
-                    fi
+                    case "${{ matrix.special }}" in
+                        '; no-optional')
+                            pytest ;;
+                        *)
+                            pytest --doctest-modules ;;
+                    esac
 
             -   name: Run codecov
                 uses: codecov/codecov-action@v2
@@ -86,13 +81,15 @@ jobs:
         steps:
             -   uses: actions/checkout@v2
 
-            -   name: Set up Python 3.9 on ubuntu-latest
+            -   name: Set up Python 3.10 on ubuntu-latest
                 uses: actions/setup-python@v2
                 with:
-                    python-version: 3.9
+                    python-version: "3.10"
 
             -   name: Install linters
-                run: pip install flake8 pydocstyle
+                run: |
+                    pip install flake8 pydocstyle mypy
+                    pip install --pre -e .[test] --upgrade
 
             -   name: Python info
                 run: |
@@ -104,8 +101,9 @@ jobs:
 
             -   name: Run flake8
                 run: flake8 docs assertionlib tests
-                continue-on-error: true
 
             -   name: Run pydocstyle
-                run: pydocstyle docs assertionlib tests
-                continue-on-error: true
+                run: pydocstyle assertionlib
+
+            -   name: Run mypy
+                run: mypy assertionlib tests

README.rst

@@ -19,7 +19,8 @@
     :target: https://docs.python.org/3.8/
 .. image:: https://img.shields.io/badge/python-3.9-blue.svg
     :target: https://docs.python.org/3.9/
-
+.. image:: https://img.shields.io/badge/python-3.10-blue.svg
+    :target: https://docs.python.org/3.10/
 
 ##################
 AssertionLib 3.2.1

assertionlib/assertion_functions.py

@@ -28,6 +28,7 @@
 from types import FunctionType
 from itertools import zip_longest
 from typing import (
+    Any,
     Sized,
     Callable,
     TypeVar,
@@ -64,7 +65,7 @@ def str_eq(a: T, b: str, *, str_converter: Callable[[T], str] = repr) -> bool:
 
 
 @to_positional
-def shape_eq(a: ndarray, b: Union[ndarray, Tuple[int, ...]]) -> bool:
+def shape_eq(a: "ndarray[Any, Any]", b: Union["ndarray[Any, Any]", Tuple[int, ...]]) -> bool:
     """Check if the shapes of **a** and **b** are equivalent: :code:`a.shape == getattr(b, 'shape', b)`.
 
     **b** should be either an object with the ``shape`` attribute (*e.g.* a NumPy array)

assertionlib/dataclass.py

@@ -58,7 +58,7 @@ def decorating_function(user_function: FT) -> FT:
         running: Set[Tuple[int, int]] = set()
 
         @wraps(user_function)
-        def wrapper(self, *args: Any, **kwargs: Any) -> Any:
+        def wrapper(self: Any, *args: Any, **kwargs: Any) -> Any:
             key = id(self), get_ident()
             if key in running:
                 return fallback(self, *args, **kwargs)

assertionlib/functions.py

@@ -133,7 +133,7 @@ def to_positional(func: FT) -> FT:
     return func
 
 
-def bind_callable(class_type: Union[type, Any], func: Callable,
+def bind_callable(class_type: Union[type, Any], func: Callable[..., Any],
                   name: Optional[str] = None, warn: bool = True) -> None:
     """Take a callable and use it to create a new assertion method for **class_type**.
 
@@ -184,7 +184,7 @@ def bind_callable(class_type: Union[type, Any], func: Callable,
 def create_assertion_func(func: Callable[..., Any]) -> Callable[..., None]:
     """Construct an assertion function from **func**."""
 
-    def wrapper(self, *args: Any,
+    def wrapper(self: Any, *args: Any,
                 invert: bool = False,
                 exception: Optional[Type[Exception]] = None,
                 post_process: Optional[Callable[[Any], Any]] = None,
@@ -250,7 +250,7 @@ def wrapper(self, *args: Any,
 """
 
 
-def create_assertion_doc(func: Callable) -> str:
+def create_assertion_doc(func: Callable[..., Any]) -> str:
     r"""Create a new NumPy style assertion docstring from the docstring of **func**.
 
     The summary of **funcs'** docstring, if available, is added to the ``"See also"`` section,
@@ -343,19 +343,22 @@ def create_assertion_doc(func: Callable) -> str:
 
 
 #: A dictionary which translates certain __module__ values to an actual valid modules
-MODULE_DICT: Mapping[str, str] = MappingProxyType({
+MODULE_DICT = MappingProxyType({
     'genericpath': 'os.path',
     'posixpath': 'os.path',
     '_operator': 'operator'
 })
 
 
-def _is_builtin_func(func: Callable) -> bool:
+def _is_builtin_func(func: Callable[..., Any]) -> bool:
     """Check if **func** is a builtin function."""
     return isbuiltin(func) and '.' not in getattr(func, '__qualname__', '')
 
 
-def get_sphinx_domain(func: Callable, module_mapping: Mapping[str, str] = MODULE_DICT) -> str:
+def get_sphinx_domain(
+    func: Callable[..., Any],
+    module_mapping: Mapping[str, str] = MODULE_DICT,
+) -> str:
     """Create a Sphinx domain for **func**.
 
     Examples
@@ -440,7 +443,7 @@ def get_sphinx_domain(func: Callable, module_mapping: Mapping[str, str] = MODULE
 })
 
 
-def load_readme(readme: Union[str, bytes, int, os.PathLike],
+def load_readme(readme: Union[str, bytes, int, "os.PathLike[str]", "os.PathLike[bytes]"],
                 replace: Mapping[str, str] = README_MAPPING,
                 **kwargs: Any) -> str:
     r"""Load and return the content of a readme file located in the same directory as this file.

assertionlib/ndrepr.py

@@ -79,9 +79,7 @@
 )
 
 
-from nanoutils import raise_if
-
-from .functions import set_docstring
+from nanoutils import raise_if, set_docstring
 
 if TYPE_CHECKING:
     import numpy as np
@@ -367,7 +365,7 @@ def repr_Signature(self, obj: inspect.Signature, level: int) -> str:  # noqa: N8
 
         return f'{param_accumulate}){ret}'
 
-    def _parse_callable(self, obj: Callable, level: int) -> Tuple[str, str]:
+    def _parse_callable(self, obj: Callable[..., Any], level: int) -> Tuple[str, str]:
         """Create a :class:`str` representation of the name and signature of a callable."""
         # Construct the name of the callable
         name: str = getattr(obj, '__qualname__', obj.__name__)
@@ -462,7 +460,7 @@ def repr_Bond(self, obj: Bond, level: int) -> str:  # noqa: N802
     # NumPy- and Pandas-related methods
 
     @raise_if(NUMPY_EX)
-    def repr_ndarray(self, obj: ndarray, level: int) -> str:
+    def repr_ndarray(self, obj: "ndarray[Any, Any]", level: int) -> str:
         """Create a :class:`str` representation of a :class:`numpy.ndarray` instance."""
         if level <= 0:
             return f'{obj.__class__.__name__}(...)'
@@ -510,7 +508,7 @@ def repr_Dataset(self, obj: Dataset, level: int) -> str:  # noqa: N802
         """Create a :class:`str` representation of a :class:`h5py.Dataset` instance."""
         return repr(obj)
 
-    def _get_ndformatter(self, obj: ndarray) -> _FormatDict:
+    def _get_ndformatter(self, obj: "ndarray[Any, Any]") -> _FormatDict:
         """Return a value for the **formatter** argument in :func:`numpy.printoptions`."""
         if obj.dtype != float and obj.dtype != int:
             return {}

mypy.ini

@@ -1,6 +1,17 @@
 [mypy]
-ignore_missing_imports = True
 warn_unused_ignores = True
 warn_redundant_casts = True
 warn_return_any = True
 show_error_codes = True
+
+[mypy-scm.*]
+ignore_missing_imports = True
+
+[mypy-pandas.*]
+ignore_missing_imports = True
+
+[mypy-h5py.*]
+ignore_missing_imports = True
+
+[mypy-wheel.*]
+ignore_missing_imports = True

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-description-file = README.rst
+description_file = README.rst
 license_files = LICENSE.md
 
 [aliases]

setup.py

@@ -31,7 +31,6 @@
 tests_require_no_optional = [
     'pytest>=5.4.0',
     'pytest-cov',
-    'pytest-mypy>=0.6.2',
 ]
 
 # Requirements for running tests

tests/test_build.py

@@ -6,7 +6,7 @@
 from nanoutils import delete_finally
 
 try:
-    import wheel
+    import wheel  # noqa: F401
 except ModuleNotFoundError as ex:
     WHEEL_EX: "None | ModuleNotFoundError" = ex
 else: