def builtin_symbols_entity_configuration(
all_builtin_symbols: List[BuiltinSymbolDocumentation]
) -> EntityTypeConfiguration:
return EntityTypeConfiguration(builtin_symbols_help(all_builtin_symbols),
render.IndividualBuiltinSymbolConstructor,
render.list_renderer_getter(),
render.hierarchy_generator_getter())
def hierarchy(
header: str,
test_case_help: TestCaseHelp,
directive_conf: EntityTypeConfiguration,
) -> generator.SectionHierarchyGenerator:
sections_helper = GeneratorsForSectionDocument(
SECTION_CONCEPT_NAME, test_case_help.phase_helps_in_order_of_execution,
TestCasePhaseDocumentationConstructor)
return h.hierarchy(
header,
children=[
h.child(
'spec',
h.with_fixed_root_target(
PredefinedHelpContentsPartReference(
HelpPredefinedContentsPart.TEST_CASE_SPEC),
test_case_specification_rendering.root(
misc_texts.TEST_CASE_SPEC_TITLE, test_case_help))),
h.child('phases', sections_helper.all_sections_list('Phases')),
h.child(
'directives',
directive_conf.get_hierarchy_generator(
DIRECTIVE_ENTITY_TYPE_NAMES.name.plural.capitalize())),
h.child(
'instructions',
sections_helper.instructions_per_section(
'Instructions per phase')),
])
def application_help_for_list_of_entities(
self, entities: list) -> ApplicationHelp:
return application_help_for(
[],
entity_name_2_entity_configuration={
self.entity_type_name:
EntityTypeConfiguration(
EntityTypeHelp(ACTOR_ENTITY_TYPE_NAMES, entities),
IndividualActorConstructor,
FlatListConstructorWithSingleLineDescriptionGetter(),
FlatEntityListHierarchyGeneratorGetter(
self.entity_type_name, IndividualActorConstructor),
)
})
def hierarchy(header: str,
test_suite_help: TestSuiteHelp,
suite_reporter_conf: EntityTypeConfiguration,
) -> generator.SectionHierarchyGenerator:
sections_helper = GeneratorsForSectionDocument(SECTION_CONCEPT_NAME,
test_suite_help.section_helps,
TestSuiteSectionDocumentationConstructor)
return h.hierarchy(
header,
children=[
h.child('spec',
h.with_fixed_root_target(
PredefinedHelpContentsPartReference(HelpPredefinedContentsPart.TEST_SUITE_SPEC),
main.hierarchy(misc_texts.TEST_SUITE_SPEC_TITLE,
test_suite_help)
)),
h.child('sections',
h.hierarchy(
'Sections',
children=[
h.child('cases-and-sub-suites',
sections_helper.custom_sections_list(
test_suite_structure.CASES_AND_SUB_SUITES_HEADER,
test_suite_help.test_cases_and_sub_suites_sections,
)),
h.child('common-case-contents',
sections_helper.custom_sections_list(
test_suite_structure.COMMON_CASE_CONTENTS_AND_CONFIG_HEADER,
test_suite_help.test_case_phase_sections,
)),
])
),
h.child('reporters',
suite_reporter_conf.get_hierarchy_generator(
SUITE_REPORTER_ENTITY_TYPE_NAMES.name.plural.capitalize())
),
h.child('instructions',
sections_helper.instructions_per_section('Instructions per section')
),
]
)
from exactly_lib.definitions.entity.all_entity_types import ACTOR_ENTITY_TYPE_NAMES
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.actors.all_actor_docs import ALL_ACTOR_DOCS
from exactly_lib.help.entities.actors.contents_structure import actors_help
from exactly_lib.help.entities.actors.render import IndividualActorConstructor
from exactly_lib.help.render.entities_list_renderer import FlatEntityListHierarchyGeneratorGetter
from exactly_lib.help.render.entity_docs import \
FlatListConstructorWithSingleLineDescriptionGetter
ACTOR_ENTITY_CONFIGURATION = EntityTypeConfiguration(
actors_help(ALL_ACTOR_DOCS), IndividualActorConstructor,
FlatListConstructorWithSingleLineDescriptionGetter(),
FlatEntityListHierarchyGeneratorGetter(ACTOR_ENTITY_TYPE_NAMES.identifier,
IndividualActorConstructor))
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.types import render
from exactly_lib.help.entities.types.all_types import all_types
from exactly_lib.help.entities.types.contents_structure import types_help
TYPE_ENTITY_CONFIGURATION = EntityTypeConfiguration(
types_help(all_types()),
render.IndividualTypeConstructor,
render.list_render_getter(),
render.hierarchy_generator_getter())
from exactly_lib.definitions.entity.all_entity_types import CONCEPT_ENTITY_TYPE_NAMES
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.concepts import render
from exactly_lib.help.entities.concepts.all_concepts import all_concepts
from exactly_lib.help.entities.concepts.contents_structure import concepts_help
from exactly_lib.help.render.entities_list_renderer import FlatEntityListHierarchyGeneratorGetter
from exactly_lib.help.render.entity_docs import \
FlatListConstructorWithSingleLineDescriptionGetter
CONCEPT_ENTITY_CONFIGURATION = EntityTypeConfiguration(
concepts_help(all_concepts()),
render.IndividualConceptConstructor,
FlatListConstructorWithSingleLineDescriptionGetter(),
FlatEntityListHierarchyGeneratorGetter(
CONCEPT_ENTITY_TYPE_NAMES.identifier,
render.IndividualConceptConstructor),
)
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.syntax_elements import contents_structure, render, all_syntax_elements
SYNTAX_ELEMENT_ENTITY_CONFIGURATION = EntityTypeConfiguration(
contents_structure.syntax_elements_help(
all_syntax_elements.ALL_SYNTAX_ELEMENT_DOCS),
render.IndividualSyntaxElementConstructor, render.list_render_getter(),
render.hierarchy_generator_getter())
from exactly_lib.definitions.entity.all_entity_types import SUITE_REPORTER_ENTITY_TYPE_NAMES
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.suite_reporters import render
from exactly_lib.help.entities.suite_reporters.contents_structure import suite_reporters_help
from exactly_lib.help.entities.suite_reporters.objects.all_suite_reporters import ALL_SUITE_REPORTERS
from exactly_lib.help.render.entities_list_renderer import FlatEntityListHierarchyGeneratorGetter
from exactly_lib.help.render.entity_docs import \
FlatListConstructorWithSingleLineDescriptionGetter
SUITE_REPORTER_ENTITY_CONFIGURATION = EntityTypeConfiguration(
suite_reporters_help(ALL_SUITE_REPORTERS),
render.IndividualSuiteReporterConstructor,
FlatListConstructorWithSingleLineDescriptionGetter(),
FlatEntityListHierarchyGeneratorGetter(SUITE_REPORTER_ENTITY_TYPE_NAMES.identifier,
render.IndividualSuiteReporterConstructor),
)
from exactly_lib.definitions.entity.all_entity_types import DIRECTIVE_ENTITY_TYPE_NAMES
from exactly_lib.help.contents_structure.entity import EntityTypeConfiguration
from exactly_lib.help.entities.directives import render
from exactly_lib.help.entities.directives.all_directives import all_directives
from exactly_lib.help.entities.directives.contents_structure import directives_help
from exactly_lib.help.render.entities_list_renderer import FlatEntityListHierarchyGeneratorGetter
from exactly_lib.help.render.entity_docs import \
FlatListConstructorWithSingleLineDescriptionGetter
DIRECTIVE_ENTITY_CONFIGURATION = EntityTypeConfiguration(
directives_help(all_directives()),
render.IndividualDirectiveConstructor,
FlatListConstructorWithSingleLineDescriptionGetter(),
FlatEntityListHierarchyGeneratorGetter(
DIRECTIVE_ENTITY_TYPE_NAMES.identifier,
render.IndividualDirectiveConstructor),
)