tf.compat.v1.flags.Flag

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

tf.compat.v1.flags.Flag(
    parser: _argument_parser.ArgumentParser[_T],
    serializer: Optional[_argument_parser.ArgumentSerializer[_T]],
    name: Text,
    default: Union[Optional[_T], Text],
    help_string: Optional[Text],
    short_name: Optional[Text] = None,
    boolean: bool = False,
    allow_override: bool = False,
    allow_override_cpp: bool = False,
    allow_hide_cpp: bool = False,
    allow_overwrite: bool = True,
    allow_using_method_names: bool = False
) -> None

Единственный общедоступный метод объекта Flag — :meth:parse, но обычно он вызывается только объектом :class:~absl.flags.FlagValues. Метод :meth:parse — это тонкая обёртка над методом :meth:ArgumentParser.parse()<absl.flags.ArgumentParser.parse>. Разобранное значение сохраняется в .value, а атрибут .present обновляется. Если этот флаг уже присутствовал, возникает ошибка.

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

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

Атрибуты
`name`	имя этого флага
`default`	значение по умолчанию для этого флага
`default_unparsed`	неразобранное значение по умолчанию для этого флага.
`default_as_str`	значение по умолчанию в виде строки repr, например "'true'" (или None)
`value`	последнее разобранное значение этого флага, установленное методом :meth:`parse`
`help`	строка справки или None, если справка недоступна
`short_name`	однобуквенный псевдоним этого флага (или None)
`boolean`	если значение равно 'true', этот флаг не принимает аргументы
`present`	значение true, если этот флаг был разобран из флагов командной строки
`parser`	объект :class:`~absl.flags.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.
`validators`	список валидаторов флага.

Методы

`flag_type`

flag_type() -> Text

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

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

`parse`

parse(
    argument: Union[Text, Optional[_T]]
) -> None

Разбирает строку и задаёт значение флага.

Аргументы
`argument`	строка или значение правильного для флага типа; аргумент для разбора.

`serialize`

serialize() -> Text

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

`unparse`

unparse() -> None

`bool`

__bool__()

`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.

© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/compat/v1/flags/Flag