aiida.cmdline.params package

Commandline parameters.

Subpackages

• aiida.cmdline.params.arguments package
  • Submodules
    • OverridableArgument
      • OverridableArgument.__call__()
      • OverridableArgument.__dict__
      • OverridableArgument.__init__()
      • OverridableArgument.__module__
      • OverridableArgument.__weakref__
• aiida.cmdline.params.options package
  • Subpackages
    • aiida.cmdline.params.options.commands package
      • Submodules
  • Submodules
    • CallableDefaultOption
      • CallableDefaultOption.__module__
      • CallableDefaultOption.get_default()
    • ConditionalOption
      • ConditionalOption.__annotations__
      • ConditionalOption.__init__()
      • ConditionalOption.__module__
      • ConditionalOption.is_required()
      • ConditionalOption.process_value()
    • ConfigFileOption
      • ConfigFileOption.__call__()
      • ConfigFileOption.__init__()
      • ConfigFileOption.__module__
    • configuration_callback()
    • configuration_option()
    • yaml_config_file_provider()
    • InteractiveOption
      • InteractiveOption.CHARACTER_IGNORE_DEFAULT
      • InteractiveOption.CHARACTER_PROMPT_HELP
      • InteractiveOption.PROMPT_COLOR
      • InteractiveOption.__annotations__
      • InteractiveOption.__init__()
      • InteractiveOption.__module__
      • InteractiveOption.get_default()
      • InteractiveOption.get_help_message()
      • InteractiveOption.is_interactive()
      • InteractiveOption.process_value()
      • InteractiveOption.prompt
      • InteractiveOption.prompt_for_value()
    • TemplateInteractiveOption
      • TemplateInteractiveOption.__annotations__
      • TemplateInteractiveOption.__init__()
      • TemplateInteractiveOption.__module__
      • TemplateInteractiveOption.prompt_for_value()
    • active_process_states()
    • graph_traversal_rules()
    • set_log_level()
    • valid_calc_job_states()
    • valid_process_states()
    • MultipleValueOption
      • MultipleValueOption.__annotations__
      • MultipleValueOption.__init__()
      • MultipleValueOption.__module__
      • MultipleValueOption.add_to_parser()
    • collect_usage_pieces()
    • OverridableOption
      • OverridableOption.__annotations__
      • OverridableOption.__call__()
      • OverridableOption.__dict__
      • OverridableOption.__init__()
      • OverridableOption.__module__
      • OverridableOption.__slotnames__
      • OverridableOption.__weakref__
      • OverridableOption.clone()
