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 из (не a < b).

__gt__

__gt__(
    other, NotImplemented=NotImplemented
)

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

__le__

__le__(
    other, NotImplemented=NotImplemented
)

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

__lt__

__lt__(
    other
)

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