TYP: switch to GHA for mypy instead of pre-commit

.github/workflows/type-checking.yaml

@@ -0,0 +1,37 @@
+name: type checking
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths-ignore:
+      - README.md
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: mypy
+    timeout-minutes: 10
+
+    concurrency:
+      group: ${{ github.ref }}-dev
+      cancel-in-progress: true
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Build yt + type check deps
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install .[typecheck]
+
+    - name: Run mypy
+      run: mypy inifix

.pre-commit-config.yaml

@@ -42,8 +42,3 @@ repos:
     hooks:
       - id: flake8
         additional_dependencies: [flake8-bugbear]
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.931
-    hooks:
-      - id: mypy

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.0.1] - 2022-01-30
+
+TYP: improve type-correctness [PR #93](https://github.com/neutrinoceros/inifix/pull/93)
+
 ## [1.0.0] - 2022-01-15
 
 The API is now declared stable and any future intentionally breaking change
@@ -16,7 +20,7 @@ will follow a deprecation cycle.
 - TYP: add mypy conf, add missing type annotations
 
 
-https://github.com/neutrinoceros/inifix/pull/91
+[PR #91](https://github.com/neutrinoceros/inifix/pull/91)
 
 ## [0.11.2] - 2022-01-05
 

README.md

@@ -1,7 +1,7 @@
 # `inifix`
 
 [![PyPI](https://img.shields.io/pypi/v/inifix.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/inifix/)
-[![PyPI](https://img.shields.io/pypi/pyversions/inifix/1.0.0?logo=python&logoColor=white&label=Python)](https://pypi.org/project/inifix/)
+[![PyPI](https://img.shields.io/pypi/pyversions/inifix/1.0.1?logo=python&logoColor=white&label=Python)](https://pypi.org/project/inifix/)
 [![codecov](https://codecov.io/gh/neutrinoceros/inifix/branch/main/graph/badge.svg)](https://codecov.io/gh/neutrinoceros/inifix)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neutrinoceros/inifix/main.svg)](https://results.pre-commit.ci/badge/github/neutrinoceros/inifix/main.svg)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

inifix/__init__.py

@@ -2,4 +2,4 @@
 from .io import load
 from .validation import validate_inifile_schema
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"

inifix/_typing.py

@@ -3,19 +3,18 @@
 from typing import AnyStr
 from typing import Dict
 from typing import Iterable
-from typing import Optional
 from typing import TypeVar
 from typing import Union
 
-T = TypeVar("T")
-Scalar = Union[int, float, bool, str]
-IterableOrSingle = Union[Iterable[T], T]
-
 if sys.version_info >= (3, 9):
     PathLike = Union[AnyStr, os.PathLike[AnyStr]]
 else:
     PathLike = Union[AnyStr, os.PathLike]
 
+T = TypeVar("T")
+Scalar = Union[int, float, bool, str]
+IterableOrSingle = Union[Iterable[T], T]
+
 # these types are used to validate schemas internally at type-checking time
 SectionT = Dict[str, IterableOrSingle[Scalar]]
-InifixConfT = Dict[Optional[str], SectionT]
+InifixConfT = Union[Dict[str, SectionT], SectionT]

inifix/io.py

@@ -132,7 +132,9 @@ def _tokenize_line(
 
 def _from_file_descriptor(file: TextIO) -> InifixConfT:
     data = file.read()
-    container: InifixConfT = {}
+
+    # see https://github.com/python/mypy/issues/6463
+    container: InifixConfT = {}  # type: ignore[assignment]
     lines = _normalize_data(data)
     if not "".join(lines):
         raise ValueError(f"{file.name!r} appears to be empty.")

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = inifix
-version = 1.0.0
+version = 1.0.1
 description = I/O facility for Idefix/Pluto configuration files
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -37,6 +37,8 @@ console_scripts =
 dev =
     pre-commit
     pytest>=6.1
+typecheck =
+    mypy==0.931
 
 [flake8]
 exclude = *__init__.py