fastapi-errors-plus 0.6.1__py3-none-any.whl → 0.6.2__py3-none-any.whl

fastapi_errors_plus/__init__.py

@@ -10,5 +10,5 @@ __all__ = [
     "BaseErrorDTO",  # Base implementation (optional)
     "StandardErrorDTO",  # Extended implementation (optional)
 ]
-__version__ = "0.6.1"
+__version__ = "0.6.2"
 

fastapi_errors_plus/base.py

@@ -122,3 +122,4 @@ class StandardErrorDTO(BaseErrorDTO):
 
 
 
+

fastapi_errors_plus/errors.py

@@ -140,7 +140,7 @@ class Errors(Mapping):
         
         if add_422:
             self._add_standard_error(
-                status.HTTP_422_UNPROCESSABLE_ENTITY,
+                status.HTTP_422_UNPROCESSABLE_CONTENT,
                 "Validation Error",
                 {"detail": "Validation error"},
             )
@@ -239,7 +239,7 @@ class Errors(Mapping):
     STANDARD_DESCRIPTIONS = {
         status.HTTP_401_UNAUTHORIZED: "Unauthorized",
         status.HTTP_403_FORBIDDEN: "Forbidden",
-        status.HTTP_422_UNPROCESSABLE_ENTITY: "Validation Error",
+        status.HTTP_422_UNPROCESSABLE_CONTENT: "Validation Error",
         status.HTTP_500_INTERNAL_SERVER_ERROR: "Internal Server Error",
     }
     
@@ -263,7 +263,7 @@ class Errors(Mapping):
         standard_keys = {
             status.HTTP_401_UNAUTHORIZED: "StandardUnauthorized",
             status.HTTP_403_FORBIDDEN: "StandardForbidden",
-            status.HTTP_422_UNPROCESSABLE_ENTITY: "StandardValidationError",
+            status.HTTP_422_UNPROCESSABLE_CONTENT: "StandardValidationError",
             status.HTTP_500_INTERNAL_SERVER_ERROR: "StandardInternalServerError",
         }
         example_key = standard_keys.get(status_code, f"Standard{status_code}")

fastapi_errors_plus/protocol.py

@@ -50,3 +50,4 @@ class ErrorDTO(Protocol):
 
 
 
+

