tf.compat.v1.flags.Flag

Информация о флаге командной строки.

tf.compat.v1.flags.Flag(
    parser,
    serializer,
    name,
    default,
    help_string,
    short_name=None,
    boolean=False,
    allow_override=False,
    allow_override_cpp=False,
    allow_hide_cpp=False,
    allow_overwrite=True,
    allow_using_method_names=False
)

'Флаги' определяют следующие поля: .name - имя флага; .default - значение по умолчанию; .default_unparsed - значение по умолчанию без синтаксического анализа; .default_as_str - значение по умолчанию в виде строки представления, например, "'true'" (или None); .value - последнее значение, проанализированное для этого флага; задаётся методом parse(); .help - строка справки или None, если справка недоступна; .short_name - однобуквенный псевдоним для этого флага (или None); .boolean - если 'true', этот флаг не принимает аргументы; .present - true, если этот флаг был прочитан из флагов командной строки; .parser - объект ArgumentParser; .serializer - объект ArgumentSerializer; .allow_override - флаг может быть переопределён без выброса ошибки, и новый флаг переопределяет старый. .allow_override_cpp - использовать флаг из C++, если доступен; определение флага заменяется флагом C++ после инициализации; .allow_hide_cpp - использовать Python флаг, несмотря на наличие флага C++ с тем же именем (игнорировать флаг C++); .using_default_value - значение флага не было установлено пользователем; .allow_overwrite - флаг можно проанализировать более одного раза без ошибок, последнее установленное значение будет использовано; .allow_using_method_names - можно ли определить этот флаг, даже если у него есть имя, которое конфликтует с методом FlagValues.

Единственный публичный метод объекта 'Flag' — parse(), но обычно его вызывает объект 'FlagValues'. Метод parse() — тонкий обертка над методом parse() 'ArgumentParser'. Проанализированное значение сохраняется в .value, а атрибут .present обновляется. Если этот флаг уже присутствовал, генерируется ошибка.

parse() также вызывается во время init для синтаксического анализа значения по умолчанию и инициализации атрибута .value. Это позволяет другим модулям Python безопасно использовать флаги, даже если основной модуль не анализирует аргументы командной строки. Атрибут .present очищается после синтаксического анализа в init. Если значение по умолчанию равно None, то шаг синтаксического анализа в init пропускается, и атрибут .value инициализируется как None.

Примечание: Значение по умолчанию также отображается пользователю в строке справки, поэтому важно, чтобы оно было допустимым значением для этого флага.

Методы

flag_type

flag_type()

Возвращает строку, описывающую тип флага.

Примечание: мы используем строки, а не типы.*Постоянные типы, потому что наши флаги могут иметь более экзотические типы, например, 'список строк, разделённых запятыми', 'список строк, разделённых пробелами' и т. д.

parse

parse(
    argument
)

Анализирует строку и устанавливает значение флага.

serialize

serialize()

Сериализует флаг.

unparse

unparse()

__eq__

__eq__(
    other
)

Возвращает self==value.

__ge__

__ge__(
    other, NotImplemented=NotImplemented
)

Возвращает a >= b. Вычисляется с помощью @total_ordering из (not a < b).

__gt__

__gt__(
    other, NotImplemented=NotImplemented
)

Возвращает a > b. Вычисляется с помощью @total_ordering из (not a < b) и (a != b).

__le__

__le__(
    other, NotImplemented=NotImplemented
)

Возвращает a <= b. Вычисляется с помощью @total_ordering из (a < b) или (a == b).

__lt__

__lt__(
    other
)

Возвращает self<value.