diff --git a/.gitignore b/.gitignore index 11041c7..b671e55 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.egg-info +/docs/_build diff --git a/README.md b/README.md new file mode 100644 index 0000000..f2f528a --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ + +SGSchema +======== + +This project aims to assist interaction with Shotgun via its API by applying knowledge of the server's schema. + +The initial use case is to assist tool developers in being able to operate on Shotgun instances with slightly different schemas. Differences can accrue due to human mistakes while creating fields, or due to the initial schemas being different across the history of Shotgun. + +You may provide aliases and tags for entity types and fields, as well as automatically detect and use the common ``"sg_"`` prefix on fields. + +This project is tightly integrated into [SGSession](https://github.com/westernx/sgsession), and used in all operations. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..59c3ef8 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,194 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: default help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +default: html + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sgcache.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sgcache.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/sgcache" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sgcache" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bf10aea --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,294 @@ +# -*- coding: utf-8 -*- +# +# sgschema documentation build configuration file, created by +# sphinx-quickstart on Thu Jul 2 10:31:08 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', + 'sphinx.ext.todo', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'sgschema' +copyright = u'2015, Mike Boers' +author = u'Mike Boers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'sgschemadoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'sgschema.tex', u'sgschema Documentation', + u'Mike Boers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'sgschema', u'sgschema Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'sgschema', u'sgschema Documentation', + author, 'sgschema', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + + + +autodoc_member_order = 'bysource' +autodoc_default_flags = ['undoc-members'] + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..27b7704 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,81 @@ +.. _index: + +SGSchema +======== + +This project aims to assist interaction with Shotgun via its API by applying +knowledge of the server's schema. + +The initial use case is to assist tool developers in being able to operate on +Shotgun instances with slightly different schemas. Differences can accrue due +to human mistakes while creating fields, or due to the initial schemas being +different across the history of Shotgun. + +You may provide aliases and tags for entity types and fields, as well as +automatically detect and use the common ``"sg_"`` prefix on fields. Example uses +(from a theoretical pipeline pipeline): + +- ``$Publish`` resolves to the ``PublishEvent`` entity type; +- ``$sgpublish:type`` is aliased to the ``PublishEvent.sg_type`` field; +- ``#sgsession:core`` is tagged to the ``Task`` fields ``content``, and ``step``; +- ``$shotgun:name`` is aliased to what Shotgun will return as the ``name`` field + of all entities; +- ``version`` resolves to the ``PublishEvent.sg_version`` field. + +This project is tightly integrated into SGSession, and used in all operations. + + +Caching +------- + +In general, schemas should be preprocessed and cached, then reloaded for each +use. To read the schema, reduce it, and cache it:: + + schema = Schema() + schema.read(shotgun_object) + schema.dump('/path/to/cache.json') + +The cached schema can then be loaded manually:: + + schema = Schema() + schema.load('/path/to/cache.json') + +The :meth:`Schema.from_cache` method uses setuptools' entrypoints to find +cached schemas from the runtime environment:: + + schema = sgschema.Schema.from_cache(shotgun.base_url) + +That class method calls any functions registered as a ``sgschema_cache`` +setuptools entrypoint. Those functions are called with the passed URL. +Whatever non-None value is returned first is loaded into the schema. The process +is effectively:: + + schema = Schema() + for func in funcs_from_entrypoints: + raw_schema = func(base_url) + if raw_schema: + schema.load(raw_schema) + break + + + + + + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + setup + python_api + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/python_api.rst b/docs/python_api.rst new file mode 100644 index 0000000..d5d6ef2 --- /dev/null +++ b/docs/python_api.rst @@ -0,0 +1,8 @@ +Python API +========== + +.. automodule:: sgschema.schema + +.. autoclass:: sgschema.schema.Schema + :members: + diff --git a/docs/setup.rst b/docs/setup.rst new file mode 100644 index 0000000..ced6240 --- /dev/null +++ b/docs/setup.rst @@ -0,0 +1,4 @@ +Setup +===== + +xxx diff --git a/sgschema/field.py b/sgschema/field.py index e5a3760..7176827 100644 --- a/sgschema/field.py +++ b/sgschema/field.py @@ -36,7 +36,9 @@ def _reduce_raw(self, schema, raw_field): raw_private = schema._raw_private['entity_fields'][self.entity.name].get(self.name, {}) if raw_private.get('identifier_column'): - self._tags.add('identifier_column') + # It would be nice to add a "name" alias, but that might be + # a little too magical. + self._aliases.add('shotgun:name') if self.data_type in ('entity', 'multi_entity'): types_ = raw_private['allowed_entity_types'] or [] diff --git a/sgschema/schema.py b/sgschema/schema.py index 1780d80..2840c04 100644 --- a/sgschema/schema.py +++ b/sgschema/schema.py @@ -15,6 +15,18 @@ class Schema(object): @classmethod def from_cache(cls, base_url): + """Use setuptools' entrypoints to load a cached schema. + + Calls functions registered to "sgschema_cache" until one of them + returns something non-None. That is loaded into the schema. + + The resulting object is memoized by the given URL, so multiple calls + to this method result in the same ``Schema`` instance. + + :param str base_url: The ``shotgun.base_url`` to lookup the schema for. + :returns: A ``Schema`` instance. + + """ # If it is a Shotgun instance, grab the url. if not isinstance(base_url, basestring): @@ -55,6 +67,7 @@ def __init__(self): @cached_property def entity_aliases(self): + """Mapping of entity aliases to entity names.""" entity_aliases = dict(self._entity_aliases) for entity in self.entities.itervalues(): for alias in entity._aliases: @@ -63,6 +76,7 @@ def entity_aliases(self): @cached_property def entity_tags(self): + """Mapping of entity tags to lists of entity names.""" entity_tags = {k: set(v) for k, v in self._entity_tags.iteritems()} for entity in self.entities.itervalues(): for tag in entity._tags: @@ -76,7 +90,20 @@ def _get_or_make_entity(self, name): return self.entities.setdefault(name, Entity(self, name)) def read(self, sg): - + """Read the raw public and private schemas from Shotgun. + + :param sg: The ``shotgun_api3.Shotgun`` instance to read the schema from. + + This reads the schema via ``Shotgun.schema_read()`` and + ``Shotgun.schema_entity_read()``, as well as the "private" schema + embedded into the Javascript of the Shotgun website. + + The raw schemas are then reduced, retaining only data types, and + other info required for SGSchema's operations. It may be required + to re-read (and cache) schema data as SGSchema is improved. + + """ + # Most of the time we don't need this, so don't bother importing. from requests import Session @@ -115,6 +142,13 @@ def _reduce_raw(self): field._reduce_raw(self, raw_field) def dump(self, path, raw=False): + """Save the schema as JSON to the given path. + + :param str path: The path to save to. + :param bool raw: Save the raw schema, or the reduced version? + + """ + if raw: with open(path, 'w') as fh: fh.write(json.dumps({ @@ -128,13 +162,14 @@ def dump(self, path, raw=False): fh.write(json.dumps(data, indent=4, sort_keys=True)) def load_directory(self, dir_path): + """Load all ``.json`` files in the given directory.""" for file_name in os.listdir(dir_path): if file_name.startswith('.') or not file_name.endswith('.json'): continue self.load(os.path.join(dir_path, file_name)) def load_raw(self, path): - + """Load a JSON file containing a raw schema.""" raw = json.loads(open(path).read()) keys = 'raw_entities', 'raw_fields', 'raw_private' @@ -152,6 +187,12 @@ def load_raw(self, path): self._reduce_raw() def load(self, input_): + """Load a JSON file or ``dict`` containing schema structures. + + If passed a string, we treat is as a path to a JSON file. + If passed a dict, it is handled directly. + + """ if isinstance(input_, basestring): encoded = open(input_).read()