fastapi-extended-query-method 0.0.3__tar.gz

fastapi_extended_query_method-0.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JorgeCardona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_extended_query_method-0.0.3/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: fastapi-extended-query-method
+Version: 0.0.3
+Summary: Native HTTP QUERY method support for FastAPI with automatic cache control and Swagger compatibility.
+Home-page: https://github.com/jorgecardona/fastapi-extended-query-method
+Author: Jorge Cardona
+Keywords: fastapi,query,http-query,openapi,swagger,rest,api,middleware
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.139.0
+Requires-Dist: uvicorn>=0.5.1
+Requires-Dist: requests>=2.34.2
+Requires-Dist: requests-cache>=1.3.3
+Requires-Dist: tabulate>=0.10.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# FastAPI Extended Query Method
+
+Native HTTP QUERY support for FastAPI.
+
+## Overview
+
+`FastAPIWithQueryHttpMethod` extends FastAPI with native support for the
+HTTP QUERY method while preserving the FastAPI developer experience.
+
+## Installation
+
+``` bash
+pip install fastapi-extended-query-method
+```
+
+## Quick Start
+
+``` python
+from src.fastapi_extended_query_method import FastAPIWithQueryHttpMethod
+
+app = FastAPIWithQueryHttpMethod(query_saving_cache=True)
+```
+
+## Swagger compatibility
+
+After starting the application:
+
+    http://localhost:8000/docs
+
+OpenAPI and Swagger do **not** currently support the HTTP QUERY method.
+
+For that reason this package automatically exposes QUERY endpoints as
+both:
+
+-   QUERY
+-   POST
+
+Use the **POST** operation in Swagger only for interactive testing.
+
+Real clients should invoke the QUERY method directly.
+
+<p align="center">
+  <img src="images/swagger.png" alt="Swagger Interface" width="900">
+</p>
+
+## Cache
+
+`query_saving_cache=True` allows caching.
+
+`query_saving_cache=False` automatically adds:
+
+-   Cache-Control: no-store
+-   Pragma: no-cache
+-   Expires: 0
+
+## Testing API
+
+``` bash
+python validate_data/test_api_query_method.py
+```
+
+<p align="center">
+  <img src="images/api_results.png" alt="API Results" width="900">
+</p>
+
+## Testing Cache
+
+### Using Cache Stored
+``` bash
+python validate_data/test_cache_comparison.py
+```
+<p align="center">
+  <img src="images/cache.png" alt="Stored Cache" width="900">
+</p>
+
+### NO Using Cache Stored
+<p align="center">
+  <img src="images/no_cache.png" alt="Without Cache" width="900">
+</p>
+
+## License
+
+MIT

fastapi_extended_query_method-0.0.3/README.md

@@ -0,0 +1,83 @@
+# FastAPI Extended Query Method
+
+Native HTTP QUERY support for FastAPI.
+
+## Overview
+
+`FastAPIWithQueryHttpMethod` extends FastAPI with native support for the
+HTTP QUERY method while preserving the FastAPI developer experience.
+
+## Installation
+
+``` bash
+pip install fastapi-extended-query-method
+```
+
+## Quick Start
+
+``` python
+from src.fastapi_extended_query_method import FastAPIWithQueryHttpMethod
+
+app = FastAPIWithQueryHttpMethod(query_saving_cache=True)
+```
+
+## Swagger compatibility
+
+After starting the application:
+
+    http://localhost:8000/docs
+
+OpenAPI and Swagger do **not** currently support the HTTP QUERY method.
+
+For that reason this package automatically exposes QUERY endpoints as
+both:
+
+-   QUERY
+-   POST
+
+Use the **POST** operation in Swagger only for interactive testing.
+
+Real clients should invoke the QUERY method directly.
+
+<p align="center">
+  <img src="images/swagger.png" alt="Swagger Interface" width="900">
+</p>
+
+## Cache
+
+`query_saving_cache=True` allows caching.
+
+`query_saving_cache=False` automatically adds:
+
+-   Cache-Control: no-store
+-   Pragma: no-cache
+-   Expires: 0
+
+## Testing API
+
+``` bash
+python validate_data/test_api_query_method.py
+```
+
+<p align="center">
+  <img src="images/api_results.png" alt="API Results" width="900">
+</p>
+
+## Testing Cache
+
+### Using Cache Stored
+``` bash
+python validate_data/test_cache_comparison.py
+```
+<p align="center">
+  <img src="images/cache.png" alt="Stored Cache" width="900">
+</p>
+
+### NO Using Cache Stored
+<p align="center">
+  <img src="images/no_cache.png" alt="Without Cache" width="900">
+</p>
+
+## License
+
+MIT

