def root(header: str) -> generator.SectionHierarchyGenerator:
tp = _text_parser()
def paragraphs_of(template: str) -> paragraphs.ParagraphItemsConstructor:
return paragraphs.constant(tp.fnap(template))
def initial_paragraphs_of(
template: str) -> sections.SectionContentsConstructor:
return sections.contents(paragraphs_of(template))
file_inclusion_doc = sections.contents(paragraphs_of(FILE_INCLUSION_DOC), [
see_also.SeeAlsoSectionConstructor(
see_also.items_of_targets(_FILE_INCLUSION_SEE_ALSO_TARGETS))
])
return h.hierarchy(
header,
initial_paragraphs=paragraphs_of(_INTRO),
children=[
h.child_leaf('phases', 'Phases',
initial_paragraphs_of(PHASES_DOC)),
h.child_leaf('phase-contents', 'Phase contents',
initial_paragraphs_of(PHASES_CONTENTS_DOC)),
h.child_hierarchy(
'instructions', 'Instructions',
paragraphs_of(INSTRUCTIONS_DOC), [
h.child_leaf(
'description',
defs.INSTRUCTION_DESCRIPTION.plural.capitalize(),
initial_paragraphs_of(INSTRUCTIONS_DESCRIPTION_DOC))
]),
h.child_leaf('file-inclusion', 'File inclusion',
file_inclusion_doc),
h.child_leaf('com-empty', 'Comments and empty lines',
initial_paragraphs_of(OTHER_DOC)),
])
def get_constructor(self, all_entity_doc_list: Iterable[EntityDocumentation]) -> SectionContentsConstructor:
partitions = partition_entities(self.partition_setup_list, all_entity_doc_list)
def section_constructor(partition: EntitiesPartition) -> SectionConstructor:
return sections.section(
docs.text(partition.partition_names_setup.header),
EntitiesListConstructor(self.entity_2_summary_paragraphs,
partition.entity_doc_list))
return sections.contents(sub_sections=map(section_constructor, partitions))
def instruction_set_constructor(
instruction_set: SectionInstructionSet,
name_2_name_text_fun: Callable[[str], docs.Text] = docs.text,
instruction_group_by:
Optional[Callable[[Sequence[InstructionDocumentation]], Sequence[InstructionGroup]]] = None
) -> sections.SectionContentsConstructor:
return sections.contents(
InstructionSetSummaryConstructor(instruction_set,
name_2_name_text_fun,
instruction_group_by)
)
def get_constructor(
self, all_entity_doc_list: Iterable[EntityDocumentation]
) -> SectionContentsConstructor:
partitions = partition_entities(self.partition_setup_list,
all_entity_doc_list)
def section_constructor(
partition: EntitiesPartition) -> SectionConstructor:
return sections.section(
docs.text(partition.partition_names_setup.header),
EntitiesListConstructor(self.entity_2_summary_paragraphs,
partition.entity_doc_list))
return sections.contents(
sub_sections=map(section_constructor, partitions))
def root(header: str, test_case_help: TestCaseHelp) -> generator.SectionHierarchyGenerator:
tp = TextParser({
'default_suite_file_name': file_names.DEFAULT_SUITE_FILE,
'act': phase_infos.ACT.name,
'assert': phase_infos.ASSERT.name,
'setup': phase_infos.SETUP.name,
'action_to_check': concepts.ACTION_TO_CHECK_CONCEPT_INFO.name,
'instruction': concepts.INSTRUCTION_CONCEPT_INFO.name,
'ATC': concepts.ACTION_TO_CHECK_CONCEPT_INFO.acronym,
'actor': concepts.ACTOR_CONCEPT_INFO.name,
'os_process': misc_texts.OS_PROCESS_NAME,
'null_actor': actors.NULL_ACTOR.singular_name,
'shell_command_marker': SHELL_COMMAND_MARKER,
'shell_command': formatting.misc_name_with_formatting(misc_texts.SHELL_COMMAND),
'shell_command_line': formatting.misc_name_with_formatting(misc_texts.SHELL_COMMAND_LINE),
})
def const_paragraphs(header_: StrOrStringText,
initial_paragraphs: List[docs.ParagraphItem]) -> generator.SectionHierarchyGenerator:
return h.leaf(header_,
sections.constant_contents(docs.section_contents(initial_paragraphs)))
def phases_documentation() -> List[ParagraphItem]:
return (tp.fnap(_PHASES_INTRO) +
[sections_short_list(test_case_help.phase_helps_in_order_of_execution,
phase_identifier.DEFAULT_PHASE.section_name,
phase_names_plain.SECTION_CONCEPT_NAME)])
act_contents = sections.contents(
paragraphs.constant(tp.fnap(_ACT)),
[
_act_examples(tp),
see_also.SeeAlsoSectionConstructor(
see_also.items_of_targets(_act_see_also_targets())
)
]
)
instructions_contents = sections.contents(
paragraphs.constant(tp.fnap(_INSTRUCTIONS)),
[
see_also.SeeAlsoSectionConstructor(
see_also.items_of_targets(_instructions_see_also_targets())
)
]
)
return h.hierarchy(
header,
children=[
h.child('phases',
const_paragraphs('Phases',
phases_documentation())
),
h.child('act',
h.leaf(
tp.text('The {act} phase, {action_to_check:/q} and {actor:s/q}'),
act_contents
)
),
h.child('instructions',
h.leaf(tp.text('{instruction:s/u}'),
instructions_contents)
),
h.child('suites',
h.hierarchy(
'Relation to test suites',
children=[
h.child('suite-contents',
const_paragraphs('Inclusion of phase contents from suites',
tp.fnap(_SUITE_CONTENTS_INCLUSION))
),
h.child('part-of-suite',
const_paragraphs('Part of suite',
tp.fnap(_PART_OF_SUITE))
),
h.leaf_not_in_toc(
see_also.SEE_ALSO_TITLE,
see_also.SeeAlsoSectionContentsConstructor(
see_also.items_of_targets(_suite_see_also_targets())
)
),
]),
),
]
)
def root(header: str, setup: Setup) -> generator.SectionHierarchyGenerator:
tp = TextParser({
'default_suite_file_name': file_names.DEFAULT_SUITE_FILE,
'act': phase_infos.ACT.name,
'action_to_check': concepts.ACTION_TO_CHECK_CONCEPT_INFO.name,
'ATC': concepts.ACTION_TO_CHECK_CONCEPT_INFO.acronym,
'actor': concepts.ACTOR_CONCEPT_INFO.name,
'os_process': misc_texts.OS_PROCESS_NAME,
'null_actor': actors.NULL_ACTOR.singular_name,
'shell_command_marker': SHELL_COMMAND_MARKER,
})
def const_paragraphs(header_: StrOrStringText,
initial_paragraphs: List[docs.ParagraphItem]) -> generator.SectionHierarchyGenerator:
return h.leaf(header_,
sections.constant_contents(docs.section_contents(initial_paragraphs)))
def phases_documentation() -> List[ParagraphItem]:
return (tp.fnap(_PHASES_INTRO) +
[sections_short_list(setup.test_case_help.phase_helps_in_order_of_execution,
phase_identifier.DEFAULT_PHASE.section_name,
phase_names_plain.SECTION_CONCEPT_NAME)])
act_contents = sections.contents(
paragraphs.constant(tp.fnap(_ACT)),
[
_act_examples(tp),
see_also.SeeAlsoSectionConstructor(
see_also.items_of_targets(_act_see_also_targets())
)
]
)
instructions_contents = sections.contents(
paragraphs.constant(tp.fnap(_INSTRUCTIONS)),
[
see_also.SeeAlsoSectionConstructor(
see_also.items_of_targets(_instructions_see_also_targets())
)
]
)
return h.hierarchy(
header,
children=[
h.child('phases',
const_paragraphs('Phases',
phases_documentation())
),
h.child('act',
h.leaf(
tp.text('The {act} phase, {action_to_check:/q} and {actor:s/q}'),
act_contents
)
),
h.child('instructions',
h.leaf('Instructions',
instructions_contents)
),
h.child('suites',
h.hierarchy(
'Relation to test suites',
children=[
h.child('suite-contents',
const_paragraphs('Inclusion of phase contents from suites',
tp.fnap(_SUITE_CONTENTS_INCLUSION))
),
h.child('part-of-suite',
const_paragraphs('Part of suite',
tp.fnap(_PART_OF_SUITE))
),
h.with_not_in_toc(
h.leaf(
see_also.SEE_ALSO_TITLE,
see_also.SeeAlsoSectionContentsConstructor(
see_also.items_of_targets(_suite_see_also_targets())
)))
,
]),
),
]
)
def initial_paragraphs_of(
template: str) -> sections.SectionContentsConstructor:
return sections.contents(paragraphs_of(template))