"""
"""
# todo: Switch various properties to this cached_property once we require python 3.8
import json
from hed.errors.exceptions import HedExceptions, HedFileError
from hed.errors import ErrorHandler, ValidationErrors
from hed.schema.hed_schema_constants import HedSectionKey
from hed.schema.hed_schema_base import HedSchemaBase
[docs]class HedSchemaGroup(HedSchemaBase):
""" Container for multiple HedSchema objects.
Notes:
- The container class is useful when library schema are included.
- You cannot save/load/etc the combined schema object directly.
"""
[docs] def __init__(self, schema_list):
""" Combine multiple HedSchema objects from a list.
Parameters:
schema_list (list): A list of HedSchema for the container.
Returns:
HedSchemaGroup: the container created.
:raises HedFileError:
- Multiple schemas have the same library prefixes.
- Empty list passed
"""
super().__init__()
if len(schema_list) == 0:
raise HedFileError(HedExceptions.BAD_PARAMETERS, "Empty list passed to HedSchemaGroup constructor.",
filename="Combined Schema")
schema_prefixes = [hed_schema._namespace for hed_schema in schema_list]
if len(set(schema_prefixes)) != len(schema_prefixes):
raise HedFileError(HedExceptions.SCHEMA_DUPLICATE_PREFIX,
"Multiple schema share the same tag name_prefix. This is not allowed.",
filename="Combined Schema")
self._schemas = {hed_schema._namespace: hed_schema for hed_schema in schema_list}
[docs] def get_schema_versions(self):
""" A list of HED version strings including namespace and library name if any of this schema.
Returns:
list: The complete version of this schema including library name and namespace.
"""
return [schema.version for schema in self._schemas.values()]
def __eq__(self, other):
return self._schemas == other._schemas
[docs] def schema_for_namespace(self, namespace):
""" Return the HedSchema for the library namespace.
Parameters:
namespace (str): A schema library name namespace.
Returns:
HedSchema or None: The specific schema for this library name namespace if exists.
"""
schema = self._schemas.get(namespace)
return schema
@property
def valid_prefixes(self):
""" Return a list of all prefixes this group will accept.
Returns:
list: A list of strings representing valid prefixes for this group.
"""
return list(self._schemas.keys())
[docs] def check_compliance(self, check_for_warnings=True, name=None, error_handler=None):
""" Check for HED3 compliance of this schema.
Parameters:
check_for_warnings (bool): If True, checks for formatting issues like invalid characters, capitalization.
name (str): If present, use as the filename for context, rather than using the actual filename.
Useful for temp filenames when supporting web services.
error_handler (ErrorHandler or None): Used to report errors. Uses a default one if none passed in.
Returns:
list: A list of all warnings and errors found in the file. Each issue is a dictionary.
"""
issues_list = []
for schema in self._schemas.values():
issues_list += schema.check_compliance(check_for_warnings, name, error_handler)
return issues_list
[docs] def get_tag_entry(self, name, key_class=HedSectionKey.Tags, schema_namespace=""):
""" Return the schema entry for this tag, if one exists.
Parameters:
name (str): Any form of basic tag(or other section entry) to look up.
This will not handle extensions or similar.
If this is a tag, it can have a schema namespace, but it's not required
key_class (HedSectionKey or str): The type of entry to return.
schema_namespace (str): Only used on Tags. If incorrect, will return None.
Returns:
HedSchemaEntry: The schema entry for the given tag.
"""
specific_schema = self.schema_for_namespace(schema_namespace)
if not specific_schema:
return None
return specific_schema.get_tag_entry(name, key_class, schema_namespace)
[docs] def find_tag_entry(self, tag, schema_namespace=""):
""" Find the schema entry for a given source tag.
Parameters:
tag (str, HedTag): Any form of tag to look up. Can have an extension, value, etc.
schema_namespace (str): The schema namespace of the tag, if any.
Returns:
HedTagEntry: The located tag entry for this tag.
str: The remainder of the tag that isn't part of the base tag.
list: A list of errors while converting.
Notes:
Works left to right (which is mostly relevant for errors).
"""
specific_schema = self.schema_for_namespace(schema_namespace)
if not specific_schema:
validation_issues = ErrorHandler.format_error(ValidationErrors.HED_LIBRARY_UNMATCHED, tag,
schema_namespace, self.valid_prefixes)
return None, None, validation_issues
return specific_schema._find_tag_entry(tag, schema_namespace)