ArgSpace

ArgSpace — это контейнер для хранения и управления обработанными аргументами командной строки. Его основная задача — предоставить удобный интерфейс для доступа к значениям, переданным при запуске приложения.

ArgSpace создаётся автоматически после обработки аргументов с помощью ArgParser и содержит коллекцию объектов InputArgument.

---

Инициализация

Создание экземпляров класса ArgSpace происходит под капотом, вам не нужно создавать их вручную.

Атрибуты:

all_arguments

Список всех обработанных аргументов типа InputArgument.

---

Методы

get_by_name

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

Возвращает аргумент по имени.

param name:

Имя искомого аргумента.

return:

Объект InputArgument или None, если аргумент не найден.

Пример использования:

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

router = Router()


@router.command("get_args")
def get_args(response: Response, argspace: FromDishka[ArgSpace]):
    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]

Возвращает все аргументы определённого типа.

param arg_type:

Тип аргумента (BooleanArgument или ValueArgument).

return:

Список аргументов указанного типа или пустой список.

Метод фильтрует all_arguments по атрибуту founder_class и возвращает аргументы, созданные из указанного типа.

Пример использования:

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

См. также

Документация по InputArgument находится здесь.

---

Примеры использования

ArgSpace используется для доступа к значениям аргументов после запуска приложения. Типичный сценарий включает обработку аргументов через ArgParser и последующее извлечение значений из ArgSpace.

Полный пример:

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()

Доступ к аргументам из обработчиков осуществляется с помощью DI. Подробнее см. здесь.

Пример использования:

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)

Запуск приложения:

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