Add type hints to api functions class

.github/workflows/coverage-lint.yml

@@ -34,7 +34,7 @@ jobs:
         run: pylint --disable=all --enable=import-error tests/
 
       - name: Coverage
-        run: pytest --cov=h3 --full-trace --cov-report=xml
+        run: pytest --cov=h3 --full-trace --cov-report=xml tests/*.py
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3.0.0

.github/workflows/tests.yml

@@ -12,6 +12,7 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
+      fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
         python-version: ['2.7', '3.5', '3.6', '3.7', '3.8', '3.9', '3.10']
@@ -47,4 +48,11 @@ jobs:
           pip install .[all]
 
       - name: Tests
-        run: pytest --cov=h3 --full-trace
+        run: pytest --cov=h3 --full-trace tests/*.py
+        shell: bash
+
+      - name: Type Tests
+        if: matrix.python-version != '2.7' && matrix.python-version != '3.5'
+        run: |
+          pytest --mypy-same-process --mypy-ini-file=mypy.ini tests/*.yml
+        shell: bash

makefile

@@ -30,7 +30,10 @@ purge: clear
 	-@rm -rf env
 
 test:
-	env/bin/pytest tests/* --cov=h3 --cov-report term-missing --durations=10
+	env/bin/pytest tests/*.py --cov=h3 --cov-report term-missing --durations=10
+
+test-types:
+	env/bin/pytest tests/*.yml --mypy-same-process --durations=10 --mypy-ini-file=mypy.ini
 
 lint:
 	env/bin/flake8 src/h3 setup.py tests

mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+ignore_missing_imports = True

setup.py

@@ -18,6 +18,16 @@ def long_desc():
     return long_description
 
 
+numpy_requires = ['numpy']
+test_requires = [
+    'pytest',
+    'pytest-cov',
+    'flake8',
+    'pylint',
+    'pytest-mypy-plugins==1.9.3;python_version>="3.6"',
+]
+install_requires = ['typing_extensions;python_version<"3.8"']
+
 setup(
     name = 'h3',
     version = about['__version__'],
@@ -34,11 +44,18 @@ def long_desc():
         'src',
         exclude = ["*.tests", "*.tests.*", "tests.*", "tests"],
     ),
+    package_data={
+        'h3': [
+            'py.typed',
+        ]
+    },
+    zip_safe=False,
     package_dir = {'': 'src'},
     cmake_languages = ('C'),
+    install_requires=install_requires,
     extras_require={
-        'numpy': ['numpy'],
-        'test': ['pytest', 'pytest-cov', 'flake8', 'pylint'],
-        'all': ['numpy', 'pytest', 'pytest-cov', 'flake8', 'pylint'],
+        'numpy': numpy_requires,
+        'test': test_requires,
+        'all': numpy_requires + test_requires,
     },
 )