mini_arcade.modules.system_lab.commands ======================================= .. py:module:: mini_arcade.modules.system_lab.commands .. autoapi-nested-parse:: CLI command for listing or running isolated system lab cases. Classes ------- .. autoapisummary:: mini_arcade.modules.system_lab.commands.SystemLabCommand Module Contents --------------- .. py:class:: SystemLabCommand Bases: :py:obj:`mini_arcade.cli.base_command.BaseCommand` Base class for all commands. Registration is done via the implementation decorator: @CommandRegistry.implementation("build") class Build(BaseCommand): ... or: from .command_registry import CommandRegistry @CommandRegistry.implementation("build") class Build(BaseCommand): ... Subclasses should implement the execute(...) method as the main entrypoint. :ivar name: Optional[str]: Command name (for registry); defaults to class name lowercased. :ivar aliases: Tuple[str, ...]: Optional command aliases. :ivar summary: Optional[str]: Short description of the command. :ivar epilog: Optional[str]: Additional help text for the command. :ivar args: Optional[List[ArgumentType]]: List of command arguments. :ivar abstract: bool: If True, the command is not registered (base class for shared logic); defaults to False. :ivar processor: Optional[BaseCommandProcessor]: The processor associated with this command. .. py:attribute:: name :value: 'system-lab' .. py:attribute:: aliases :value: ('run-system',) .. py:attribute:: args .. py:attribute:: __doc__ :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ List or run isolated system lab cases. Usage: mini-arcade system-lab --module my_game.debug.system_lab --list mini-arcade system-lab --module my_game.debug.system_lab --case ship_move --steps 3 mini-arcade system-lab --module my_game.debug.system_lab --visual --backend native """ .. raw:: html
.. py:method:: validate(**kwargs) Optional argument validation hook.