tf.compat.v1.flags.FlagValues

Регистр объектов 'Flag'.

tf.compat.v1.flags.FlagValues()

Объект 'FlagValues' может сканировать аргументы командной строки, передавая аргументы флагов объектам 'Flag', которые он владеет. Он также обеспечивает легкий доступ к значениям флагов. Обычно в приложении нужен только один объект 'FlagValues': flags.FLAGS

Этот класс сильно перегружен:

Объекты 'Flag' регистрируются через setitem: FLAGS['longname'] = x # регистрация нового флага

Атрибут .value зарегистрированных объектов 'Flag' можно получить как атрибуты этого объекта 'FlagValues' через getattr. Можно использовать как длинное, так и короткое имя исходных объектов 'Flag' для доступа к его значению: FLAGS.longname # прочитанное значение флага FLAGS.x # прочитанное значение флага (короткое имя)

Аргументы командной строки сканируются и передаются зарегистрированным объектам 'Flag' через метод call. Необработанные аргументы, включая argv0, возвращаются. argv = FLAGS(sys.argv) # сканирование аргументов командной строки

Исходные зарегистрированные объекты Flag можно получить с помощью оператора в стиле словаря, getitem: x = FLAGS['longname'] # доступ к зарегистрированному объекту Flag

Оператор str() для объекта 'FlagValues' предоставляет справку по всем зарегистрированным объектам 'Flag'.

Методы

append_flag_values

append_flag_values(
    flag_values
)

Добавляет флаги, зарегистрированные в другом экземпляре FlagValues.

append_flags_into_file

append_flags_into_file(
    filename
)

Добавляет все назначения флагов из этого объекта FlagInfo в файл.

Вывод будет в формате файла флагов.

Примечание: ДОЛЖЕН отражать поведение C++ AppendFlagsIntoFile из https://github.com/gflags/gflags

find_module_defining_flag

find_module_defining_flag(
    flagname, default=None
)

Возвращает имя модуля, определяющего этот флаг, или значение по умолчанию.

find_module_id_defining_flag

find_module_id_defining_flag(
    flagname, default=None
)

Возвращает ID модуля, определяющего этот флаг, или значение по умолчанию.

flag_values_dict

flag_values_dict()

Возвращает словарь, сопоставляющий имена флагов со значениями флагов.

flags_by_module_dict

flags_by_module_dict()

Возвращает словарь module_name -> список определенных флагов.

flags_by_module_id_dict

flags_by_module_id_dict()

Возвращает словарь module_id -> список определенных флагов.

flags_into_string

flags_into_string()

Возвращает строку с назначениями флагов из этого объекта FlagValues.

Эта функция игнорирует флаги, значение которых None. Каждое назначение флага отделяется новой строкой.

Примечание: ДОЛЖЕН отражать поведение C++ CommandlineFlagsIntoString из https://github.com/gflags/gflags

get_flag_value

get_flag_value(
    name, default
)

Возвращает значение флага (если оно не None) или значение по умолчанию.

get_flags_for_module

get_flags_for_module(
    module
)

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

get_help

get_help(
    prefix='', include_special_flags=True
)

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

get_key_flags_for_module

get_key_flags_for_module(
    module
)

Возвращает список ключевых флагов для модуля.

is_gnu_getopt

is_gnu_getopt()

is_parsed

is_parsed()

Возвращает, были ли обработаны флаги.

key_flags_by_module_dict

key_flags_by_module_dict()

Возвращает словарь module_name -> список ключевых флагов.

main_module_help

main_module_help()

Описание ключевых флагов основного модуля.

mark_as_parsed

mark_as_parsed()

Явно отмечает флаги как обработанные.

Используйте это, когда вызывающая сторона знает, что этот FlagValues был обработан так, как будто произошло вызов call(). Это просто публичный метод для использования такими вещами, как appcommands, которые выполняют дополнительный парсинг команд.

module_help

module_help(
    module
)

Описание ключевых флагов модуля.

read_flags_from_files

read_flags_from_files(
    argv, force_gnu=True
)

Обрабатывает аргументы командной строки, но также позволяет считывать аргументы из файла.

Эта функция вызывается FLAGS(argv). Она ищет в входном списке флаг, похожий на: --flagfile=. Затем она открывает , считывает все допустимые пары ключ-значение и вставляет их в входной список ровно в том месте, где находится аргумент --flagfile.

Обратите внимание, что флаги вашего приложения все еще определяются обычным способом с использованием функций типа absl.flags DEFINE_flag().

Примечания (предполагая, что на входе у нас есть какая-то командная строка): --> При дублировании флагов последний встреченный должен «победить». --> Поскольку флаги, появляющиеся позже, побеждают, настройки файла флагов могут быть «слабыми», если --flagfile находится в начале последовательности аргументов, и могут быть «сильными», если --flagfile находится в конце. --> Дополнительный "--flagfile=" МОЖЕТ быть вложен в файл флагов. Он будет расширен точно в том месте, где он найден. --> В файле флагов строка, начинающаяся с # или //, является комментарием. --> Совершенно пустые строки должны игнорироваться.

register_flag_by_module

register_flag_by_module(
    module_name, flag
)

Записывает модуль, который определяет конкретный флаг.

Мы отслеживаем, какой флаг определен каким модулем, чтобы позже отсортировать флаги по модулям.

register_flag_by_module_id

register_flag_by_module_id(
    module_id, flag
)

Записывает модуль, который определяет конкретный флаг.

register_key_flag_for_module

register_key_flag_for_module(
    module_name, flag
)

Указывает, что флаг является ключевым флагом для модуля.

remove_flag_values

remove_flag_values(
    flag_values
)

Удаляет флаги, которые были ранее добавлены из другого FlagValues.

set_default

set_default(
    name, value
)

Изменяет значение по умолчанию указанного объекта флага.

Текущее значение флага также обновляется, если флаг в настоящее время использует значение по умолчанию, т.е. не указан в командной строке и не установлен с помощью FLAGS.name = value.

set_gnu_getopt

set_gnu_getopt(
    gnu_getopt=True
)

Устанавливает, использовать ли сканирование в стиле GNU.

Стиль GNU позволяет смешивать флаги и аргументы, не являющиеся флагами. См. http://docs.python.org/library/getopt.html#getopt.gnu_getopt

unparse_flags

unparse_flags()

Депарсит все флаги до состояния до вызова FLAGS(argv).

validate_all_flags

validate_all_flags()

Проверяет, проходят ли все флаги проверку.

write_help_in_xml_format

write_help_in_xml_format(
    outfile=None
)

Выводит документацию по флагам в формате XML.

Примечание: Мы используем имена элементов, согласующиеся с теми, которые используются библиотекой флагов командной строки C++, из https://github.com/gflags/gflags. Мы также используем несколько новых элементов (например, ), но мы не вмешиваемся / не перекрываем существующие XML-элементы, используемые библиотекой C++. Пожалуйста, сохраните эту согласованность.

__call__

__call__(
    argv, known_only=False
)

Парсит флаги из argv; сохраняет обработанные флаги в этом объекте FlagValues.

Все необработанные аргументы возвращаются.

__contains__

__contains__(
    name
)

Возвращает True, если имя является значением (флагом) в словаре.

__getitem__

__getitem__(
    name
)

Возвращает объект Flag для флага --name.

__iter__

__iter__()

__len__

__len__()