Topic/improvements (#229)

* feat(improve-fastapi): Add fix_api_docs (#227)

This function fixes errors loading /docs when a root_path is set

Co-authored-by: redjax <[email protected]>

* fix(diskcache): Rename check_cache_key_exists() -> search_cache() (#228)

Co-authored-by: redjax <[email protected]>

* chore(format): Check & format code

---------

Co-authored-by: redjax <[email protected]>

Author: redjax

red_utils/diskcache_utils/__init__.py

@@ -11,14 +11,14 @@
 )
 from .operations import (
     check_cache,
-    check_cache_key_exists,
     clear_cache,
     convert_to_seconds,
     delete_val,
     get_cache_size,
     get_val,
     manage_cache_tag_index,
     new_cache,
+    search_cache,
     set_expire,
     set_val,
 )

red_utils/diskcache_utils/operations.py

@@ -116,7 +116,7 @@ def clear_cache(cache: Cache = None) -> bool:
         )
 
 
-def check_cache_key_exists(key: str = None, cache: diskcache.core.Cache = None) -> bool:
+def search_cache(key: str = None, cache: diskcache.core.Cache = None) -> bool:
     """Check if a key exists in a cache."""
     ## Key validation
     validate_key(key=key)
@@ -198,7 +198,7 @@ def set_expire(
     validate_cache(cache)
     validate_expire(expire)
 
-    if not check_cache_key_exists(key=key, cache=cache):
+    if not search_cache(key=key, cache=cache):
         return {
             "warning": f"Cache item with key [{key}] does not exist in cache at {cache.directory}/"
         }
@@ -218,7 +218,7 @@ def get_val(key: valid_key_types = None, cache: Cache = None, tags: list[str] =
     validate_cache(cache)
     validate_tags(tags)
 
-    if check_cache_key_exists(key=key, cache=cache):
+    if search_cache(key=key, cache=cache):
         try:
             with cache as ref:
                 _val = ref.get(key=key)

red_utils/fastapi_utils/operations.py

@@ -23,6 +23,23 @@
 from fastapi import APIRouter, FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
+def fix_api_docs(app: FastAPI):
+    """Fix Not Found /api/v1/openapi.json error when a root_path is set.
+
+    NOTE: This is *only* necessary if you set a root_path in the FastAPI app,
+    i.e. app = FastAPI(root_path="/some/path").
+
+    If a FastAPI app is initialized with root_path=$some_path, the /docs
+    route breaks. Pass the FastAPI app to through this function to fix,
+    i.e.:
+    fix_api_docs(app)
+    """
+
+    @app.get(app.root_path + "/openapi.json")
+    def custom_swagger_ui_html():
+        return app.openapi()
+
+
 def update_tags_metadata(
     tags_metadata: list = tags_metadata,
     update_metadata: Union[list[dict[str, str]], dict[str, str]] = None,