def see_also_targets(self) -> List[CrossReferenceId]:
name_and_cross_refs = [syntax_elements.PATH_SYNTAX_ELEMENT]
name_and_cross_refs += rel_opts.see_also_name_and_cross_refs(
self._dst_rel_opt_conf.options)
name_and_cross_refs += rel_opts.see_also_name_and_cross_refs(
self._src_rel_opt_conf.options)
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_refs = [concepts.SYMBOL_CONCEPT_INFO,
concepts.TYPE_CONCEPT_INFO,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
syntax_elements.HERE_DOCUMENT_SYNTAX_ELEMENT,
]
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def _see_also_targets() -> List[see_also.SeeAlsoTarget]:
return cross_reference_id_list([
concepts.PREPROCESSOR_CONCEPT_INFO,
concepts.DIRECTIVE_CONCEPT_INFO,
concepts.INSTRUCTION_CONCEPT_INFO,
concepts.ACTOR_CONCEPT_INFO,
concepts.SYMBOL_CONCEPT_INFO,
])
def see_also_targets(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
phase_infos.ACT,
concepts.ACTION_TO_CHECK_CONCEPT_INFO,
actors.COMMAND_LINE_ACTOR,
syntax_elements.STRING_SOURCE_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
])
def see_also_targets(self) -> list:
name_and_cross_refs = [syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.HERE_DOCUMENT_SYNTAX_ELEMENT,
syntax_elements.STRING_TRANSFORMER_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
]
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_refs = [
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.FILES_MATCHER_SYNTAX_ELEMENT,
]
name_and_cross_refs += rel_path_doc.see_also_name_and_cross_refs(
ACTUAL_RELATIVITY_CONFIGURATION.options)
return cross_reference_id_list(name_and_cross_refs)
def see_also_targets(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
concepts.TEST_CASE_DIRECTORY_STRUCTURE_CONCEPT_INFO,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
concepts.SYMBOL_CONCEPT_INFO,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
types.PATH_TYPE_INFO,
]) + [DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE]
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_refs = [
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
syntax_elements.RICH_STRING_SYNTAX_ELEMENT,
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.STRING_TRANSFORMER_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
]
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_refs = ([
concepts.SYMBOL_CONCEPT_INFO,
concepts.TYPE_CONCEPT_INFO,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
syntax_elements.RICH_STRING_SYNTAX_ELEMENT,
] + list(syntax_elements.ALL_ELEMENTS_CORRESPONDING_TO_TYPES))
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def see_also_targets(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
concepts.TCDS_CONCEPT_INFO,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
concepts.SYMBOL_CONCEPT_INFO,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
types.PATH_TYPE_INFO,
]) + [DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE]
def see_also_targets(self) -> List[SeeAlsoTarget]:
ret_val = name_and_cross_ref.cross_reference_id_list([
concepts.SANDBOX_CONCEPT_INFO,
types.PATH_TYPE_INFO,
])
ret_val += [
phase_infos.ACT.cross_reference_target,
DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE,
]
return ret_val
def see_also_targets(self) -> List[SeeAlsoTarget]:
ret_val = name_and_cross_ref.cross_reference_id_list([
concepts.TEST_CASE_DIRECTORY_STRUCTURE_CONCEPT_INFO,
conf_params.HOME_CASE_DIRECTORY_CONF_PARAM_INFO,
conf_params.HOME_ACT_DIRECTORY_CONF_PARAM_INFO,
])
ret_val += [
phase_infos.SETUP.instruction_cross_reference_target(instruction_names.ENV_VAR_INSTRUCTION_NAME)
]
return ret_val
def see_also_targets(self) -> List[SeeAlsoTarget]:
ret_val = name_and_cross_ref.cross_reference_id_list([
concepts.SDS_CONCEPT_INFO,
types.PATH_TYPE_INFO,
])
ret_val += [
phase_infos.ACT.cross_reference_target,
DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE,
]
return ret_val
def see_also_targets(self) -> List[SeeAlsoTarget]:
info_refs = cross_reference_id_list([
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
concepts.SYMBOL_CONCEPT_INFO,
types.LIST_TYPE_INFO,
])
plain_refs = [
define_symbol.DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE,
]
return info_refs + plain_refs
def see_also_targets(self) -> list:
info_refs = cross_reference_id_list([
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
concepts.SYMBOL_CONCEPT_INFO,
types.LIST_TYPE_INFO,
])
plain_refs = [
define_symbol.DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE,
]
return info_refs + plain_refs
def see_also_targets(self) -> List[CrossReferenceId]:
info_refs = cross_reference_id_list([
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_ARGUMENT_SYNTAX_ELEMENT,
syntax_elements.STRING_TRANSFORMER_SYNTAX_ELEMENT,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.LIST_SYNTAX_ELEMENT,
syntax_elements.SHELL_COMMAND_LINE_SYNTAX_ELEMENT,
syntax_elements.STRING_SOURCE_SYNTAX_ELEMENT,
concepts.SYMBOL_CONCEPT_INFO,
types.PROGRAM_TYPE_INFO,
])
plain_refs = [
define_symbol.DEFINE_SYMBOL_INSTRUCTION_CROSS_REFERENCE,
]
return info_refs + plain_refs
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_ref_elements = [
syntax_elements.STRING_TRANSFORMER_SYNTAX_ELEMENT,
syntax_elements.INTEGER_COMPARISON_SYNTAX_ELEMENT,
syntax_elements.LINE_MATCHER_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
syntax_elements.REGEX_SYNTAX_ELEMENT,
]
name_and_cross_ref_elements += rel_opts.see_also_name_and_cross_refs(
EXPECTED_FILE_REL_OPT_ARG_CONFIG.options)
return (
cross_reference_id_list(name_and_cross_ref_elements)
+
self.string_or_here_doc_or_file_arg.see_also_targets()
)
def documentation() -> SyntaxElementDocumentation:
executable_arg = syntax_elements.PATH_SYNTAX_ELEMENT.single_mandatory
optional_arguments_arg = syntax_elements.PROGRAM_ARGUMENT_SYNTAX_ELEMENT.zero_or_more
invokation_variants = [
invokation_variant_from_args([executable_arg, optional_arguments_arg],
_executable_file_description()),
programs.system_program([optional_arguments_arg]),
programs.python_interpreter([optional_arguments_arg]),
]
return syntax_element_documentation(
None,
syntax_elements.ACT_INTERPRETER_SYNTAX_ELEMENT,
_TEXT_PARSER.fnap(_MAIN__DESCRIPTION),
(),
invokation_variants,
[],
name_and_cross_ref.cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_ARGUMENT_SYNTAX_ELEMENT,
]),
)
def documentation() -> SyntaxElementDocumentation:
invokation_variants = [
_string(),
_symbol_reference(),
_existing_path(
pgm_syntax_elements.EXISTING_FILE_OPTION_NAME,
_EXISTING_FILE_DESCRIPTION,
),
_existing_path(
pgm_syntax_elements.EXISTING_DIR_OPTION_NAME,
_EXISTING_DIR_DESCRIPTION,
),
_existing_path(
pgm_syntax_elements.EXISTING_PATH_OPTION_NAME,
_EXISTING_PATH_DESCRIPTION,
),
]
return syntax_element_documentation(
None,
syntax_elements.PROGRAM_ARGUMENT_SYNTAX_ELEMENT,
_TEXT_PARSER.fnap(_MAIN__DESCRIPTION),
(),
invokation_variants,
[
rel_path_doc.path_element_2(
PATH_OF_EXISTING_FILE_OPT_CONFIG,
_TEXT_PARSER.paras(path_syntax.the_path_of_an_existing_file(final_dot=True)))
],
cross_reference_id_list([
syntax_elements.RICH_STRING_SYNTAX_ELEMENT,
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.LIST_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
]),
)
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_refs = [syntax_elements.PATH_SYNTAX_ELEMENT]
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
def _see_also_specific(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
conf_params.HOME_ACT_DIRECTORY_CONF_PARAM_INFO,
concepts.SHELL_SYNTAX_CONCEPT_INFO,
])
from exactly_lib.common.help.syntax_contents_structure import InvokationVariant
from exactly_lib.definitions.cross_ref.name_and_cross_ref import cross_reference_id_list
from exactly_lib.definitions.entity import syntax_elements, concepts
from exactly_lib.help.entities.syntax_elements.contents_structure import syntax_element_documentation
from exactly_lib.symbol.symbol_syntax import symbol_reference_syntax_for_name
_MAIN_DESCRIPTION_REST = symbol_reference_syntax_for_name(
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT.argument.name)
DOCUMENTATION = syntax_element_documentation(
None, syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT, [], (), [
InvokationVariant(
symbol_reference_syntax_for_name(
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT.argument.name))
], [],
cross_reference_id_list([
concepts.SYMBOL_CONCEPT_INFO,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
]))
def see_also_targets(self) -> Sequence[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.FILE_MATCHER_SYNTAX_ELEMENT,
syntax_elements.STRING_SYNTAX_ELEMENT,
])
from exactly_lib.definitions.cross_ref.name_and_cross_ref import cross_reference_id_list
from exactly_lib.definitions.entity import syntax_elements
from exactly_lib.help.entities.syntax_elements.contents_structure import syntax_element_documentation
from exactly_lib.util.textformat.textformat_parser import TextParser
_EXPRESSION_DESCRIPTION = """\
An expression using Python syntax.
The expression must evaluate to an integer (a Python "int").
"""
_TEXT_PARSER = TextParser({
'STRING':
syntax_elements.STRING_SYNTAX_ELEMENT.singular_name,
})
DOCUMENTATION = syntax_element_documentation(
None, syntax_elements.INTEGER_SYNTAX_ELEMENT, (), (), [
invokation_variant_from_args([
syntax_elements.STRING_SYNTAX_ELEMENT.single_mandatory,
])
], [
SyntaxElementDescription(
syntax_elements.STRING_SYNTAX_ELEMENT.singular_name,
_TEXT_PARSER.fnap(_EXPRESSION_DESCRIPTION),
),
], cross_reference_id_list([
syntax_elements.STRING_SYNTAX_ELEMENT,
]))
def see_also_targets(self) -> Sequence[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.GLOB_PATTERN_SYNTAX_ELEMENT,
syntax_elements.REGEX_SYNTAX_ELEMENT,
])
def see_also_targets(self) -> list:
return cross_reference_id_list([
self.conf_param,
concepts.HDS_CONCEPT_INFO,
])
def _here_doc() -> InvokationVariant:
return invokation_variant_from_args([
a.Single(
a.Multiplicity.MANDATORY,
a.Constant(string.HERE_DOCUMENT_MARKER_PREFIX +
_HERE_DOC_SYNTAX_MARKER)),
a.Single(a.Multiplicity.ZERO_OR_MORE, a.Named(_HERE_DOC_LINE)),
a.Single(a.Multiplicity.MANDATORY,
a.Constant(_HERE_DOC_SYNTAX_MARKER)),
], _TEXT_PARSER.fnap(_DESCRIPTION__HERE_DOC))
DOCUMENTATION = syntax_element_documentation(
None,
syntax_elements.RICH_STRING_SYNTAX_ELEMENT,
(),
(),
[
_normal_string(),
string_common.text_until_end_of_line(),
_here_doc(),
],
[],
cross_reference_id_list([
types.STRING_TYPE_INFO,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
]),
)
def see_also_targets(self) -> list:
return cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.HERE_DOCUMENT_SYNTAX_ELEMENT,
syntax_elements.STRING_SYNTAX_ELEMENT,
])
for type_info in sorted(file_properties.TYPE_INFO.values(),
key=lambda ti: ti.type_argument)
])
NAME_SYNTAX_DESCRIPTION = grammar.SimpleExpressionDescription(
argument_usage_list=[
a.Choice(a.Multiplicity.MANDATORY,
[
instruction_arguments.GLOB_PATTERN,
REG_EX_ARGUMENT,
])
],
description_rest=_TP.fnap(_NAME_MATCHER_SED_DESCRIPTION),
see_also_targets=cross_reference_id_list([
syntax_elements.GLOB_PATTERN_SYNTAX_ELEMENT,
syntax_elements.REGEX_SYNTAX_ELEMENT,
]),
)
TYPE_SYNTAX_DESCRIPTION = grammar.SimpleExpressionDescription(
argument_usage_list=[
a.Single(a.Multiplicity.MANDATORY,
TYPE_MATCHER_ARGUMENT)],
description_rest=_type_matcher_sed_description()
)
REGULAR_FILE_CONTENTS_SYNTAX_DESCRIPTION = grammar.SimpleExpressionDescription(
argument_usage_list=[
a.Single(a.Multiplicity.MANDATORY,
syntax_elements.STRING_MATCHER_SYNTAX_ELEMENT.argument)],
description_rest=_TP.fnap(_REGULAR_FILE_CONTENTS_MATCHER_SED_DESCRIPTION),
def see_also_targets(self) -> list:
name_and_cross_ref_list = [
types.PROGRAM_TYPE_INFO,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
]
return cross_reference_id_list(name_and_cross_ref_list)
def see_also_targets(self) -> Sequence[SeeAlsoTarget]:
return cross_reference_id_list([
self._documentation.names.contents_matcher_syntax_element,
])
def see_also_targets(self) -> List[SeeAlsoTarget]:
name_and_cross_ref_list = [
types.PROGRAM_TYPE_INFO,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
]
return cross_reference_id_list(name_and_cross_ref_list)
def see_also_targets(self) -> List[SeeAlsoTarget]:
return name_and_cross_ref.cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.FILES_SOURCE_SYNTAX_ELEMENT,
])
def see_also_targets__file() -> List[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.STRING_MATCHER_SYNTAX_ELEMENT,
])
def see_also_targets(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
])
def see_also_targets(self) -> List[SeeAlsoTarget]:
return name_and_cross_ref.cross_reference_id_list([
concepts.ENVIRONMENT_VARIABLE_CONCEPT_INFO,
syntax_elements.STRING_SYNTAX_ELEMENT,
syntax_elements.STRING_SOURCE_SYNTAX_ELEMENT,
])
def _see_also_specific(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
conf_params.HDS_ACT_DIRECTORY_CONF_PARAM_INFO,
syntax_elements.PATH_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
])
def see_also_targets(self) -> Sequence[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
])
def see_also_targets__std_out_err() -> List[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.STRING_MATCHER_SYNTAX_ELEMENT,
syntax_elements.PROGRAM_SYNTAX_ELEMENT,
concepts.ACTION_TO_CHECK_CONCEPT_INFO,
])
from exactly_lib.common.help.syntax_contents_structure import InvokationVariant
from exactly_lib.definitions.cross_ref.name_and_cross_ref import cross_reference_id_list
from exactly_lib.definitions.entity import syntax_elements, concepts
from exactly_lib.help.entities.syntax_elements.contents_structure import syntax_element_documentation
from exactly_lib.symbol.symbol_syntax import symbol_reference_syntax_for_name
_MAIN_DESCRIPTION_REST = symbol_reference_syntax_for_name(syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT.argument.name)
DOCUMENTATION = syntax_element_documentation(
None,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
[],
[
InvokationVariant(
symbol_reference_syntax_for_name(syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT.argument.name)
)
],
[],
cross_reference_id_list([
concepts.SYMBOL_CONCEPT_INFO,
syntax_elements.SYMBOL_NAME_SYNTAX_ELEMENT,
]))
<<EOF
first line
...
last line
EOF
```
Any single-word string may be used instead of "EOF" as marker.
What matters is that the maker at start and end of input
matches.
Any {SYMBOL_REFERENCE_SYNTAX_ELEMENT} appearing in the text is substituted.
"""
_TEXT_PARSER = TextParser({
'SYMBOL_REFERENCE_SYNTAX_ELEMENT': syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT.singular_name
})
DOCUMENTATION = syntax_element_documentation(None,
syntax_elements.HERE_DOCUMENT_SYNTAX_ELEMENT,
_TEXT_PARSER.fnap(_MAIN_DESCRIPTION_REST),
[],
[],
cross_reference_id_list([
STRING_TYPE_INFO,
syntax_elements.SYMBOL_REFERENCE_SYNTAX_ELEMENT,
]))
def see_also_targets(self) -> List[SeeAlsoTarget]:
return cross_reference_id_list([
syntax_elements.PATH_SYNTAX_ELEMENT,
concepts.CURRENT_WORKING_DIRECTORY_CONCEPT_INFO,
])
def see_also_targets(self) -> List[CrossReferenceId]:
name_and_cross_refs = [syntax_elements.PATH_SYNTAX_ELEMENT]
name_and_cross_refs += rel_opts.see_also_name_and_cross_refs(self._dst_rel_opt_conf.options)
name_and_cross_refs += rel_opts.see_also_name_and_cross_refs(self._src_rel_opt_conf.options)
return name_and_cross_ref.cross_reference_id_list(name_and_cross_refs)
