evmos.proto.autogen.py.cosmos.autocli.v1

Classes

`AppOptionsRequest`()	AppOptionsRequest is the RemoteInfoService/AppOptions request type.
`AppOptionsResponse`(module_options, ...)	AppOptionsResponse is the RemoteInfoService/AppOptions response type.
`FlagOptions`(name, shorthand, usage, ...)	FlagOptions are options for flags generated from rpc request fields.
`ModuleOptions`(tx, query)	ModuleOptions describes the CLI options for a Cosmos SDK module.
`PositionalArgDescriptor`(proto_field, varargs)	PositionalArgDescriptor describes a positional argument.
`QueryBase`()
`QueryStub`(channel, *[, timeout, deadline, ...])
`RpcCommandOptions`(rpc_method, use, long, ...)	RpcCommandOptions specifies options for commands generated from protobuf rpc methods.
`ServiceCommandDescriptor`(service, ...)	ServiceCommandDescriptor describes a CLI command based on a protobuf service.

class evmos.proto.autogen.py.cosmos.autocli.v1.AppOptionsRequest[source]

Bases: Message

AppOptionsRequest is the RemoteInfoService/AppOptions request type.

class evmos.proto.autogen.py.cosmos.autocli.v1.AppOptionsResponse(module_options: ~typing.Dict[str, ~evmos.proto.autogen.py.cosmos.autocli.v1.ModuleOptions] = <object object>)[source]

Bases: Message

AppOptionsResponse is the RemoteInfoService/AppOptions response type.

module_options: Dict[str, ModuleOptions] = <object object>: module_options is a map of module name to autocli module options.

class evmos.proto.autogen.py.cosmos.autocli.v1.FlagOptions(name: str = <object object>, shorthand: str = <object object>, usage: str = <object object>, default_value: str = <object object>, deprecated: str = <object object>, shorthand_deprecated: str = <object object>, hidden: bool = <object object>)[source]

Bases: Message

FlagOptions are options for flags generated from rpc request fields. By default, all request fields are configured as flags based on the kebab-case name of the field. Fields can be turned into positional arguments instead by using RpcCommandOptions.positional_args.

default_value: str = <object object>: default_value is the default value as text.

deprecated: str = <object object>: deprecated is the usage text to show if this flag is deprecated.

hidden: bool = <object object>: hidden hides the flag from help/usage text

name: str = <object object>: name is an alternate name to use for the field flag.

shorthand: str = <object object>: shorthand is a one-letter abbreviated flag.

shorthand_deprecated: str = <object object>: shorthand_deprecated is the usage text to show if the shorthand of this flag is deprecated.

usage: str = <object object>: usage is the help message.

class evmos.proto.autogen.py.cosmos.autocli.v1.ModuleOptions(tx: ~evmos.proto.autogen.py.cosmos.autocli.v1.ServiceCommandDescriptor = <object object>, query: ~evmos.proto.autogen.py.cosmos.autocli.v1.ServiceCommandDescriptor = <object object>)[source]

Bases: Message

ModuleOptions describes the CLI options for a Cosmos SDK module.

query: ServiceCommandDescriptor = <object object>: query describes the queries commands for the module.

tx: ServiceCommandDescriptor = <object object>: tx describes the tx commands for the module.

class evmos.proto.autogen.py.cosmos.autocli.v1.PositionalArgDescriptor(proto_field: str = <object object>, varargs: bool = <object object>)[source]

Bases: Message

PositionalArgDescriptor describes a positional argument.

proto_field: str = <object object>: proto_field specifies the proto field to use as the positional arg. Any fields used as positional args will not have a flag generated.

varargs: bool = <object object>: varargs makes a positional parameter a varargs parameter. This can only be applied to last positional parameter and the proto_field must a repeated field.

class evmos.proto.autogen.py.cosmos.autocli.v1.QueryBase[source]

Bases: ServiceBase

async app_options(app_options_request: AppOptionsRequest) → AppOptionsResponse[source]

Bases: ServiceStub

async app_options(app_options_request: AppOptionsRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AppOptionsResponse[source]

class evmos.proto.autogen.py.cosmos.autocli.v1.RpcCommandOptions(rpc_method: str = <object object>, use: str = <object object>, long: str = <object object>, short: str = <object object>, example: str = <object object>, alias: ~typing.List[str] = <object object>, suggest_for: ~typing.List[str] = <object object>, deprecated: str = <object object>, version: str = <object object>, flag_options: ~typing.Dict[str, ~evmos.proto.autogen.py.cosmos.autocli.v1.FlagOptions] = <object object>, positional_args: ~typing.List[~evmos.proto.autogen.py.cosmos.autocli.v1.PositionalArgDescriptor] = <object object>, skip: bool = <object object>)[source]

Bases: Message

RpcCommandOptions specifies options for commands generated from protobuf rpc methods.

alias: List[str] = <object object>: alias is an array of aliases that can be used instead of the first word in Use.

deprecated: str = <object object>: deprecated defines, if this command is deprecated and should print this string when used.

example: str = <object object>: example is examples of how to use the command.

flag_options: Dict[str, FlagOptions] = <object object>: flag_options are options for flags generated from rpc request fields. By default all request fields are configured as flags. They can also be configured as positional args instead using positional_args.

long: str = <object object>: long is the long message shown in the ‘help <this-command>’ output.

positional_args: List[PositionalArgDescriptor] = <object object>: positional_args specifies positional arguments for the command.

rpc_method: str = <object object>: rpc_method is short name of the protobuf rpc method that this command is generated from.

short: str = <object object>: short is the short description shown in the ‘help’ output.

skip: bool = <object object>: skip specifies whether to skip this rpc method when generating commands.

suggest_for: List[str] = <object object>: suggest_for is an array of command names for which this command will be suggested - similar to aliases but only suggests.

use: str = <object object>: use is the one-line usage method. It also allows specifying an alternate name for the command as the first word of the usage text. By default the name of an rpc command is the kebab-case short name of the rpc method.

version: str = <object object>: version defines the version for this command. If this value is non-empty and the command does not define a “version” flag, a “version” boolean flag will be added to the command and, if specified, will print content of the “Version” variable. A shorthand “v” flag will also be added if the command does not define one.

class evmos.proto.autogen.py.cosmos.autocli.v1.ServiceCommandDescriptor(service: str = <object object>, rpc_command_options: ~typing.List[~evmos.proto.autogen.py.cosmos.autocli.v1.RpcCommandOptions] = <object object>, sub_commands: ~typing.Dict[str, ~evmos.proto.autogen.py.cosmos.autocli.v1.ServiceCommandDescriptor] = <object object>)[source]

Bases: Message

ServiceCommandDescriptor describes a CLI command based on a protobuf service.

rpc_command_options: List[RpcCommandOptions] = <object object>: rpc_command_options are options for commands generated from rpc methods. If no options are specified for a given rpc method on the service, a command will be generated for that method with the default options.

service: str = <object object>: service is the fully qualified name of the protobuf service to build the command from. It can be left empty if sub_commands are used instead which may be the case if a module provides multiple tx and/or query services.

sub_commands: Dict[str, ServiceCommandDescriptor] = <object object>: sub_commands is a map of optional sub-commands for this command based on different protobuf services. The map key is used as the name of the sub-command.