🔨 run mypy in pre-commit

Author: ianardee

.github/workflows/linting.yml

@@ -25,24 +25,24 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-dev-${{ hashFiles('**/setup.py') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ${{ runner.os }}-dev-
+          ${{ runner.os }}-pip-
 
     - name: Install dependencies
       # We install the full dev requirements to make sure everything installs OK
       run: |
         python -m pip install pip
         pip install -e .[dev]
 
-    - name: Analysing the code with Black
-      run: |
-        black --check .
-
-    - name: Analysing the code with mypy
-      run: |
-        mypy --install-types --non-interactive ./mindee
+    - name: Cache pre-commit
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pre-commit
+        key: ${{ runner.os }}-prec-${{ hashFiles('.pre-commit-config.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-prec-
 
-    - name: Analysing the code with pylint
+    - name: Run all static analysis
       run: |
-        pylint ./mindee
+        pre-commit run --all-files

.pre-commit-config.yaml

@@ -32,3 +32,14 @@ repos:
         args: [
           "-j2"
         ]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.942
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - toml
+          - pikepdf
+          - types-pytz
+          - types-requests
+          - types-setuptools

README.md

@@ -6,7 +6,7 @@ Here's the TL;DR of getting started.
 First, get an [API Key](https://developers.mindee.com/docs/make-your-first-request#create-an-api-key)
 
 Then, install this library:
-```shell script
+```shell
 pip install mindee
 ```
 

mindee/client.py

@@ -319,7 +319,7 @@ def doc_from_b64string(
         Load a document from a base64 encoded string.
 
         :param input_string: Input to parse as base64 string
-        :param filename: The url_name of the file (without the path)
+        :param filename: The name of the file (without the path)
         :param cut_pdf_mode: Number (between 1 and 3 incl.) of pages to reconstruct a pdf with.
 
             * if 1: pages [0]
@@ -350,7 +350,7 @@ def doc_from_bytes(
         Load a document from raw bytes.
 
         :param input_bytes: Raw byte input
-        :param filename: The url_name of the file (without the path)
+        :param filename: The name of the file (without the path)
         :param cut_pdf_mode: Number (between 1 and 3 incl.) of pages to reconstruct a PDF with.
 
             * if 1: pages [0]

pyproject.toml

@@ -9,10 +9,6 @@ strict_equality = true
 disallow_any_unimported = true
 disallow_untyped_calls = true
 
-[[tool.mypy.overrides]]
-module = ['pikepdf',]
-ignore_missing_imports = true
-
 [tool.pylic]
 safe_licenses = [
   "Apache Software License",

setup.py

@@ -6,8 +6,8 @@
 
 dir_path = os.path.dirname(os.path.realpath(__file__))
 version_file = os.path.join(dir_path, "mindee", "version")
-with open(version_file, "r", encoding="utf-8") as version_file:
-    __version__ = version_file.read().strip()
+with open(version_file, "r", encoding="utf-8") as file_p:
+    __version__ = file_p.read().strip()
 
 setup(
     version=__version__,