python3-capsolver 0.9.4__py3-none-any.whl → 1.0.1__py3-none-any.whl

python3_capsolver/friendly_captcha.py

@@ -0,0 +1,105 @@
+from typing import Union
+
+from .core.base import CaptchaParams
+from .core.enum import CaptchaTypeEnm
+
+__all__ = ("FriendlyCaptcha",)
+
+
+class FriendlyCaptcha(CaptchaParams):
+    """
+    The class is used to work with Capsolver FriendlyCaptchaTaskProxyless methods.
+
+    Args:
+        api_key: Capsolver API key
+        captcha_type: Captcha type name, like ``FriendlyCaptchaTaskProxyless`` and etc.
+        kwargs: additional params for client, like captcha waiting time
+                    available keys:
+                     - sleep_time: int - captcha solution waintig time in sec
+                     - request_url: str - API address for sending requests,
+                                            else official will be used
+
+    Examples:
+        >>> from python3_capsolver.core.enum import CaptchaTypeEnm
+        >>> from python3_capsolver.friendly_captcha import FriendlyCaptcha
+        >>> FriendlyCaptcha(api_key="CAP-XXXXX",
+        ...         captcha_type=CaptchaTypeEnm.FriendlyCaptchaTaskProxyless,
+        ...         ).captcha_handler(task_payload={
+        ...                                 "websiteURL": "https://www.yourwebsite.com",
+        ...                                 "proxy": "ip:port:user:pass"
+        ...                         })
+        {
+            "errorId":0,
+            "errorCode":"None",
+            "errorDescription":"None",
+            "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+            "status":"ready",
+            "solution":{
+                "cookies": "cf_clearance=_VPxxxx",
+                "headers": {
+                    "sec-ch-ua": "\"Chromium\";v=\"130\", \"Google Chrome\";v=\"130\", \"Not?A_Brand\";v=\"99\"",
+                    "sec-ch-ua-platform": "\"Windows\"",
+                    "accept": "text/html,axxxx",
+                    "User-Agent": "Mozilla/5.0xxxx",
+                    "sec-ch-ua-mobile": "?0",
+                    "sec-fetch-user": "?1",
+                    "referer": "https://www.yourwebsite.com",
+                    "Sec-Fetch-Dest": "document",
+                    "Sec-Fetch-Mode": "navigate",
+                    "Sec-Fetch-Site": "same-origin",
+                    "accept-language": "en",
+                },
+                "page_url": "https://www.yourwebsite.com",
+                "proxy": "your proxyxxxx",
+                "token": "_VPCTZXP5bhinxxxx"
+            }
+        }
+
+        >>> import asyncio
+        >>> from python3_capsolver.core.enum import CaptchaTypeEnm
+        >>> from python3_capsolver.friendly_captcha import FriendlyCaptcha
+        >>> asyncio.run(FriendlyCaptcha(api_key="CAP-XXXXX",
+        ...         captcha_type=CaptchaTypeEnm.FriendlyCaptchaTaskProxyless,
+        ...         ).aio_captcha_handler(task_payload={
+        ...                                 "websiteURL": "https://www.yourwebsite.com",
+        ...                                 "proxy": "ip:port:user:pass"
+        ...                         }))
+        {
+            "errorId":0,
+            "errorCode":"None",
+            "errorDescription":"None",
+            "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+            "status":"ready",
+            "solution":{
+                "cookies": "cf_clearance=_VPxxxx",
+                "headers": {
+                    "sec-ch-ua": "\"Chromium\";v=\"130\", \"Google Chrome\";v=\"130\", \"Not?A_Brand\";v=\"99\"",
+                    "sec-ch-ua-platform": "\"Windows\"",
+                    "accept": "text/html,axxxx",
+                    "User-Agent": "Mozilla/5.0xxxx",
+                    "sec-ch-ua-mobile": "?0",
+                    "sec-fetch-user": "?1",
+                    "referer": "https://www.yourwebsite.com",
+                    "Sec-Fetch-Dest": "document",
+                    "Sec-Fetch-Mode": "navigate",
+                    "Sec-Fetch-Site": "same-origin",
+                    "accept-language": "en",
+                },
+                "page_url": "https://www.yourwebsite.com",
+                "proxy": "your proxyxxxx",
+                "token": "_VPCTZXP5bhinxxxx"
+            }
+        }
+
+    Notes:
+        https://docs.capsolver.com/en/guide/captcha/FriendlyCaptcha/
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        captcha_type: Union[CaptchaTypeEnm, str] = CaptchaTypeEnm.FriendlyCaptchaTaskProxyless,
+        **kwargs,
+    ):
+
+        super().__init__(api_key=api_key, captcha_type=captcha_type, **kwargs)

python3_capsolver/gee_test.py

@@ -1,108 +1,76 @@
 from typing import Union
 
-from python3_capsolver.core.base import BaseCaptcha
-from python3_capsolver.core.enum import GeeTestCaptchaTypeEnm
-from python3_capsolver.core.serializer import GeeTestSer, CaptchaResponseSer
+from .core.base import CaptchaParams
+from .core.enum import CaptchaTypeEnm
 
+__all__ = ("GeeTest",)
 
-class GeeTest(BaseCaptcha):
+
+class GeeTest(CaptchaParams):
     """
