Rename Registries to be clear on purpose

Author: DiamondJoseph

docs/source/reference/service.md

@@ -79,7 +79,6 @@ When registering new types, make reference to the
 .. autosummary::
    :toctree: generated
 
-   tiled.media_type_registration.serialization_registry
    tiled.media_type_registration.SerializationRegistry
    tiled.media_type_registration.SerializationRegistry.register
    tiled.media_type_registration.SerializationRegistry.media_types

tiled/client/container.py

@@ -14,7 +14,7 @@
 from ..adapters.utils import IndexersMixin
 from ..iterviews import ItemsView, KeysView, ValuesView
 from ..queries import KeyLookup
-from ..query_registration import query_registry
+from ..query_registration import default_query_registry
 from ..structures.core import Spec, StructureFamily
 from ..structures.data_source import DataSource
 from ..utils import UNCHANGED, OneShotCachedMap, Sentinel, node_repr, safe_json_dump
@@ -986,7 +986,7 @@ def _queries_to_params(*queries):
     "Compute GET params from the queries."
     params = collections.defaultdict(list)
     for query in queries:
-        name = query_registry.query_type_to_name[type(query)]
+        name = default_query_registry.query_type_to_name[type(query)]
         for field, value in query.encode().items():
             if value is not None:
                 params[f"filter[{name}][condition][{field}]"].append(value)

tiled/config.py

@@ -10,19 +10,20 @@
 from datetime import timedelta
 from functools import cache
 from pathlib import Path
+from typing import Optional
 
 import jsonschema
 
 from .adapters.mapping import MapAdapter
 from .media_type_registration import (
-    compression_registry as default_compression_registry,
+    CompressionRegistry,
+    SerializationRegistry,
+    default_compression_registry,
+    default_serialization_registry,
 )
-from .media_type_registration import (
-    serialization_registry as default_serialization_registry,
-)
-from .query_registration import query_registry as default_query_registry
+from .query_registration import QueryRegistry, default_query_registry
 from .utils import import_object, parse, prepend_to_sys_path
-from .validation_registration import validation_registry as default_validation_registry
+from .validation_registration import ValidationRegistry, default_validation_registry
 
 
 @cache
