♻️ homogenize typing & classes (#191)

Author: sebastianMindee

mindee/client.py

@@ -18,7 +18,7 @@
 from mindee.mindee_http.mindee_api import MindeeApi
 from mindee.parsing.common.async_predict_response import AsyncPredictResponse
 from mindee.parsing.common.feedback_response import FeedbackResponse
-from mindee.parsing.common.inference import Inference, TypeInference
+from mindee.parsing.common.inference import Inference
 from mindee.parsing.common.predict_response import PredictResponse
 from mindee.parsing.common.string_dict import StringDict
 
@@ -72,7 +72,7 @@ def parse(
         page_options: Optional[PageOptions] = None,
         cropper: bool = False,
         endpoint: Optional[Endpoint] = None,
-    ) -> PredictResponse[TypeInference]:
+    ) -> PredictResponse:
         """
         Call prediction API on the document and parse the results.
 

mindee/parsing/common/async_predict_response.py

@@ -1,12 +1,12 @@
-from typing import Optional, Type
+from typing import Generic, Optional, Type
 
 from mindee.parsing.common.api_response import ApiResponse, StringDict
 from mindee.parsing.common.document import Document
-from mindee.parsing.common.inference import Inference
+from mindee.parsing.common.inference import TypeInference
 from mindee.parsing.common.job import Job
 
 
-class AsyncPredictResponse(ApiResponse):
+class AsyncPredictResponse(Generic[TypeInference], ApiResponse):
     """
     Async Response Wrapper class for a Predict response.
 
@@ -18,7 +18,7 @@ class AsyncPredictResponse(ApiResponse):
     document: Optional[Document]
 
     def __init__(
-        self, prediction_type: Type[Inference], raw_response: StringDict
+        self, inference_type: Type[TypeInference], raw_response: StringDict
     ) -> None:
         """
         Container wrapper for a raw API response.
@@ -32,4 +32,4 @@ def __init__(
         super().__init__(raw_response)
         self.job = Job(raw_response["job"])
         if "document" in raw_response and raw_response["document"]:
-            self.document = Document(prediction_type, raw_response["document"])
+            self.document = Document(inference_type, raw_response["document"])

mindee/parsing/common/document.py

@@ -35,7 +35,7 @@ class Document(Generic[TypePrediction, TypePage]):
 
     def __init__(
         self,
-        prediction_type: Type[Inference],
+        inference_type: Type[Inference],
         raw_response: StringDict,
     ):
         self.id = raw_response.get("id", "")
@@ -44,7 +44,7 @@ def __init__(
             self.ocr = Ocr(raw_response["ocr"])
         if "extras" in raw_response and raw_response["extras"]:
             self.extras = Extras(raw_response["extras"])
-        self.inference = prediction_type(raw_response["inference"])
+        self.inference = inference_type(raw_response["inference"])
 
     def __str__(self) -> str:
         return (

mindee/parsing/common/inference.py

@@ -2,7 +2,7 @@
 
 from mindee.error.mindee_error import MindeeError
 from mindee.parsing.common.page import TypePage
-from mindee.parsing.common.prediction import TypePrediction
+from mindee.parsing.common.prediction import Prediction, TypePrediction
 from mindee.parsing.common.product import Product
 from mindee.parsing.common.string_dict import StringDict
 
@@ -16,7 +16,7 @@ class Inference(Generic[TypePrediction, TypePage]):
     """Name of the endpoint for OTS APIs"""
     endpoint_version: Optional[str]
     """Version of the endpoint for OTS APIs"""
-    prediction: TypePrediction
+    prediction: Prediction
     """A document's top-level Prediction."""
     pages: List[TypePage]
     """A document's pages."""

mindee/parsing/common/predict_response.py

@@ -16,7 +16,7 @@ class PredictResponse(Generic[TypeInference], ApiResponse):
     """The document object, properly parsed after being retrieved from the server."""
 
     def __init__(
-        self, prediction_type: Type[TypeInference], raw_response: StringDict
+        self, inference_type: Type[TypeInference], raw_response: StringDict
     ) -> None:
         """
         Container for the raw API response and the parsed document.
@@ -25,4 +25,4 @@ def __init__(
         :param http_response: json response from HTTP call
         """
         super().__init__(raw_response)
-        self.document = Document(prediction_type, raw_response["document"])
+        self.document = Document(inference_type, raw_response["document"])