♻️ migrate to ruff for linting

.pre-commit-config.yaml

@@ -1,15 +1,10 @@
 repos:
-  - repo: https://github.com/ambv/black
-    rev: 25.9.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.14.3
     hooks:
-      - id: black
-
-  - repo: https://github.com/pycqa/isort
-    rev: 7.0.0
-    hooks:
-      - id: isort
-        args: [ "--profile", "black" , "--split-on-trailing-comma", "true"]
-        additional_dependencies: [toml]
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix]
+      - id: ruff-format
 
   - repo: https://github.com/pycqa/pydocstyle
     rev: 6.3.0

mindee/__init__.py

@@ -38,6 +38,7 @@
     "PredictResponse",
     "WorkflowResponse",
     "JobResponse",
+    "Job",
     "InferenceResponse",
     "product",
 ]

mindee/error/__init__.py

@@ -15,3 +15,19 @@
 )
 from mindee.error.mindee_image_error import MindeeImageError
 from mindee.error.mindee_pdf_error import MindeePDFError
+
+__all__ = [
+    "MindeeError",
+    "MindeeApiError",
+    "MindeeApiV2Error",
+    "MindeeClientError",
+    "MindeeProductError",
+    "MindeeHTTPError",
+    "MindeeHTTPClientError",
+    "MindeeHTTPServerError",
+    "handle_error",
+    "MindeeImageError",
+    "MindeePDFError",
+    "GeometryError",
+    "MimeTypeError",
+]

mindee/extraction/__init__.py

@@ -6,3 +6,12 @@
 from mindee.extraction.multi_receipts_extractor import multi_receipts_extractor
 from mindee.extraction.pdf_extractor.extracted_pdf import ExtractedPdf
 from mindee.extraction.pdf_extractor.pdf_extractor import PdfExtractor
+
+__all__ = [
+    "ExtractedImage",
+    "ExtractedPdf",
+    "PdfExtractor",
+    "attach_image_as_new_file",
+    "extract_multiple_images_from_source",
+    "multi_receipts_extractor",
+]

mindee/extraction/common/__init__.py

@@ -3,3 +3,9 @@
     attach_image_as_new_file,
     extract_multiple_images_from_source,
 )
+
+__all__ = [
+    "ExtractedImage",
+    "attach_image_as_new_file",
+    "extract_multiple_images_from_source",
+]

mindee/extraction/multi_receipts_extractor/__init__.py

@@ -1 +1,3 @@
 from mindee.extraction.multi_receipts_extractor import multi_receipts_extractor
+
+__all__ = ["multi_receipts_extractor"]

mindee/extraction/pdf_extractor/__init__.py

@@ -1,2 +1,4 @@
 from mindee.extraction.pdf_extractor.extracted_pdf import ExtractedPdf
 from mindee.extraction.pdf_extractor.pdf_extractor import PdfExtractor
+
+__all__ = ["ExtractedPdf", "PdfExtractor"]

mindee/geometry/__init__.py

@@ -14,3 +14,24 @@
     get_bounding_box,
     quadrilateral_from_prediction,
 )
+
+__all__ = [
+    "BBox",
+    "MinMax",
+    "Point",
+    "Points",
+    "Polygon",
+    "Quadrilateral",
+    "is_point_in_polygon_x",
+    "is_point_in_polygon_y",
+    "is_point_in_y",
+    "is_point_in_x",
+    "quadrilateral_from_prediction",
+    "get_bbox",
+    "get_min_max_x",
+    "get_min_max_y",
+    "get_bounding_box",
+    "get_centroid",
+    "polygon_from_prediction",
+    "merge_polygons",
+]

mindee/image_operations/__init__.py

@@ -1 +1,3 @@
 from mindee.image_operations.image_compressor import compress_image
+
+__all__ = ["compress_image"]

mindee/input/__init__.py

@@ -9,3 +9,17 @@
 from mindee.input.sources.path_input import PathInput
 from mindee.input.sources.url_input_source import UrlInputSource
 from mindee.input.workflow_options import WorkflowOptions
+
+__all__ = [
+    "InputType",
+    "LocalInputSource",
+    "UrlInputSource",
+    "PathInput",
+    "FileInput",
+    "Base64Input",
+    "BytesInput",
+    "WorkflowOptions",
+    "PollingOptions",
+    "PageOptions",
+    "LocalResponse",
+]

mindee/mindee_http/__init__.py

@@ -8,3 +8,15 @@
 )
 from mindee.mindee_http.workflow_endpoint import WorkflowEndpoint
 from mindee.mindee_http.workflow_settings import WorkflowSettings
