gemseo / core / grammars

Show inherited members

json_grammar module

A Grammar based on JSON schema.

class gemseo.core.grammars.json_grammar.JSONGrammar(name, file_path='', descriptions=mappingproxy({}), **kwargs)

Bases: BaseGrammar

A grammar based on a JSON schema.

For the dictionary-like methods similar to update, when a key exists in both grammars, the values can be merged instead of being updated by passing merge = True. In that case, the resulting grammar will allow any of the values.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

• name (str) – The name of the grammar.

• file_path (str | Path) –

  The path to a JSON schema file. If None, do not initialize the grammar from a JSON schema file.

  By default it is set to “”.

• descriptions (Mapping[str, str]) –

  The descriptions of the elements read from file_path, in the form: {element_name: element_meaning}. If None, use the descriptions available in the JSON schema if any.

  By default it is set to {}.

• **kwargs (Any) – These arguments are not used.

Raises:

ValueError – If the name is empty.

DATA_CONVERTER_CLASS

alias of DataConverter

is_array(name, numeric_only=False)

Check if an element is an array.

Parameters:

• name (str) – The name of the element.

• numeric_only (bool) –

  Whether to check if the array elements are numbers.

  By default it is set to False.

Returns:

Whether the element is an array.

Raises:

KeyError – If the element is not in the grammar.

Return type:

bool

set_descriptions(descriptions)

Set the properties descriptions.

Parameters:

descriptions (Mapping[str, str]) – The descriptions, mapping properties names to the description.

Return type:

None

to_file(path='')

Write the grammar ,schema to a json file.

Parameters:

path (Path | str) –

The file path. If empty, write to a file named after the grammar and with .json extension.

By default it is set to “”.

Return type:

None

to_json(*args, **kwargs)

Return the JSON representation of the grammar schema.

Parameters:

• *args (Any) – The positional arguments passed to json.dumps().

• **kwargs (Any) – The keyword arguments passed to json.dumps().

Returns:

The JSON representation of the schema.

Return type:

str

update_from_file(path, merge=False)

Update the grammar from a schema file.

Parameters:

• path (str | Path) – The path to the schema file.

• merge (bool) –

  Whether to merge or update the grammar.

  By default it is set to False.

Raises:

FileNotFoundError – If the schema file does not exist.

Return type:

None

update_from_schema(schema, merge=False)

Update the grammar from a json schema.

Parameters:

• schema (Schema) – The schema to update from.

• merge (bool) –

  Whether to merge or update the grammar.

  By default it is set to False.

Return type:

None

from_namespaced: NamespacesMapping

The mapping from element names with namespace prefix to element names without namespace prefix.

name: str

The name of the grammar.

property schema: Schema

The dictionary representation of the schema.

to_namespaced: NamespacesMapping

The mapping from element names without namespace prefix to element names with namespace prefix.

Examples using JSONGrammar

Merge or update a JSONGrammar

Merge or update a JSONGrammar