fastapi-error-map 0.1.0__tar.gz → 0.9.0__tar.gz

fastapi_error_map-0.9.0/.github/workflows/ci.yaml

@@ -0,0 +1,32 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv pip install -e '.[dev,test]' --system
+
+      - name: Lint code
+        run: make code.lint
+
+      - name: Run tests for Codecov
+        run: pytest --cov=fastapi_error_map --cov-branch --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

fastapi_error_map-0.9.0/.github/workflows/test-compatibility.yaml

@@ -0,0 +1,38 @@
+name: TestCompatibility
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  compatibility:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up ${{ matrix.python-version }} on ${{ matrix.os }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install nox
+        run: uv pip install nox --system
+
+      - name: Run tests
+        run: nox -s compatibility

fastapi_error_map-0.9.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Ivan Borovets
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fastapi_error_map-0.9.0/PKG-INFO

@@ -0,0 +1,320 @@
+Metadata-Version: 2.4
+Name: fastapi-error-map
+Version: 0.9.0
+Summary: Elegant per-endpoint error handling in FastAPI with OpenAPI schema generation
+Author-email: Ivan Borovets <ivan.r.borovets@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: orjson>=3.11.1
+Provides-Extra: dev
+Requires-Dist: mypy==1.8.0; extra == 'dev'
+Requires-Dist: pre-commit==4.2.0; extra == 'dev'
+Requires-Dist: ruff==0.11.2; extra == 'dev'
+Provides-Extra: examples
+Requires-Dist: uvicorn==0.35.0; extra == 'examples'
+Provides-Extra: publish
+Requires-Dist: hatch==1.14.1; extra == 'publish'
+Provides-Extra: test
+Requires-Dist: coverage==7.10.1; extra == 'test'
+Requires-Dist: httpx==0.28.1; extra == 'test'
+Requires-Dist: nox==2025.5.1; extra == 'test'
+Requires-Dist: pytest-asyncio==1.1.0; extra == 'test'
+Requires-Dist: pytest-cov==6.2.1; extra == 'test'
+Requires-Dist: pytest==8.4.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+## FastAPI Error Map
+
+[![PyPI version](https://badge.fury.io/py/fastapi-error-map.svg)](https://badge.fury.io/py/fastapi-error-map)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-error-map)
+![GitHub License](https://img.shields.io/github/license/ivan-borovets/fastapi-error-map)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ivan-borovets/fastapi-error-map/ci.yaml)
+
+Elegant per-endpoint error handling in FastAPI with OpenAPI schema generation.
+
+### 📦 Installation
+
+```bash
+pip install fastapi-error-map
+```
+
+### 🚀 Quickstart
+
+```python
+# A seamless replacement for APIRouter with error mapping support
+router = ErrorAwareRouter()
+
+
+@router.get(
+    "/stock",
+    error_map={
+        # Minimal rule: return 401 and respond with {"error": "..."}
+        # using default translator
+        AuthorizationError: 401,
+        # Full rule: return 409 and respond with custom JSON
+        # using custom translator, and trigger side effect
+        OutOfStockError: rule(
+            status=409,
+            translator=OutOfStockTranslator(),
+            on_error=notify,
+        ),
+    },
+)
+def check_stock(user_id: int = 0) -> None:
+    if user_id == 0:
+        raise AuthorizationError
+    raise OutOfStockError("No items available.")
+
+```
+
+- Fully compatible with `APIRouter`
+- Error handling centralized at the endpoint level
+- OpenAPI schema automatically generated
+
+<div align="center">
+  <img src="docs/example-openapi.png" alt="Example OpenAPI" width="600"/>
+  <p><em>Figure 1: Example OpenAPI</em></p>
+</div>
+
+### 🔍 Why Not Global Handlers?
+
+To convert application errors into HTTP responses, FastAPI allows attaching exception handlers to the app instance.
+These handlers are global, which makes it harder to customize the response based on context and can become a source of
+hidden bugs.
+
+```python
+app.add_exception_handler(UserNotFoundError, error_handler)
+
+```
+
+For example, `error_handler` might turn `UserNotFoundError` into `404 Not Found`.
+But in an authentication context, it might mean `401 Unauthorized`, and in a communication scenario —
+`422 Unprocessable Entity`.
+The fact that a user is missing carries different meaning in different situations.
+
+If accuracy and clarity in your API matter more than the short-term convenience of global (and implicit) exception
+interception, prefer handling exceptions directly in the route — where full context is available: request type, business
+scenario, and client expectations.
+
+You could use `try/except` blocks or a decorator with error mapping.
+The first doesn't keep your views clean and duplicates logic between routes.
+The second solves that, but like the first, remains invisible to FastAPI: the framework can't extract possible responses
+from your decorator to include in the OpenAPI schema.
+You could define `responses` manually, but that risks a mismatch between the schema and actual behavior — because
+there's no single source of truth.
+
+`fastapi-error-map` solves this by letting you define error handling rules right in the route declaration.
+See the [example in the 🚀 Quickstart](#-quickstart).
+
+### ⚙ How `error_map` Works
+
+Error handling rules are defined directly in the route declaration of an `ErrorAwareRouter`, using the `error_map`
+parameter.
+
+There are two ways to do it:
+
+#### 🔸 Short Form
+
+```python
+error_map = {
+    SomeError: 400,
+}
+
+```
+
+Which is equivalent to:
+
+```python
+error_map = {
+    SomeError: rule(status=400),
+}
+
+```
+
+In both cases, the default translator is used, which returns JSON like:
+
+```json
+{
+  "error": "SomeError"
+}
+```
+
+#### 🔹 Full Form
+
+Allows you to specify the status code, and optionally a `translator` and `on_error`:
+
+```python
+error_map = {
+    MyError: rule(
+        status=409,
+        translator=MyTranslator(),
+        on_error=report_to_sentry,
+    ),
+}
+
+```
+
+Parameters of `rule(...)`, * — required:
+
+- `status`* — HTTP status code to return (e.g. `404`, `409`, `422`)
+- `translator` — object that converts an exception into JSON response. If not provided, the default one is used (returns
+  `{ "error": "..." }`)
+- `on_error` — function to call when an exception occurs (e.g. logging or alerting)
+
+### 🧰 Custom Translators
+
+If you want to change the error response format, define your own `translator` — object that implements `ErrorTranslator`
+protocol.
+It has:
+
+- `.from_error(err)` — turns exception into serializable object
+- `.error_response_model_cls` — returns a class describing object structure (used for OpenAPI)
+
+Example:
+
+```python
+from dataclasses import dataclass
+from fastapi_error_map.translators import ErrorTranslator
+
+
+@dataclass
+class MyErrorResponse:
+    type: str
+    message: str
+
+
+class MyTranslator(ErrorTranslator[MyErrorResponse]):
+    @property
+    def error_response_model_cls(self) -> type[MyErrorResponse]:
+        return MyErrorResponse
+
+    def from_error(self, err: Exception) -> MyErrorResponse:
+        return MyErrorResponse(
+            type=type(err).__name__,
+            message=str(err),
+        )
+
+```
+
+### 🔄 Side Effects (`on_error`)
+
+The `on_error` parameter in `rule(...)` allows specifying function to run when exception occurs, before response is
+generated.
+It doesn't affect the HTTP response, but it's useful for:
+
+- logging
+- sending alerts
+- metrics
+- debugging
+
+Example:
+
+```python
+def notify_admin(err: Exception) -> None:
+    print(f"[!] Error: {type(err).__name__} — {err}")
+
+
+error_map = {
+    DangerousOperationError: rule(
+        status=500,
+        translator=MyTranslator(),
+        on_error=notify_admin,
+    ),
+}
+
+```
+
+### 🧠 Parameter Precedence
+
+Error handling and schema generation in `fastapi-error-map` are fully driven by route-level arguments to `.get()`,
+`.post()`, etc.
+
+#### 📎 Core Parameters
+
+In addition to `error_map`, you can also pass:
+
+```
+@router.get(
+    "/path",
+    error_map=...,
+    default_on_error=...,
+    warn_on_unmapped=...,
+    default_client_error_translator=...,
+    default_server_error_translator=...,
+)
+```
+
+These parameters apply to the current route only.
+They are not set on the router level (for now).
+
+#### ➕ How Parameters Are Resolved
+
+When an error occurs, `fastapi-error-map` processes it as follows:
+
+1. `status` is taken from `rule(...)`, or from short form: `SomeError: 400`
+2. `translator`:
+
+- If provided in `rule(...)`, it is used
+- Otherwise:
+    - If the status is `< 500`, `default_client_error_translator` is used (if given)
+    - If the status is `>= 500`, `default_server_error_translator` is used (if given)
+    - If none are set, the built-in one is used:
+  ```raw
+  { "error": "..." } or { "error": "Internal server error" }
+  ```
+
+3. `on_error`:
+    - If provided in `rule(...)`, it is used
+    - Otherwise, `default_on_error` is used if provided
+    - If neither is set, nothing is called
+
+#### 🧾 OpenAPI: `responses` Takes Priority
+
+If you explicitly pass the `responses=...` parameter to `.get(...)` / `.post(...)`, it overrides the schema generation
+from `error_map` — but only for the specified status codes.
+
+```python
+@router.get(
+    "/foo",
+    error_map={SomeError: 400},
+    responses={400: {"model": {}}},  # ← this wins
+)
+
+```
+
+#### 🚨 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`.  
+If a rule is missing, a `RuntimeError` is raised, and the original exception is attached as `__cause__`.
+This helps you catch missing error cases at runtime.
+
+If you set `warn_on_unmapped=False`, the library won’t complain about missing rules and will re-raise the exception
+as-is.
+In that case:
+
+- the exception type is preserved
+- the original stack trace is retained
+- the global `@app.exception_handler(...)` in FastAPI will receive raw exception
+
+#### 📘 Handling by FastAPI
+
+FastAPI will always catch unhandled exceptions and pass them to the global `@app.exception_handler(...)` if defined.
+This behavior is not affected by `warn_on_unmapped`.
+
+If the error is declared in `error_map`, `fastapi-error-map` handles the response itself — the global handler will not
+be triggered.