Added Metadata to public API (#363)

* Added Metadata to _serializers.py's __all__

* Added RUF022 to sort __all__

* Created a CHANGELOG entry

Author: jamesbraza

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## development
 
+- Added `Metadata` to public API. (#363)
 - Fix race condition in FileStorage initialization. (#353)
 
 ## 0.1.3 (1st July, 2025)

hishel/_async/_storages.py

@@ -36,10 +36,10 @@
 __all__ = (
     "AsyncBaseStorage",
     "AsyncFileStorage",
-    "AsyncRedisStorage",
-    "AsyncSQLiteStorage",
     "AsyncInMemoryStorage",
+    "AsyncRedisStorage",
     "AsyncS3Storage",
+    "AsyncSQLiteStorage",
 )
 
 StoredResponse: TypeAlias = tp.Tuple[Response, Request, Metadata]

hishel/_controller.py

@@ -20,7 +20,7 @@
 HEURISTICALLY_CACHEABLE_STATUS_CODES = (200, 203, 204, 206, 300, 301, 308, 404, 405, 410, 414, 501)
 HTTP_METHODS = ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]
 
-__all__ = ("Controller", "HEURISTICALLY_CACHEABLE_STATUS_CODES")
+__all__ = ("HEURISTICALLY_CACHEABLE_STATUS_CODES", "Controller")
 
 
 def get_updated_headers(

hishel/_serializers.py

@@ -17,7 +17,7 @@
 KNOWN_RESPONSE_EXTENSIONS = ("http_version", "reason_phrase")
 KNOWN_REQUEST_EXTENSIONS = ("timeout", "sni_hostname")
 
-__all__ = ("PickleSerializer", "JSONSerializer", "YAMLSerializer", "BaseSerializer", "clone_model")
+__all__ = ("BaseSerializer", "JSONSerializer", "Metadata", "PickleSerializer", "YAMLSerializer", "clone_model")
 
 T = tp.TypeVar("T", Request, Response)
 

hishel/_sync/_storages.py

@@ -36,10 +36,10 @@
 __all__ = (
     "BaseStorage",
     "FileStorage",
-    "RedisStorage",
-    "SQLiteStorage",
     "InMemoryStorage",
+    "RedisStorage",
     "S3Storage",
+    "SQLiteStorage",
 )
 
 StoredResponse: TypeAlias = tp.Tuple[Response, Request, Metadata]

pyproject.toml

@@ -117,7 +117,8 @@ select = [
     "E",
     "F",
     "W",
-    "I"
+    "I",
+    "RUF022"
 ]
 
 [tool.ruff.lint.isort]