mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs
This commit is contained in:
@@ -1,13 +1,5 @@
|
||||
from argenta.command import Flag, PossibleValues
|
||||
|
||||
# Создание флагов с любыми значениями
|
||||
output_flag = Flag(name="output", possible_values=PossibleValues.ALL)
|
||||
# Creating flags with any values
|
||||
message_flag = Flag(name="message", possible_values=PossibleValues.ALL)
|
||||
name_flag = Flag(name="name", possible_values=PossibleValues.ALL)
|
||||
|
||||
# Можно передать любую строку или ничего
|
||||
# Примеры:
|
||||
# --output result.json
|
||||
# --message "Any text here"
|
||||
# --name "User Name"
|
||||
# --message
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
import re
|
||||
|
||||
from argenta.command import Flag, PossibleValues
|
||||
|
||||
# Флаг без значения
|
||||
# Flag without value
|
||||
verbose_flag = Flag(name="verbose", possible_values=PossibleValues.NEITHER)
|
||||
|
||||
# Флаг с любым значением
|
||||
# Flag with any value
|
||||
output_flag = Flag(name="output", possible_values=PossibleValues.ALL)
|
||||
|
||||
# Флаг со списком допустимых значений
|
||||
# Flag with a list of valid values
|
||||
format_flag = Flag(name="format", possible_values=["json", "xml", "csv", "yaml"])
|
||||
|
||||
# Флаг с регулярным выражением
|
||||
# Flag with regular expression
|
||||
email_flag = Flag(name="email", possible_values=re.compile(r"^[\w\.-]+@[\w\.-]+\.\w+$"))
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
from argenta.command import Flag, PossibleValues
|
||||
|
||||
# Создание флагов без значений
|
||||
# Creating flags without values
|
||||
help_flag = Flag(name="help", possible_values=PossibleValues.NEITHER)
|
||||
verbose_flag = Flag(name="verbose", possible_values=PossibleValues.NEITHER)
|
||||
force_flag = Flag(name="force", possible_values=PossibleValues.NEITHER)
|
||||
|
||||
# Такие флаги используются как переключатели
|
||||
# Правильно: myapp --help
|
||||
# Неправильно: myapp --help something
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
from argenta.command.flag.defaults import PredefinedFlags
|
||||
|
||||
# Проверка типа possible_values в предопределенных флагах
|
||||
print(PredefinedFlags.HELP.possible_values) # PossibleValues.NEITHER
|
||||
print(PredefinedFlags.INFO.possible_values) # PossibleValues.NEITHER
|
||||
print(PredefinedFlags.ALL.possible_values) # PossibleValues.NEITHER
|
||||
|
||||
# Сетевые флаги используют регулярные выражения, а не PossibleValues
|
||||
# PredefinedFlags.HOST использует Pattern для валидации IP
|
||||
# PredefinedFlags.PORT использует Pattern для валидации порта
|
||||
Reference in New Issue
Block a user