fastapi-error-map 0.9.3__tar.gz → 0.9.4__tar.gz

{fastapi_error_map-0.9.3 → fastapi_error_map-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-error-map
-Version: 0.9.3
+Version: 0.9.4
 Summary: Elegant per-endpoint error handling in FastAPI with OpenAPI schema generation
 Project-URL: Homepage, https://github.com/ivan-borovets/fastapi-error-map
 Project-URL: Repository, https://github.com/ivan-borovets/fastapi-error-map
@@ -41,7 +41,7 @@ Description-Content-Type: text/markdown
 
 ## FastAPI Error Map
 
-[![PyPI version](https://badge.fury.io/py/fastapi-error-map.svg?cacheBust=2)](https://badge.fury.io/py/fastapi-error-map)
+[![PyPI version](https://badge.fury.io/py/fastapi-error-map.svg?cacheBust=4)](https://badge.fury.io/py/fastapi-error-map)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-error-map?cacheBust=1)
 [![codecov](https://codecov.io/gh/ivan-borovets/fastapi-error-map/branch/master/graph/badge.svg?token=ABTVQLI0RL)](https://codecov.io/gh/ivan-borovets/fastapi-error-map)
 ![GitHub License](https://img.shields.io/github/license/ivan-borovets/fastapi-error-map?cacheBust=1)
@@ -260,6 +260,11 @@ If it raises, the exception propagates and the request fails.
 This is intentional to avoid hiding errors in side effects — they should be fixed rather than silently ignored.
 Keep `on_error` robust or wrap it on your side if you prefer soft-fail logging.
 
+> [!NOTE]
+> Both translator and `on_error` receive the raised exception as an argument.
+> If your implementation does not use it, suppress the unused-argument warning from your linter (e.g. `# noqa: ARG002`
+> for Ruff).
+
 ### 🧠 Parameter Precedence
 
 Error handling and schema generation in `fastapi-error-map` are fully driven by route-level arguments to `.get()`,
@@ -318,7 +323,7 @@ from `error_map` — but only for the specified status codes.
 
 ```
 
-#### 🚨 Handling Unmapped Exceptions (`warn_on_unmapped`)
+#### ❗ Handling Unmapped Exceptions (`warn_on_unmapped`)
 
 By default (`warn_on_unmapped=True`), `fastapi-error-map` expects every exception raised in a handler to be explicitly
 listed in `error_map`.  

{fastapi_error_map-0.9.3 → fastapi_error_map-0.9.4}/README.md

@@ -1,6 +1,6 @@
 ## FastAPI Error Map
 
-[![PyPI version](https://badge.fury.io/py/fastapi-error-map.svg?cacheBust=2)](https://badge.fury.io/py/fastapi-error-map)
+[![PyPI version](https://badge.fury.io/py/fastapi-error-map.svg?cacheBust=4)](https://badge.fury.io/py/fastapi-error-map)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-error-map?cacheBust=1)
 [![codecov](https://codecov.io/gh/ivan-borovets/fastapi-error-map/branch/master/graph/badge.svg?token=ABTVQLI0RL)](https://codecov.io/gh/ivan-borovets/fastapi-error-map)
 ![GitHub License](https://img.shields.io/github/license/ivan-borovets/fastapi-error-map?cacheBust=1)
@@ -219,6 +219,11 @@ If it raises, the exception propagates and the request fails.
 This is intentional to avoid hiding errors in side effects — they should be fixed rather than silently ignored.
 Keep `on_error` robust or wrap it on your side if you prefer soft-fail logging.
 
+> [!NOTE]
+> Both translator and `on_error` receive the raised exception as an argument.
+> If your implementation does not use it, suppress the unused-argument warning from your linter (e.g. `# noqa: ARG002`
+> for Ruff).
+
 ### 🧠 Parameter Precedence
 
 Error handling and schema generation in `fastapi-error-map` are fully driven by route-level arguments to `.get()`,
@@ -277,7 +282,7 @@ from `error_map` — but only for the specified status codes.
 
 ```
 
-#### 🚨 Handling Unmapped Exceptions (`warn_on_unmapped`)
+#### ❗ Handling Unmapped Exceptions (`warn_on_unmapped`)
 
 By default (`warn_on_unmapped=True`), `fastapi-error-map` expects every exception raised in a handler to be explicitly
 listed in `error_map`.  

{fastapi_error_map-0.9.3 → fastapi_error_map-0.9.4}/fastapi_error_map/translators.py

@@ -71,5 +71,5 @@ class DefaultServerErrorTranslator(ErrorTranslator[SimpleErrorResponseModel]):
     def error_response_model_cls(self) -> type[SimpleErrorResponseModel]:
         return SimpleErrorResponseModel
 
-    def from_error(self, _err: Exception) -> SimpleErrorResponseModel:
+    def from_error(self, err: Exception) -> SimpleErrorResponseModel:
         return SimpleErrorResponseModel(error="Internal server error")

{fastapi_error_map-0.9.3 → fastapi_error_map-0.9.4}/pyproject.toml

@@ -7,7 +7,7 @@ sources = ["src"]
 
 [project]
 name = "fastapi-error-map"
-version = "0.9.3"
+version = "0.9.4"
 description = "Elegant per-endpoint error handling in FastAPI with OpenAPI schema generation"
 readme = "README.md"
 license = { text = "Apache-2.0" }
@@ -160,6 +160,7 @@ split-on-trailing-comma = true
 
 [tool.ruff.lint.per-file-ignores]
 "tests/**" = [
+    "ARG002", # unused-method-argument
     "PLR2004", # magic-value-comparison
     "S101", # assert
 ]
@@ -175,6 +176,9 @@ split-on-trailing-comma = true
     "UP006", # non-pep585-annotation
     "UP035", # deprecated-import
 ]
+"src/fastapi_error_map/translators.py" = [
+    "ARG002", # unused-method-argument
+]
 
 [tool.slotscheck]
 strict-imports = true

{fastapi_error_map-0.9.3 → fastapi_error_map-0.9.4}/tests/unit/translator_stubs.py

@@ -27,7 +27,7 @@ class DummyServerErrorTranslator(ErrorTranslator[ServerErrorStub]):
     def error_response_model_cls(self) -> type[ServerErrorStub]:
         return ServerErrorStub
 
-    def from_error(self, _err: Exception) -> ServerErrorStub:
+    def from_error(self, err: Exception) -> ServerErrorStub:
         return ServerErrorStub(error="internal")
 
 
@@ -36,5 +36,5 @@ class CustomTranslator(ErrorTranslator[dict[str, str]]):
     def error_response_model_cls(self) -> type[dict[str, str]]:
         return dict
 
-    def from_error(self, _err: Exception) -> dict[str, str]:
+    def from_error(self, err: Exception) -> dict[str, str]:
         return {"msg": "explicit"}