fastapi-errors-plus 0.5.0__tar.gz → 0.6.0__tar.gz

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/LICENSE

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

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-errors-plus
-Version: 0.5.0
+Version: 0.6.0
 Summary: Universal library for documenting errors in FastAPI endpoints
 Author-email: Igor Selivanov <seligoroff@gmail.com>
 License: MIT
@@ -246,10 +246,10 @@ def delete_item(id: int):
 ```
 
 **Benefits:**
-- ✅ No need to write ErrorDTO classes from scratch
-- ✅ Correct implementation out of the box
-- ✅ Reusable across all endpoints
-- ✅ Supports inheritance for custom logic
+- No need to write ErrorDTO classes from scratch
+- Correct implementation out of the box
+- Reusable across all endpoints
+- Supports inheritance for custom logic
 
 ### 5. Mixed Usage
 
@@ -319,6 +319,8 @@ class ErrorDTO(Protocol):
 
 Any class implementing this protocol (through structural typing) can be used with `Errors()`.
 
+**Best Practice:** For maximum clarity, consider making your domain exceptions implement the ErrorDTO protocol directly. See [Best Practice: Connecting Exceptions and ErrorDTO](#best-practice-connecting-exceptions-and-errordto) for details.
+
 ### When to Use Protocol vs BaseErrorDTO
 
 **Use Protocol (structural typing)** when:
@@ -333,6 +335,71 @@ 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!
 
+## Best Practice: Connecting Exceptions and ErrorDTO
+
+### Problem
+
+It's not always clear which exception corresponds to which ErrorDTO:
+
+```python
+# Not clear which exception this documents
+responses=Errors(notification_not_found_error)
+```
+
+### Solution: Domain Exception as ErrorDTO
+
+**Recommended approach** — make your exceptions implement ErrorDTO protocol:
+
+```python
+# domain/exceptions.py
+from typing import Dict, Any
+
+class DomainException(Exception):
+    """Base exception implementing ErrorDTO protocol."""
+    status_code: int
+    message: str
+    
+    def to_example(self) -> Dict[str, Any]:
+        return {self.message: {"value": {"detail": self.message}}}
+    
+    @classmethod
+    def for_openapi(cls):
+        """Returns instance for OpenAPI documentation."""
+        return cls()
+
+class NotificationNotFoundError(DomainException):
+    status_code = 404
+    message = "Notification not found"
+    
+    def __init__(self, notification_id: str = ""):
+        self.notification_id = notification_id
+        super().__init__(self.message)
+    
+    @classmethod
+    def for_openapi(cls):
+        return cls(notification_id="example_id")
+
+# In endpoint
+@router.delete(
+    "/{notificationId}",
+    responses=Errors(
+        NotificationNotFoundError.for_openapi(),  # Clear connection!
+    ),
+)
+async def delete_notification(notification_id: str):
+    if not notification:
+        raise NotificationNotFoundError(notification_id)  # Same exception!
+```
+
+**Benefits:**
+- Exception and ErrorDTO are one class
+- Clear connection visible in endpoint
+- No duplication
+- Type-safe
+- Works with any project architecture
+
+See [examples/domain_exceptions.py](examples/domain_exceptions.py) for complete example.
+
 ## Compatibility with Existing Projects
 
 If your project already has error DTOs (like `ApiErrorDTO`), they can work with `fastapi-errors-plus` if they implement the `ErrorDTO` protocol:

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/README.md

@@ -220,10 +220,10 @@ def delete_item(id: int):
 ```
 
 **Benefits:**
-- ✅ No need to write ErrorDTO classes from scratch
-- ✅ Correct implementation out of the box
-- ✅ Reusable across all endpoints
-- ✅ Supports inheritance for custom logic
+- No need to write ErrorDTO classes from scratch
+- Correct implementation out of the box
+- Reusable across all endpoints
+- Supports inheritance for custom logic
 
 ### 5. Mixed Usage
 
@@ -293,6 +293,8 @@ class ErrorDTO(Protocol):
 
 Any class implementing this protocol (through structural typing) can be used with `Errors()`.
 