fastapi_extended_query_method-0.0.3/fastapi_extended_query_method.egg-info/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: fastapi-extended-query-method
+Version: 0.0.3
+Summary: Native HTTP QUERY method support for FastAPI with automatic cache control and Swagger compatibility.
+Home-page: https://github.com/jorgecardona/fastapi-extended-query-method
+Author: Jorge Cardona
+Keywords: fastapi,query,http-query,openapi,swagger,rest,api,middleware
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.139.0
+Requires-Dist: uvicorn>=0.5.1
+Requires-Dist: requests>=2.34.2
+Requires-Dist: requests-cache>=1.3.3
+Requires-Dist: tabulate>=0.10.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# FastAPI Extended Query Method
+
+Native HTTP QUERY support for FastAPI.
+
+## Overview
+
+`FastAPIWithQueryHttpMethod` extends FastAPI with native support for the
+HTTP QUERY method while preserving the FastAPI developer experience.
+
+## Installation
+
+``` bash
+pip install fastapi-extended-query-method
+```
+
+## Quick Start
+
+``` python
+from src.fastapi_extended_query_method import FastAPIWithQueryHttpMethod
+
+app = FastAPIWithQueryHttpMethod(query_saving_cache=True)
+```
+
+## Swagger compatibility
+
+After starting the application:
+
+    http://localhost:8000/docs
+
+OpenAPI and Swagger do **not** currently support the HTTP QUERY method.
+
+For that reason this package automatically exposes QUERY endpoints as
+both:
+
+-   QUERY
+-   POST
+
+Use the **POST** operation in Swagger only for interactive testing.
+
+Real clients should invoke the QUERY method directly.
+
+<p align="center">
+  <img src="images/swagger.png" alt="Swagger Interface" width="900">
+</p>
+
+## Cache
+
+`query_saving_cache=True` allows caching.
+
+`query_saving_cache=False` automatically adds:
+
+-   Cache-Control: no-store
+-   Pragma: no-cache
+-   Expires: 0
+
+## Testing API
+
+``` bash
+python validate_data/test_api_query_method.py
+```
+
+<p align="center">
+  <img src="images/api_results.png" alt="API Results" width="900">
+</p>
+
+## Testing Cache
+
+### Using Cache Stored
+``` bash
+python validate_data/test_cache_comparison.py
+```
+<p align="center">
+  <img src="images/cache.png" alt="Stored Cache" width="900">
+</p>
+
+### NO Using Cache Stored
+<p align="center">
+  <img src="images/no_cache.png" alt="Without Cache" width="900">
+</p>
+
+## License
+
+MIT

fastapi_extended_query_method-0.0.3/fastapi_extended_query_method.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+setup.py
+fastapi_extended_query_method.egg-info/PKG-INFO
+fastapi_extended_query_method.egg-info/SOURCES.txt
+fastapi_extended_query_method.egg-info/dependency_links.txt
+fastapi_extended_query_method.egg-info/requires.txt
+fastapi_extended_query_method.egg-info/top_level.txt
+src/__init__.py
+src/fastapi_extended_query_method.py

fastapi_extended_query_method-0.0.3/fastapi_extended_query_method.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_extended_query_method-0.0.3/fastapi_extended_query_method.egg-info/requires.txt

@@ -0,0 +1,5 @@
+fastapi>=0.139.0
+uvicorn>=0.5.1
+requests>=2.34.2
+requests-cache>=1.3.3
+tabulate>=0.10.0

fastapi_extended_query_method-0.0.3/fastapi_extended_query_method.egg-info/top_level.txt

@@ -0,0 +1 @@
+src

fastapi_extended_query_method-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fastapi_extended_query_method-0.0.3/setup.py