{fastapi_errors_plus-0.6.1.dist-info → fastapi_errors_plus-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-errors-plus
-Version: 0.6.1
+Version: 0.6.2
 Summary: Universal library for documenting errors in FastAPI endpoints
 Author-email: Igor Selivanov <seligoroff@gmail.com>
 License: MIT
@@ -335,6 +335,102 @@ Any class implementing this protocol (through structural typing) can be used wit
 
 Both approaches work together — you can mix them in the same `Errors()` call!
 
+## Using Pydantic with ErrorDTO
+
+**Note:** Pydantic is **not required** to use this library. This section is for projects that already use Pydantic and want to integrate it with the ErrorDTO protocol.
+
+Since the library uses structural typing (Protocol), any class that implements the required attributes (`status_code`, `message`, `to_example()`) will work, including Pydantic models.
+
+### Simple Pydantic Model as ErrorDTO
+
+```python
+from pydantic import BaseModel, Field
+from fastapi_errors_plus import Errors
+from typing import Dict, Any
+
+class PydanticErrorDTO(BaseModel):
+    """Pydantic model implementing ErrorDTO Protocol."""
+    status_code: int = Field(..., ge=400, le=599, description="HTTP status code")
+    message: str = Field(..., min_length=1, description="Error message")
+    
+    def to_example(self) -> Dict[str, Any]:
+        """Generate example for OpenAPI."""
+        return {
+            self.message: {
+                "value": {"detail": self.message},
+            },
+        }
+
+# Usage
+notification_error = PydanticErrorDTO(
+    status_code=404,
+    message="Notification not found",
+)
+
+@router.delete(
+    "/{id}",
+    responses=Errors(notification_error),
+)
+def delete_item(id: int):
+    pass
+```
+
+**Benefits:**
+- Runtime validation through Pydantic
+- Type safety
+- Automatic field documentation
+- Works with ErrorDTO Protocol through structural typing
+
+### Complex ErrorDTO with Pydantic
+
+For errors with additional fields:
+
+```python
+from pydantic import BaseModel, Field
+from fastapi_errors_plus import Errors
+from typing import Dict, Any, Optional
+
+class DetailedErrorDTO(BaseModel):
+    """Pydantic model for errors with additional fields."""
+    status_code: int = Field(..., ge=400, le=599)
+    message: str = Field(..., min_length=1)
+    error_code: Optional[str] = Field(None, description="Internal error code")
+    timestamp: Optional[str] = Field(None, description="Error timestamp")
+    
+    def to_example(self) -> Dict[str, Any]:
+        """Generate example for OpenAPI."""
+        example = {"detail": self.message}
+        if self.error_code:
+            example["error_code"] = self.error_code
+        if self.timestamp:
+            example["timestamp"] = self.timestamp
+        
+        return {
+            self.message: {
+                "value": example,
+            },
+        }
+
+# Usage
+validation_error = DetailedErrorDTO(
+    status_code=422,
+    message="Validation failed",
+    error_code="VALIDATION_ERROR",
+    timestamp="2025-01-15T10:30:00Z",
+)
+```
+
+**When to use Pydantic with ErrorDTO:**
+- Your project already uses Pydantic extensively
+- You need runtime validation for error objects
+- You want automatic field documentation
+- You have complex error structures with multiple fields
+
+**When not to use Pydantic:**
+- Your project doesn't use Pydantic (use `BaseErrorDTO` or `StandardErrorDTO` instead)
+- You need simple error objects (dataclasses are sufficient)
+- You want to keep dependencies minimal
+
 ## Best Practice: Connecting Exceptions and ErrorDTO
 
 ### Problem

fastapi_errors_plus-0.6.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+fastapi_errors_plus/__init__.py,sha256=EGgxWvcYC_R3mwD8wDu5_Cx7U2E58pnYnC3YHrDtzJY,454
+fastapi_errors_plus/base.py,sha256=tGCroiEZM9aNYH9ikmYbp-FHZF7yDMfZyMMF-5rc9qQ,3581
+fastapi_errors_plus/errors.py,sha256=zS1AO_auXfDlrnfNMHkvNpUwREXs76atL_fRDlm_cUo,20871
+fastapi_errors_plus/protocol.py,sha256=HaoMr73cL64y3Q9KcO0cKh_DcJbcR3VHxMZLsmpjsWI,1219
+fastapi_errors_plus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_errors_plus-0.6.2.dist-info/licenses/LICENSE,sha256=PpYbS0f6IOOqH1JNR3K1UKZdEio6iO2ur9r8TwIZ7zs,1094
+fastapi_errors_plus-0.6.2.dist-info/METADATA,sha256=a9v0T3zfWh8uSBmK6UpzRvun7yS7DxgyO80odgtUECY,24420
+fastapi_errors_plus-0.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_errors_plus-0.6.2.dist-info/top_level.txt,sha256=vmHLF1-DQYB2quqrvdBA0g6rDtgOWQBrA1m-X_WyNk8,20
+fastapi_errors_plus-0.6.2.dist-info/RECORD,,

{fastapi_errors_plus-0.6.1.dist-info → fastapi_errors_plus-0.6.2.dist-info}/licenses/LICENSE

@@ -23,3 +23,4 @@ SOFTWARE.
 
 
 
+

fastapi_errors_plus-0.6.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-fastapi_errors_plus/__init__.py,sha256=aYuyu5HwVWzgT0QhkKhHuJez0ARHoHG0ynQCHQPzbrc,454
-fastapi_errors_plus/base.py,sha256=iTQ6WFxc5fLoY0Omi8aPNua7wBqQj20Z5ZPOOJhTIow,3580
-fastapi_errors_plus/errors.py,sha256=7ikmrSphWOH_nnxLC0HPQ0RPiuR1u8olw3bxGxdLv50,20868
-fastapi_errors_plus/protocol.py,sha256=466lfnVKWa1jjD0iWy3r_FIXFIqTuATJOT9sqXxbKZE,1218
-fastapi_errors_plus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_errors_plus-0.6.1.dist-info/licenses/LICENSE,sha256=W_dONuuw-DA1UPcP9NPnQbhCbtMkLjhUr3Ne96398VU,1093
-fastapi_errors_plus-0.6.1.dist-info/METADATA,sha256=PA7WauqlQWEKuOIz_Mcv5ECBaLgTCng1cSKN34fJof4,21455
-fastapi_errors_plus-0.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_errors_plus-0.6.1.dist-info/top_level.txt,sha256=vmHLF1-DQYB2quqrvdBA0g6rDtgOWQBrA1m-X_WyNk8,20
-fastapi_errors_plus-0.6.1.dist-info/RECORD,,