JSONSchemata 0.0.0.dev55__tar.gz → 0.0.0.dev56__tar.gz

{jsonschemata-0.0.0.dev55/src/JSONSchemata.egg-info → jsonschemata-0.0.0.dev56}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: JSONSchemata
-Version: 0.0.0.dev55
+Version: 0.0.0.dev56
 Requires-Python: >=3.10
 License-File: LICENSE
 Requires-Dist: referencing>=0.35.1
 Requires-Dist: PkgData==0.0.0.dev5
-Requires-Dist: PySerials==0.0.0.dev59
-Requires-Dist: PyLinks==0.0.0.dev69
+Requires-Dist: PySerials==0.0.0.dev60
+Requires-Dist: PyLinks==0.0.0.dev70

{jsonschemata-0.0.0.dev55 → jsonschemata-0.0.0.dev56}/pyproject.toml

@@ -17,12 +17,12 @@ namespaces = true
 # ----------------------------------------- Project Metadata -------------------------------------
 #
 [project]
-version = "0.0.0.dev55"
+version = "0.0.0.dev56"
 name = "JSONSchemata"
 dependencies = [
     "referencing >= 0.35.1",
     "PkgData == 0.0.0.dev5",
-    "PySerials == 0.0.0.dev59",
-    "PyLinks == 0.0.0.dev69",
+    "PySerials == 0.0.0.dev60",
+    "PyLinks == 0.0.0.dev70",
 ]
 requires-python = ">=3.10"

