ArgSpace

ArgSpace is a container for storing and managing processed command-line arguments. Its main purpose is to provide a convenient interface for accessing values passed at application startup.

ArgSpace is created automatically after processing arguments using ArgParser and contains a collection of InputArgument objects.

---

Initialization

Creation of ArgSpace class instances happens under the hood, you don’t need to create them manually.

Attributes:

all_arguments

List of all processed arguments of type InputArgument.

---

Methods

get_by_name

get_by_name(self, name: str) -> InputArgument | None

Returns an argument by name.

param name:

Name of the argument to search for.

return:

InputArgument object or None if the argument is not found.

Usage example:

config_arg = argspace.get_by_name("config")
if config_arg:
    print(f"Config path: {config_arg.value}")

verbose_arg = argspace.get_by_name("verbose")
if verbose_arg and verbose_arg.value:
    print("Verbose mode enabled")

unknown_arg = argspace.get_by_name("nonexistent")
if unknown_arg is None:
    print("Argument not found")

---

get_by_type

get_by_type(self, arg_type: type[BaseArgument]) -> list[InputArgument] | list[Never]

Returns all arguments of a specific type.

param arg_type:

Argument type (BooleanArgument or ValueArgument).

return:

List of arguments of the specified type or an empty list.

The method filters all_arguments by the founder_class attribute and returns arguments created from the specified type.

Usage example:

from argenta import Response, Router
from argenta.di import FromDishka
from argenta.orchestrator.argparser import ArgSpace, BooleanArgument, ValueArgument

router = Router()


@router.command("get_args")
def get_args(response: Response, argspace: FromDishka[ArgSpace]):
    # Get all boolean flags
    boolean_flags = argspace.get_by_type(BooleanArgument)
    print(f"Active flags: {[arg.name for arg in boolean_flags if arg.value]}")

    # Get all value arguments
    value_args = argspace.get_by_type(ValueArgument)
    for arg in value_args:
        print(f"{arg.name} = {arg.value}")

    # Count arguments of each type
    print(f"Boolean arguments: {len(argspace.get_by_type(BooleanArgument))}")
    print(f"Value arguments: {len(argspace.get_by_type(ValueArgument))}")

---

InputArgument

See also

Documentation for InputArgument is located here.

---

Usage Examples

ArgSpace is used to access argument values after the application starts. A typical scenario includes processing arguments through ArgParser and subsequent extraction of values from ArgSpace.

Complete example:

from argenta import App, Orchestrator
from argenta.orchestrator.argparser import ArgParser, ValueArgument

arguments = [
    ValueArgument("host", help="Server host", is_required=True),
    ValueArgument("port", help="Server port", is_required=True),
]

argparser = ArgParser(
    processed_args=arguments, 
    name="WebServer", 
    description="Simple web server"
)

app = App()
orchestrator = Orchestrator(argparser)


def main():
    argspace = argparser.parsed_argspace

    host = argspace.get_by_name("host")
    port = argspace.get_by_name("port")

    print("Server configuration:")
    print(f"  Host: {host.value}")
    print(f"  Port: {port.value}")

    orchestrator.start_polling(app)


if __name__ == "__main__":
    main()

Access to arguments from handlers is done using DI. For more details, see here.

Usage example:

from argenta import Response, Router
from argenta.di import FromDishka
from argenta.orchestrator.argparser import ArgSpace

router = Router()


@router.command("get_args")
async def get_args(response: Response, argspace: FromDishka[ArgSpace]):
    print(argspace.all_arguments)

Running the application:

python server.py --host 0.0.0.0 --port 9000
# Output:
# Server configuration:
#   Host: 0.0.0.0
#   Port: 9000