+
+__all__ = [
+    "BaseEndpoint",
+    "CustomEndpoint",
+    "Endpoint",
+    "MindeeApi",
+    "clean_request_json",
+    "is_valid_async_response",
+    "is_valid_sync_response",
+    "WorkflowEndpoint",
+    "WorkflowSettings",
+]

mindee/mindee_http/response_validation_v2.py

@@ -15,7 +15,7 @@ def is_valid_post_response(response: requests.Response) -> bool:
     if not is_valid_sync_response(response):
         return False
     response_json = json.loads(response.content)
-    if not "job" in response_json:
+    if "job" not in response_json:
         return False
     if (
         "job" in response_json
@@ -36,6 +36,6 @@ def is_valid_get_response(response: requests.Response) -> bool:
     if not is_valid_sync_response(response):
         return False
     response_json = json.loads(response.content)
-    if not "inference" in response_json and not "job" in response_json:
+    if "inference" not in response_json and "job" not in response_json:
         return False
     return True

mindee/parsing/__init__.py

@@ -1 +1,7 @@
-from mindee.parsing import common, custom, standard
+from mindee.parsing import (
+    common,
+    custom,
+    standard,
+)
+
+__all__ = ["common", "custom", "standard"]

mindee/parsing/common/__init__.py

@@ -21,3 +21,29 @@
     line_separator,
 )
 from mindee.parsing.common.workflow_response import WorkflowResponse
+
+__all__ = [
+    "ApiRequest",
+    "ApiResponse",
+    "AsyncPredictResponse",
+    "Document",
+    "Execution",
+    "ExecutionFile",
+    "ExecutionPriority",
+    "CropperExtra",
+    "Extras",
+    "FeedbackResponse",
+    "Inference",
+    "TypeInference",
+    "WorkflowResponse",
+    "line_separator",
+    "clean_out_string",
+    "format_for_display",
+    "Prediction",
+    "Job",
+    "OrientationField",
+    "Page",
+    "PredictResponse",
+    "MVisionV1",
+    "Ocr",
+]

mindee/parsing/common/extras/__init__.py

@@ -1,2 +1,7 @@
 from mindee.parsing.common.extras.cropper_extra import CropperExtra
 from mindee.parsing.common.extras.extras import Extras
+
+__all__ = [
+    "Extras",
+    "CropperExtra",
+]

mindee/parsing/common/ocr/__init__.py

@@ -1 +1,3 @@
 from mindee.parsing.common.ocr.ocr import Ocr
+
+__all__ = ["Ocr"]

mindee/parsing/common/page.py

@@ -41,7 +41,7 @@ def __init__(
     def __str__(self) -> str:
         title = f"Page {self.id}"
         dashes = "-" * len(title)
-        return f"{title}\n" f"{dashes}\n" f"{self.prediction}\n"
+        return f"{title}\n{dashes}\n{self.prediction}\n"
 
 
 TypePage = TypeVar("TypePage", bound=Page)

mindee/parsing/common/summary_helper.py

@@ -30,5 +30,5 @@ def format_for_display(
     return (
         out_string
         if len(out_string) <= max_col_size
-        else f"{out_string[:max_col_size-3]}..."
+        else f"{out_string[: max_col_size - 3]}..."
     )

mindee/parsing/custom/__init__.py

@@ -1,3 +1,11 @@
 from mindee.parsing.custom.classification import ClassificationField
 from mindee.parsing.custom.line_items import CustomLine, get_line_items
 from mindee.parsing.custom.list import ListField, ListFieldValue
+
+__all__ = [
+    "ClassificationField",
+    "CustomLine",
+    "get_line_items",
+    "ListField",
+    "ListFieldValue",
+]

mindee/parsing/generated/__init__.py

@@ -3,3 +3,9 @@
     GeneratedObjectField,
     is_generated_object,
 )
+
+__all__ = [
+    "GeneratedListField",
+    "GeneratedObjectField",
+    "is_generated_object",
+]

mindee/parsing/standard/__init__.py

@@ -20,3 +20,27 @@
 from mindee.parsing.standard.position import PositionField
 from mindee.parsing.standard.tax import Taxes, TaxField
 from mindee.parsing.standard.text import StringField
+
+__all__ = [
+    "AddressField",
+    "AmountField",
+    "BaseField",
+    "FieldConfidenceMixin",
+    "FieldPositionMixin",
+    "bool_to_string",
+    "float_to_string",
+    "int_to_string",
+    "to_opt_bool",
+    "to_opt_float",
+    "to_opt_int",
+    "BooleanField",
+    "ClassificationField",
+    "CompanyRegistrationField",
+    "DateField",
+    "LocaleField",
+    "PaymentDetailsField",
+    "PositionField",
+    "Taxes",
+    "TaxField",
+    "StringField",
+]

mindee/parsing/v2/inference_model.py

@@ -11,4 +11,4 @@ def __init__(self, raw_response: StringDict) -> None:
         self.id = raw_response["id"]
 
     def __str__(self) -> str:
-        return f"Model\n=====" f"\n:ID: {self.id}"
+        return f"Model\n=====\n:ID: {self.id}"

mindee/pdf/__init__.py

@@ -5,3 +5,11 @@
     has_source_text,
     lerp,
 )
+
+__all__ = [
+    "PDFCharData",
+    "compress_pdf",
+    "extract_text_from_pdf",
+    "has_source_text",
+    "lerp",
+]

mindee/product/__init__.py

@@ -155,3 +155,75 @@
 from mindee.product.resume.resume_v1_social_networks_url import (
     ResumeV1SocialNetworksUrl,
 )
+
+__all__ = [
+    "fr",
+    "ind",
+    "us",
+    "BarcodeReaderV1",
+    "BarcodeReaderV1Document",
+    "BillOfLadingV1",
+    "BillOfLadingV1Carrier",
+    "BillOfLadingV1CarrierItem",
+    "BillOfLadingV1Consignee",
+    "BillOfLadingV1Document",
+    "BillOfLadingV1NotifyParty",
+    "BillOfLadingV1Shipper",
+    "BusinessCardV1",
+    "BusinessCardV1Document",
+    "CropperV1",
+    "CropperV1Document",
+    "CropperV1Page",
+    "CustomV1",
+    "CustomV1Document",
+    "CustomV1Page",
+    "DeliveryNoteV1",
+    "DeliveryNoteV1Document",
+    "DriverLicenseV1",
+    "DriverLicenseV1Document",
+    "FinancialDocumentV1",
+    "FinancialDocumentV1Document",
+    "FinancialDocumentV1LineItem",
+    "GeneratedV1",
+    "GeneratedV1Document",
+    "GeneratedV1Page",
+    "InternationalIdV2",
+    "InternationalIdV2Document",
+    "InvoiceV4",
+    "InvoiceV4Document",
+    "InvoiceV4LineItem",
+    "InvoiceSplitterV1",
+    "InvoiceSplitterV1Document",
+    "InvoiceSplitterV1InvoicePageGroup",
+    "MaterialCertificateV1",
+    "MaterialCertificateV1Document",
+    "MultiReceiptsDetectorV1",
+    "MultiReceiptsDetectorV1Document",
+    "NutritionFactsLabelV1",
+    "NutritionFactsLabelV1AddedSugar",
+    "NutritionFactsLabelV1Calorie",
+    "NutritionFactsLabelV1Cholesterol",
+    "NutritionFactsLabelV1DietaryFiber",
+    "NutritionFactsLabelV1Document",
+    "NutritionFactsLabelV1Nutrient",
+    "NutritionFactsLabelV1Protein",
+    "NutritionFactsLabelV1SaturatedFat",
+    "NutritionFactsLabelV1ServingSize",
+    "NutritionFactsLabelV1Sodium",
+    "NutritionFactsLabelV1TotalCarbohydrate",
+    "NutritionFactsLabelV1TotalFat",
+    "NutritionFactsLabelV1TotalSugar",
+    "NutritionFactsLabelV1TransFat",
+    "PassportV1",
+    "PassportV1Document",
+    "ReceiptV5",
+    "ReceiptV5Document",
+    "ReceiptV5LineItem",
+    "ResumeV1",
+    "ResumeV1Certificate",
+    "ResumeV1Document",
+    "ResumeV1Education",
+    "ResumeV1Language",
+    "ResumeV1ProfessionalExperience",
+    "ResumeV1SocialNetworksUrl",
+]

mindee/product/barcode_reader/__init__.py

@@ -2,3 +2,8 @@
 from mindee.product.barcode_reader.barcode_reader_v1_document import (
     BarcodeReaderV1Document,
 )
+
+__all__ = [
+    "BarcodeReaderV1",
+    "BarcodeReaderV1Document",
+]

mindee/product/barcode_reader/barcode_reader_v1_document.py

@@ -36,10 +36,10 @@ def __init__(
         ]
 
     def __str__(self) -> str:
-        codes_1d = f"\n { ' ' * 13 }".join(
+        codes_1d = f"\n {' ' * 13}".join(
             [str(item) for item in self.codes_1d],
         )
-        codes_2d = f"\n { ' ' * 13 }".join(
+        codes_2d = f"\n {' ' * 13}".join(
             [str(item) for item in self.codes_2d],
         )
         out_str: str = f":Barcodes 1D: {codes_1d}\n"