from ..sprkkr.configuration import (
ConfigurationValueDefinition,
ConfigurationFileDefinition,
ConfigurationSectionDefinition,
ConfigurationSection,
)
from ..common.configuration_definitions import SeparatorDefinition
from ..common.decorators import cached_class_property, cache
from ..common.grammar_types import (
unsigned,
Array,
Table,
Keyword,
GrammarType,
pot_mixed,
line_string,
line_end,
Separator as SeparatorType,
BlankSeparator as BlankSeparatorType,
)
import pyparsing as pp
from .result_files import ResultFile
from ..common.grammar import generate_grammar
[docs]
class ResultFileValueDefinition(ConfigurationValueDefinition):
"""This class describes the format of one value of
a header of a result file"""
@cached_class_property
def delimiter():
with generate_grammar():
return pp.Empty().set_name("\t")
prefix = " "
type_from_type_map = {str: line_string}
type_of_dangerous = pot_mixed
[docs]
class ResultFileSection(ConfigurationSection):
pass
[docs]
class ResultFileSectionDefinition(ConfigurationSectionDefinition):
@cached_class_property
def delimiter():
with generate_grammar():
return pp.Suppress("\n").set_whitespace_chars(" \r\t").set_name("\n")
custom_class = None
force_order = True
[docs]
class BlankSeparator(SeparatorDefinition):
"""
A special (hidden) value, that appears in a result file header
The separator is a blank line
"""
separator_type = BlankSeparatorType()
[docs]
class Separator(SeparatorDefinition):
"""
A special (hidden) value, that appears in a result file header
"""
separator_type = SeparatorType(char="#", length=80)
[docs]
class ResultFileDefinition(ConfigurationFileDefinition):
"""This class describes the format of one
structure of a structured result file"""
force_order = True
""" The order of items in a result file is fixed """
value_name_format = "{:<12}"
child_class = ResultFileValueDefinition
""" standard child class """
custom_class = None
""" No custom members in the result files """
delimiter = line_end
""" Options are delimited by newlines in result files. """
result_class = ResultFile
configuration_type_name = "RESULT FILE"
[docs]
def add_ignored(self, out):
"""In the result files, do not ignore doublecrossed lines"""
return out
@property
def extension(self):
mod = self.__class__.__module__
return mod.rsplit(".", 1)[1]
[docs]
def create_result_file_definition(keyword, add, name=None, cls=ResultFileDefinition, **kwargs):
"""Create a definition of a result file. Supply the additional values
containing the actual data.
"""
V = ResultFileValueDefinition
if isinstance(keyword, str):
if name is None:
name = keyword
keyword = V("KEYWORD", Keyword(keyword))
elif isinstance(keyword, GrammarType):
keyword = V("KEYWORD", keyword)
fields = [keyword]
fields.extend(result_file_header())
if add:
fields.extend(add)
return cls(f"{name}", fields, **kwargs)