upd docs and typehinting

AndreiDrang · Dec 8, 2023 · eda564e · eda564e
1 parent a53de1e
commit eda564e
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 26 deletions.
diff --git a/src/python_rucaptcha/amazon_waf.py b/src/python_rucaptcha/amazon_waf.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import AmazonWAFCaptchaEnm
 
@@ -9,7 +11,7 @@ def __init__(
         websiteKey: str,
         iv: str,
         context: str,
-        method: str = AmazonWAFCaptchaEnm.AmazonTaskProxyless.value,
+        method: Union[str, AmazonWAFCaptchaEnm] = AmazonWAFCaptchaEnm.AmazonTaskProxyless,
         *args,
         **kwargs,
     ):

diff --git a/src/python_rucaptcha/audio_captcha.py b/src/python_rucaptcha/audio_captcha.py
@@ -74,7 +74,7 @@ def __init__(
             Dict with full server response
 
         Notes:
-            https://rucaptcha.com/api-rucaptcha#audio
+            https://rucaptcha.com/api-docs/audio
         """
 
         super().__init__(method=AudioCaptchaEnm.AudioTask.value, *args, **kwargs)

diff --git a/src/python_rucaptcha/capy_puzzle.py b/src/python_rucaptcha/capy_puzzle.py
@@ -1,10 +1,17 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import CapyPuzzleEnm
 
 
 class CapyPuzzle(BaseCaptcha):
     def __init__(
-        self, websiteURL: str, websiteKey: str, method: str = CapyPuzzleEnm.CapyTaskProxyless.value, *args, **kwargs
+        self,
+        websiteURL: str,
+        websiteKey: str,
+        method: Union[str, CapyPuzzleEnm] = CapyPuzzleEnm.CapyTaskProxyless,
+        *args,
+        **kwargs,
     ):
         """
         The class is used to work with CapyPuzzle.
@@ -102,7 +109,7 @@ def __init__(
         if method not in CapyPuzzleEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {CapyPuzzleEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -118,7 +125,7 @@ def captcha_handler(self, **kwargs):
 
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/fun_captcha.py b/src/python_rucaptcha/fun_captcha.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import FunCaptchaEnm
 
@@ -7,7 +9,7 @@ def __init__(
         self,
         websiteURL: str,
         websitePublicKey: str,
-        method: str = FunCaptchaEnm.FunCaptchaTaskProxyless.value,
+        method: Union[str, FunCaptchaEnm] = FunCaptchaEnm.FunCaptchaTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -73,7 +75,7 @@ def __init__(
         if method not in FunCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {FunCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -88,7 +90,7 @@ def captcha_handler(self, **kwargs):
         """
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/hcaptcha.py b/src/python_rucaptcha/hcaptcha.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import HCaptchaEnm
 
@@ -7,7 +9,7 @@ def __init__(
         self,
         websiteURL: str,
         websiteKey: str,
-        method: str = HCaptchaEnm.HCaptchaTaskProxyless.value,
+        method: Union[str, HCaptchaEnm] = HCaptchaEnm.HCaptchaTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -33,7 +35,7 @@ def __init__(
                "solution":{
                   "token":"P1_eyJ0eXAiOiJKV...1LDq89KyJ5A",
                   "respKey":"E0_eyJ0eXAiOiJK...y2w5_YbP8PGuJBBo",
-                  "userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.5614.0 Safari/537.36",
+                  "userAgent":"Mozilla/5.0 (.......",
                   "gRecaptchaResponse":"P1_eyJ0eXAiOiJKV...1LDq89KyJ5A"
                },
                "cost":"0.00299",
@@ -55,7 +57,7 @@ def __init__(
                "solution":{
                   "token":"P1_eyJ0eXAiOiJKV...1LDq89KyJ5A",
                   "respKey":"E0_eyJ0eXAiOiJK...y2w5_YbP8PGuJBBo",
-                  "userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.5614.0 Safari/537.36",
+                  "userAgent":"Mozilla/5.0 (........",
                   "gRecaptchaResponse":"P1_eyJ0eXAiOiJKV...1LDq89KyJ5A"
                },
                "cost":"0.00299",
@@ -80,7 +82,7 @@ def __init__(
         if method not in HCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {HCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -96,7 +98,7 @@ def captcha_handler(self, **kwargs):
 
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/key_captcha.py b/src/python_rucaptcha/key_captcha.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import KeyCaptchaEnm
 
@@ -10,7 +12,7 @@ def __init__(
         s_s_c_session_id: str,
         s_s_c_web_server_sign: str,
         s_s_c_web_server_sign2: str,
-        method: str = KeyCaptchaEnm.KeyCaptchaTaskProxyless.value,
+        method: Union[str, KeyCaptchaEnm] = KeyCaptchaEnm.KeyCaptchaTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -62,7 +64,7 @@ def __init__(
             Dict with full server response
 
         Notes:
-            https://rucaptcha.com/api-rucaptcha#solving_keycaptcha
+            https://rucaptcha.com/api-docs/keycaptcha
         """
         super().__init__(method=method, *args, **kwargs)
 
@@ -80,7 +82,7 @@ def __init__(
         if method not in KeyCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {KeyCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -96,7 +98,7 @@ def captcha_handler(self, **kwargs):
 
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/lemin_captcha.py b/src/python_rucaptcha/lemin_captcha.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import LeminCaptchaEnm
 
@@ -8,7 +10,7 @@ def __init__(
         websiteURL: str,
         captchaId: str,
         div_id: str,
-        method: str = LeminCaptchaEnm.LeminTaskProxyless.value,
+        method: Union[str, LeminCaptchaEnm] = LeminCaptchaEnm.LeminTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -82,7 +84,7 @@ def __init__(
         if method not in LeminCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {LeminCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -97,7 +99,7 @@ def captcha_handler(self, **kwargs):
         """
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/re_captcha.py b/src/python_rucaptcha/re_captcha.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import ReCaptchaEnm
 
@@ -8,7 +10,7 @@ def __init__(
         websiteURL: str,
         websiteKey: str,
         minScore: float = 0.3,
-        method: str = ReCaptchaEnm.RecaptchaV2TaskProxyless.value,
+        method: Union[str, ReCaptchaEnm] = ReCaptchaEnm.RecaptchaV2TaskProxyless.value,
         *args,
         **kwargs,
     ):
@@ -127,7 +129,9 @@ def __init__(
 
         Notes:
             https://rucaptcha.com/api-docs/recaptcha-v2
+
             https://rucaptcha.com/api-docs/recaptcha-v3
+
             https://rucaptcha.com/api-docs/recaptcha-v2-enterprise
         """
         super().__init__(method=method, *args, **kwargs)
@@ -140,7 +144,7 @@ def __init__(
         if method not in ReCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {ReCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -155,7 +159,7 @@ def captcha_handler(self, **kwargs):
         """
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method
 

diff --git a/src/python_rucaptcha/turnstile.py b/src/python_rucaptcha/turnstile.py
@@ -1,3 +1,5 @@
+from typing import Union
+
 from .core.base import BaseCaptcha
 from .core.enums import TurnstileCaptchaEnm
 
@@ -8,7 +10,7 @@ def __init__(
         websiteURL: str,
         websiteKey: str,
         userAgent: str,
-        method: str = TurnstileCaptchaEnm.TurnstileTaskProxyless.value,
+        method: Union[str, TurnstileCaptchaEnm] = TurnstileCaptchaEnm.TurnstileTaskProxyless,
         *args,
         **kwargs,
     ):
@@ -81,7 +83,7 @@ def __init__(
         if method not in TurnstileCaptchaEnm.list_values():
             raise ValueError(f"Invalid method parameter set, available - {TurnstileCaptchaEnm.list_values()}")
 
-    def captcha_handler(self, **kwargs):
+    def captcha_handler(self, **kwargs) -> dict:
         """
         Sync solving method
 
@@ -96,7 +98,7 @@ def captcha_handler(self, **kwargs):
         """
         return self._processing_response(**kwargs)
 
-    async def aio_captcha_handler(self):
+    async def aio_captcha_handler(self) -> dict:
         """
         Async solving method