@@ -40,10 +41,10 @@ def construct_build_app_kwargs(
     config,
     *,
     source_filepath=None,
-    query_registry=None,
-    compression_registry=None,
-    serialization_registry=None,
-    validation_registry=None,
+    query_registry: Optional[QueryRegistry] = None,
+    compression_registry: Optional[CompressionRegistry] = None,
+    serialization_registry: Optional[SerializationRegistry] = None,
+    validation_registry: Optional[ValidationRegistry] = None,
 ):
     """
     Given parsed configuration, construct arguments for build_app(...).

tiled/media_type_registration.py

@@ -197,21 +197,21 @@ def __call__(self, media_type, encoder, *args, **kwargs):
         return self.dispatch(media_type, encoder)(*args, **kwargs)
 
 
-serialization_registry = SerializationRegistry()
+default_serialization_registry = SerializationRegistry()
 "Global serialization registry. See Registry for usage examples."
 
-deserialization_registry = SerializationRegistry()
+default_deserialization_registry = SerializationRegistry()
 "Global deserialization registry. See Registry for usage examples."
 
-compression_registry = CompressionRegistry()
+default_compression_registry = CompressionRegistry()
 "Global compression registry. See Registry for usage examples."
 
 
 for media_type in [
     "application/json",
     "application/x-msgpack",
 ]:
-    compression_registry.register(
+    default_compression_registry.register(
         media_type,
         "gzip",
         lambda buffer: gzip.GzipFile(mode="wb", fileobj=buffer, compresslevel=9),
@@ -225,7 +225,7 @@ def __call__(self, media_type, encoder, *args, **kwargs):
     "text/plain",
     "text/html",
 ]:
-    compression_registry.register(
+    default_compression_registry.register(
         media_type,
         "gzip",
         # Use a lower compression level. High compression is extremely slow
@@ -270,7 +270,7 @@ def close(self):
         "text/html",
         "text/plain",
     ]:
-        compression_registry.register(media_type, "zstd", ZstdBuffer)
+        default_compression_registry.register(media_type, "zstd", ZstdBuffer)
 
 if modules_available("lz4"):
     import lz4
@@ -326,7 +326,7 @@ def close(self):
         "text/html",
         "text/plain",
     ]:
-        compression_registry.register(media_type, "lz4", LZ4Buffer)
+        default_compression_registry.register(media_type, "lz4", LZ4Buffer)
 
 if modules_available("blosc2"):
     import blosc2
@@ -355,4 +355,4 @@ def close(self):
             pass
 
     for media_type in ["application/octet-stream", APACHE_ARROW_FILE_MIME_TYPE]:
-        compression_registry.register(media_type, "blosc2", BloscBuffer)
+        default_compression_registry.register(media_type, "blosc2", BloscBuffer)

tiled/query_registration.py

@@ -79,8 +79,8 @@ def inner(cls):
 
 
 # Make a global registry.
-query_registry = QueryRegistry()
-register = query_registry.register
+default_query_registry = QueryRegistry()
+register = default_query_registry.register
 """Register a new type of query."""
 
 

tiled/serialization/array.py

@@ -3,7 +3,10 @@
 
 import numpy
 
-from ..media_type_registration import deserialization_registry, serialization_registry
+from ..media_type_registration import (
+    default_deserialization_registry,
+    default_serialization_registry,
+)
 from ..utils import (
     SerializationError,
     UnsupportedShape,
@@ -22,13 +25,13 @@ def as_buffer(array, metadata):
         return numpy.asarray(array).tobytes()
 
 
-serialization_registry.register(
+default_serialization_registry.register(
     "array",
     "application/octet-stream",
     as_buffer,
 )
 if modules_available("orjson"):
-    serialization_registry.register(
+    default_serialization_registry.register(
         "array",
         "application/json",
         lambda array, metadata: safe_json_dump(array),
@@ -43,10 +46,12 @@ def serialize_csv(array, metadata):
     return file.getvalue().encode()
 
 
-serialization_registry.register("array", "text/csv", serialize_csv)
-serialization_registry.register("array", "text/x-comma-separated-values", serialize_csv)
-serialization_registry.register("array", "text/plain", serialize_csv)
-deserialization_registry.register(
+default_serialization_registry.register("array", "text/csv", serialize_csv)
+default_serialization_registry.register(
+    "array", "text/x-comma-separated-values", serialize_csv
+)
+default_serialization_registry.register("array", "text/plain", serialize_csv)
+default_deserialization_registry.register(
     "array",
     "application/octet-stream",
     lambda buffer, dtype, shape: numpy.frombuffer(buffer, dtype=dtype).reshape(shape),
@@ -90,10 +95,10 @@ def array_from_buffer_PIL(buffer, format, dtype, shape):
         image = Image.open(file, format=format)
         return numpy.asarray(image).asdtype(dtype).reshape(shape)
 
-    serialization_registry.register(
+    default_serialization_registry.register(
         "array", "image/png", lambda array, metadata: save_to_buffer_PIL(array, "png")
     )
-    deserialization_registry.register(
+    default_deserialization_registry.register(
         "array",
         "image/png",
         lambda buffer, dtype, shape: array_from_buffer_PIL(buffer, "png", dtype, shape),
@@ -120,18 +125,24 @@ def save_to_buffer_tifffile(array, metadata):
         imwrite(file, normalized_array)
         return file.getbuffer()
 
-    serialization_registry.register("array", "image/tiff", save_to_buffer_tifffile)
-    deserialization_registry.register("array", "image/tiff", array_from_buffer_tifffile)
+    default_serialization_registry.register(
+        "array", "image/tiff", save_to_buffer_tifffile
+    )
+    default_deserialization_registry.register(
+        "array", "image/tiff", array_from_buffer_tifffile
+    )
 
 
 def serialize_html(array, metadata):
     "Try to display as image. Fall back to CSV."
     try:
-        png_data = serialization_registry.dispatch("array", "image/png")(
+        png_data = default_serialization_registry.dispatch("array", "image/png")(
             array, metadata
         )
     except Exception:
-        csv_data = serialization_registry.dispatch("array", "text/csv")(array, metadata)
+        csv_data = default_serialization_registry.dispatch("array", "text/csv")(
+            array, metadata
+        )
         return "<html>" "<body>" f"{csv_data.decode()!s}" "</body>" "</html>"
     else:
         return (
@@ -145,4 +156,4 @@ def serialize_html(array, metadata):
         )
 
 
-serialization_registry.register("array", "text/html", serialize_html)
+default_serialization_registry.register("array", "text/html", serialize_html)

tiled/serialization/awkward.py

@@ -3,12 +3,15 @@
 
 import awkward
 
-from ..media_type_registration import deserialization_registry, serialization_registry
+from ..media_type_registration import (
+    default_deserialization_registry,
+    default_serialization_registry,
+)
 from ..structures.core import StructureFamily
 from ..utils import APACHE_ARROW_FILE_MIME_TYPE, modules_available
 
 
-@serialization_registry.register(StructureFamily.awkward, "application/zip")
+@default_serialization_registry.register(StructureFamily.awkward, "application/zip")
 def to_zipped_buffers(components, metadata):
     (form, length, container) = components
     file = io.BytesIO()
@@ -22,7 +25,7 @@ def to_zipped_buffers(components, metadata):
     return file.getbuffer()
 
 
-@deserialization_registry.register(StructureFamily.awkward, "application/zip")
+@default_deserialization_registry.register(StructureFamily.awkward, "application/zip")
 def from_zipped_buffers(buffer, form, length):
     file = io.BytesIO(buffer)
     with zipfile.ZipFile(file, "r") as zip:
@@ -33,7 +36,7 @@ def from_zipped_buffers(buffer, form, length):
     return container
 
 
-@serialization_registry.register(StructureFamily.awkward, "application/json")
+@default_serialization_registry.register(StructureFamily.awkward, "application/json")
 def to_json(components, metadata):
     (form, length, container) = components
     file = io.StringIO()
@@ -44,7 +47,7 @@ def to_json(components, metadata):
 
 if modules_available("pyarrow"):
 
-    @serialization_registry.register(
+    @default_serialization_registry.register(
         StructureFamily.awkward, APACHE_ARROW_FILE_MIME_TYPE
     )
     def to_arrow(components, metadata):
@@ -60,7 +63,9 @@ def to_arrow(components, metadata):
 
     # There seems to be no official Parquet MIME type.
     # https://issues.apache.org/jira/browse/PARQUET-1889
-    @serialization_registry.register(StructureFamily.awkward, "application/x-parquet")
+    @default_serialization_registry.register(
+        StructureFamily.awkward, "application/x-parquet"
+    )
     def to_parquet(components, metadata):
         import pyarrow.parquet
 

tiled/serialization/container.py

@@ -1,6 +1,6 @@
 import io
 
-from ..media_type_registration import serialization_registry
+from ..media_type_registration import default_serialization_registry
 from ..structures.core import StructureFamily
 from ..utils import (
     SerializationError,
@@ -78,7 +78,7 @@ async def serialize_hdf5(node, metadata, filter_for_access):
                     dataset.attrs.create(k, v)
         return buffer.getbuffer()
 
-    serialization_registry.register(
+    default_serialization_registry.register(
         StructureFamily.container, "application/x-hdf5", serialize_hdf5
     )
 
@@ -101,6 +101,6 @@ async def serialize_json(node, metadata, filter_for_access):
                 d = d[key]["contents"]
         return safe_json_dump(to_serialize)
 
-    serialization_registry.register(
+    default_serialization_registry.register(
         StructureFamily.container, "application/json", serialize_json
     )

tiled/serialization/sparse.py

@@ -1,6 +1,9 @@
 import io
 
-from ..media_type_registration import deserialization_registry, serialization_registry
+from ..media_type_registration import (
+    default_deserialization_registry,
+    default_serialization_registry,
+)
 from ..utils import modules_available
 
 if modules_available("h5py"):
@@ -19,7 +22,9 @@ def serialize_hdf5(sparse_arr, metadata):
                 file.attrs.create(k, v)
         return buffer.getbuffer()
 
-    serialization_registry.register("sparse", "application/x-hdf5", serialize_hdf5)
+    default_serialization_registry.register(
+        "sparse", "application/x-hdf5", serialize_hdf5
+    )
 
 if modules_available("pandas", "pyarrow"):
     import pandas
@@ -37,7 +42,7 @@ def serialize_hdf5(sparse_arr, metadata):
     if modules_available("openpyxl"):
         from .table import serialize_excel
 
-        serialization_registry.register(
+        default_serialization_registry.register(
             "sparse",
             XLSX_MIME_TYPE,
             lambda sparse_arr, metadata: serialize_excel(
@@ -52,38 +57,38 @@ def to_dataframe(sparse_arr):
         d["data"] = sparse_arr.data
         return pandas.DataFrame(d)
 
-    deserialization_registry.register(
+    default_deserialization_registry.register(
         "sparse", APACHE_ARROW_FILE_MIME_TYPE, deserialize_arrow
     )
-    serialization_registry.register(
+    default_serialization_registry.register(
         "sparse",
         APACHE_ARROW_FILE_MIME_TYPE,
         lambda sparse_arr, metadata: serialize_arrow(
             to_dataframe(sparse_arr), metadata, preserve_index=False
         ),
     )
-    serialization_registry.register(
+    default_serialization_registry.register(
         "sparse",
         "application/x-parquet",
         lambda sparse_arr, metadata: serialize_parquet(
             to_dataframe(sparse_arr), metadata, preserve_index=False
         ),
     )
-    serialization_registry.register(
+    default_serialization_registry.register(
         "sparse",
         "text/csv",
         lambda sparse_arr, metadata: serialize_csv(
             to_dataframe(sparse_arr), metadata, preserve_index=False
         ),
     )
-    serialization_registry.register(
+    default_serialization_registry.register(
         "sparse",
         "text/plain",
         lambda sparse_arr, metadata: serialize_csv(
             to_dataframe(sparse_arr), metadata, preserve_index=False
         ),
     )
-    serialization_registry.register(
+    default_serialization_registry.register(
         "sparse",
         "text/html",
         lambda sparse_arr, metadata: serialize_html(
@@ -99,7 +104,7 @@ def serialize_json(sparse_arr, metadata):
                 {column: df[column].tolist() for column in df},
             )
 
-        serialization_registry.register(
+        default_serialization_registry.register(
             "sparse",
             "application/json",
             serialize_json,