python3-capsolver 1.0.1__tar.gz → 1.1.0__tar.gz

{python3_capsolver-1.0.1/src/python3_capsolver.egg-info → python3_capsolver-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python3-capsolver
-Version: 1.0.1
+Version: 1.1.0
 Summary: Python 3.8+ Capsolver library with AIO module.
 Author-email: AndreiDrang <python-captcha@pm.me>
 License: MIT License
@@ -32,6 +32,7 @@ Requires-Dist: requests>=2.21.0
 Requires-Dist: aiohttp>=3.9.2
 Requires-Dist: msgspec<0.20,>=0.18
 Requires-Dist: tenacity<10,>=8
+Dynamic: license-file
 
 # python3-capsolver
 

python3_capsolver-1.1.0/src/python3_capsolver/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.1.0"

python3_capsolver-1.1.0/src/python3_capsolver/control.py

@@ -0,0 +1,431 @@
+from typing import Dict
+
+from .core.base import CaptchaParams
+from .core.enum import CaptchaTypeEnm, EndpointPostfixEnm
+from .core.aio_captcha_instrument import AIOCaptchaInstrument
+from .core.sio_captcha_instrument import SIOCaptchaInstrument
+
+__all__ = ("Control",)
+
+
+class Control(CaptchaParams):
+    """
+    The class is used to work with Capsolver control methods.
+
+    Args:
+        api_key: Capsolver API key
+
+    Notes:
+        https://docs.capsolver.com/en/guide/api-getbalance/
+
+        https://docs.capsolver.com/en/guide/api-gettaskresult/
+
+        https://docs.capsolver.com/en/guide/api-createtask/
+
+        https://docs.capsolver.com/en/guide/api-getToken/
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+    ):
+        super().__init__(api_key=api_key, captcha_type=CaptchaTypeEnm.Control)
+
+    def get_balance(self) -> dict:
+        """
+        Synchronous method to view the balance
+
+        Examples:
+            >>> from python3_capsolver.control import Control
+            >>> Control(api_key="CAI-1324...").get_balance()
+            {'balance': 48.6361, 'errorId': 0, 'packages': []}
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstring for more info
+        """
+        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
+        return self._captcha_handling_instrument.send_post_request(
+            session=self._captcha_handling_instrument.session,
+            url_postfix=EndpointPostfixEnm.GET_BALANCE,
+            payload={"clientKey": self.create_task_payload.clientKey},
+        )
+
+    async def aio_get_balance(self) -> dict:
+        """
+        Asynchronous method to view the balance
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.control import Control
+            >>> asyncio.run(Control(api_key="CAI-1324...").aio_get_balance())
+            {'balance': 48.6361, 'errorId': 0, 'packages': []}
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            Check class docstring for more info
+        """
+        return await AIOCaptchaInstrument.send_post_request(
+            url_postfix=EndpointPostfixEnm.GET_BALANCE,
+            payload={"clientKey": self.create_task_payload.clientKey},
+        )
+
+    def create_task(self, task_payload: Dict) -> dict:
+        """
+        Synchronous method to send custom ``createTask`` request.
+
+        This is the custom analog for prepared captcha solving classes.
+        With this method u can create task with custom type and get
+        response with task solution or task ID (depends on task type).
+        The main difference with ``captcha_handler`` methods
+        - there is no retries logic and other sugar.
+
+        Args:
+            task_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``task`` key.
+                            Like ``websiteURL``, ``image``, ``proxyPassword``, ``websiteKey`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> from python3_capsolver.control import Control
+            >>> Control(api_key="CAI-1324...").get_task_result(
+            ...                             task_payload={
+            ...                                 "type": "VisionEngine",
+            ...                                 "image": "base64_image_body",
+            ...                                 "question": "click on the object",
+            ...                                 "module": "space_detection",
+            ...                             }
+            ...                     )
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "userAgent": "xxx",
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-createtask/
+        """
+        self.task_params.update(task_payload)
+        self.create_task_payload.task = self.task_params
+        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
+        return self._captcha_handling_instrument.send_post_request(
+            session=self._captcha_handling_instrument.session,
+            url_postfix=EndpointPostfixEnm.CREATE_TASK,
+            payload=self.create_task_payload.to_dict(),
+        )
+
+    async def aio_create_task(self, task_payload: Dict) -> dict:
+        """
+        Asynchronous method to send custom ``createTask`` request.
+
+        This is the custom analog for prepared captcha solving classes.
+        With this method u can create task with custom type and get
+        response with task solution or task ID (depends on task type).
+        The main difference with ``captcha_handler`` methods
+        - there is no retries logic and other sugar.
+
+        Args:
+            task_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``task`` key.
+                            Like ``websiteURL``, ``image``, ``proxyPassword``, ``websiteKey`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.control import Control
+            >>> asyncio.run(Control(api_key="CAI-1324...")
+            ...                 .aio_create_task(
+            ...                             task_payload={
+            ...                                 "type": "VisionEngine",
+            ...                                 "image": "base64_image_body",
+            ...                                 "question": "click on the unique object",
+            ...                                 "module": "space_detection",
+            ...                             }
+            ...                     ))
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "userAgent": "xxx",
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-createtask/
+        """
+        self.task_params.update(task_payload)
+        self.create_task_payload.task = self.task_params
+        return await AIOCaptchaInstrument.send_post_request(
+            url_postfix=EndpointPostfixEnm.CREATE_TASK,
+            payload=self.create_task_payload.to_dict(),
+        )
+
+    def get_task_result(self, task_id: str) -> dict:
+        """
+        Synchronous method to send ``getTaskResult`` request
+
+        Args:
+            task_id: Task ID
+
+        Examples:
+            >>> from python3_capsolver.control import Control
+            >>> Control(api_key="CAI-1324...").get_task_result(task_id="db0a3153-xxxx")
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "userAgent": "xxx",
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-gettaskresult/
+        """
+        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
+        return self._captcha_handling_instrument.send_post_request(
+            session=self._captcha_handling_instrument.session,
+            url_postfix=EndpointPostfixEnm.GET_TASK_RESULT,
+            payload={"clientKey": self.create_task_payload.clientKey, "taskId": task_id},
+        )
+
+    async def aio_get_task_result(self, task_id: str) -> dict:
+        """
+        Synchronous method to send ``getTaskResult`` request
+
+        Args:
+            task_id: Task ID
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.control import Control
+            >>> asyncio.run(Control(api_key="CAI-1324...")
+            ...                     .aio_get_task_result(task_id="db0a3153-xxxx"))
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "userAgent": "xxx",
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-gettaskresult/
+        """
+        return await AIOCaptchaInstrument.send_post_request(
+            url_postfix=EndpointPostfixEnm.GET_TASK_RESULT,
+            payload={"clientKey": self.create_task_payload.clientKey, "taskId": task_id},
+        )
+
+    def get_token(self, task_payload: Dict) -> dict:
+        """
+        Synchronous method to send custom ``getToken`` request.
+
+        Args:
+            task_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``task`` key.
+                            Like ``websiteURL``, ``image``, ``proxyPassword``, ``websiteKey`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> from python3_capsolver.control import Control
+            >>> Control(api_key="CAI-1324...").get_token(
+            ...                             task_payload={
+            ...                                 "type": "ReCaptchaV3TaskProxyLess",
+            ...                                 "websiteURL": "https://demo.com/",
+            ...                                 "websiteKey": "6LcpsXsnAAAbbAcxxxx"
+            ...                             }
+            ...                     )
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-getToken/
+        """
+        self.task_params.update(task_payload)
+        self.create_task_payload.task = self.task_params
+        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
+        return self._captcha_handling_instrument.send_post_request(
+            session=self._captcha_handling_instrument.session,
+            url_postfix=EndpointPostfixEnm.GET_TOKEN,
+            payload=self.create_task_payload.to_dict(),
+        )
+
+    async def aio_get_token(self, task_payload: Dict) -> dict:
+        """
+        Asynchronous method to send custom ``getToken`` request.
+
+        Args:
+            task_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``task`` key.
+                            Like ``websiteURL``, ``image``, ``proxyPassword``, ``websiteKey`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.control import Control
+            >>> asyncio.run(Control(api_key="CAI-1324...")
+            ...                 .aio_get_token(
+            ...                             task_payload={
+            ...                                 "type": "ReCaptchaV3TaskProxyLess",
+            ...                                 "websiteURL": "https://demo.com/",
+            ...                                 "websiteKey": "6LcpsXsnAAAbbAcxxxx"
+            ...                             }
+            ...                     ))
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "taskId": "db0a3153-xxxx",
+                "status":"ready",
+                "solution": {
+                    "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-xxxx"
+                },
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-getToken/
+        """
+        self.task_params.update(task_payload)
+        self.create_task_payload.task = self.task_params
+        return await AIOCaptchaInstrument.send_post_request(
+            url_postfix=EndpointPostfixEnm.GET_TOKEN,
+            payload=self.create_task_payload.to_dict(),
+        )
+
+    def feedback_task(self, task_id: str, result_payload: Dict) -> dict:
+        """
+        Synchronous method to send custom ``feedbackTask`` request.
+
+        Args:
+            task_id: Task ID to report
+            result_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``result`` key.
+                            Like ``invalid``, ``code``, ``message`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> from python3_capsolver.control import Control
+            >>> Control(api_key="CAI-1324...").feedback_task(
+            ...                             task_id="db0a3153-xxxx",
+            ...                             result_payload={
+            ...                                 "invalid": True,
+            ...                                 "code": 1001,
+            ...                                 "message": "invalid token"
+            ...                             }
+            ...                     )
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "message": "okay"
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-feedback/
+        """
+        self.task_params.update(result_payload)
+        dict_payload = self.create_task_payload.to_dict()
+        dict_payload.update({"result": self.task_params, "taskId": task_id})
+
+        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
+        return self._captcha_handling_instrument.send_post_request(
+            session=self._captcha_handling_instrument.session,
+            url_postfix=EndpointPostfixEnm.GET_TOKEN,
+            payload=dict_payload,
+        )
+
+    async def aio_feedback_task(self, task_id: str, result_payload: Dict) -> dict:
+        """
+        Asynchronous method to send custom ``feedbackTask`` request.
+
+        Args:
+            task_id: Task ID to report
+            result_payload: Some additional parameters that will be used in creating the task
+                            and will be passed to the payload under ``result`` key.
+                            Like ``invalid``, ``code``, ``message`` and etc.
+                            more info in service docs
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.control import Control
+            >>> asyncio.run(Control(api_key="CAI-1324...")
+            ...                 .aio_feedback_task(
+            ...                             task_id="db0a3153-xxxx",
+            ...                             result_payload={
+            ...                                 "invalid": True,
+            ...                                 "code": 1001,
+            ...                                 "message": "invalid token"
+            ...                             }
+            ...                     ))
+            {
+                "errorId": 0,
+                "errorCode":"None",
+                "errorDescription":"None",
+                "message": "okay"
+            }
+
+        Returns:
+            Dict with full server response
+
+        Notes:
+            https://docs.capsolver.com/en/guide/api-feedback/
+        """
+        self.task_params.update(result_payload)
+        dict_payload = self.create_task_payload.to_dict()
+        dict_payload.update({"result": self.task_params, "taskId": task_id})
+
+        return await AIOCaptchaInstrument.send_post_request(
+            url_postfix=EndpointPostfixEnm.GET_TOKEN,
+            payload=dict_payload,
+        )

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/aio_captcha_instrument.py

@@ -6,15 +6,15 @@ from urllib import parse
 import aiohttp
 
 from .enum import ResponseStatusEnm, EndpointPostfixEnm
-from .const import REQUEST_URL, VALID_STATUS_CODES, GET_BALANCE_POSTFIX
+from .const import REQUEST_URL, VALID_STATUS_CODES
 from .utils import attempts_generator
 from .serializer import CaptchaResponseSer
-from .captcha_instrument import CaptchaInstrument
+from .captcha_instrument import CaptchaInstrumentBase
 
 __all__ = ("AIOCaptchaInstrument",)
 
 
-class AIOCaptchaInstrument(CaptchaInstrument):
+class AIOCaptchaInstrument(CaptchaInstrumentBase):
     """
     Instrument for working with async captcha
     """
@@ -29,9 +29,9 @@ class AIOCaptchaInstrument(CaptchaInstrument):
         self.created_task_data = CaptchaResponseSer(**await self.__create_task())
 
         # if task created and already ready - return result
-        if self.created_task_data.errorId == 0 and self.created_task_data.status == ResponseStatusEnm.Processing.value:
+        if self.created_task_data.errorId == 0:
             return (await self.__get_result()).to_dict()
-        elif self.created_task_data.errorId != 0:
+        else:
             self.created_task_data.status = ResponseStatusEnm.Failed
 
         return self.created_task_data.to_dict()
@@ -84,22 +84,24 @@ class AIOCaptchaInstrument(CaptchaInstrument):
                 # if captcha just created or in processing now - wait
                 await asyncio.sleep(self.captcha_params.sleep_time)
 
-            # default response if server is silent
-            self.result.errorId = 1
-            self.result.errorCode = self.CAPTCHA_UNSOLVABLE
-            self.result.errorDescription = "Captcha not recognized"
-            self.result.taskId = self.created_task_data.taskId
-            self.result.status = ResponseStatusEnm.Failed
+        # default response if server is silent
+        self.result.errorId = 1
+        self.result.errorCode = self.CAPTCHA_UNSOLVABLE
+        self.result.errorDescription = self.CAPTCHA_UNSOLVABLE_DESCRIPTION
+        self.result.taskId = self.created_task_data.taskId
+        self.result.status = ResponseStatusEnm.Failed
 
     @staticmethod
-    async def send_post_request(payload: Optional[dict] = None, url_postfix: str = GET_BALANCE_POSTFIX) -> dict:
+    async def send_post_request(
+        payload: Optional[dict] = None, url_postfix: EndpointPostfixEnm = EndpointPostfixEnm.GET_BALANCE
+    ) -> dict:
         """
         Function send ASYNC request to service and wait for result
         """
 
         async with aiohttp.ClientSession() as session:
             try:
-                async with session.post(parse.urljoin(REQUEST_URL, url_postfix), json=payload) as resp:
+                async with session.post(parse.urljoin(REQUEST_URL, url_postfix.value), json=payload) as resp:
                     if resp.status == 200:
                         return await resp.json()
                     else:

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/base.py

@@ -1,12 +1,10 @@
 from typing import Any, Dict
 
-from python3_capsolver.core.enum import CaptchaTypeEnm
-from python3_capsolver.core.serializer import TaskSer
-
+from .enum import CaptchaTypeEnm
 from .const import REQUEST_URL
-from .serializer import RequestCreateTaskSer, RequestGetTaskResultSer
+from .serializer import TaskSer, RequestCreateTaskSer, RequestGetTaskResultSer
 from .context_instr import AIOContextManager, SIOContextManager
-from .captcha_instrument import CaptchaInstrument
+from .captcha_instrument import CaptchaInstrumentBase
 from .aio_captcha_instrument import AIOCaptchaInstrument
 from .sio_captcha_instrument import SIOCaptchaInstrument
 
@@ -38,7 +36,7 @@ class CaptchaParams(SIOContextManager, AIOContextManager):
         # prepare `get task result` payload
         self.get_result_params = RequestGetTaskResultSer(clientKey=api_key)
         self.request_url = request_url
-        self._captcha_handling_instrument = CaptchaInstrument()
+        self._captcha_handling_instrument = CaptchaInstrumentBase()
         self.sleep_time = sleep_time
 
     def captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/captcha_instrument.py

@@ -13,10 +13,26 @@ from .enum import SaveFormatsEnm
 from .const import RETRIES, ASYNC_RETRIES
 from .serializer import CaptchaResponseSer
 
-__all__ = ("CaptchaInstrument", "FileInstrument")
+__all__ = ("CaptchaInstrumentBase", "FileInstrument")
 
 
 class FileInstrument:
+    """
+    This class contains usefull methods for async and async files processing to prepare them for solving
+
+    Examples:
+        >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+        >>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
+        /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBUVxxxxx
+
+        >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+        >>> body = FileInstrument().file_processing(captcha_link="https://some-url/file.jpeg")
+        /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBUVxxxxx
+
+    Returns:
+        String with decoded file data
+    """
+
     @staticmethod
     def _local_file_captcha(captcha_file: str):
         """
@@ -80,6 +96,33 @@ class FileInstrument:
         file_extension: str = "png",
         **kwargs,
     ) -> str:
+        """
+        Synchronous method for captcha image processing.
+         - Method can read local file and return it's as base64 string.
+         - Method can read file URL and return it's as base64 string.
+         - Method can decode base64 bytes and return it's as base64 string.
+
+        Args:
+            captcha_link: URL link to file. Instrument will send GET request to it and read content
+            captcha_file: Local file path. Instrument will read it
+            captcha_base64: Readed file base64 data. Instrument will decode it in ``utf-8``
+            save_format: This arg works only with ``captcha_link`` arg.
+                            If ``SaveFormatsEnm.CONST`` is set - file will be loaded and saved locally.
+            img_clearing: This arg works only with ``captcha_link`` arg.
+                            If ``False`` - file wil not be removed downloading and saving locally.
+            file_path: This arg works only with ``captcha_link`` and ``SaveFormatsEnm.CONST`` args.
+                        In this param u can set locally path for downloaded file saving.
+            file_extension: This arg works only with ``file_path`` args.
+                        In this param u MUST set file format for saving.
+
+        Examples:
+            >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+            >>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
+            /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBUVxxxxx
+
+        Returns:
+            String with decoded file data
+        """
         # if a local file link is passed
         if captcha_file:
             return base64.b64encode(self._local_file_captcha(captcha_file=captcha_file)).decode("utf-8")
@@ -109,6 +152,35 @@ class FileInstrument:
         file_extension: str = "png",
         **kwargs,
     ) -> str:
+        """
+        Asynchronous method for captcha image processing.
+         - Method can read local file and return it's as base64 string.
+         - Method can read file URL and return it's as base64 string.
+         - Method can decode base64 bytes and return it's as base64 string.
+
+        Args:
+            captcha_link: URL link to file. Instrument will send GET request to it and read content
+            captcha_file: Local file path. Instrument will read it
+            captcha_base64: Readed file base64 data. Instrument will decode it in ``utf-8``
+            save_format: This arg works only with ``captcha_link`` arg.
+                            If ``SaveFormatsEnm.CONST`` is set - file will be loaded and saved locally.
+            img_clearing: This arg works only with ``captcha_link`` arg.
+                            If ``False`` - file wil not be removed downloading and saving locally.
+            file_path: This arg works only with ``captcha_link`` and ``SaveFormatsEnm.CONST`` args.
+                        In this param u can set locally path for downloaded file saving.
+            file_extension: This arg works only with ``file_path`` args.
+                        In this param u MUST set file format for saving.
+
+        Examples:
+            >>> import asyncio
+            >>> from python3_capsolver.core.captcha_instrument import FileInstrument
+            >>> body = asyncio.run(FileInstrument()
+            ...                     .aio_file_processing(captcha_file="captcha_example.jpeg"))
+            /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBUVxxxxx
+
+        Returns:
+            String with decoded file data
+        """
         # if a local file link is passed
         if captcha_file:
             return base64.b64encode(self._local_file_captcha(captcha_file=captcha_file)).decode("utf-8")
@@ -129,8 +201,9 @@ class FileInstrument:
             raise ValueError("No valid captcha variant is set.")
 
 
-class CaptchaInstrument(FileInstrument):
+class CaptchaInstrumentBase:
     CAPTCHA_UNSOLVABLE = "ERROR_CAPTCHA_UNSOLVABLE"
+    CAPTCHA_UNSOLVABLE_DESCRIPTION = "Captcha not recognized"
     """
     Basic Captcha solving class
 

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/const.py

@@ -7,10 +7,7 @@ __all__ = (
     "RETRIES",
     "REQUEST_URL",
     "ASYNC_RETRIES",
-    "GET_RESULT_POSTFIX",
     "VALID_STATUS_CODES",
-    "GET_BALANCE_POSTFIX",
-    "CREATE_TASK_POSTFIX",
 )
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
@@ -19,9 +16,6 @@ RETRIES = Retry(total=5, backoff_factor=0.9, status_forcelist=[500, 502, 503, 50
 ASYNC_RETRIES = AsyncRetrying(wait=wait_fixed(5), stop=stop_after_attempt(5), reraise=True)
 
 REQUEST_URL = "https://api.capsolver.com"
-CREATE_TASK_POSTFIX = "/createTask"
-GET_RESULT_POSTFIX = "/getTaskResult"
-GET_BALANCE_POSTFIX = "/getBalance"
 VALID_STATUS_CODES = (200, 202, 400, 401, 405)
 
 APP_ID = "3E36E3CD-7EB5-4CAF-AA15-91011E652321"

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/enum.py

@@ -26,6 +26,8 @@ class EndpointPostfixEnm(MyEnum):
     GET_BALANCE = "getBalance"
     CREATE_TASK = "createTask"
     GET_TASK_RESULT = "getTaskResult"
+    GET_TOKEN = "getToken"
+    FEEDBACK_TASK = "feedbackTask"
 
 
 class CaptchaTypeEnm(MyEnum):

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/core/sio_captcha_instrument.py

@@ -7,15 +7,15 @@ import requests
 from requests.adapters import HTTPAdapter
 
 from .enum import ResponseStatusEnm, EndpointPostfixEnm
-from .const import RETRIES, REQUEST_URL, VALID_STATUS_CODES, GET_BALANCE_POSTFIX
+from .const import RETRIES, REQUEST_URL, VALID_STATUS_CODES
 from .utils import attempts_generator
 from .serializer import CaptchaResponseSer
-from .captcha_instrument import CaptchaInstrument
+from .captcha_instrument import CaptchaInstrumentBase
 
 __all__ = ("SIOCaptchaInstrument",)
 
 
-class SIOCaptchaInstrument(CaptchaInstrument):
+class SIOCaptchaInstrument(CaptchaInstrumentBase):
     """
     Instrument for working with sync captcha
     """
@@ -36,9 +36,9 @@ class SIOCaptchaInstrument(CaptchaInstrument):
         self.created_task_data = CaptchaResponseSer(**self.__create_task())
 
         # if task created and ready - return result
-        if self.created_task_data.errorId == 0 and self.created_task_data.status == ResponseStatusEnm.Processing:
+        if self.created_task_data.errorId == 0:
             return self.__get_result().to_dict()
-        elif self.created_task_data.errorId != 0:
+        else:
             self.created_task_data.status = ResponseStatusEnm.Failed
 
         return self.created_task_data.to_dict()
@@ -92,7 +92,7 @@ class SIOCaptchaInstrument(CaptchaInstrument):
         # default response if server is silent
         self.result.errorId = 1
         self.result.errorCode = self.CAPTCHA_UNSOLVABLE
-        self.result.errorDescription = "Captcha not recognized"
+        self.result.errorDescription = self.CAPTCHA_UNSOLVABLE_DESCRIPTION
         self.result.taskId = self.created_task_data.taskId
         self.result.status = ResponseStatusEnm.Failed
 
@@ -100,13 +100,13 @@ class SIOCaptchaInstrument(CaptchaInstrument):
     def send_post_request(
         payload: Optional[dict] = None,
         session: requests.Session = requests.Session(),
-        url_postfix: str = GET_BALANCE_POSTFIX,
+        url_postfix: EndpointPostfixEnm = EndpointPostfixEnm.GET_BALANCE,
     ) -> dict:
         """
         Function send SYNC request to service and wait for result
         """
         try:
-            resp = session.post(parse.urljoin(REQUEST_URL, url_postfix), json=payload)
+            resp = session.post(parse.urljoin(REQUEST_URL, url_postfix.value), json=payload)
             if resp.status_code == 200:
                 return resp.json()
             else:

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/image_to_text.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Union
 
 from .core.base import CaptchaParams
 from .core.enum import CaptchaTypeEnm
@@ -12,6 +12,7 @@ class ImageToText(CaptchaParams):
 
     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
@@ -21,7 +22,6 @@ class ImageToText(CaptchaParams):
     Examples:
         >>> 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"}
@@ -41,7 +41,6 @@ class ImageToText(CaptchaParams):
         >>> 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"}
@@ -61,7 +60,6 @@ class ImageToText(CaptchaParams):
 
         >>> 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,
@@ -84,38 +82,8 @@ class ImageToText(CaptchaParams):
         https://docs.capsolver.com/guide/recognition/ImageToTextTask.html
     """
 
-    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:
-            task_payload: Captcha solving `task` payload, include `body`, `module` and other fields.
-
-        Returns:
-            Dict with full server response
-
-        Notes:
-            Check class docstring for more info
-        """
-        task_payload.pop("type", None)
-        return super().captcha_handler(task_payload=task_payload)
-
-    async def aio_captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:
-        """
-        Asynchronous method for captcha solving
-
-        Args:
-            task_payload: Captcha solving `task` payload, include `body`, `module` and other fields.
-
-        Returns:
-            Dict with full server response
+    def __init__(
+        self, api_key: str, captcha_type: Union[CaptchaTypeEnm, str] = CaptchaTypeEnm.ImageToTextTask, **kwargs
+    ):
 
-        Notes:
-            Check class docstring for more info
-        """
-        task_payload.pop("type", None)
-        return await super().aio_captcha_handler(task_payload=task_payload)
+        super().__init__(api_key=api_key, captcha_type=captcha_type, **kwargs)

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/src/python3_capsolver/vision_engine.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Union
 
 from .core.base import CaptchaParams
 from .core.enum import CaptchaTypeEnm
@@ -12,6 +12,7 @@ class VisionEngine(CaptchaParams):
 
     Args:
         api_key: Capsolver API key
+        captcha_type: Captcha type name, like ``VisionEngine`` and etc.
         kwargs: additional params for client, like captcha waiting time
                     available keys:
                      - sleep_time: int - captcha solution waintig time in sec
@@ -66,37 +67,5 @@ class VisionEngine(CaptchaParams):
         https://docs.capsolver.com/en/guide/recognition/VisionEngine/
     """
 
-    def __init__(self, api_key: str, **kwargs):
-        super().__init__(api_key=api_key, captcha_type=CaptchaTypeEnm.VisionEngine, **kwargs)
-
-    def captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:
-        """
-        Synchronous method for captcha solving
-
-        Args:
-            task_payload: Captcha solving `task` payload, include `body`, `module` and other fields.
-
-        Returns:
-            Dict with full server response
-
-        Notes:
-            Check class docstring for more info
-        """
-        task_payload.pop("type", None)
-        return super().captcha_handler(task_payload=task_payload)
-
-    async def aio_captcha_handler(self, task_payload: Dict) -> Dict[str, Any]:
-        """
-        Asynchronous method for captcha solving
-
-        Args:
-            task_payload: Captcha solving `task` payload, include `question`, `image` and other fields.
-
-        Returns:
-            Dict with full server response
-
-        Notes:
-            Check class docstring for more info
-        """
-        task_payload.pop("type", None)
-        return await super().aio_captcha_handler(task_payload=task_payload)
+    def __init__(self, api_key: str, captcha_type: Union[CaptchaTypeEnm, str] = CaptchaTypeEnm.VisionEngine, **kwargs):
+        super().__init__(api_key=api_key, captcha_type=captcha_type, **kwargs)

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0/src/python3_capsolver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python3-capsolver
-Version: 1.0.1
+Version: 1.1.0
 Summary: Python 3.8+ Capsolver library with AIO module.
 Author-email: AndreiDrang <python-captcha@pm.me>
 License: MIT License
@@ -32,6 +32,7 @@ Requires-Dist: requests>=2.21.0
 Requires-Dist: aiohttp>=3.9.2
 Requires-Dist: msgspec<0.20,>=0.18
 Requires-Dist: tenacity<10,>=8
+Dynamic: license-file
 
 # python3-capsolver
 

{python3_capsolver-1.0.1 → python3_capsolver-1.1.0}/tests/test_image_to_text.py

@@ -6,8 +6,9 @@ from python3_capsolver.core.serializer import CaptchaResponseSer
 
 class TestImageToTextBase(BaseTest):
     def test_captcha_handler_exist(self):
-        assert "captcha_handler" in ImageToText.__dict__.keys()
-        assert "aio_captcha_handler" in ImageToText.__dict__.keys()
+        instance = ImageToText(api_key=self.get_random_string(36))
+        assert "captcha_handler" in instance.__dir__()
+        assert "aio_captcha_handler" in instance.__dir__()
 
 
 class TestImageToText(BaseTest):

python3_capsolver-1.0.1/src/python3_capsolver/__version__.py

@@ -1 +0,0 @@
-__version__ = "1.0.1"

python3_capsolver-1.0.1/src/python3_capsolver/control.py

@@ -1,68 +0,0 @@
-from .core.base import CaptchaParams
-from .core.enum import CaptchaTypeEnm
-from .core.const import GET_BALANCE_POSTFIX
-from .core.aio_captcha_instrument import AIOCaptchaInstrument
-from .core.sio_captcha_instrument import SIOCaptchaInstrument
-
-__all__ = ("Control",)
-
-
-class Control(CaptchaParams):
-    """
-    The class is used to work with Capsolver control methods.
-
-    Args:
-        api_key: Capsolver API key
-
-    Notes:
-        https://docs.capsolver.com/en/guide/api-getbalance/
-    """
-
-    def __init__(
-        self,
-        api_key: str,
-    ):
-        super().__init__(api_key=api_key, captcha_type=CaptchaTypeEnm.Control)
-
-    def get_balance(self) -> dict:
-        """
-        Synchronous method to view the balance
-
-        Examples:
-            >>> from python3_capsolver.control import Control
-            >>> Control(api_key="CAI-1324...").get_balance()
-            {'balance': 48.6361, 'errorId': 0, 'packages': []}
-
-        Returns:
-            Dict with full server response
-
-        Notes:
-            Check class docstring for more info
-        """
-        self._captcha_handling_instrument = SIOCaptchaInstrument(captcha_params=self)
-        return self._captcha_handling_instrument.send_post_request(
-            session=self._captcha_handling_instrument.session,
-            url_postfix=GET_BALANCE_POSTFIX,
-            payload={"clientKey": self.create_task_payload.clientKey},
-        )
-
-    async def aio_get_balance(self) -> dict:
-        """
-        Asynchronous method to view the balance
-
-        Examples:
-        >>> import asyncio
-        >>> from python3_capsolver.control import Control
-        >>> asyncio.run(Control(api_key="CAI-1324...").aio_get_balance())
-        {'balance': 48.6361, 'errorId': 0, 'packages': []}
-
-        Returns:
-            Dict with full server response
-
-        Notes:
-            Check class docstring for more info
-        """
-        return await AIOCaptchaInstrument.send_post_request(
-            url_postfix=GET_BALANCE_POSTFIX,
-            payload={"clientKey": self.create_task_payload.clientKey},
-        )