-    The class is used to work with Capsolver GeeTestTask methods.
+    The class is used to work with Capsolver GeeTestTaskProxyLess methods.
 
     Args:
         api_key: Capsolver API key
         captcha_type: Captcha type name, like ``GeeTestTaskProxyLess`` and etc.
-        websiteURL: Address of a webpage with Geetest
-        gt: The domain public key, rarely updated
-        challenge: If you need to solve Geetest V3 you must use this parameter, don't need if you need to solve GeetestV4
+        kwargs: additional params for client, like captcha waiting time
+                    available keys:
+                     - sleep_time: int - captcha solution waintig time in sec
+                     - request_url: str - API address for sending requests,
+                                            else official will be used
 
     Examples:
-        >>> GeeTest(api_key="CAI-1324...",
-        ...         captcha_type=GeeTestCaptchaTypeEnm.GeeTestTaskProxyLess,
-        ...         websiteURL="https://www.geetest.com/en/demo",
-        ...         gt="022397c99c9f646f6477822485f30404",
-        ...         challenge='12345678abc90123d45678ef90123a456b'
-        ...        ).captcha_handler()
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'gRecaptchaResponse': '44795sds...'}
-                          )
-
-        >>> GeeTest(api_key="CAI-1324...",
-        ...         captcha_type=GeeTestCaptchaTypeEnm.GeeTestTask,
-        ...         websiteURL="https://www.geetest.com/en/demo",
-        ...         gt="022397c99c9f646f6477822485f30404",
-        ...         challenge='12345678abc90123d45678ef90123a456b'
-        ...         proxy="socks5:192.191.100.10:4780:user:pwd"
-        ...        ).captcha_handler()
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'gRecaptchaResponse': '44795sds...'}
-                          )
-
-        >>> await GeeTest(api_key="CAI-1324...",
-        ...         captcha_type="GeetestTaskProxyless",
-        ...         websiteURL="https://www.geetest.com/en/demo",
-        ...         gt="022397c99c9f646f6477822485f30404",
-        ...         challenge='12345678abc90123d45678ef90123a456b'
-        ...        ).aio_captcha_handler()
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'gRecaptchaResponse': '44795sds...'}
-                          )
-
-
-    Returns:
-        CaptchaResponseSer model with full server response
+        >>> from python3_capsolver.core.enum import CaptchaTypeEnm
+        >>> from python3_capsolver.gee_test import GeeTest
+
+        >>> GeeTest(api_key="CAP-XXXXX",
+        ...         captcha_type=CaptchaTypeEnm.GeeTestTaskProxyLess,
+        ...         ).captcha_handler(task_payload={
+        ...                                 "websiteURL": "https://www.geetest.com/en/demo",
+        ...                                 "gt": "022397c99c9f646f6477822485f30404",
+        ...                                 "challenge": "12345678abc90123d45678ef90123a456b",
+        ...                         })
+        {
+            "errorId":0,
+            "errorCode":"None",
+            "errorDescription":"None",
+            "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+            "status":"ready",
+            "solution":{
+                "challenge": "xxx",
+                "validate": "xxx"
+            }
+        }
+
+        >>> import asyncio
+        >>> from python3_capsolver.core.enum import CaptchaTypeEnm
+        >>> from python3_capsolver.gee_test import GeeTest
+
+        >>> asyncio.run(GeeTest(api_key="CAP-XXXXX",
+        ...         captcha_type=CaptchaTypeEnm.GeeTestTaskProxyLess,
+        ...         ).aio_captcha_handler(task_payload={
+        ...                                 "websiteURL": "https://www.geetest.com/en/demo",
+        ...                                 "gt": "022397c99c9f646f6477822485f30404",
+        ...                                 "challenge": "12345678abc90123d45678ef90123a456b",
+        ...                         }))
+        {
+            "errorId":0,
+            "errorCode":"None",
+            "errorDescription":"None",
+            "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+            "status":"ready",
+            "solution":{
+                "challenge": "xxx",
+                "validate": "xxx"
+            }
+        }
 
     Notes:
-        https://docs.capsolver.com/guide/captcha/Geetest.html
+        https://docs.capsolver.com/en/guide/captcha/Geetest/
     """
 
     def __init__(
-        self, captcha_type: Union[GeeTestCaptchaTypeEnm, str], websiteURL: str, gt: str, challenge: str, *args, **kwargs
+        self, api_key: str, captcha_type: Union[CaptchaTypeEnm, str] = CaptchaTypeEnm.GeeTestTaskProxyLess, **kwargs
     ):
-        super().__init__(*args, **kwargs)
-
-        if captcha_type in GeeTestCaptchaTypeEnm.list():
-            self.task_params = GeeTestSer(**locals()).dict()
-        else:
-            raise ValueError(
-                f"""Invalid `captcha_type` parameter set for `{self.__class__.__name__}`,
-                available - {GeeTestCaptchaTypeEnm.list()}"""
-            )
-        for key in kwargs:
-            self.task_params.update({key: kwargs[key]})
-
-    def captcha_handler(self) -> CaptchaResponseSer:
-        """
-        Sync solving method
-
-        Returns:
-            CaptchaResponseSer model with full service response
-
-        Notes:
-            Check class docstring for more info
-        """
-        return self._processing_captcha(create_params=self.task_params)
-
-    async def aio_captcha_handler(self) -> CaptchaResponseSer:
-        """
-        Async  solving method
-
-        Returns:
-            CaptchaResponseSer model with full service response
 
-        Notes:
-            Check class docstring for more info
-        """
-        return await self._aio_processing_captcha(create_params=self.task_params)
+        super().__init__(api_key=api_key, captcha_type=captcha_type, **kwargs)

python3_capsolver/image_to_text.py

@@ -1,151 +1,121 @@
-from typing import Union
+from typing import Any, Dict
 
-from python3_capsolver.core.base import BaseCaptcha
-from python3_capsolver.core.enum import ImageToTextTaskTypeEnm
-from python3_capsolver.core.serializer import TaskSer, CaptchaResponseSer
+from .core.base import CaptchaParams
+from .core.enum import CaptchaTypeEnm
 
+__all__ = ("ImageToText",)
 
-class ImageToText(BaseCaptcha):
+
+class ImageToText(CaptchaParams):
     """
-    The class is used to work with Capsolver Image captcha solving methods.
+    The class is used to work with Capsolver Image captcha solving method.
 
     Args:
         api_key: Capsolver API key
