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
)

'Flag' объекты определяют следующие поля: .name - имя флага; .default - значение по умолчанию для этого флага; .default_unparsed - значение по умолчанию без обработки для флага. .default_as_str - значение по умолчанию в виде строки repr, например, "'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 безопасно использовать флаги, даже если модуль main пренебрегает анализом аргументов командной строки. Атрибут .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.