maestral.cli.core

This module provides custom click command line parameters for Maestral such DropboxPath, ConfigKey and ConfigName, as well as an ordered command group class which prints its help output in sections.

Module Contents

class maestral.cli.core.DropboxPath(file_okay=True, dir_okay=True)

Bases: click.ParamType

A command line parameter representing a Dropbox path

This parameter type provides custom shell completion for items inside the local Dropbox folder.

Parameters:

• file_okay (bool) – Controls if a file is a possible value.

• dir_okay (bool) – Controls if a directory is a possible value.

name = 'Dropbox path'

envvar_list_splitter

convert(value, param, ctx)

Parameters:

• value (str | None) –

• param (click.Parameter | None) –

• ctx (click.Context | None) –

Return type:

str | None

shell_complete(ctx, param, incomplete)

Parameters:

• ctx (click.Context | None) –

• param (click.Parameter | None) –

• incomplete (str) –

Return type:

list[click.shell_completion.CompletionItem]

class maestral.cli.core.ConfigKey

Bases: click.ParamType

A command line parameter representing a config key

This parameter type provides custom shell completion for existing config keys.

name = 'key'

shell_complete(ctx, param, incomplete)

Parameters:

• ctx (click.Context | None) –

• param (click.Parameter | None) –

• incomplete (str) –

Return type:

list[click.shell_completion.CompletionItem]

class maestral.cli.core.ConfigName(existing=True)

Bases: click.ParamType

A command line parameter representing a Dropbox path

This parameter type provides custom shell completion for existing config names.

Parameters:

existing (bool) – If True require an existing config, otherwise create a new config on demand.

name = 'config'

convert(value, param, ctx)

Parameters:

• value (str | None) –

• param (click.Parameter | None) –

• ctx (click.Context | None) –

Return type:

str | None

shell_complete(ctx, param, incomplete)

Parameters:

• ctx (click.Context | None) –

• param (click.Parameter | None) –

• incomplete (str) –

Return type:

list[click.shell_completion.CompletionItem]

class maestral.cli.core.OrderedGroup

Bases: click.Group

Click command group with customizable sections of help output.

sections: dict[str, list[tuple[str, click.Command]]]

add_command(cmd, name=None, section='')

Parameters:

• cmd (click.Command) –

• name (str | None) –

• section (str) –

Return type:

None

format_commands(ctx, formatter)

Parameters:

• ctx (click.Context) –

• formatter (click.HelpFormatter) –

Return type:

None

class maestral.cli.core.CliException

Bases: click.ClickException

Subclass of click.CliException exception with a nicely formatted error message.

show(file=None)

Parameters:

file (Any) –

Return type:

None