Add autocomplete + tests + type checking (#1041)

* Add autocomplete + tests + type checking

* add isort as a dev dependency

* also reorder attributes definition for readability

* add types for mypy

* add simplejson types

* do not raise on follow imports with mypy in CI

* remove unused mypy plugins

* more readable code generation ?

* Move static import formatter to a separate util and add it to makefile

* add check to workflow

* pragma no cover in init.py

.github/workflows/python-quality.yml

@@ -18,15 +18,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install dependencies
-      run: |
-        pip install --upgrade pip
-        pip install .[dev]
-    - run: black --check tests src
-    - run: isort --check-only tests src
-    - run: flake8 tests src
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .[dev]
+      - run: black --check tests src
+      - run: isort --check-only tests src
+      - run: flake8 tests src
+      - run: python utils/check_static_imports.py
+
+      # Run type checking at least on huggingface_hub root file to check all modules
+      # that can be lazy-loaded actually exist.
+      - run: mypy src/huggingface_hub/__init__.py --follow-imports=silent

Makefile

@@ -1,17 +1,19 @@
 .PHONY: quality style test
 
 
-check_dirs := tests src setup.py
+check_dirs := tests src utils setup.py
 
 
 quality:
 	black --check $(check_dirs)
 	isort --check-only $(check_dirs)
 	flake8 $(check_dirs)
+	python utils/check_static_imports.py
 
 style:
 	black $(check_dirs)
 	isort $(check_dirs)
+	python utils/check_static_imports.py --update-file
 
 test:
 	HUGGINGFACE_CO_STAGING=1 pytest -sv ./tests/

setup.py

@@ -36,18 +36,21 @@ def get_version() -> str:
 extras["tensorflow"] = ["tensorflow", "pydot", "graphviz"]
 
 extras["testing"] = [
+    "datasets",
+    "isort>=5.5.4",
+    "jedi",
+    "Jinja2",
     "pytest",
     "pytest-cov",
-    "datasets",
     "soundfile",
-    "Jinja2",
 ]
 
 extras["quality"] = [
     "black==22.3",
-    "isort>=5.5.4",
     "flake8>=3.8.3",
     "flake8-bugbear",
+    "isort>=5.5.4",
+    "mypy",
 ]
 
 extras["all"] = extras["testing"] + extras["quality"]