schema_salad.runtime

Shared code for parsers generated by the Python codegen.

See --codegen=python & python_codegen.

Attributes

`IdxType`
`SaveableType`
`save_type`

Classes

`LoadingOptions`	Class that holds the state of loading a SALAD document.
`Saveable`	Mark classes than have a save() and fromDoc() function.

Functions

`extract_type`(val_type)	Take a type of value, and extracts the value as a string.
`convert_typing`(val_type)	Normalize type names to schema-salad types.
`parse_errors`(error_message)	Parse error messages from several loaders into one error message.
`save`(val[, top, base_url, relative_uris])	Convert an object to a JSON/YAML friendly dictionary.
`save_with_metadata`(val, valLoadingOpts[, top, ...])	Save and set $namespaces, $schemas, $base and any other metadata fields at the top level.
`file_uri`(path[, split_frag])	Transform a file path into a URL with file scheme.
`prefix_url`(url, namespaces)	Expand short forms into full URLs using the given namespace dictionary.
`save_relative_uri`(uri, base_url, scoped_id, ref_scope, ...)	Convert any URI to a relative one, obeying the scoping rules.
`shortname`(inputid)	Compute the shortname of a fully qualified identifier.

Module Contents

type schema_salad.runtime.IdxType = MutableMapping[str, tuple[Any, 'LoadingOptions']]

class schema_salad.runtime.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, no_link_check=None, container=None)

Class that holds the state of loading a SALAD document.

Parameters:

fetcher (schema_salad.fetcher.Fetcher | None)
namespaces (dict[str, str] | None)
schemas (list[str] | None)
fileuri (str | None)
copyfrom (LoadingOptions | None)
original_doc (Any | None)
addl_metadata (dict[str, str] | None)
baseuri (str | None)
idx (IdxType | None)
imports (list[str] | None)
includes (list[str] | None)
no_link_check (bool | None)
container (str | None)

idx: Final[IdxType]

fileuri: Final[str | None]

baseuri: Final[str]

namespaces: Final[collections.abc.MutableMapping[str, str]]

schemas: Final[collections.abc.MutableSequence[str]]

original_doc: Final[Any | None]

addl_metadata: Final[collections.abc.MutableMapping[str, Any]]

fetcher: Final[schema_salad.fetcher.Fetcher]

vocab: Final[dict[str, str]]

rvocab: Final[dict[str, str]]

cache: Final[schema_salad.utils.CacheType]

imports: Final[list[str]]

includes: Final[list[str]]

no_link_check: Final[bool | None]

container: Final[str | None]

property graph: rdflib.Graph

Generate a merged rdflib.Graph from all entries in self.schemas.

Return type:: rdflib.Graph

class schema_salad.runtime.Saveable

Mark classes than have a save() and fromDoc() function.

classmethod fromDoc(_doc, baseuri, loadingOptions, docRoot=None)

Abstractmethod:

Parameters:

_doc (Any)
baseuri (str)
loadingOptions (LoadingOptions)
docRoot (str | None)

Return type:

Self

Construct this object from the result of yaml.load().

abstractmethod save(top=False, base_url='', relative_uris=True)

Convert this object to a JSON/YAML friendly dictionary.

Parameters:

top (bool)
base_url (str)
relative_uris (bool)

Return type:

dict[str, Any]

schema_salad.runtime.SaveableType

type schema_salad.runtime.save_type = None | MutableMapping[str, Any] | MutableSequence[Any] | int | float | bool | str

schema_salad.runtime.extract_type(val_type)

Take a type of value, and extracts the value as a string.

Parameters:: val_type (type[Any])
Return type:: str

schema_salad.runtime.convert_typing(val_type)

Normalize type names to schema-salad types.

Parameters:: val_type (str)
Return type:: str

schema_salad.runtime.parse_errors(error_message)

Parse error messages from several loaders into one error message.

Parameters:: error_message (str)
Return type:: tuple[str, str, str]

schema_salad.runtime.save(val, top=True, base_url='', relative_uris=True)

Convert an object to a JSON/YAML friendly dictionary.

Parameters:

val (Any)
top (bool)
base_url (str)
relative_uris (bool)

Return type:

save_type

schema_salad.runtime.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.runtime.file_uri(path, split_frag=False)

Transform a file path into a URL with file scheme.

Parameters:

path (str)
split_frag (bool)

Return type:

str

schema_salad.runtime.prefix_url(url, namespaces)

Expand short forms into full URLs using the given namespace dictionary.

Parameters:

url (str)
namespaces (dict[str, str])

Return type:

str

schema_salad.runtime.save_relative_uri(uri, base_url, scoped_id, ref_scope, relative_uris)

Convert any URI to a relative one, obeying the scoping rules.

Parameters:

uri (Any)
base_url (str)
scoped_id (bool)
ref_scope (int | None)
relative_uris (bool)

Return type:

Any

schema_salad.runtime.shortname(inputid)

Compute the shortname of a fully qualified identifier.

See https://w3id.org/cwl/v1.2/SchemaSalad.html#Short_names.

Parameters:: inputid (str)
Return type:: str