def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'cd_concept': formatting.concept(self.singular_name()),
'CD': self.acronym(),
'program_name': formatting.program_name(program_info.PROGRAM_NAME),
'sds_concept': formatting.concept_(concepts.SDS_CONCEPT_INFO),
'act_sub_dir': SUB_DIRECTORY__ACT + '/',
'path_type': formatting.symbol_type_(types.PATH_TYPE_INFO),
'act_phase': phase_names.ACT.emphasis,
'rel_cd_option': formatting.cli_option(path.REL_CWD_OPTION),
'cd_instruction': InstructionName(instruction_names.CHANGE_DIR_INSTRUCTION_NAME),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'instruction': concepts.INSTRUCTION_CONCEPT_INFO.name,
'os_process': misc_texts.OS_PROCESS_NAME,
})
return DescriptionWithSubSections(
self.single_line_description(),
SectionContents(
tp.fnap(_INITIAL_PARAGRAPHS),
[
docs.section(
tp.text(_USING_THE_CD_HEADER),
tp.fnap(_USING_THE_CD)
),
docs.section(
tp.text(_DESCRIPTION_DEF_INSTRUCTION_HEADER),
cd_instruction_section_on_def_instruction()
),
]
))
def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'reporter_option': formatting.cli_option(OPTION_FOR_REPORTER),
'default_reporter': formatting.entity(reporters.DEFAULT_REPORTER.singular_name),
})
return from_simple_description(
Description(self.single_line_description(),
tp.fnap(_DESCRIPTION_REST)))
def cd_instruction_section_on_def_instruction() -> List[ParagraphItem]:
tp = TextParser({
'current_directory_concept': formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'symbol_concept': formatting.concept(concepts.SYMBOL_CONCEPT_INFO.singular_name),
'rel_cd_option': formatting.cli_option(file_ref.REL_CWD_OPTION),
'path_type': formatting.keyword(types.PATH_TYPE_INFO.name.singular),
})
return tp.fnap(_CD_INSTRUCTION_SECTION_ON_DEF_INSTRUCTION)
def __init__(self):
super().__init__(SOURCE_INTERPRETER_ACTOR)
format_map = {
'phase': phase_names.PHASE_NAME_DICTIONARY,
'actor_option': formatting.cli_option(common_cli_options.OPTION_FOR_ACTOR),
'actor_instruction': formatting.InstructionName(ACTOR_INSTRUCTION_NAME),
'shell_command': formatting.misc_name_with_formatting(misc_texts.SHELL_COMMAND),
}
self._parser = TextParser(format_map)
def cd_instruction_section_on_def_instruction() -> List[ParagraphItem]:
tp = TextParser({
'current_directory_concept': formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'symbol_concept': formatting.concept(concepts.SYMBOL_CONCEPT_INFO.singular_name),
'rel_cd_option': formatting.cli_option(path.REL_CWD_OPTION),
'path_type': types.PATH_TYPE_INFO.name,
})
return tp.fnap(_CD_INSTRUCTION_SECTION_ON_DEF_INSTRUCTION)
def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'reporter_option':
formatting.cli_option(OPTION_FOR_REPORTER),
'default_reporter':
formatting.entity(reporters.DEFAULT_REPORTER.singular_name),
})
return from_simple_description(
Description(self.single_line_description(),
tp.fnap(_DESCRIPTION_REST)))
def path_type_path_rendering() -> SectionItem:
tp = TextParser({
'current_directory_concept': formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'symbol_concept': formatting.concept(concepts.SYMBOL_CONCEPT_INFO.singular_name),
'rel_cd_option': formatting.cli_option(file_ref.REL_CWD_OPTION),
'path_type': formatting.keyword(types.PATH_TYPE_INFO.name.singular),
})
return Section(tp.text(_PATH_TYPE_PATH_RENDERING_DESCRIPTION_HEADER),
tp.section_contents(_PATH_TYPE_PATH_RENDERING_DESCRIPTION))
def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'the_concept': formatting.concept(self.name().singular),
'preprocessor_option': formatting.cli_option(OPTION_FOR_PREPROCESSOR),
'is_a_shell_cmd': misc_texts.IS_A_SHELL_CMD,
'an_exit_code': misc_texts.EXIT_CODE.singular_determined.capitalize(),
})
return from_simple_description(
Description(self.single_line_description(),
tp.fnap(_DESCRIPTION_REST)))
def purpose(self) -> DescriptionWithSubSections:
parser = TextParser({
'phase': phase_names.PHASE_NAME_DICTIONARY,
'the_concept': formatting.conf_param_(conf_params.HOME_ACT_DIRECTORY_CONF_PARAM_INFO),
'home_dir_env_var': ENV_VAR_HOME_ACT,
'rel_option': formatting.cli_option(REL_HOME_ACT_OPTION)
})
return from_simple_description(
Description(self.single_line_description(),
parser.fnap(_REST_DESCRIPTION)))
def __init__(self):
super().__init__(concepts.SANDBOX_CONCEPT_INFO)
self._tp = TextParser({
'program_name': formatting.program_name(program_info.PROGRAM_NAME),
'phase': phase_names.PHASE_NAME_DICTIONARY,
'instruction': AnyInstructionNameDictionary(),
'cwd': formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'cd_instruction': InstructionName(CHANGE_DIR_INSTRUCTION_NAME),
'keep_sandbox_option': formatting.cli_option(command_line_options.OPTION_FOR_KEEPING_SANDBOX_DIRECTORY),
})
def path_type_path_rendering() -> SectionItem:
tp = TextParser({
'current_directory_concept': formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'symbol_concept': formatting.concept(concepts.SYMBOL_CONCEPT_INFO.singular_name),
'rel_cd_option': formatting.cli_option(path.REL_CWD_OPTION),
'path_type': types.PATH_TYPE_INFO.name,
'external_program': misc_texts.EXTERNAL_PROGRAM,
'os_process': misc_texts.OS_PROCESS_NAME,
'Note': headers.NOTE_LINE_HEADER,
})
return Section(tp.text(_PATH_TYPE_PATH_RENDERING_DESCRIPTION_HEADER),
tp.section_contents(_PATH_TYPE_PATH_RENDERING_DESCRIPTION))
def purpose(self) -> DescriptionWithSubSections:
parser = TextParser({
'action_to_check': concepts.ACTION_TO_CHECK_CONCEPT_INFO.name,
'actor': concepts.ACTOR_CONCEPT_INFO.name,
'ATC': concepts.ACTION_TO_CHECK_CONCEPT_INFO.acronym,
'actor_option': formatting.cli_option(common_cli_options.OPTION_FOR_ACTOR),
'actor_instruction': formatting.InstructionName(ACTOR_INSTRUCTION_NAME),
'act': phase_infos.ACT.name,
'phase': PHASE_NAME_DICTIONARY,
'os_process': misc_texts.OS_PROCESS_NAME,
})
return DescriptionWithSubSections(concepts.ACTION_TO_CHECK_CONCEPT_INFO.single_line_description,
docs.section_contents(parser.fnap(_DESCRIPTION)))
def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'the_concept':
formatting.concept(self.name().singular),
'preprocessor_option':
formatting.cli_option(OPTION_FOR_PREPROCESSOR),
'is_a_system_cmd':
misc_texts.IS_A_SYSTEM_CMD,
'exit_code':
misc_texts.EXIT_CODE,
})
return from_simple_description(
Description(self.single_line_description(),
tp.fnap(_DESCRIPTION_REST)))
def purpose(self) -> DescriptionWithSubSections:
parse = TextParser({
'action_to_check': formatting.concept_(concepts.ACTION_TO_CHECK_CONCEPT_INFO),
'actor': self.name(),
'actor_option': formatting.cli_option(common_cli_options.OPTION_FOR_ACTOR),
'actor_instruction': formatting.InstructionName(instruction_names.ACTOR_INSTRUCTION_NAME),
'act': phase_infos.ACT.name,
'default_actor': actors.DEFAULT_ACTOR_SINGLE_LINE_VALUE,
'actor_conf_param': formatting.conf_param_(conf_params.ACTOR_CONF_PARAM_INFO),
'conf_param': concepts.CONFIGURATION_PARAMETER_CONCEPT_INFO.name,
})
contents = parse.fnap(_AFTER_SINGLE_LINE_DESCRIPTION)
return DescriptionWithSubSections(self.single_line_description(),
docs.section_contents(contents))
def __init__(self, setup: Setup):
self._setup = setup
self._tp = TextParser({
'phase': setup.phase_names,
'program_name': formatting.program_name(program_info.PROGRAM_NAME),
'instruction': concepts.INSTRUCTION_CONCEPT_INFO.name.singular,
'instructions': concepts.INSTRUCTION_CONCEPT_INFO.name.plural,
'ATC': concepts.ACTION_TO_CHECK_CONCEPT_INFO.singular_name,
'act_phase': phase_infos.ACT.name,
'symbol': concepts.SYMBOL_CONCEPT_INFO.name.singular,
'symbols': concepts.SYMBOL_CONCEPT_INFO.name.plural,
'cli_option_for_preprocessor': formatting.cli_option(OPTION_FOR_PREPROCESSOR),
'an_error_in_source': misc_texts.SYNTAX_ERROR_NAME.singular_determined,
'directive': concepts.DIRECTIVE_CONCEPT_INFO.name,
'including': formatting.keyword(directives.INCLUDING_DIRECTIVE_INFO.singular_name),
})
def purpose(self) -> DescriptionWithSubSections:
parser = TextParser({
'phase':
phase_names.PHASE_NAME_DICTIONARY,
'the_concept':
formatting.conf_param_(HDS_CASE_DIRECTORY_CONF_PARAM_INFO),
'instruction':
concepts.INSTRUCTION_CONCEPT_INFO.name,
'dir_symbol':
tcds_symbols.SYMBOL_HDS_CASE,
'rel_option':
formatting.cli_option(REL_HDS_CASE_OPTION),
'symbol':
concepts.SYMBOL_CONCEPT_INFO.name,
})
return from_simple_description(
Description(self.single_line_description(),
parser.fnap(_REST_DESCRIPTION)))
def _contents(self) -> Sequence[ParagraphItem]:
tp = TextParser({
'action_to_check': formatting.concept_(concepts.ACTION_TO_CHECK_CONCEPT_INFO),
'actor': self.name(),
'actor_option': formatting.cli_option(common_cli_options.OPTION_FOR_ACTOR),
'actor_instruction': formatting.InstructionName(instruction_names.ACTOR_INSTRUCTION_NAME),
'act': phase_infos.ACT.name,
'default_actor': actors.DEFAULT_ACTOR_SINGLE_LINE_VALUE,
'null_actor': formatting.entity(actors.NULL_ACTOR.singular_name),
'actor_conf_param': formatting.conf_param_(conf_params.ACTOR_CONF_PARAM_INFO),
'conf_param': concepts.CONFIGURATION_PARAMETER_CONCEPT_INFO.name,
'space': misc_texts.WHITESPACE,
})
ret_val = list(tp.fnap(_AFTER_SLD__BEFORE_EXAMPLES))
ret_val += atc.atc_examples()
ret_val += tp.fnap(_AFTER_SLD__AFTER_EXAMPLES)
return ret_val
def __init__(self):
self._tp = TextParser({
'phase':
phase_names.PHASE_NAME_DICTIONARY,
'program_name':
formatting.program_name(program_info.PROGRAM_NAME),
'instruction':
concepts.INSTRUCTION_CONCEPT_INFO.name,
'ATC':
concepts.ACTION_TO_CHECK_CONCEPT_INFO.singular_name,
'symbol':
concepts.SYMBOL_CONCEPT_INFO.name,
'directive':
concepts.DIRECTIVE_CONCEPT_INFO.name,
'actor':
concepts.ACTOR_CONCEPT_INFO.name,
'exit_code':
misc_texts.EXIT_CODE,
'exit_identifier':
misc_texts.EXIT_IDENTIFIER,
'act_phase':
phase_infos.ACT.name,
'cli_option_for_preprocessor':
formatting.cli_option(OPTION_FOR_PREPROCESSOR),
'an_error_in_source':
misc_texts.SYNTAX_ERROR_NAME.singular_determined,
'including':
formatting.keyword(
directives.INCLUDING_DIRECTIVE_INFO.singular_name),
'stdout':
misc_texts.STDOUT,
'execution':
processing.STEP_EXECUTION,
'validation':
processing.STEP_VALIDATION,
'preprocessing':
processing.STEP_PRE_PROCESSING,
})
def _description() -> Sequence[ParagraphItem]:
parser = TextParser({
'action_to_check':
concepts.ACTION_TO_CHECK_CONCEPT_INFO.name,
'actor':
concepts.ACTOR_CONCEPT_INFO.name,
'ATC':
concepts.ACTION_TO_CHECK_CONCEPT_INFO.acronym,
'actor_option':
formatting.cli_option(common_cli_options.OPTION_FOR_ACTOR),
'actor_instruction':
formatting.InstructionName(ACTOR_INSTRUCTION_NAME),
'act':
phase_infos.ACT.name,
'phase':
PHASE_NAME_DICTIONARY,
'os_process':
misc_texts.OS_PROCESS_NAME,
})
ret_val = list(parser.fnap(_DESCRIPTION))
ret_val += atc.atc_examples()
return ret_val
def purpose(self) -> DescriptionWithSubSections:
tp = TextParser({
'cd_concept': formatting.concept(self.singular_name()),
'CD': self.acronym(),
'program_name': formatting.program_name(program_info.PROGRAM_NAME),
'sds_concept': formatting.concept_(concepts.SANDBOX_CONCEPT_INFO),
'act_sub_dir': SUB_DIRECTORY__ACT + '/',
'path_type': formatting.symbol_type_(types.PATH_TYPE_INFO),
'act_phase': phase_names.ACT.syntax,
'rel_cd_option': formatting.cli_option(file_ref.REL_CWD_OPTION),
'cd_instruction': InstructionName(instruction_names.CHANGE_DIR_INSTRUCTION_NAME),
'run_instruction': InstructionName(instruction_names.RUN_INSTRUCTION_NAME),
'shell_instruction': InstructionName(instruction_names.SHELL_INSTRUCTION_NAME),
'def_instruction': InstructionName(instruction_names.SYMBOL_DEFINITION_INSTRUCTION_NAME),
'os_process': misc_texts.OS_PROCESS_NAME,
})
return DescriptionWithSubSections(
self.single_line_description(),
SectionContents(
tp.fnap(_INITIAL_PARAGRAPHS),
[
docs.section(
tp.text(_USING_THE_CD_HEADER),
tp.fnap(_USING_THE_CD)
),
docs.section(
tp.text(_DESCRIPTION_DEF_INSTRUCTION_HEADER),
cd_instruction_section_on_def_instruction()
),
]
))
'SDS':
concepts.SDS_CONCEPT_INFO.acronym,
'sds_concept':
formatting.concept_(concepts.SDS_CONCEPT_INFO),
'program_name':
formatting.program_name(program_info.PROGRAM_NAME),
'phase':
phase_names.PHASE_NAME_DICTIONARY,
'instruction':
concepts.INSTRUCTION_CONCEPT_INFO.name,
'cwd':
formatting.concept_(concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO),
'cd_instruction':
InstructionName(CHANGE_DIR_INSTRUCTION_NAME),
'keep_sandbox_option':
formatting.cli_option(
command_line_options.OPTION_FOR_KEEPING_SANDBOX_DIRECTORY),
'symbol':
formatting.concept_(concepts.SYMBOL_CONCEPT_INFO),
'validation':
processing.STEP_VALIDATION,
'stdout':
misc_texts.STDOUT,
'stderr':
misc_texts.STDERR,
})
SANDBOX_CONCEPT = _SandboxConcept()
def _dir_path_and_rel_options(symbol_name: Text,
rel_option: Text) -> List[ParagraphItem]:
