harp.commandline.options.server

Inheritance diagram of harp.commandline.options.server

class CommonServerOptions[source]

Bases: dict

Common server options, in a dataclass.

__init__(*, options=<factory>, endpoints=<factory>, files=(), examples=(), applications=(), enable=(), disable=())
Parameters:
Return type:

None

as_list()[source]
applications: tuple = ()
disable: tuple = ()
enable: tuple = ()
endpoints: Iterable
examples: tuple = ()
files: tuple = ()
options: dict
class ConfigOptions[source]

Bases: object

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

__init__(*, files=(), examples=(), options=<factory>)
Parameters:
Return type:

None

examples: tuple = ()
files: tuple = ()
options: dict
config_command(name=None, cls=<class 'harp.commandline.options.server._EnhancedParserCommand'>, **attrs)[source]

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

Parameters:
Return type:

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

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

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

Parameters:
Return type:

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