Move zero_ex.json_schemas to its own package

python-packages/json_schemas/src/conf.py

@@ -0,0 +1,54 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+# Reference: http://www.sphinx-doc.org/en/master/config
+
+from typing import List
+import pkg_resources
+
+
+# pylint: disable=invalid-name
+# because these variables are not named in upper case, as globals should be.
+
+project = "0x-json-schemas"
+# pylint: disable=redefined-builtin
+copyright = "2018, ZeroEx, Intl."
+author = "F. Eugene Aumson"
+version = pkg_resources.get_distribution("0x-json-schemas").version
+release = ""  # The full version, including alpha/beta/rc tags
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["doc_templates"]
+
+source_suffix = ".rst"
+# eg: source_suffix = [".rst", ".md"]
+
+master_doc = "index"  # The master toctree document.
+
+language = None
+
+exclude_patterns: List[str] = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+html_theme = "alabaster"
+
+html_static_path = ["doc_static"]
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "order_utilspydoc"
+
+# -- Extension configuration:
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"https://docs.python.org/": None}

python-packages/json_schemas/src/index.rst

@@ -0,0 +1,18 @@
+.. source for the sphinx-generated build/docs/web/index.html
+
+Python zero_ex.order_utils
+==========================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: zero_ex.json_schemas
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

python-packages/json_schemas/src/zero_ex/__init__.py

@@ -0,0 +1,2 @@
+"""0x Python API."""
+__import__("pkg_resources").declare_namespace(__name__)

python-packages/json_schemas/src/zero_ex/json_schemas/__init__.py

@@ -0,0 +1,74 @@
+"""JSON schemas and associated utilities."""
+
+from os import path
+import json
+from typing import Mapping
+
+from pkg_resources import resource_string
+import jsonschema
+
+
+class _LocalRefResolver(jsonschema.RefResolver):
+    """Resolve package-local JSON schema id's."""
+
+    def __init__(self):
+        """Initialize a new instance."""
+        self.ref_to_file = {
+            "/addressSchema": "address_schema.json",
+            "/hexSchema": "hex_schema.json",
+            "/orderSchema": "order_schema.json",
+            "/wholeNumberSchema": "whole_number_schema.json",
+            "/ECSignature": "ec_signature_schema.json",
+            "/signedOrderSchema": "signed_order_schema.json",
+            "/ecSignatureParameterSchema": (
+                "ec_signature_parameter_schema.json" + ""
+            ),
+        }
+        jsonschema.RefResolver.__init__(self, "", "")
+
+    def resolve_from_url(self, url: str) -> str:
+        """Resolve the given URL.
+
+        :param url: a string representing the URL of the JSON schema to fetch.
+        :returns: a string representing the deserialized JSON schema
+        :raises jsonschema.ValidationError: when the resource associated with
+                   `url` does not exist.
+        """
+        ref = url.replace("file://", "")
+        if ref in self.ref_to_file:
+            return json.loads(
+                resource_string(
+                    "zero_ex.json_schemas", f"schemas/{self.ref_to_file[ref]}"
+                )
+            )
+        raise jsonschema.ValidationError(
+            f"Unknown ref '{ref}'. "
+            + f"Known refs: {list(self.ref_to_file.keys())}."
+        )
+
+
+# Instantiate the `_LocalRefResolver()` only once so that `assert_valid()` can
+# perform multiple schema validations without reading from disk the schema
+# every time.
+_LOCAL_RESOLVER = _LocalRefResolver()
+
+
+def assert_valid(data: Mapping, schema_id: str) -> None:
+    """Validate the given `data` against the specified `schema`.
+
+    :param data: Python dictionary to be validated as a JSON object.
+    :param schema_id: id property of the JSON schema to validate against.  Must
+        be one of those listed in `the 0x JSON schema files
+        <https://github.com/0xProject/0x-monorepo/tree/development/packages/json-schemas/schemas>`_.
+
+    Raises an exception if validation fails.
+
+    >>> assert_valid(
+    ...     {'v': 27, 'r': '0x'+'f'*64, 's': '0x'+'f'*64},
+    ...     '/ECSignature',
+    ... )
+    """
+    # noqa
+
+    _, schema = _LOCAL_RESOLVER.resolve(schema_id)
+    jsonschema.validate(data, schema, resolver=_LOCAL_RESOLVER)

python-packages/json_schemas/src/zero_ex/json_schemas/schemas

@@ -0,0 +1 @@
+../../../../../packages/json-schemas/schemas/