Add py.typed marker and complete type annotations

docs/conf.py

@@ -44,6 +44,10 @@
     "sphinx.ext.viewcode",
 ]
 
+autodoc_default_options = {
+    "exclude-members": "type",
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

pyproject.toml

@@ -31,6 +31,9 @@ async = ["httpx>=0.24"]
 tests = ["pytest", "retry", "selenium"]
 docs = ["sphinx"]
 
+[tool.setuptools.package-data]
+python_anticaptcha = ["py.typed"]
+
 [tool.setuptools-scm]
 fallback_version = "0.0.0"
 

python_anticaptcha/base.py

@@ -5,10 +5,12 @@
 import time
 import json
 import warnings
+from types import TracebackType
 from typing import Any
 
 from urllib.parse import urljoin
 from .exceptions import AnticaptchaException
+from .tasks import BaseTask
 
 SLEEP_EVERY_CHECK_FINISHED = 3
 MAXIMUM_JOIN_TIME = 60 * 5
@@ -111,14 +113,19 @@ def __init__(
         )
         self.session = requests.Session()
 
-    def __enter__(self):
+    def __enter__(self) -> AnticaptchaClient:
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> bool:
         self.session.close()
         return False
 
-    def close(self):
+    def close(self) -> None:
         self.session.close()
 
     def __repr__(self) -> str:
@@ -146,7 +153,7 @@ def _check_response(self, response: dict[str, Any]) -> None:
                 response["errorId"], response["errorCode"], response["errorDescription"]
             )
 
-    def createTask(self, task: Any) -> Job:
+    def createTask(self, task: BaseTask) -> Job:
         request = {
             "clientKey": self.client_key,
             "task": task.serialize(),
@@ -161,7 +168,7 @@ def createTask(self, task: Any) -> Job:
         self._check_response(response)
         return Job(self, response["taskId"])
 
-    def createTaskSmee(self, task: Any, timeout: int = MAXIMUM_JOIN_TIME) -> Job:
+    def createTaskSmee(self, task: BaseTask, timeout: int = MAXIMUM_JOIN_TIME) -> Job:
         """
         Beta method to stream response from smee.io
         """

python_anticaptcha/exceptions.py

@@ -15,7 +15,7 @@ def __init__(self, error_id: int | str | None, error_code: int | str, error_desc
 
 
 class InvalidWidthException(AnticaptchaException):
-    def __init__(self, width):
+    def __init__(self, width: int) -> None:
         self.width = width
         msg = "Invalid width (%s). Can be one of these: 100, 50, 33, 25." % (
             self.width,
@@ -24,7 +24,7 @@ def __init__(self, width):
 
 
 class MissingNameException(AnticaptchaException):
-    def __init__(self, cls):
+    def __init__(self, cls: type) -> None:
         self.cls = cls
         msg = 'Missing name data in {0}. Provide {0}.__init__(name="X") or {0}.serialize(name="X")'.format(
             str(self.cls)