mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs
This commit is contained in:
@@ -5,27 +5,20 @@ ArgSpace
|
||||
|
||||
``ArgSpace`` — это контейнер для хранения и управления обработанными аргументами командной строки. Его основная задача — предоставить удобный интерфейс для доступа к значениям, переданным при запуске приложения.
|
||||
|
||||
``ArgSpace`` создаётся автоматически после обработки аргументов с помощью `ArgParser` и содержит коллекцию объектов `InputArgument`.
|
||||
``ArgSpace`` создаётся автоматически после обработки аргументов с помощью ``ArgParser`` и содержит коллекцию объектов ``InputArgument``.
|
||||
|
||||
-----
|
||||
|
||||
Инициализация
|
||||
-------------
|
||||
|
||||
.. code-block:: python
|
||||
:linenos:
|
||||
|
||||
__init__(self, all_arguments: list[InputArgument]) -> None
|
||||
|
||||
Создаёт новое пространство аргументов.
|
||||
|
||||
* ``all_arguments``: Список обработанных аргументов в виде объектов `InputArgument`. Каждый элемент содержит имя, значение и тип исходного аргумента.
|
||||
Создание экземпляров класса ``ArgSpace`` происходит под `капотом`, вам не нужно создавать их вручную.
|
||||
|
||||
**Атрибуты:**
|
||||
|
||||
.. py:attribute:: all_arguments
|
||||
|
||||
Список всех обработанных аргументов типа `InputArgument`, включая значения по умолчанию для не указанных параметров.
|
||||
Список всех обработанных аргументов типа ``InputArgument``.
|
||||
|
||||
-----
|
||||
|
||||
@@ -43,29 +36,13 @@ get_by_name
|
||||
Возвращает аргумент по имени.
|
||||
|
||||
:param name: Имя искомого аргумента.
|
||||
:return: Объект `InputArgument` или `None`, если аргумент не найден.
|
||||
|
||||
Метод выполняет линейный поиск по списку `all_arguments`. Если аргумент не найден, возвращается `None`.
|
||||
:return: Объект ``InputArgument`` или ``None``, если аргумент не найден.
|
||||
|
||||
**Пример использования:**
|
||||
|
||||
.. code-block:: python
|
||||
.. literalinclude:: ../../../code_snippets/argspace/snippet4.py
|
||||
:linenos:
|
||||
|
||||
# Получение значения конкретного аргумента
|
||||
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
|
||||
@@ -78,10 +55,10 @@ get_by_type
|
||||
|
||||
Возвращает все аргументы определённого типа.
|
||||
|
||||
:param arg_type: Тип аргумента (`BooleanArgument` или `ValueArgument`).
|
||||
:param arg_type: Тип аргумента (``BooleanArgument`` или ``ValueArgument``).
|
||||
:return: Список аргументов указанного типа или пустой список.
|
||||
|
||||
Метод фильтрует `all_arguments` по атрибуту `founder_class` и возвращает аргументы, созданные из указанного типа.
|
||||
Метод фильтрует ``all_arguments`` по атрибуту ``founder_class`` и возвращает аргументы, созданные из указанного типа.
|
||||
|
||||
**Пример использования:**
|
||||
|
||||
@@ -101,14 +78,14 @@ InputArgument
|
||||
Примеры испольования
|
||||
--------------------
|
||||
|
||||
`ArgSpace` используется для доступа к значениям аргументов после запуска приложения. Типичный сценарий включает обработку аргументов через `ArgParser` и последующее извлечение значений из `ArgSpace`.
|
||||
``ArgSpace`` используется для доступа к значениям аргументов после запуска приложения. Типичный сценарий включает обработку аргументов через ``ArgParser`` и последующее извлечение значений из ``ArgSpace``.
|
||||
|
||||
**Полный пример:**
|
||||
|
||||
.. literalinclude:: ../../../code_snippets/argspace/snippet.py
|
||||
:linenos:
|
||||
|
||||
Доступ к аргументам из обработчиков осуществляется с помощью DI. Подробнее см. :ref:`здесь <root_dependency_injection>`.
|
||||
Доступ к аргументам из обработчиков осуществляется с помощью ``di``. Подробнее см. :ref:`здесь <root_dependency_injection>`.
|
||||
|
||||
.. literalinclude:: ../../../code_snippets/argspace/snippet2.py
|
||||
:linenos:
|
||||
@@ -117,14 +94,6 @@ InputArgument
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# С параметрами по умолчанию
|
||||
python server.py
|
||||
# Output:
|
||||
# Server configuration:
|
||||
# Host: localhost
|
||||
# Port: 8080
|
||||
|
||||
# С кастомными параметрами
|
||||
python server.py --host 0.0.0.0 --port 9000
|
||||
# Output:
|
||||
# Server configuration:
|
||||
|
||||
Reference in New Issue
Block a user