AEngineConsole 0.0.1

Console applications engine.

Argument parser

===============

---

 file: ArgParser.py
 class: ArgumentParser

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

Методы

---

add_rule( )

ArgumentParse.add_rule(var_name, flag)

ex: ArgumentParse.add_rule('MyKey', '-key'),
    ArgumentParse.add_rule('MyKey', ['-key1', '-key2'])

var_name - имя переменной, которая будет содержать значение после флага

flag - флаг для обозначения аргумента (должен начинаться с "-" и стоять перед значением)

---

add_rules_dict( )

ArgumentParse.add_rules_dict(rules)

ex: ArgumentParse.add_rules_dict({
    'key1': '-flag1',
    'key2': ['-flag2', '-flag3']
})

rules - словарь с правилами { var_name: flags }

---

parse( )

ArgumentParse.parse(args_list = None)

ex: ArgumentParse.parse()

args_list - список аргументов. Если None, то парсинг происходит из sys.argv

---

Argument list

===============

---

 file: ArgParser.py
 class: ArgumentList

Класс, содержащий аргументы консоли после ArgumentParser.parse().

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

---

Применение

---

ex: python main.py --host smth.ru

main.py:

from AEngine_console.ArgParser import ArgumentParser, ArgumentList

ArgumentParser.add_rule('host', ['--host', '-h'])
ArgumentParser.parse()
args = ArgumentList()
print(args.host)

output: smth.ru