aiida.cmdline

Package Contents

Classes

AbsolutePathParamType
CalculationParamType
CodeParamType
ComputerParamType
ConfigOptionParamType
DataParamType
DynamicEntryPointCommandGroup
EmailType
EntryPointType
FileOrUrl
GroupParamType
HostnameType
IdentifierParamType
LabelStringType
LazyChoice
MpirunCommandParamType
MultipleValueParamType
NodeParamType
NonEmptyStringParamType
PathOrUrl
PluginParamType
ProcessParamType
ProfileParamType
ShebangParamType
UserParamType
VerdiCommandGroup
WorkflowParamType

Functions

dbenv
echo_critical
echo_dictionary
echo_error
echo_info
echo_report
echo_success
echo_warning
format_call_graph
is_verbose
only_if_daemon_running
with_dbenv

API

class aiida.cmdline.AbsolutePathParamType

Bases: click.Path

name = 'AbsolutePath'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.CalculationParamType

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

name = 'Calculation'

property orm_class_loader

class aiida.cmdline.CodeParamType(sub_classes=None, entry_point=None)

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

Initialization

name = 'Code'

property orm_class_loader

shell_complete(ctx, param, incomplete)

convert(value, param, ctx)

class aiida.cmdline.ComputerParamType

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

name = 'Computer'

property orm_class_loader

shell_complete(ctx, param, incomplete)

class aiida.cmdline.ConfigOptionParamType

Bases: click.types.StringParamType

name = 'config option'

convert(value, param, ctx)

shell_complete(ctx, param, incomplete)

class aiida.cmdline.DataParamType(sub_classes=None)

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

Initialization

name = 'Data'

property orm_class_loader

class aiida.cmdline.DynamicEntryPointCommandGroup(command, entry_point_group: str, entry_point_name_filter='.*', **kwargs)

Bases: aiida.cmdline.groups.verdi.VerdiCommandGroup

Initialization

list_commands(ctx) → list[str]

get_command(ctx, cmd_name)

create_command(entry_point)

create_options(entry_point)

list_options(entry_point)

static create_option(name, spec)

class aiida.cmdline.EmailType

Bases: click.types.StringParamType

name = 'email'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.EntryPointType

Bases: aiida.cmdline.params.types.strings.NonEmptyStringParamType

name = 'entrypoint'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.FileOrUrl(timeout_seconds=URL_TIMEOUT_SECONDS, **kwargs)

Bases: click.File

Initialization

name = 'FileOrUrl'

convert(value, param, ctx)

get_url(url, param, ctx)

class aiida.cmdline.GroupParamType(create_if_not_exist=False, sub_classes=('aiida.groups:core',))

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

Initialization

name = 'Group'

property orm_class_loader

shell_complete(ctx, param, incomplete)

convert(value, param, ctx)

class aiida.cmdline.HostnameType

Bases: click.types.StringParamType

name = 'hostname'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.IdentifierParamType(sub_classes=None)

Bases: click.ParamType, abc.ABC

Initialization

abstract property orm_class_loader

convert(value, param, ctx)

class aiida.cmdline.LabelStringType

Bases: aiida.cmdline.params.types.strings.NonEmptyStringParamType

name = 'labelstring'

ALPHABET = '\\w\\.\\-'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.LazyChoice(get_choices)

Bases: click.ParamType

Initialization

name = 'choice'

property _click_choice

property choices

get_metavar(param)

get_missing_message(param)

convert(value, param, ctx)

__repr__()

class aiida.cmdline.MpirunCommandParamType

Bases: click.types.StringParamType

name = 'mpiruncommandstring'

__repr__()

convert(value, param, ctx)

class aiida.cmdline.MultipleValueParamType(param_type)

Bases: click.ParamType

Initialization

get_metavar(param)

convert(value, param, ctx)

class aiida.cmdline.NodeParamType

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

name = 'Node'

property orm_class_loader

class aiida.cmdline.NonEmptyStringParamType

Bases: click.types.StringParamType

name = 'nonemptystring'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.PathOrUrl(timeout_seconds=URL_TIMEOUT_SECONDS, **kwargs)

Bases: click.Path

Initialization

name = 'PathOrUrl'

convert(value, param, ctx)

checks_url(url, param, ctx)

class aiida.cmdline.PluginParamType(group=None, load=False, *args, **kwargs)

Bases: aiida.cmdline.params.types.strings.EntryPointType

Initialization

name = 'plugin'

_factory_mapping = None

_init_entry_points()

property groups

property has_potential_ambiguity

get_valid_arguments()

get_possibilities(incomplete='')

shell_complete(ctx, param, incomplete)

get_missing_message(param)

get_entry_point_from_string(entry_point_string)

validate_entry_point_group(group)

convert(value, param, ctx)

class aiida.cmdline.ProcessParamType

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

name = 'Process'

property orm_class_loader

class aiida.cmdline.ProfileParamType(*args, **kwargs)

Bases: aiida.cmdline.params.types.strings.LabelStringType

Initialization

name = 'profile'

static deconvert_default(value)

convert(value, param, ctx)

shell_complete(ctx, param, incomplete)

class aiida.cmdline.ShebangParamType

Bases: click.types.StringParamType

name = 'shebangline'

convert(value, param, ctx)

__repr__()

class aiida.cmdline.UserParamType(create=False)

Bases: click.ParamType

Initialization

name = 'user'

convert(value, param, ctx)

shell_complete(ctx, param, incomplete)

class aiida.cmdline.VerdiCommandGroup

Bases: click.Group

context_class = None

static add_verbosity_option(cmd)

fail_with_suggestions(ctx, cmd_name)

get_command(ctx, cmd_name)

group(*args, **kwargs)

class aiida.cmdline.WorkflowParamType

Bases: aiida.cmdline.params.types.identifier.IdentifierParamType

name = 'WorkflowNode'

property orm_class_loader

aiida.cmdline.dbenv()

aiida.cmdline.echo_critical(message: str, bold: bool = False, nl: bool = True, err: bool = True, prefix: bool = True) → None

aiida.cmdline.echo_dictionary(dictionary, fmt='json+date', sort_keys=True)

aiida.cmdline.echo_error(message: str, bold: bool = False, nl: bool = True, err: bool = True, prefix: bool = True) → None

aiida.cmdline.echo_info(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) → None

aiida.cmdline.echo_report(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) → None

aiida.cmdline.echo_success(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) → None

aiida.cmdline.echo_warning(message: str, bold: bool = False, nl: bool = True, err: bool = False, prefix: bool = True) → None

aiida.cmdline.format_call_graph(calc_node, max_depth: int = None, info_fn=calc_info)

aiida.cmdline.is_verbose()

aiida.cmdline.only_if_daemon_running(echo_function=echo.echo_critical, message=None)

aiida.cmdline.with_dbenv()