fix stupid pycharm messing with random strings

Author: sebastianMindee

mindee/client.py

@@ -92,7 +92,7 @@ def parse(
             This performs a full OCR operation on the server and will increase response time.
             Only available on financial document APIs.
 
-        :param close_file: Whether to ``close()`` the file after product it.
+        :param close_file: Whether to ``close()`` the file after parsing it.
           Set to ``False`` if you need to access the file after this operation.
 
         :param page_options: If set, remove pages from the document as specified.
@@ -154,7 +154,7 @@ def enqueue(
         :param include_words: Whether to include the full text for each page.
             This performs a full OCR operation on the server and will increase response time.
 
-        :param close_file: Whether to ``close()`` the file after product it.
+        :param close_file: Whether to ``close()`` the file after parsing it.
           Set to ``False`` if you need to access the file after this operation.
 
         :param page_options: If set, remove pages from the document as specified.
@@ -299,7 +299,7 @@ def enqueue_and_parse(  # pylint: disable=too-many-locals
         :param include_words: Whether to include the full text for each page.
             This performs a full OCR operation on the server and will increase response time.
 
-        :param close_file: Whether to ``close()`` the file after product it.
+        :param close_file: Whether to ``close()`` the file after parsing it.
             Set to ``False`` if you need to access the file after this operation.
 
         :param page_options: If set, remove pages from the document as specified.

mindee/commands/cli_parser.py

@@ -104,7 +104,7 @@ class MindeeParser:
     parser: MindeeArgumentParser
     """Parser options."""
     parsed_args: Namespace
-    """Stores attributes relating to product."""
+    """Stores attributes relating to parsing."""
     client: Client
     """Mindee client"""
     document_info: CommandConfig
@@ -159,7 +159,7 @@ def call_parse(self) -> None:
             print(response.raw_http)
         else:
             if response.document is None:
-                raise MindeeClientError("Something went wrong during async product.")
+                raise MindeeClientError("Something went wrong during async parsing.")
             # print the OCR
             if self.parsed_args.include_words:
                 print("#############\nDocument Text\n#############\n::\n")

mindee/error/mindee_error.py

@@ -4,7 +4,7 @@ class MindeeError(RuntimeError):
 
 class MindeeClientError(MindeeError):
     """
-    An exception relating to document product errors.
+    An exception relating to document parsing errors.
 
     Not to be confused with `MindeeHTTPClientError`.
     """

mindee/mindee_http/endpoint.py

@@ -44,7 +44,7 @@ def predict_req_post(
 
         :param input_source: Input object
         :param include_words: Include raw OCR words in the response
-        :param close_file: Whether to `close()` the file after product it.
+        :param close_file: Whether to `close()` the file after parsing it.
         :param cropper: Including Mindee cropping results.
         :param full_text: Whether to include the full OCR text response in compatible APIs.
         :return: requests response
@@ -68,7 +68,7 @@ def predict_async_req_post(
 
         :param input_source: Input object
         :param include_words: Include raw OCR words in the response
-        :param close_file: Whether to `close()` the file after product it.
+        :param close_file: Whether to `close()` the file after parsing it.
         :param cropper: Including Mindee cropping results.
         :param full_text: Whether to include the full OCR text response in compatible APIs.
         :param workflow_id: Workflow ID.
@@ -184,7 +184,7 @@ def training_req_post(
 
         :param input_source: Input object
         :return: requests response
-        :param close_file: Whether to `close()` the file after product it.
+        :param close_file: Whether to `close()` the file after parsing it.
         """
         files = {"document": input_source.read_contents(close_file)}
         params = {"training": True, "with_candidates": True}
@@ -206,7 +206,7 @@ def training_async_req_post(
 
         :param input_source: Input object
         :return: requests response
-        :param close_file: Whether to `close()` the file after product it.
+        :param close_file: Whether to `close()` the file after parsing it.
         """
         files = {"document": input_source.read_contents(close_file)}
         params = {"training": True, "async": True}

mindee/mindee_http/response_validation.py

@@ -56,7 +56,7 @@ def clean_request_json(response: requests.Response) -> StringDict:
     Checks and correct the response error format depending on the two possible kind of returns.
 
     :param response: Raw request response.
-    :return: Returns the job error if the error is due to product, returns the http error otherwise.
+    :return: Returns the job error if the error is due to parsing, returns the http error otherwise.
     """
     response_json = response.json()
     if response.status_code < 200 or response.status_code > 302:

tests/v1/test_client.py

@@ -97,7 +97,7 @@ def test_cut_options(dummy_client: Client):
         f"{FILE_TYPES_DIR}/pdf/multipage.pdf"
     )
     try:
-        # need to keep file open to count the pages after product
+        # need to keep file open to count the pages after parsing
         dummy_client.parse(
             ReceiptV5,
             input_doc,