• aiida.cmdline.params.types package
  • Submodules
    • CalculationParamType
      • CalculationParamType.__abstractmethods__
      • CalculationParamType.__annotations__
      • CalculationParamType.__module__
      • CalculationParamType._abc_impl
      • CalculationParamType.name
      • CalculationParamType.orm_class_loader
    • LazyChoice
      • LazyChoice.__annotations__
      • LazyChoice.__init__()
      • LazyChoice.__module__
      • LazyChoice.__repr__()
      • LazyChoice._click_choice
      • LazyChoice.choices
      • LazyChoice.convert()
      • LazyChoice.get_metavar()
      • LazyChoice.get_missing_message()
      • LazyChoice.name
    • CodeParamType
      • CodeParamType.__abstractmethods__
      • CodeParamType.__annotations__
      • CodeParamType.__init__()
      • CodeParamType.__module__
      • CodeParamType._abc_impl
      • CodeParamType.convert()
      • CodeParamType.name
      • CodeParamType.orm_class_loader
      • CodeParamType.shell_complete()
    • ComputerParamType
      • ComputerParamType.__abstractmethods__
      • ComputerParamType.__annotations__
      • ComputerParamType.__module__
      • ComputerParamType.__slotnames__
      • ComputerParamType._abc_impl
      • ComputerParamType.name
      • ComputerParamType.orm_class_loader
      • ComputerParamType.shell_complete()
    • MpirunCommandParamType
      • MpirunCommandParamType.__annotations__
      • MpirunCommandParamType.__module__
      • MpirunCommandParamType.__repr__()
      • MpirunCommandParamType.convert()
      • MpirunCommandParamType.name
    • ShebangParamType
      • ShebangParamType.__annotations__
      • ShebangParamType.__module__
      • ShebangParamType.__repr__()
      • ShebangParamType.convert()
      • ShebangParamType.name
    • ConfigOptionParamType
      • ConfigOptionParamType.__annotations__
      • ConfigOptionParamType.__module__
      • ConfigOptionParamType.convert()
      • ConfigOptionParamType.name
      • ConfigOptionParamType.shell_complete()
    • DataParamType
      • DataParamType.__abstractmethods__
      • DataParamType.__annotations__
      • DataParamType.__module__
      • DataParamType._abc_impl
      • DataParamType.name
      • DataParamType.orm_class_loader
    • GroupParamType
      • GroupParamType.__abstractmethods__
      • GroupParamType.__annotations__
      • GroupParamType.__init__()
      • GroupParamType.__module__
      • GroupParamType._abc_impl
      • GroupParamType.convert()
      • GroupParamType.name
      • GroupParamType.orm_class_loader
      • GroupParamType.shell_complete()
    • IdentifierParamType
      • IdentifierParamType.__abstractmethods__
      • IdentifierParamType.__annotations__
      • IdentifierParamType.__init__()
      • IdentifierParamType.__module__
      • IdentifierParamType._abc_impl
      • IdentifierParamType._entry_points
      • IdentifierParamType.convert()
      • IdentifierParamType.orm_class_loader
    • MultipleValueParamType
      • MultipleValueParamType.__annotations__
      • MultipleValueParamType.__init__()
      • MultipleValueParamType.__module__
      • MultipleValueParamType.convert()
      • MultipleValueParamType.get_metavar()
    • NodeParamType
      • NodeParamType.__abstractmethods__
      • NodeParamType.__annotations__
      • NodeParamType.__module__
      • NodeParamType._abc_impl
      • NodeParamType.name
      • NodeParamType.orm_class_loader
    • AbsolutePathOrEmptyParamType
      • AbsolutePathOrEmptyParamType.__annotations__
      • AbsolutePathOrEmptyParamType.__module__
      • AbsolutePathOrEmptyParamType.__repr__()
      • AbsolutePathOrEmptyParamType.convert()
      • AbsolutePathOrEmptyParamType.name
    • AbsolutePathParamType
      • AbsolutePathParamType.__annotations__
      • AbsolutePathParamType.__module__
      • AbsolutePathParamType.__repr__()
      • AbsolutePathParamType.convert()
      • AbsolutePathParamType.name
    • FileOrUrl
      • FileOrUrl.__annotations__
      • FileOrUrl.__init__()
      • FileOrUrl.__module__
      • FileOrUrl.convert()
      • FileOrUrl.get_url()
      • FileOrUrl.name
    • PathOrUrl
      • PathOrUrl.__annotations__
      • PathOrUrl.__init__()
      • PathOrUrl.__module__
      • PathOrUrl.checks_url()
      • PathOrUrl.convert()
      • PathOrUrl.name
    • check_timeout_seconds()
    • PluginParamType
      • PluginParamType.__annotations__
      • PluginParamType.__init__()
      • PluginParamType.__module__
      • PluginParamType.__slotnames__
      • PluginParamType._entry_point_names
      • PluginParamType._entry_points
      • PluginParamType._factory_mapping
      • PluginParamType.convert()
      • PluginParamType.get_entry_point_from_string()
      • PluginParamType.get_missing_message()
      • PluginParamType.get_possibilities()
      • PluginParamType.get_valid_arguments()
      • PluginParamType.groups
      • PluginParamType.has_potential_ambiguity
      • PluginParamType.name
      • PluginParamType.shell_complete()
      • PluginParamType.validate_entry_point_group()
    • ProcessParamType
      • ProcessParamType.__abstractmethods__
      • ProcessParamType.__annotations__
      • ProcessParamType.__module__
      • ProcessParamType._abc_impl
      • ProcessParamType.name
      • ProcessParamType.orm_class_loader
    • ProfileParamType
      • ProfileParamType.__annotations__
      • ProfileParamType.__init__()
      • ProfileParamType.__module__
      • ProfileParamType.convert()
      • ProfileParamType.deconvert_default()
      • ProfileParamType.name
      • ProfileParamType.shell_complete()
    • EmailType
      • EmailType.__annotations__
      • EmailType.__module__
      • EmailType.__repr__()
      • EmailType.__slotnames__
      • EmailType.convert()
      • EmailType.name
    • EntryPointType
      • EntryPointType.__annotations__
      • EntryPointType.__module__
      • EntryPointType.__repr__()
      • EntryPointType.convert()
      • EntryPointType.name
    • HostnameType
      • HostnameType.__annotations__
      • HostnameType.__module__
      • HostnameType.__repr__()
      • HostnameType.__slotnames__
      • HostnameType.convert()
      • HostnameType.name
    • LabelStringType
      • LabelStringType.ALPHABET
      • LabelStringType.__annotations__
      • LabelStringType.__module__
      • LabelStringType.__repr__()
      • LabelStringType.convert()
      • LabelStringType.name
    • NonEmptyStringParamType
      • NonEmptyStringParamType.__annotations__
      • NonEmptyStringParamType.__module__
      • NonEmptyStringParamType.__repr__()
      • NonEmptyStringParamType.__slotnames__
      • NonEmptyStringParamType.convert()
      • NonEmptyStringParamType.name
    • UserParamType
      • UserParamType.__annotations__
      • UserParamType.__init__()
      • UserParamType.__module__
      • UserParamType.convert()
      • UserParamType.name
      • UserParamType.shell_complete()
    • WorkflowParamType
      • WorkflowParamType.__abstractmethods__
      • WorkflowParamType.__annotations__
      • WorkflowParamType.__module__
      • WorkflowParamType._abc_impl
      • WorkflowParamType.name
      • WorkflowParamType.orm_class_loader