def test_load_schema(schema_dir):
"""Smoke test for schemacode.schema.load_schema."""
# Pointing to a nonexistent directory should raise a ValueError
bad_path = "/path/to/nowhere"
with pytest.raises(ValueError):
schema.load_schema(bad_path)
# Otherwise the function should return a dictionary
schema_obj = schema.load_schema(schema_dir)
assert isinstance(schema_obj, dict)
def make_columns_table(column_info, src_path=None):
"""Generate a markdown table of TSV column information.
Parameters
----------
column_info : dict
A list of the column names.
Column names correspond to filenames in the "columns" directory of the
schema.
Until requirement levels can be codified in the schema,
this argument will be a dictionary, with the column names as keys and
the requirement levels as values.
src_path : str | None
The file where this macro is called, which may be explicitly provided
by the "page.file.src_path" variable.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested columns.
"""
if src_path is None:
src_path = _get_source_path()
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_columns_table(schema_obj,
column_info,
src_path=src_path)
return table
def make_subobject_table(object_tuple, field_info, src_path=None):
"""Generate a markdown table of a metadata object's field information.
Parameters
----------
object_tuple : tuple of string
A tuple pointing to the object to render.
field_names : dict
A list of the field names.
Field names correspond to filenames in the "metadata" directory of the
schema.
Until requirement levels can be codified in the schema,
this argument will be dictionary, with the field names as keys and
the requirement levels as values.
src_path : str | None
The file where this macro is called, which may be explicitly provided
by the "page.file.src_path" variable.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested fields.
"""
if src_path is None:
src_path = _get_source_path()
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_subobject_table(schema_obj,
object_tuple,
field_info,
src_path=src_path)
return table
def make_glossary():
"""Generate glossary.
Returns
-------
text : str
A multiline string containing descriptions and some formatting
information about the entities in the schema.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
text = render.make_glossary(schema_obj)
return text
def make_entity_definitions():
"""Generate definitions and other relevant information for entities in the
specification.
Returns
-------
text : str
A multiline string containing descriptions and some formatting
information about the entities in the schema.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
text = render.make_entity_definitions(schema_obj)
return text
def make_suffix_table(suffixes):
"""Generate a markdown table of suffix information.
Parameters
----------
suffixes : list of str
A list of the suffixes to include in the table.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested fields.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_suffix_table(schema_obj, suffixes)
return table
def make_entity_table(**kwargs):
"""Generate an entity table from the schema, based on specific filters.
Parameters
----------
kwargs : dict
Keyword arguments used to filter the schema.
Example kwargs that may be used include: "suffixes", "datatypes",
"extensions".
Returns
-------
table : str
A Markdown-format table containing the corresponding entity table for
a subset of the schema.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_entity_table(schema_obj, **kwargs)
return table
def make_filename_template(**kwargs):
"""Generate a filename template snippet from the schema, based on specific
filters.
Parameters
----------
kwargs : dict
Keyword arguments used to filter the schema.
Example kwargs that may be used include: "suffixes", "datatypes",
"extensions".
Returns
-------
codeblock : str
A multiline string containing the filename templates for file types
in the schema, after filtering.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
codeblock = render.make_filename_template(schema_obj, **kwargs)
return codeblock
def make_glossary(src_path=None):
"""Generate glossary.
Parameters
----------
src_path : str | None
The file where this macro is called, which may be explicitly provided
by the "page.file.src_path" variable.
Returns
-------
text : str
A multiline string containing descriptions and some formatting
information about the entities in the schema.
"""
if src_path is None:
src_path = _get_source_path()
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
text = render.make_glossary(schema_obj, src_path=src_path)
return text
def make_columns_table(column_info):
"""Generate a markdown table of TSV column information.
Parameters
----------
column_info : dict
A list of the column names.
Column names correspond to filenames in the "columns" folder of the
schema.
Until requirement levels can be codified in the schema,
this argument will be a dictionary, with the column names as keys and
the requirement levels as values.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested columns.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_columns_table(schema_obj, column_info)
return table
def make_metadata_table(field_info):
"""Generate a markdown table of metadata field information.
Parameters
----------
field_names : dict
A list of the field names.
Field names correspond to filenames in the "metadata" folder of the
schema.
Until requirement levels can be codified in the schema,
this argument will be dictionary, with the field names as keys and
the requirement levels as values.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested fields.
"""
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_metadata_table(schema_obj, field_info)
return table
def make_suffix_table(suffixes, src_path=None):
"""Generate a markdown table of suffix information.
Parameters
----------
suffixes : list of str
A list of the suffixes to include in the table.
src_path : str | None
The file where this macro is called, which may be explicitly provided
by the "page.file.src_path" variable.
Returns
-------
table : str
A Markdown-format table containing the corresponding table for
the requested fields.
"""
if src_path is None:
src_path = _get_source_path()
schemapath = utils.get_schema_path()
schema_obj = schema.load_schema(schemapath)
table = render.make_suffix_table(schema_obj, suffixes, src_path=src_path)
return table
def schema_obj(schema_dir):
"""Schema object."""
return schema.load_schema(schema_dir)
