Add type annotations

Author: rkoopmans

.github/workflows/ci-cd.yml

@@ -42,11 +42,34 @@ jobs:
       run: |
         pytest
 
+  Mypy:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          "3.12"
+        ]
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install -r test-requirements.txt -r requirements.txt
+    - name: Run tests
+      run: |
+        mypy --check tinify
+
   Integration_tests:
     if: github.event_name == 'push'
     runs-on: ${{ matrix.os }}
     timeout-minutes: 10
-    needs: Unit_tests
+    needs: [Unit_tests, Mypy, Unit_Tests_Py27]
     strategy:
       fail-fast: false
       matrix:

CHANGES.md

@@ -1,5 +1,6 @@
-## 1.6.1
+## 1.7.0
 
+* Added type annotations
 * Updated runtime support
     * Dropped python 3.7
     * Added Python 3.12

setup.py

@@ -11,7 +11,10 @@
 from version import __version__
 
 install_require = ["requests >= 2.7.0, < 3.0.0"]
-tests_require = ["pytest", "pytest-xdist", "requests-mock"]
+tests_require = ["pytest", "pytest-xdist", "requests-mock", "types-requests"]
+
+if sys.version_info.major > 2:
+    tests_require.append("mypy")
 
 setup(
     name="tinify",
@@ -26,7 +29,7 @@
     packages=["tinify"],
     package_data={
         "": ["LICENSE", "README.md"],
-        "tinify": ["data/cacert.pem"],
+        "tinify": ["data/cacert.pem", "py.typed"],
     },
     install_requires=install_require,
     tests_require=tests_require,

test/__init__.py

@@ -8,6 +8,13 @@
 if not os.environ.get("TINIFY_KEY"):
     sys.exit("Set the TINIFY_KEY environment variable.")
 
+try:
+    from typing import TYPE_CHECKING
+    if TYPE_CHECKING:
+        from tinify.source import Source
+except ImportError:
+    pass
+
 
 @contextmanager
 def create_named_tmpfile():
@@ -22,20 +29,26 @@ def create_named_tmpfile():
     finally:
         os.unlink(tmp.name)
 
+@pytest.fixture(scope="module", autouse=True)
+def tinify_patch():
+    tinify.key = os.environ.get("TINIFY_KEY")
+    tinify.proxy = os.environ.get("TINIFY_PROXY")
+
+    yield
+
+    tinify.key = None
+    tinify.proxy = None
 
 # Fixture for shared resources
 @pytest.fixture(scope="module")
 def optimized_image():
-    tinify.key = os.environ.get("TINIFY_KEY")
-    tinify.proxy = os.environ.get("TINIFY_PROXY")
-
     unoptimized_path = os.path.join(
         os.path.dirname(__file__), "examples", "voormedia.png"
     )
     return tinify.from_file(unoptimized_path)
 
 
-def test_should_compress_from_file(optimized_image):
+def test_should_compress_from_file(optimized_image): # type: (Source) -> None
     with create_named_tmpfile() as tmp:
         optimized_image.to_file(tmp)
 
@@ -69,10 +82,9 @@ def test_should_compress_from_url():
         assert b"Copyright Voormedia" not in contents
 
 
-def test_should_resize(optimized_image):
+def test_should_resize(optimized_image): # type: (Source) -> None
     with create_named_tmpfile() as tmp:
         optimized_image.resize(method="fit", width=50, height=20).to_file(tmp)
-
         size = os.path.getsize(tmp)
         with open(tmp, "rb") as f:
             contents = f.read()
@@ -84,7 +96,7 @@ def test_should_resize(optimized_image):
         assert b"Copyright Voormedia" not in contents
 
 
-def test_should_preserve_metadata(optimized_image):
+def test_should_preserve_metadata(optimized_image): # type: (Source) -> None
     with create_named_tmpfile() as tmp:
         optimized_image.preserve("copyright", "creation").to_file(tmp)
 
@@ -99,11 +111,30 @@ def test_should_preserve_metadata(optimized_image):
         assert b"Copyright Voormedia" in contents
 
 
-def test_should_transcode_image(optimized_image):
+def test_should_transcode_image(optimized_image): # type: (Source) -> None
     with create_named_tmpfile() as tmp:
-        optimized_image.convert(type=["image/webp"]).to_file(tmp)
+        conv = optimized_image.convert(type=["image/webp"])
+        conv.to_file(tmp)
         with open(tmp, "rb") as f:
             content = f.read()
 
         assert b"RIFF" == content[:4]
         assert b"WEBP" == content[8:12]
+
+        assert conv.result().size < optimized_image.result().size
+        assert conv.result().media_type == "image/webp"
+        assert conv.result().extension == "webp"
+
+
+def test_should_handle_invalid_key():
+    invalid_key = "invalid_key"
+    tinify.key = invalid_key
+    with pytest.raises(tinify.AccountError):
+        tinify.from_url(
+            "https://raw.githubusercontent.com/tinify/tinify-python/master/test/examples/voormedia.png"
+        )
+    tinify.key = os.environ.get("TINIFY_KEY")
+
+def test_should_handle_invalid_image():
+    with pytest.raises(tinify.ClientError):
+        tinify.from_buffer("invalid_image.png")

test/integration.py

@@ -6,7 +6,7 @@
 
 @pytest.fixture
 def dummy_file():
-    return os.path.join(os.path.dirname(__file__), "examples", "dummy.png")
+    return os.path.join(os.path.dirname(__file__), "..", "examples", "dummy.png")
 
 
 @pytest.fixture(autouse=True)