Source code for ase2sprkkr.result_files.definition_registry

"""Discovery of structured SPR-KKR result-file definitions."""

from ..common.module_registry import ModuleRegistry, RegistryDefinitionError
from . import definitions


[docs] class ResultFileDefinitionRegistry(ModuleRegistry): """Load result-file ``definition`` objects from definition modules."""
[docs] def __init__(self, package=definitions): super().__init__(package, "definition")
[docs] def by_extension(self): """Map each extension to *all* definitions that can parse it.""" grouped = {} for definition in self.values(include_aliases=False): extension = definition.extension.lower().lstrip(".") grouped.setdefault(extension, []).append(definition) return {extension: tuple(group) for extension, group in grouped.items()}
[docs] def by_name(self): """Map unique format names to definitions, retaining unambiguous ext aliases. Unlike file extensions, module names identify a single parser. For compatibility, a unique extension such as `dat` remains a valid format name (the JXC parser), even though its module is named `jxc`. """ definitions = { name.lower(): self[name] for name in self.names(include_aliases=False) } extensions = {} # Reuse the values already materialized above instead of a second # registry enumeration through by_extension(). for definition in definitions.values(): extension = definition.extension.lower().lstrip(".") extensions.setdefault(extension, []).append(definition) for extension, candidates in extensions.items(): if len(candidates) == 1: existing = definitions.get(extension) if existing is not None and existing is not candidates[0]: raise RegistryDefinitionError( f"Format name {extension!r} conflicts with its file extension" ) definitions.setdefault(extension, candidates[0]) return definitions
[docs] def definition_for_task_file(self, task_file): """Return the known structured format associated with a task file.""" return None if task_file.type is None else self[task_file.type]
[docs] def info_for_task_file(self, task_file): """Task-specific info wins over its registered file-format description.""" if task_file.info is not None: return task_file.info definition = self.definition_for_task_file(task_file) return None if definition is None else definition.info
result_file_definition_registry = ResultFileDefinitionRegistry()