schema_salad.metaschema
Module Contents
Classes
Mark classes than have a save() and fromDoc() function. |
|
Mark classes than have a save() and fromDoc() function. |
|
A field of a record. |
|
Mark classes than have a save() and fromDoc() function. |
|
Define an enumerated type. |
|
Mark classes than have a save() and fromDoc() function. |
|
Attached to a record field to define how the parent record field is handled for |
|
Mark classes than have a save() and fromDoc() function. |
|
Mark classes than have a save() and fromDoc() function. |
|
Mark classes than have a save() and fromDoc() function. |
|
Abstract base for schema-defined types. |
|
A field of a record. |
|
Mark classes than have a save() and fromDoc() function. |
|
Define an enumerated type. |
|
A documentation section. This type exists to facilitate self-documenting |
Functions
|
Load field. |
|
Take a type of value, and extracts the value as a string. |
|
Normalize type names to schema-salad types. |
|
Parse error messages from several loaders into one error message. |
|
|
|
Save and set $namespaces, $schemas, $base and any other metadata fields at the top level. |
|
|
|
|
|
Expand short forms into full URLs using the given namespace dictionary. |
|
Convert any URI to a relative one, obeying the scoping rules. |
|
Compute the shortname of a fully qualified identifier. |
|
|
|
|
|
|
|
Shortcut to load via a YAML object. |
Attributes
- schema_salad.metaschema.IdxType
- class schema_salad.metaschema.LoadingOptions(fetcher=None, namespaces=None, schemas=None, fileuri=None, copyfrom=None, original_doc=None, addl_metadata=None, baseuri=None, idx=None, imports=None, includes=None)
- Parameters:
fetcher (Optional[schema_salad.fetcher.Fetcher]) –
schemas (Optional[List[str]]) –
fileuri (Optional[str]) –
copyfrom (Optional[LoadingOptions]) –
original_doc (Optional[Any]) –
baseuri (Optional[str]) –
idx (Optional[IdxType]) –
imports (Optional[List[str]]) –
includes (Optional[List[str]]) –
- property graph: rdflib.Graph
Generate a merged rdflib.Graph from all entries in self.schemas.
- Return type:
- idx: IdxType
- fetcher: schema_salad.fetcher.Fetcher
- cache: schema_salad.utils.CacheType
- class schema_salad.metaschema.Saveable
Bases:
digraph inheritanced0872ffd38 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }abc.ABC
Mark classes than have a save() and fromDoc() function.
- abstract classmethod fromDoc(_doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
_doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- schema_salad.metaschema.load_field(val, fieldtype, baseuri, loadingOptions, lc=None)
Load field.
- Parameters:
fieldtype (_Loader) –
baseuri (str) –
loadingOptions (LoadingOptions) –
lc (Optional[List[Any]]) –
- Return type:
Any
- schema_salad.metaschema.save_type
- schema_salad.metaschema.extract_type(val_type)
Take a type of value, and extracts the value as a string.
- Parameters:
val_type (Type[Any]) –
- Return type:
- schema_salad.metaschema.convert_typing(val_type)
Normalize type names to schema-salad types.
- schema_salad.metaschema.parse_errors(error_message)
Parse error messages from several loaders into one error message.
- schema_salad.metaschema.save(val, top=True, base_url='', relative_uris=True)
- schema_salad.metaschema.save_with_metadata(val, valLoadingOpts, top=True, base_url='', relative_uris=True)
Save and set $namespaces, $schemas, $base and any other metadata fields at the top level.
- Parameters:
val (Any) –
valLoadingOpts (LoadingOptions) –
top (bool) –
base_url (str) –
relative_uris (bool) –
- Return type:
save_type
- schema_salad.metaschema.expand_url(url, base_url, loadingOptions, scoped_id=False, vocab_term=False, scoped_ref=None)
- schema_salad.metaschema.file_uri(path, split_frag=False)
- schema_salad.metaschema.prefix_url(url, namespaces)
Expand short forms into full URLs using the given namespace dictionary.
- schema_salad.metaschema.save_relative_uri(uri, base_url, scoped_id, ref_scope, relative_uris)
Convert any URI to a relative one, obeying the scoping rules.
- schema_salad.metaschema.shortname(inputid)
Compute the shortname of a fully qualified identifier.
- class schema_salad.metaschema.Documented
Bases:
digraph inheritancea7a74ee728 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Mark classes than have a save() and fromDoc() function.
- class schema_salad.metaschema.RecordField(name, type_, doc=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance2c5cf93dd6 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RecordField" [URL="#schema_salad.metaschema.RecordField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A field of a record."]; "Documented" -> "RecordField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Documented
A field of a record.
- Parameters:
name (Any) –
type_ (Any) –
doc (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.RecordSchema(type_, fields=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance1f940565de { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "RecordSchema" [URL="#schema_salad.metaschema.RecordSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "RecordSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Mark classes than have a save() and fromDoc() function.
- Parameters:
type_ (Any) –
fields (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.EnumSchema(symbols, type_, name=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritancea9629043e4 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "EnumSchema" [URL="#schema_salad.metaschema.EnumSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Define an enumerated type."]; "Saveable" -> "EnumSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Define an enumerated type.
- Parameters:
symbols (Any) –
type_ (Any) –
name (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.ArraySchema(items, type_, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance40ad3e0a5b { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "ArraySchema" [URL="#schema_salad.metaschema.ArraySchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "ArraySchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Mark classes than have a save() and fromDoc() function.
- Parameters:
items (Any) –
type_ (Any) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.JsonldPredicate(_id=None, _type=None, _container=None, identity=None, noLinkCheck=None, mapSubject=None, mapPredicate=None, refScope=None, typeDSL=None, secondaryFilesDSL=None, subscope=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance471ed4e28d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "JsonldPredicate" [URL="#schema_salad.metaschema.JsonldPredicate",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Attached to a record field to define how the parent record field is handled for"]; "Saveable" -> "JsonldPredicate" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Attached to a record field to define how the parent record field is handled for URI resolution and JSON-LD context generation.
- Parameters:
_id (Optional[Any]) –
_type (Optional[Any]) –
_container (Optional[Any]) –
identity (Optional[Any]) –
noLinkCheck (Optional[Any]) –
mapSubject (Optional[Any]) –
mapPredicate (Optional[Any]) –
refScope (Optional[Any]) –
typeDSL (Optional[Any]) –
secondaryFilesDSL (Optional[Any]) –
subscope (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.SpecializeDef(specializeFrom, specializeTo, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance80113f5fcc { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SpecializeDef" [URL="#schema_salad.metaschema.SpecializeDef",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "SpecializeDef" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Mark classes than have a save() and fromDoc() function.
- Parameters:
specializeFrom (Any) –
specializeTo (Any) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.NamedType
Bases:
digraph inheritancebb9c2c4a34 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "NamedType" [URL="#schema_salad.metaschema.NamedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "NamedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Saveable
Mark classes than have a save() and fromDoc() function.
- class schema_salad.metaschema.DocType
Bases:
digraph inheritance1fed15c982 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "DocType" [URL="#schema_salad.metaschema.DocType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Documented" -> "DocType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Documented
Mark classes than have a save() and fromDoc() function.
- class schema_salad.metaschema.SchemaDefinedType
Bases:
digraph inheritanceb6322b30aa { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "DocType" [URL="#schema_salad.metaschema.DocType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Documented" -> "DocType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SchemaDefinedType" [URL="#schema_salad.metaschema.SchemaDefinedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base for schema-defined types."]; "DocType" -> "SchemaDefinedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; }DocType
Abstract base for schema-defined types.
- class schema_salad.metaschema.SaladRecordField(name, type_, doc=None, jsonldPredicate=None, default=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritancea1b912dff2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RecordField" [URL="#schema_salad.metaschema.RecordField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A field of a record."]; "Documented" -> "RecordField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SaladRecordField" [URL="#schema_salad.metaschema.SaladRecordField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A field of a record."]; "RecordField" -> "SaladRecordField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; }RecordField
A field of a record.
- Parameters:
name (Any) –
type_ (Any) –
doc (Optional[Any]) –
jsonldPredicate (Optional[Any]) –
default (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.SaladRecordSchema(name, type_, inVocab=None, fields=None, doc=None, docParent=None, docChild=None, docAfter=None, jsonldPredicate=None, documentRoot=None, abstract=None, extends=None, specialize=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance3af8ae8c7e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "DocType" [URL="#schema_salad.metaschema.DocType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Documented" -> "DocType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NamedType" [URL="#schema_salad.metaschema.NamedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "NamedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RecordSchema" [URL="#schema_salad.metaschema.RecordSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "RecordSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SaladRecordSchema" [URL="#schema_salad.metaschema.SaladRecordSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "NamedType" -> "SaladRecordSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RecordSchema" -> "SaladRecordSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SchemaDefinedType" -> "SaladRecordSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SchemaDefinedType" [URL="#schema_salad.metaschema.SchemaDefinedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base for schema-defined types."]; "DocType" -> "SchemaDefinedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; }NamedType
,RecordSchema
,SchemaDefinedType
Mark classes than have a save() and fromDoc() function.
- Parameters:
name (Any) –
type_ (Any) –
inVocab (Optional[Any]) –
fields (Optional[Any]) –
doc (Optional[Any]) –
docParent (Optional[Any]) –
docChild (Optional[Any]) –
docAfter (Optional[Any]) –
jsonldPredicate (Optional[Any]) –
documentRoot (Optional[Any]) –
abstract (Optional[Any]) –
extends (Optional[Any]) –
specialize (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.SaladEnumSchema(symbols, type_, name=None, inVocab=None, doc=None, docParent=None, docChild=None, docAfter=None, jsonldPredicate=None, documentRoot=None, extends=None, extension_fields=None, loadingOptions=None)
Bases:
digraph inheritance81f83ceda7 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "DocType" [URL="#schema_salad.metaschema.DocType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Documented" -> "DocType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EnumSchema" [URL="#schema_salad.metaschema.EnumSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Define an enumerated type."]; "Saveable" -> "EnumSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NamedType" [URL="#schema_salad.metaschema.NamedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Saveable" -> "NamedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SaladEnumSchema" [URL="#schema_salad.metaschema.SaladEnumSchema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Define an enumerated type."]; "NamedType" -> "SaladEnumSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EnumSchema" -> "SaladEnumSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SchemaDefinedType" -> "SaladEnumSchema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."]; "ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SchemaDefinedType" [URL="#schema_salad.metaschema.SchemaDefinedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base for schema-defined types."]; "DocType" -> "SchemaDefinedType" [arrowsize=0.5,style="setlinewidth(0.5)"]; }NamedType
,EnumSchema
,SchemaDefinedType
Define an enumerated type.
- Parameters:
symbols (Any) –
type_ (Any) –
name (Optional[Any]) –
inVocab (Optional[Any]) –
doc (Optional[Any]) –
docParent (Optional[Any]) –
docChild (Optional[Any]) –
docAfter (Optional[Any]) –
jsonldPredicate (Optional[Any]) –
documentRoot (Optional[Any]) –
extends (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- class schema_salad.metaschema.Documentation(name, type_, inVocab=None, doc=None, docParent=None, docChild=None, docAfter=None, extension_fields=None, loadingOptions=None)
-
digraph inheritancebe54ef369d {
bgcolor=transparent;
rankdir=LR;
size="8.0, 12.0";
"ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"];
"DocType" [URL="#schema_salad.metaschema.DocType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
"Documented" -> "DocType" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Documentation" [URL="#schema_salad.metaschema.Documentation",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A documentation section. This type exists to facilitate self-documenting"];
"NamedType" -> "Documentation" [arrowsize=0.5,style="setlinewidth(0.5)"];
"DocType" -> "Documentation" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Documented" [URL="#schema_salad.metaschema.Documented",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
"Saveable" -> "Documented" [arrowsize=0.5,style="setlinewidth(0.5)"];
"NamedType" [URL="#schema_salad.metaschema.NamedType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
"Saveable" -> "NamedType" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Saveable" [URL="#schema_salad.metaschema.Saveable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mark classes than have a save() and fromDoc() function."];
"ABC" -> "Saveable" [arrowsize=0.5,style="setlinewidth(0.5)"];
}
A documentation section. This type exists to facilitate self-documenting schemas but has no role in formal validation.
- Parameters:
name (Any) –
type_ (Any) –
inVocab (Optional[Any]) –
doc (Optional[Any]) –
docParent (Optional[Any]) –
docChild (Optional[Any]) –
docAfter (Optional[Any]) –
extension_fields (Optional[Dict[str, Any]]) –
loadingOptions (Optional[LoadingOptions]) –
- attrs
- classmethod fromDoc(doc, baseuri, loadingOptions, docRoot=None)
Construct this object from the result of yaml.load().
- Parameters:
doc (Any) –
baseuri (str) –
loadingOptions (LoadingOptions) –
docRoot (Optional[str]) –
- Return type:
- schema_salad.metaschema.strtype
- schema_salad.metaschema.inttype
- schema_salad.metaschema.floattype
- schema_salad.metaschema.booltype
- schema_salad.metaschema.None_type
- schema_salad.metaschema.Any_type
- schema_salad.metaschema.PrimitiveTypeLoader
Names of salad data types (based on Avro schema declarations).
Refer to the [Avro schema declaration documentation](https://avro.apache.org/docs/current/spec.html#schemas) for detailed information.
null: no value boolean: a binary value int: 32-bit signed integer long: 64-bit signed integer float: single precision (32-bit) IEEE 754 floating-point number double: double precision (64-bit) IEEE 754 floating-point number string: Unicode character sequence
- schema_salad.metaschema.AnyLoader
The Any type validates for any non-null value.
- schema_salad.metaschema.RecordFieldLoader
- schema_salad.metaschema.RecordSchemaLoader
- schema_salad.metaschema.EnumSchemaLoader
- schema_salad.metaschema.ArraySchemaLoader
- schema_salad.metaschema.JsonldPredicateLoader
- schema_salad.metaschema.SpecializeDefLoader
- schema_salad.metaschema.SaladRecordFieldLoader
- schema_salad.metaschema.SaladRecordSchemaLoader
- schema_salad.metaschema.SaladEnumSchemaLoader
- schema_salad.metaschema.DocumentationLoader
- schema_salad.metaschema.array_of_strtype
- schema_salad.metaschema.union_of_None_type_or_strtype_or_array_of_strtype
- schema_salad.metaschema.uri_strtype_True_False_None
- schema_salad.metaschema.union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype
- schema_salad.metaschema.array_of_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype
- schema_salad.metaschema.union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype_or_array_of_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype
- schema_salad.metaschema.typedsl_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype_or_array_of_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype_2
- schema_salad.metaschema.array_of_RecordFieldLoader
- schema_salad.metaschema.union_of_None_type_or_array_of_RecordFieldLoader
- schema_salad.metaschema.idmap_fields_union_of_None_type_or_array_of_RecordFieldLoader
- schema_salad.metaschema.Record_nameLoader
- schema_salad.metaschema.typedsl_Record_nameLoader_2
- schema_salad.metaschema.union_of_None_type_or_strtype
- schema_salad.metaschema.uri_union_of_None_type_or_strtype_True_False_None
- schema_salad.metaschema.uri_array_of_strtype_True_False_None
- schema_salad.metaschema.Enum_nameLoader
- schema_salad.metaschema.typedsl_Enum_nameLoader_2
- schema_salad.metaschema.uri_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype_or_array_of_union_of_PrimitiveTypeLoader_or_RecordSchemaLoader_or_EnumSchemaLoader_or_ArraySchemaLoader_or_strtype_False_True_2
- schema_salad.metaschema.Array_nameLoader
- schema_salad.metaschema.typedsl_Array_nameLoader_2
- schema_salad.metaschema.union_of_None_type_or_booltype
- schema_salad.metaschema.union_of_None_type_or_inttype
- schema_salad.metaschema.uri_strtype_False_False_1
- schema_salad.metaschema.uri_union_of_None_type_or_strtype_False_False_None
- schema_salad.metaschema.uri_union_of_None_type_or_strtype_or_array_of_strtype_False_False_None
- schema_salad.metaschema.union_of_None_type_or_strtype_or_JsonldPredicateLoader
- schema_salad.metaschema.union_of_None_type_or_Any_type
- schema_salad.metaschema.array_of_SaladRecordFieldLoader
- schema_salad.metaschema.union_of_None_type_or_array_of_SaladRecordFieldLoader
- schema_salad.metaschema.idmap_fields_union_of_None_type_or_array_of_SaladRecordFieldLoader
- schema_salad.metaschema.uri_union_of_None_type_or_strtype_or_array_of_strtype_False_False_1
- schema_salad.metaschema.array_of_SpecializeDefLoader
- schema_salad.metaschema.union_of_None_type_or_array_of_SpecializeDefLoader
- schema_salad.metaschema.idmap_specialize_union_of_None_type_or_array_of_SpecializeDefLoader
- schema_salad.metaschema.Documentation_nameLoader
- schema_salad.metaschema.typedsl_Documentation_nameLoader_2
- schema_salad.metaschema.union_of_SaladRecordSchemaLoader_or_SaladEnumSchemaLoader_or_DocumentationLoader
- schema_salad.metaschema.array_of_union_of_SaladRecordSchemaLoader_or_SaladEnumSchemaLoader_or_DocumentationLoader
- schema_salad.metaschema.union_of_SaladRecordSchemaLoader_or_SaladEnumSchemaLoader_or_DocumentationLoader_or_array_of_union_of_SaladRecordSchemaLoader_or_SaladEnumSchemaLoader_or_DocumentationLoader
- schema_salad.metaschema.load_document(doc, baseuri=None, loadingOptions=None)
- Parameters:
doc (Any) –
baseuri (Optional[str]) –
loadingOptions (Optional[LoadingOptions]) –
- Return type:
Any
- schema_salad.metaschema.load_document_with_metadata(doc, baseuri=None, loadingOptions=None, addl_metadata_fields=None)
- Parameters:
doc (Any) –
baseuri (Optional[str]) –
loadingOptions (Optional[LoadingOptions]) –
addl_metadata_fields (Optional[MutableSequence[str]]) –
- Return type:
Any
- schema_salad.metaschema.load_document_by_string(string, uri, loadingOptions=None)
- Parameters:
string (Any) –
uri (str) –
loadingOptions (Optional[LoadingOptions]) –
- Return type:
Any
- schema_salad.metaschema.load_document_by_yaml(yaml, uri, loadingOptions=None)
Shortcut to load via a YAML object. yaml: must be from ruamel.yaml.main.YAML.load with preserve_quotes=True
- Parameters:
yaml (Any) –
uri (str) –
loadingOptions (Optional[LoadingOptions]) –
- Return type:
Any