-        captcha_type: Captcha type name, like ``ImageToTextTask`` and etc.
+        kwargs: additional params for client, like captcha waiting time
+                    available keys:
+                     - sleep_time: int - captcha solution waintig time in sec
+                     - request_url: str - API address for sending requests,
+                                            else official will be used
 
     Examples:
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> ImageToText(api_key="CAI-12345....").captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'gcphjd'}
-                          )
-
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> ImageToText(api_key="CAI-12345....",
-        ...             module='queueit'
-        ...            ).captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'zzzzz'}
-                          )
-
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> ImageToText(api_key="CAI-12345....",
-        ...             module='dell',
-        ...             score=0.98,
-        ...             case=True,
-        ...            ).captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'gcphjd'}
-                          )
-
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> with ImageToText(api_key="CAI-12345....") as image_to_text_inst:
-        ...    image_to_text_inst.captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'gcphjd'}
-                          )
-
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> await ImageToText(api_key="CAI-12345....").aio_captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'gcphjd'}
-                          )
-
-        >>> with open('some_image.jpeg', 'rb') as img_file:
-        ...    img_data = img_file.read()
-        >>> body = base64.b64encode(img_data).decode("utf-8")
-        >>> with ImageToText(api_key="CAI-12345....") as image_to_text_inst:
-        ...    await image_to_text_inst.aio_captcha_handler(body=body)
-        CaptchaResponseSer(errorId=0,
-                           errorCode=None,
-                           errorDescription=None,
-                           taskId='73bdcd28-6c77-4414-8....',
-                           status=<ResponseStatusEnm.Ready: 'ready'>,
-                           solution={'confidence': 0.9585, 'text': 'gcphjd'}
-                          )
-
-    Returns:
-        CaptchaResponseSer model with full server response
+        >>> from python3_capsolver.image_to_text import ImageToText
+        >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+
+        >>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
+        >>> ImageToText(api_key="CAI-12345....").captcha_handler(
+        ...                     task_payload={"body": body, "module": "common"}
+        ...                    )
+        {
+           "errorId":0,
+           "errorCode":"None",
+           "errorDescription":"None",
+           "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+           "status":"ready",
+           "solution":{
+              "confidence":0.9585,
+              "text":"gcphjd"
+           }
+        }
+
+        >>> import asyncio
+        >>> from python3_capsolver.image_to_text import ImageToText
+        >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+
+        >>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
+        >>> asyncio.run(ImageToText(api_key="CAI-12345....").aio_captcha_handler(
+        ...                     task_payload={"body": body, "module": "common"}
+        ...                     )
+        ...         )
+        {
+           "errorId":0,
+           "errorCode":"None",
+           "errorDescription":"None",
+           "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+           "status":"ready",
+           "solution":{
+              "confidence":0.9585,
+              "text":"gcphjd"
+           }
+        }
+
+        >>> from python3_capsolver.image_to_text import ImageToText
+        >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+
+        >>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
+        >>> ImageToText(api_key="CAI-12345....").captcha_handler(
+        ...                     task_payload={"body": body,
+        ...                                     "module": "common",
+        ...                                     "score": 0.92}
+        ...                     )
+        {
+           "errorId":0,
+           "errorCode":"None",
+           "errorDescription":"None",
+           "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
+           "status":"ready",
+           "solution":{
+              "confidence":0.9585,
+              "text":"gcphjd"
+           }
+        }
 
     Notes:
         https://docs.capsolver.com/guide/recognition/ImageToTextTask.html
     """
 
-    def __init__(
-        self,
-        captcha_type: Union[ImageToTextTaskTypeEnm, str] = ImageToTextTaskTypeEnm.ImageToTextTask,
-        *args,
-        **kwargs,
-    ):
-        super().__init__(*args, **kwargs)
-        if captcha_type in ImageToTextTaskTypeEnm.list():
-            self.task_params = TaskSer(**locals()).dict(exclude_none=True)
-        else:
-            raise ValueError(
-                f"""Invalid `captcha_type` parameter set for `{self.__class__.__name__}`,
-                available - {ImageToTextTaskTypeEnm.list()}"""
-            )
-        for key in kwargs:
-            self.task_params.update({key: kwargs[key]})
-
-    def captcha_handler(self, body: str) -> CaptchaResponseSer:
+    def __init__(self, api_key: str, **kwargs):
+
+        super().__init__(api_key=api_key, captcha_type=CaptchaTypeEnm.ImageToTextTask, **kwargs)
+
+    def captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:
         """
         Synchronous method for captcha solving
 
         Args:
-            body: Base64 encoded content of the image, decoded into str
+            task_payload: Captcha solving `task` payload, include `body`, `module` and other fields.
 
         Returns:
-            CaptchaResponseSer model with full server response
+            Dict with full server response
 
         Notes:
             Check class docstring for more info
         """
-        self.task_params.update({"body": body})
-        return self._processing_captcha(create_params=self.task_params)
+        task_payload.pop("type", None)
+        return super().captcha_handler(task_payload=task_payload)
 
-    async def aio_captcha_handler(self, body: str) -> CaptchaResponseSer:
+    async def aio_captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:
         """
         Asynchronous method for captcha solving
 
         Args:
-            body: Base64 encoded content of the image, decoded into str
+            task_payload: Captcha solving `task` payload, include `body`, `module` and other fields.
 
         Returns:
-            CaptchaResponseSer model with full server response
+            Dict with full server response
 
         Notes:
             Check class docstring for more info
         """
-        self.task_params.update({"body": body})
-        return await self._aio_processing_captcha(create_params=self.task_params)
+        task_payload.pop("type", None)
+        return await super().aio_captcha_handler(task_payload=task_payload)