@@ -0,0 +1,53 @@
+import os
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as file:
+    long_description = file.read()
+
+# Get version from environment variable or fallback to a default value
+version = os.getenv("PACKAGE_VERSION", "0.0.1")  # Default to '0.0.7' if not provided
+
+setuptools.setup(
+    name="fastapi-extended-query-method",
+    version=version,  # Use the dynamic version from the environment variable
+    author="Jorge Cardona",
+    description="Native HTTP QUERY method support for FastAPI with automatic cache control and Swagger compatibility.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/jorgecardona/fastapi-extended-query-method",
+    packages=setuptools.find_packages(),
+    include_package_data=True,
+    install_requires=[
+        "fastapi>=0.139.0",
+        "uvicorn>=0.5.1",
+        "requests>=2.34.2",
+        "requests-cache>=1.3.3",
+        "tabulate>=0.10.0",
+    ],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Framework :: FastAPI",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Topic :: Internet :: WWW/HTTP",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ],
+    keywords=[
+        "fastapi",
+        "query",
+        "http-query",
+        "openapi",
+        "swagger",
+        "rest",
+        "api",
+        "middleware",
+    ],
+    python_requires=">=3.10",
+)

fastapi_extended_query_method-0.0.3/src/fastapi_extended_query_method.py

@@ -0,0 +1,85 @@
+from typing import Any, Callable
+from fastapi import FastAPI, Request, Response
+from fastapi.openapi.utils import get_openapi
+import logging
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(levelname)s: %(message)s",
+)
+
+logger = logging.getLogger(__name__)
+
+class FastAPIWithQueryHttpMethod(FastAPI):
+    """
+    [ES] Clase FastAPI modificada que habilita soporte nativo y visual para el método HTTP QUERY
+         y permite configurar automáticamente el guardado de caché para dicho método.
+
+    [EN] Modified FastAPI class that enables native and visual support for the HTTP QUERY method
+         and allows configuring cache saving for this method.
+    """
+
+    def __init__(
+        self,
+        *args: Any,
+        query_saving_cache: bool = True,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+
+        self.query_saving_cache = query_saving_cache
+
+        @self.middleware("http")
+        async def add_query_cache_headers(
+            request: Request,
+            call_next: Callable[[Request], Any],
+        ) -> Response:
+            response: Response = await call_next(request)
+
+            # [ES] Cuando el modo de guardado de caché está deshabilitado para QUERY,
+            #      evitamos que clientes, proxies o navegadores almacenen en caché
+            #      la respuesta, ya que este método puede transportar información
+            #      sensible.
+            #
+            # [EN] When cache saving mode is disabled for QUERY,
+            #      prevent clients, proxies and browsers from caching the response,
+            #      since this method may carry sensitive information.
+            if not self.query_saving_cache and request.method.upper() == "QUERY":
+                response.headers["Cache-Control"] = "no-store, no-cache, must-revalidate, max-age=0"
+                response.headers["Pragma"] = "no-cache"
+                response.headers["Expires"] = "0"
+                logger.info("QUERY cache saving is disabled. Clients, browsers, and proxies will not cache responses containing sensitive data.")
+
+            return response
+
+    def query(self, path: str, **kwargs: Any) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
+        """
+        [ES] Decorador para registrar un endpoint que acepte tanto POST como QUERY.
+             Se usa POST para que Swagger UI no lo rompa y permita probarlo desde la web,
+             y QUERY para soportar peticiones con dicho método HTTP real.
+
+        [EN] Decorator to register an endpoint that accepts both POST and QUERY.
+             POST is used so Swagger UI doesn't break and allows testing it from the web,
+             and QUERY to support requests with that actual HTTP method.
+        """
+        return self.api_route(path, methods=["POST", "QUERY"], **kwargs)
+
+    def openapi(self) -> dict[str, Any]:
+        """
+        [ES] Genera el esquema OpenAPI estándar garantizando que la ruta sea visible.
+
+        [EN] Generates the standard OpenAPI schema ensuring that the route is visible.
+        """
+        if self.openapi_schema:
+            return self.openapi_schema
+
+        openapi_schema = get_openapi(
+            title=self.title,
+            version=self.version,
+            openapi_version=self.openapi_version,
+            description=self.description,
+            routes=self.routes,
+        )
+
+        self.openapi_schema = openapi_schema
+        return self.openapi_schema