Public Member Functions
None	__init__ (self, str name, str description, Type[Union[int, float, str, bool]] data_type, bool positional=False, list[str] aliases=[], bool required=True, int number_of_args=1)

Public Attributes
	name = name

	description = description

	positional = positional

	required = required

	number_of_args = number_of_args

Static Public Attributes
Type	data_type [Union[int, float, str, bool]]

list	aliases [str]

Detailed Description

A class that represents a parameter for a command.

Args:
    name (str): The name of the parameter.
    description (str): The description of the parameter.
    data_type (object): The type of the parameter.
    aliases (list[str]): The aliases of the parameter.
    required (bool): Whether the parameter is required.
    number_of_args (int): The number of arguments the parameter can take. (INFINITE_ARGS for infinite)

Definition at line 18 of file command.py.

Constructor & Destructor Documentation

◆ init()

None talkomatic.commands.command.CommandParameter.__init__	(		self,
		str	name,
		str	description,
		Type[Union[int, float, str, bool]]	data_type,
		bool	positional = False,
		list[str]	aliases = [],
		bool	required = True,
		int	number_of_args = 1 )

Definition at line 39 of file command.py.

Member Data Documentation

◆ aliases

list talkomatic.commands.command.CommandParameter.aliases [str]

static

Definition at line 34 of file command.py.

◆ data_type

Type talkomatic.commands.command.CommandParameter.data_type [Union[int, float, str, bool]]

static

Definition at line 33 of file command.py.

◆ description

talkomatic.commands.command.CommandParameter.description = description

Definition at line 44 of file command.py.

◆ name

talkomatic.commands.command.CommandParameter.name = name

Definition at line 43 of file command.py.

◆ number_of_args

talkomatic.commands.command.CommandParameter.number_of_args = number_of_args

Definition at line 49 of file command.py.

◆ positional

talkomatic.commands.command.CommandParameter.positional = positional

Definition at line 46 of file command.py.

◆ required

talkomatic.commands.command.CommandParameter.required = required

Definition at line 48 of file command.py.

The documentation for this class was generated from the following file:

C:/Users/jean-/talkomatic.py/talkomatic/commands/command.py

Public Member Functions

Public Attributes

Static Public Attributes