🗑️ Deprecate MemoryIO class and associated tests (#721)

yezz123 · Dec 25, 2024 · d415577 · d415577
2 parents 4ada740 + 2a17209
commit d415577
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 264 deletions.
diff --git a/authx/_internal/__init__.py b/authx/_internal/__init__.py
@@ -7,7 +7,6 @@
     log_info,
     set_log_level,
 )
-from authx._internal._memory import MemoryIO
 from authx._internal._signature import SignatureSerializer
 from authx._internal._utils import (
     RESERVED_CLAIMS,
@@ -36,6 +35,5 @@
     "utc",
     "end_of_day",
     "end_of_week",
-    "MemoryIO",
     "SignatureSerializer",
 )
diff --git a/authx/_internal/_memory.py b/authx/_internal/_memory.py
diff --git a/docs/api/extra/cache.md b/docs/api/extra/cache.md
@@ -4,7 +4,7 @@
      You need to install dependencies to use The HTTP Cache.
 
      ```console
-     $ pip install authx_extra[redis]
+     $ pip install authx_extra
      ```
 
 ::: authx_extra.cache.HTTPCacheBackend
diff --git a/docs/api/extra/metrics.md b/docs/api/extra/metrics.md
@@ -4,7 +4,7 @@
      You need to install dependencies to use The Prometheus Metrics Middleware.
 
      ```console
-     $ pip install authx_extra[prometheus]
+     $ pip install authx_extra
      ```
 
 ::: authx_extra.metrics.MetricsMiddleware
diff --git a/docs/api/extra/oauth2.md b/docs/api/extra/oauth2.md
@@ -1,3 +1,10 @@
 # MiddlewareOauth2
 
+!!! warning
+     You need to install dependencies to use The Oauth2 Middleware.
+
+     ```console
+     $ pip install authx_extra
+     ```
+
 ::: authx_extra.oauth2.MiddlewareOauth2
diff --git a/docs/api/extra/profiler.md b/docs/api/extra/profiler.md
@@ -4,7 +4,7 @@
      You need to install dependencies to use The Profiler.
 
      ```console
-     $ pip install authx_extra[profiler]
+     $ pip install authx_extra
      ```
 
 ::: authx_extra.profiler.ProfilerMiddleware
diff --git a/docs/api/extra/session.md b/docs/api/extra/session.md
@@ -1,3 +1,10 @@
 # SessionIntegration
 
+!!! warning
+     You need to install dependencies to use The Session Integration.
+
+     ```console
+     $ pip install authx_extra
+     ```
+
 ::: authx_extra.session.SessionIntegration
diff --git a/docs/api/internal/extra/memory.md b/docs/api/internal/extra/memory.md
@@ -0,0 +1,10 @@
+# MemoryIO
+
+!!! warning
+     You need to install dependencies to use The Memory Cache.
+
+     ```console
+     $ pip install authx_extra
+     ```
+
+::: authx_extra.extra._memory.MemoryIO
diff --git a/docs/api/internal/memory.md b/docs/api/internal/memory.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -230,8 +230,8 @@ nav:
     - Internal:
       - api/internal/callback.md
       - api/internal/errors.md
-      - api/internal/memory.md
       - api/internal/signature.md
+      - api/internal/extra/memory.md
     - Extra:
       - api/extra/session.md
       - api/extra/profiler.md

diff --git a/tests/internal/test_memory.py b/tests/internal/test_memory.py
diff --git a/tests/internal/test_signature.py b/tests/internal/test_signature.py