+**Best Practice:** For maximum clarity, consider making your domain exceptions implement the ErrorDTO protocol directly. See [Best Practice: Connecting Exceptions and ErrorDTO](#best-practice-connecting-exceptions-and-errordto) for details.
+
 ### When to Use Protocol vs BaseErrorDTO
 
 **Use Protocol (structural typing)** when:
@@ -307,6 +309,71 @@ 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!
 
+## Best Practice: Connecting Exceptions and ErrorDTO
+
+### Problem
+
+It's not always clear which exception corresponds to which ErrorDTO:
+
+```python
+# Not clear which exception this documents
+responses=Errors(notification_not_found_error)
+```
+
+### Solution: Domain Exception as ErrorDTO
+
+**Recommended approach** — make your exceptions implement ErrorDTO protocol:
+
+```python
+# domain/exceptions.py
+from typing import Dict, Any
+
+class DomainException(Exception):
+    """Base exception implementing ErrorDTO protocol."""
+    status_code: int
+    message: str
+    
+    def to_example(self) -> Dict[str, Any]:
+        return {self.message: {"value": {"detail": self.message}}}
+    
+    @classmethod
+    def for_openapi(cls):
+        """Returns instance for OpenAPI documentation."""
+        return cls()
+
+class NotificationNotFoundError(DomainException):
+    status_code = 404
+    message = "Notification not found"
+    
+    def __init__(self, notification_id: str = ""):
+        self.notification_id = notification_id
+        super().__init__(self.message)
+    
+    @classmethod
+    def for_openapi(cls):
+        return cls(notification_id="example_id")
+
+# In endpoint
+@router.delete(
+    "/{notificationId}",
+    responses=Errors(
+        NotificationNotFoundError.for_openapi(),  # Clear connection!
+    ),
+)
+async def delete_notification(notification_id: str):
+    if not notification:
+        raise NotificationNotFoundError(notification_id)  # Same exception!
+```
+
+**Benefits:**
+- Exception and ErrorDTO are one class
+- Clear connection visible in endpoint
+- No duplication
+- Type-safe
+- Works with any project architecture
+
+See [examples/domain_exceptions.py](examples/domain_exceptions.py) for complete example.
+
 ## Compatibility with Existing Projects
 
 If your project already has error DTOs (like `ApiErrorDTO`), they can work with `fastapi-errors-plus` if they implement the `ErrorDTO` protocol:

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/fastapi_errors_plus/__init__.py

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

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/fastapi_errors_plus/base.py

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

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/fastapi_errors_plus/protocol.py

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

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/fastapi_errors_plus.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-errors-plus
-Version: 0.5.0
+Version: 0.6.0
 Summary: Universal library for documenting errors in FastAPI endpoints
 Author-email: Igor Selivanov <seligoroff@gmail.com>
 License: MIT
@@ -246,10 +246,10 @@ def delete_item(id: int):
 ```
 
 **Benefits:**
-- ✅ No need to write ErrorDTO classes from scratch
-- ✅ Correct implementation out of the box
-- ✅ Reusable across all endpoints
-- ✅ Supports inheritance for custom logic
+- No need to write ErrorDTO classes from scratch
+- Correct implementation out of the box
+- Reusable across all endpoints
+- Supports inheritance for custom logic
 
 ### 5. Mixed Usage
 
@@ -319,6 +319,8 @@ class ErrorDTO(Protocol):
 
 Any class implementing this protocol (through structural typing) can be used with `Errors()`.
 
+**Best Practice:** For maximum clarity, consider making your domain exceptions implement the ErrorDTO protocol directly. See [Best Practice: Connecting Exceptions and ErrorDTO](#best-practice-connecting-exceptions-and-errordto) for details.
+
 ### When to Use Protocol vs BaseErrorDTO
 
 **Use Protocol (structural typing)** when:
@@ -333,6 +335,71 @@ 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!
 
+## Best Practice: Connecting Exceptions and ErrorDTO
+
+### Problem
+
+It's not always clear which exception corresponds to which ErrorDTO:
+
+```python
+# Not clear which exception this documents
+responses=Errors(notification_not_found_error)
+```
+
+### Solution: Domain Exception as ErrorDTO
+
+**Recommended approach** — make your exceptions implement ErrorDTO protocol:
+
+```python
+# domain/exceptions.py
+from typing import Dict, Any
+
+class DomainException(Exception):
+    """Base exception implementing ErrorDTO protocol."""
+    status_code: int
+    message: str
+    
+    def to_example(self) -> Dict[str, Any]:
+        return {self.message: {"value": {"detail": self.message}}}
+    
+    @classmethod
+    def for_openapi(cls):
+        """Returns instance for OpenAPI documentation."""
+        return cls()
+
+class NotificationNotFoundError(DomainException):
+    status_code = 404
+    message = "Notification not found"
+    
+    def __init__(self, notification_id: str = ""):
+        self.notification_id = notification_id
+        super().__init__(self.message)
+    
+    @classmethod
+    def for_openapi(cls):
+        return cls(notification_id="example_id")
+
+# In endpoint
+@router.delete(
+    "/{notificationId}",
+    responses=Errors(
+        NotificationNotFoundError.for_openapi(),  # Clear connection!
+    ),
+)
+async def delete_notification(notification_id: str):
+    if not notification:
+        raise NotificationNotFoundError(notification_id)  # Same exception!
+```
+
+**Benefits:**
+- Exception and ErrorDTO are one class
+- Clear connection visible in endpoint
+- No duplication
+- Type-safe
+- Works with any project architecture
+
+See [examples/domain_exceptions.py](examples/domain_exceptions.py) for complete example.
+
 ## Compatibility with Existing Projects
 
 If your project already has error DTOs (like `ApiErrorDTO`), they can work with `fastapi-errors-plus` if they implement the `ErrorDTO` protocol:

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-errors-plus"
-version = "0.5.0"
+version = "0.6.0"
 description = "Universal library for documenting errors in FastAPI endpoints"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -46,3 +46,29 @@ python_files = "test_*.py"
 python_classes = "Test*"
 python_functions = "test_*"
 
+[tool.coverage.run]
+source = ["fastapi_errors_plus"]
+omit = [
+    "*/tests/*",
+    "*/__pycache__/*",
+    "*/venv/*",
+    "*/.venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]
+precision = 2
+show_missing = true
+skip_covered = false
+
+[tool.coverage.html]
+directory = "tests/htmlcov"
+

{fastapi_errors_plus-0.5.0 → fastapi_errors_plus-0.6.0}/tests/test_base.py

@@ -303,3 +303,4 @@ class TestBaseErrorDTOCompatibility:
         assert status.HTTP_500_INTERNAL_SERVER_ERROR in responses
 
 
+