Модули и функции · встроенный MicroPython FEMM 5

argparse

Разбор списка текстовых параметров расчётного сценария.

Условия работы

Передавайте parse_args явный список: аргументы окна FEMM не обязаны совпадать с параметрами вашей программы.
Поддержаны action store/store_const/store_true/store_false, dest, nargs, const, default, help, type. Неподдержанные ключи add_argument могут быть молча проигнорированы.
Ошибочный разбор и -h/--help пытаются вызвать отсутствующий sys.exit и заканчиваются AttributeError. Передавайте явный корректный список; результат успешного разбора — namedtuple.

argparse.ArgumentParserСоздаёт отдельный парсер параметров серии FEMM. Других параметров конструктора нет.

argparse.ArgumentParser

ArgumentParser(*, description="")

Создаёт отдельный парсер параметров серии FEMM. Других параметров конструктора нет.

Аргументы

Аргументы вызова `argparse.ArgumentParser`
Имя	Назначение и допустимые значения
`description`	Описание, выводимое полной справкой.

Возвращаемое значение

Объект парсера.

Пример

"Пример argparse.ArgumentParser.\nСреда: встроенный MicroPython FEMM 5.\nСоздаёт отдельный парсер параметров серии FEMM. Других параметров конструктора нет.\nРезультат: Объект парсера."

import argparse
p = argparse.ArgumentParser(description='Sweep')
p.add_argument('--turns', type=int, default=100)
assert p.parse_args([]).turns == 100

Ожидаемый результат. Проверки assert проходят без исключения.

Скачать пример · Ссылка на функцию

Этот пример выполнен в установленном FEMM 5.

argparse.ArgumentParser.add_argumentРегистрирует поле и правила преобразования. nargs принимает целое число, ?, * или +.

argparse.ArgumentParser.add_argument

parser.add_argument(*args, **kwargs)

Регистрирует поле и правила преобразования. nargs принимает целое число, ?, * или +.

Аргументы

Аргументы вызова `argparse.ArgumentParser.add_argument`
Имя	Назначение и допустимые значения
`args`	Одно имя позиционного аргумента либо варианты ключа, например -n и --turns.
`kwargs`	action, dest, nargs, const, default, help и type; type должен быть вызываемым преобразователем.

Возвращаемое значение

None.

Пример

"Пример argparse.ArgumentParser.add_argument.\nСреда: встроенный MicroPython FEMM 5.\nРегистрирует поле и правила преобразования. nargs принимает целое число, ?, * или +.\nРезультат: None."

import argparse
p = argparse.ArgumentParser(description='Sweep')
p.add_argument('--turns', type=int, default=100)
assert p.parse_args(['--turns','120']).turns == 120

Ожидаемый результат. Проверки assert проходят без исключения.

Скачать пример · Ссылка на функцию

Этот пример выполнен в установленном FEMM 5.

argparse.ArgumentParser.parse_argsРазбирает все параметры; неизвестный ключ считается ошибкой.

argparse.ArgumentParser.parse_args

parser.parse_args(args=None)

Разбирает все параметры; неизвестный ключ считается ошибкой.

Аргументы

Аргументы вызова `argparse.ArgumentParser.parse_args`
Имя	Назначение и допустимые значения
`args`	Список строк; None означает sys.argv[1:]. Исходный список копируется.

Возвращаемое значение

namedtuple с полями зарегистрированных параметров.

Пример

"Пример argparse.ArgumentParser.parse_args.\nСреда: встроенный MicroPython FEMM 5.\nРазбирает все параметры; неизвестный ключ считается ошибкой.\nРезультат: namedtuple с полями зарегистрированных параметров."

import argparse
p = argparse.ArgumentParser(description='Sweep')
p.add_argument('--turns', type=int, default=100)
a = p.parse_args(['--turns','80'])
assert a.turns == 80

Ожидаемый результат. Проверки assert проходят без исключения.

Скачать пример · Ссылка на функцию

Этот пример выполнен в установленном FEMM 5.

argparse.ArgumentParser.parse_known_argsПозволяет отделить параметры модели от параметров вызывающего сценария.

argparse.ArgumentParser.parse_known_args

parser.parse_known_args(args=None)

Позволяет отделить параметры модели от параметров вызывающего сценария.

Аргументы

Аргументы вызова `argparse.ArgumentParser.parse_known_args`
Имя	Назначение и допустимые значения
`args`	Список строк или None для sys.argv[1:].

Возвращаемое значение

Пара (namedtuple параметров, список неизвестных строк).

Пример

"Пример argparse.ArgumentParser.parse_known_args.\nСреда: встроенный MicroPython FEMM 5.\nПозволяет отделить параметры модели от параметров вызывающего сценария.\nРезультат: Пара (namedtuple параметров, список неизвестных строк)."

import argparse
p = argparse.ArgumentParser(description='Sweep')
p.add_argument('--turns', type=int, default=100)
a, unknown = p.parse_known_args(['--turns','80','--mesh','fine'])
assert a.turns == 80 and unknown == ['--mesh','fine']

Ожидаемый результат. Проверки assert проходят без исключения.

Скачать пример · Ссылка на функцию

Этот пример выполнен в установленном FEMM 5.

argparse.ArgumentParser.usageПоказывает синтаксис сценария без запуска разбора.

argparse.ArgumentParser.usage

parser.usage(full)

Показывает синтаксис сценария без запуска разбора.

Аргументы

Аргументы вызова `argparse.ArgumentParser.usage`
Имя	Назначение и допустимые значения
`full`	True для полного описания и перечня полей, False для одной строки usage.

Возвращаемое значение

None; печатает справку в консоль FEMM.

Пример

"Пример argparse.ArgumentParser.usage.\nСреда: встроенный MicroPython FEMM 5.\nПоказывает синтаксис сценария без запуска разбора.\nРезультат: None; печатает справку в консоль FEMM."

import argparse
p = argparse.ArgumentParser(description='Sweep')
p.add_argument('--turns', type=int, default=100)
p.usage(False)

Ожидаемый результат. Проверки assert проходят без исключения.

Скачать пример · Ссылка на функцию

Этот пример выполнен в установленном FEMM 5.

Имена в установленной сборке

Перечень получен во встроенном интерпретаторе. Он включает функции, классы и константы. Ссылки ведут к контрактам; для прямого доступа ulab учитывайте условия этого раздела.

ArgumentParserArgumentTypeErrornamedtuplesys