{jsonschemata-0.0.0.dev55 → jsonschemata-0.0.0.dev56/src/JSONSchemata.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: JSONSchemata
-Version: 0.0.0.dev55
+Version: 0.0.0.dev56
 Requires-Python: >=3.10
 License-File: LICENSE
 Requires-Dist: referencing>=0.35.1
 Requires-Dist: PkgData==0.0.0.dev5
-Requires-Dist: PySerials==0.0.0.dev59
-Requires-Dist: PyLinks==0.0.0.dev69
+Requires-Dist: PySerials==0.0.0.dev60
+Requires-Dist: PyLinks==0.0.0.dev70

jsonschemata-0.0.0.dev56/src/JSONSchemata.egg-info/requires.txt

@@ -0,0 +1,4 @@
+referencing>=0.35.1
+PkgData==0.0.0.dev5
+PySerials==0.0.0.dev60
+PyLinks==0.0.0.dev70

{jsonschemata-0.0.0.dev55 → jsonschemata-0.0.0.dev56}/src/jsonschemata/registry.py

@@ -1,4 +1,7 @@
-from typing import Callable as _Callable
+from __future__ import annotations as _annotations
+
+from typing import TYPE_CHECKING as _TYPE_CHECKING
+
 import referencing as _referencing
 from referencing import jsonschema as _ref_jsonschema, retrieval as _ref_retrieval
 import pkgdata as _pkgdata
@@ -7,39 +10,46 @@ import pylinks as _pl
 
 from jsonschemata import edit as _edit
 
+if _TYPE_CHECKING:
+    from typing import Callable, Sequence
+
 
 def make(
-    dynamic: bool = False,
+    resources: Sequence[dict | _referencing.Resource | tuple[str, dict | _referencing.Resource]] | None = None,
+    default_specification: _referencing.Specification = _ref_jsonschema.DRAFT202012,
     crawl: bool = True,
-    add_resources: list[dict | _referencing.Resource | tuple[str, dict | _referencing.Resource]] | None = None,
-    add_resources_default_spec: _referencing.Specification = _ref_jsonschema.DRAFT202012,
-    retrieval_func: _Callable[[str], str | _referencing.Resource] = None,
+    clean: bool = False,
+    dynamic: bool = True,
+    retrieval_function: Callable[[str], str | _referencing.Resource] = None,
 ) -> _referencing.Registry:
-    """Create a registry of all JSON schemas.
+    """Create a JSON Schema registry.
 
     Parameters
     ----------
-    dynamic : bool, default: False
-        If True, any reference that is not found in the registry will be
-        [dynamically retrieved](https://referencing.readthedocs.io/en/stable/intro/#dynamically-retrieving-resources)
-        and [cached](https://referencing.readthedocs.io/en/stable/intro/#caching).
-        The retrieval works as follows:
+    resources
+        A list of schema resources to add to the registry. Each resource can be a dictionary or
+        a [`referencing.Resource`](https://referencing.readthedocs.io/en/stable/api/#referencing.Resource)
+        object. If a schema does not have an "$id",
+        the ID must be provided along with the resource as a tuple of (ID, schema).
+    default_specification
+        The default specification to use when creating a resource from a dictionary.
+        The default is Draft 2020-12.
+    crawl
+        Pre-[crawl](https://referencing.readthedocs.io/en/stable/api/#referencing.Registry.crawl)
+        all resources so that the registry is
+        [fully ready](https://referencing.readthedocs.io/en/stable/schema-packages/).
+    clean
+        Only add the input resources (if any) to the registry,
+        without adding any of the predefined schemas.
+    dynamic
+        [Dynamically retrieve](https://referencing.readthedocs.io/en/stable/intro/#dynamically-retrieving-resources)
+        and [cache](https://referencing.readthedocs.io/en/stable/intro/#caching)
+        references that are not found in the registry.
+        If set to True, the default behaviour is as follows (see `retrieval_function` for customization):
         If the reference URI starts with "http" or "https", the URI is fetched using an HTTP GET request.
         Otherwise, the URI is assumed to be a local filepath,
         which can be either absolute or relative to the current working directory.
-        You can also provide a custom retrieval function using the `retrieval_func` parameter.
-    crawl : bool, default: True
-        Pre [crawl](https://referencing.readthedocs.io/en/stable/api/#referencing.Registry.crawl)
-        all resources so that the registry is
-        [fully ready](https://referencing.readthedocs.io/en/stable/schema-packages/).
-    add_resources: list[dict | referencing.Resource | tuple[str, dict | referencing.Resource]] | None, default: None
-        A list of additional resources to add to the registry. Each resource can be a dictionary or
-        a [`referencing.Resource`](https://referencing.readthedocs.io/en/stable/api/#referencing.Resource)
-        object. If a resource does not have an "$id",
-        the ID must be provided along with the resource as a tuple of (ID, resource).
-    add_resources_default_spec: referencing.Specification, default: referencing.jsonschema.DRAFT202012
-        The default specification to use when creating an additional resource from a dictionary.
-    retrieval_func: Callable[[str], str | referencing.Resource], optional
+    retrieval_function: Callable[[str], str | referencing.Resource], optional
         A custom retrieval function to use when `dynamic` is True.
         The function should take a URI as input and return the reference schema.
         If you want the retrieval function to also cache the retrieved references,
@@ -48,7 +58,6 @@ def make(
         decorator, in which case the function must return the reference schema as a JSON string
         (cf. [Referencing Docs](https://referencing.readthedocs.io/en/stable/intro/#caching)).
         If the decorator is not used, the function must return the schema as a `referencing.Resource` instead.
-        Note that this retrieval function will only be used when `dynamic` is set to `True`.
     Returns
     -------
     referencing.Registry
@@ -62,37 +71,39 @@ def make(
             return _pl.http.request(url=uri, response_type="str")
         return _ps.write.to_json_string(_ps.read.from_file(path=uri, toml_as_dict=True), sort_keys=False)
 
-    schema_dir_path = _pkgdata.get_package_path_from_caller(top_level=True) / "_data"
-    resources = []
-    for schema_filepath in schema_dir_path.glob("**/*.yaml"):
-        schema_dict = _ps.read.yaml_from_file(path=schema_filepath)
-        _edit.required_last(schema_dict)
-        schema = _referencing.Resource.from_contents(
-            schema_dict, default_specification=_ref_jsonschema.DRAFT202012
-        )
-        resources.append(schema)
-
+    full_resources = []
     id_resources: list[tuple[str, _referencing.Resource]] = []
-    for add_resource in add_resources or []:
+
+    if not clean:
+        schema_dir_path = _pkgdata.get_package_path_from_caller(top_level=True) / "_data"
+        for schema_filepath in schema_dir_path.glob("**/*.yaml"):
+            schema_dict = _ps.read.yaml_from_file(path=schema_filepath)
+            _edit.required_last(schema_dict)
+            schema = _referencing.Resource.from_contents(
+                schema_dict, default_specification=_ref_jsonschema.DRAFT202012
+            )
+            full_resources.append(schema)
+    for add_resource in resources or []:
         resource_id = None
         if isinstance(add_resource, dict):
             add_resource = _referencing.Resource.from_contents(
-                add_resource, default_specification=add_resources_default_spec
+                add_resource, default_specification=default_specification
             )
-        elif isinstance(add_resource, tuple):
+        elif isinstance(add_resource, (list, tuple)):
             resource_id, resource_dict = add_resource
             add_resource = _referencing.Resource.from_contents(
-                resource_dict, default_specification=add_resources_default_spec,
+                resource_dict, default_specification=default_specification,
             )
         if resource_id:
             id_resources.append((resource_id, add_resource))
         else:
-            resources.append(add_resource)
+            full_resources.append(add_resource)
 
     registry = _referencing.Registry(
-        retrieve=retrieval_func or retrieve_url
+        retrieve=retrieval_function or retrieve_url
     ) if dynamic else _referencing.Registry()
-    registry = resources @ registry
+    if full_resources:
+        registry = full_resources @ registry
     if id_resources:
         registry = registry.with_resources(id_resources)
     if crawl:

jsonschemata-0.0.0.dev55/src/JSONSchemata.egg-info/requires.txt

@@ -1,4 +0,0 @@
-referencing>=0.35.1
-PkgData==0.0.0.dev5
-PySerials==0.0.0.dev59
-PyLinks==0.0.0.dev69