ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

orionis.console.entities.Command

class documentation

class Command(BaseEntity): (source)

View In Hierarchy

Represent a console command and its metadata.

Parameters
objType or class associated with the command.
methodMethod name to invoke on the object. Defaults to 'handle'.
timestampsEnable timestamps for this command. Defaults to True.
signatureCommand usage signature.
descriptionBrief description of the command.
argsDeclarative argument list while the command is being defined, and the parser built from it once the loader materializes the command. Defaults to None.
Returns
CommandInstance containing metadata and configuration for a console command.
Class Variable args Undocumented
Class Variable description Undocumented
Class Variable method Undocumented
Class Variable obj Undocumented
Class Variable signature Undocumented
Class Variable timestamps Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __post_init__ Provide a no-op initialization hook for subclass validation.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
args: list of Argument or argparse.ArgumentParser or None, optional = (source)

Undocumented

description: str = (source)

Undocumented

method: str, optional = (source)

Undocumented

obj: type = (source)

Undocumented

signature: str = (source)

Undocumented

timestamps: bool, optional = (source)

Undocumented