base_grammar module¶
Base class for validating data structures.
- class gemseo.core.grammars.base_grammar.BaseGrammar(name)[source]¶
-
An abstract base class for grammars with a dictionary-like interface.
A grammar considers a certain type of data defined by mandatory and optional names bound to types. A name-type pair is referred to as a grammar element. A grammar can validate a data from these elements.
Initialize self. See help(type(self)) for accurate signature.
- Parameters:
name (str) – The name of the grammar.
- Raises:
ValueError – If the name is empty.
- add_namespace(name, namespace)[source]¶
Add a namespace prefix to an existing grammar element.
The updated element name will be
namespace``+:data:`~gemseo.core.namespaces.namespace_separator`+``name
.- Parameters:
- Raises:
ValueError – If the variable already has a namespace.
- Return type:
None
- copy()¶
Create a shallow copy.
- Returns:
The shallow copy.
- Return type:
Self
- get(k[, d]) D[k] if k in D, else d. d defaults to None. ¶
- items() a set-like object providing a view on D's items ¶
- keys() a set-like object providing a view on D's keys ¶
- to_simple_grammar()[source]¶
Convert the grammar to a
SimpleGrammar
.- Returns:
A
SimpleGrammar
version of the current grammar.- Return type:
- update_from_data(data, merge=False)[source]¶
Update the grammar from name-value pairs.
The updated elements are required.
- Parameters:
data (Data) – The data from which to get the names and types, typically
{element_name: element_value}
.merge (bool) –
Whether to merge or update the grammar.
By default it is set to False.
- Return type:
None
- update_from_names(names, merge=False)[source]¶
Update the grammar from names.
The updated elements are required and bind the names to NumPy arrays.
- update_from_types(names_to_types, merge=False)[source]¶
Update the grammar from names bound to types.
The updated elements are required.
- Parameters:
names_to_types (SimpleGrammarTypes) – The mapping defining the data names as keys, and data types as values.
merge (bool) –
Whether to merge or update the grammar.
By default it is set to False.
- Return type:
None
- validate(data, raise_exception=True)[source]¶
Validate data against the grammar.
- Parameters:
data (Data) – The data to be checked, with a dictionary-like format:
{element_name: element_value}
.raise_exception (bool) –
Whether to raise an exception when the validation fails.
By default it is set to True.
- Raises:
InvalidDataError – If the validation fails and
raise_exception
isTrue
.- Return type:
None
- values() an object providing a view on D's values ¶
- DATA_CONVERTER_CLASS: ClassVar[str | type[BaseDataConverter[BaseGrammar]]]¶
The class or the class name of the data converter.
- property data_converter: BaseDataConverter[BaseGrammar]¶
The converter of data values to NumPy arrays and vice versa.
- from_namespaced: NamespacesMapping¶
The mapping from element names with namespace prefix to element names without namespace prefix.
- property required_names: RequiredNames¶
The names of the required elements.
- to_namespaced: NamespacesMapping¶
The mapping from element names without namespace prefix to element names with namespace prefix.