harp.commandline.options.server

class CommonServerOptions

Bases: dict

Common server options, in a dataclass.

__init__(*, options=<factory>, endpoints=<factory>, files=(), examples=(), applications=(), enable=(), disable=(), strict=False)

Parameters:

• options (dict)

• endpoints (Iterable)

• files (tuple)

• examples (tuple)

• applications (tuple)

• enable (tuple)

• disable (tuple)

• strict (bool)

Return type:

None

as_list()

applications: tuple = ()

disable: tuple = ()

enable: tuple = ()

endpoints: Iterable

examples: tuple = ()

files: tuple = ()

options: dict

strict: bool = False

class ConfigOptions

Bases: object

ConfigOptions(*, files: tuple = (), examples: tuple = (), options: dict = <factory>)

__init__(*, files=(), examples=(), options=<factory>)

Parameters:

• files (tuple)

• examples (tuple)

• options (dict)

Return type:

None

examples: tuple = ()

files: tuple = ()

options: dict

config_command(name=None, cls=<class 'harp.commandline.options.server._EnhancedParserCommand'>, **attrs)

Creates a click command with configuration options (–set, –example, –file).

Parameters:

• name (str | None | Callable[[...], Any])

• cls (Type[CmdType])

• attrs (Any)

Return type:

Command | Callable[[Callable[[…], Any]], Command | CmdType]

server_command(name=None, cls=<class 'harp.commandline.options.server._EnhancedParserCommand'>, **attrs)

Creates a click command with server options (–enable, –disable, –applications, –endpoint and all configuration options).

Parameters:

• name (str | None | Callable[[...], Any])

• cls (Type[CmdType])

• attrs (Any)

Return type:

Command | Callable[[Callable[[…], Any]], Command | CmdType]