winreg – доступ к реестру Windows¶winreg – Windows registry access

Функции¶Functions

Этот модуль предоставляет следующие функции:

winreg.CloseKey(hkey)¶

Закрывает ранее открытый ключ реестра. Аргумент hkey указывает ранее открытый ключ.

Примечание

Если hkey не закрыт с помощью этого метода (или через hkey.Close()), он закрывается, когда объект hkey уничтожается Python.

winreg.ConnectRegistry(computer_name, key)¶

Устанавливает соединение с предопределенным дескриптором реестра на другом компьютере и возвращает объект-дескриптор.

computer_name – это имя удаленного компьютера в формате r"\\computername". Если None, используется локальный компьютер.

key – это предопределенный дескриптор для подключения.

Возвращаемое значение – это дескриптор открытого ключа. Если функция завершается ошибкой, возникает OSError исключение.

Возбуждает событие аудита winreg.ConnectRegistry с аргументами computer_name, key.

Изменено в версии 3.3: См. выше.

winreg.CreateKey(key, sub_key)¶

Создает или открывает указанный ключ, возвращая объект-дескриптор.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – это строка, задающая имя ключа, который открывает или создает этот метод.

Если key – один из предопределенных ключей, sub_key может быть None. В этом случае возвращаемый дескриптор совпадает с дескриптором ключа, переданным в функцию.

Если ключ уже существует, эта функция открывает существующий ключ.

Возвращаемое значение – это дескриптор открытого ключа. Если функция завершается ошибкой, возникает OSError исключение.

Вызывает событие аудита winreg.CreateKey с аргументами key, sub_key, access.

Вызывает событие аудита winreg.OpenKey/result с аргументом key.

Изменено в версии 3.3: См. выше.

winreg.CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE)¶

Создает или открывает указанный ключ, возвращая объект-дескриптор.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – это строка, задающая имя ключа, который открывает или создает этот метод.

reserved – это зарезервированное целое число, которое должно быть равно нулю. По умолчанию – ноль.

access – это целое число, задающее маску доступа, которая описывает требуемый уровень безопасности для ключа. По умолчанию – KEY_WRITE. См. Access Rights для других допустимых значений.

Если key – один из предопределенных ключей, sub_key может быть None. В этом случае возвращаемый дескриптор совпадает с дескриптором ключа, переданным в функцию.

Если ключ уже существует, эта функция открывает существующий ключ.

Возвращаемое значение – это дескриптор открытого ключа. Если функция завершается ошибкой, возникает OSError исключение.

Вызывает событие аудита winreg.CreateKey с аргументами key, sub_key, access.

Вызывает событие аудита winreg.OpenKey/result с аргументом key.

Добавлено в версии 3.2.

Изменено в версии 3.3: См. выше.

winreg.DeleteKey(key, sub_key)¶

Удаляет указанный ключ.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – это строка, которая должна быть подразделом ключа, идентифицированного key параметром. Это значение не должно быть None, и ключ не может содержать подразделы.

Этот метод не может удалять ключи, содержащие подразделы.

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

Вызывает событие аудита winreg.DeleteKey с аргументами key, sub_key, access.

Изменено в версии 3.3: См. выше.

winreg.DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)¶

Удаляет указанный ключ.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – это строка, которая должна быть подразделом ключа, идентифицированного key параметром. Это значение не должно быть None, и ключ не может иметь подразделы.

reserved – это зарезервированное целое число, которое должно быть равно нулю. По умолчанию – ноль.

access – это целое число, задающее маску доступа, описывающую желаемый уровень безопасности для ключа. Значение по умолчанию – KEY_WOW64_64KEY. В 32-разрядной Windows константы WOW64 игнорируются. См. Access Rights для других допустимых значений.

Этот метод не может удалять ключи, содержащие подразделы.

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

В неподдерживаемых версиях Windows возбуждается исключение NotImplementedError.

Вызывает событие аудита winreg.DeleteKey с аргументами key, sub_key, access.

Добавлено в версии 3.2.

Изменено в версии 3.3: См. выше.

winreg.DeleteValue(key, value)¶

Удаляет именованное значение из ключа реестра.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

value – это строка, определяющая значение, которое нужно удалить.

Возбуждает событие аудита winreg.DeleteValue с аргументами key, value.

winreg.EnumKey(key, index)¶

Перечисляет подразделы открытого ключа реестра, возвращая строку.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

index – это целое число, определяющее индекс извлекаемого ключа.

Функция при каждом вызове получает имя одного подраздела. Обычно она вызывается многократно, пока не возникнет исключение OSError, указывающее на отсутствие других значений.

Возбуждает событие аудита winreg.EnumKey с аргументами key, index.

Изменено в версии 3.3: См. выше.

winreg.EnumValue(key, index)¶

Перечисляет значения открытого ключа реестра, возвращая кортеж.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

index – это целое число, определяющее индекс извлекаемого значения.

Функция при каждом вызове получает имя одного подраздела. Обычно она вызывается многократно, пока не возникнет исключение OSError, указывающее на отсутствие других значений.

Результат – кортеж из 3 элементов:

Индекс	Значение
0	Строка, идентифицирующая имя значения.
1	Объект, содержащий данные значения, и его тип зависит от базового типа раздела реестра.
2	Целое число, идентифицирующее тип данных значения (см. таблицу в документации для SetValueEx()).

Возбуждает событие аудита winreg.EnumValue с аргументами key, index.

Изменено в версии 3.3: См. выше.

winreg.ExpandEnvironmentStrings(str)¶

Заменяет заполнители переменных среды %NAME% в строках вида REG_EXPAND_SZ:

>>> ExpandEnvironmentStrings('%windir%')
'C:\\Windows'

Вызывает событие аудита winreg.ExpandEnvironmentStrings с аргументом str.

winreg.FlushKey(key)¶

Записывает все атрибуты раздела в реестр.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

Вызов FlushKey() для изменения раздела не обязателен. Изменения в реестре сбрасываются на диск самим реестром с помощью его отложенного сброса (lazy flusher). Изменения в реестре также сбрасываются на диск при завершении работы системы. В отличие от CloseKey(), метод FlushKey() возвращает управление только после записи всех данных в реестр. Приложение должно вызывать FlushKey() только в случае, если требуется абсолютная уверенность, что изменения в реестре находятся на диске.

Примечание

Если нет уверенности, требуется ли вызов FlushKey(), скорее всего, он не требуется.

winreg.LoadKey(key, sub_key, file_name)¶

Создаёт подраздел в указанном разделе и сохраняет информацию реестра из указанного файла в этот подраздел.

key – это дескриптор, возвращённый ConnectRegistry(), или одна из констант HKEY_USERS или HKEY_LOCAL_MACHINE.

sub_key – это строка, идентифицирующая загружаемый подраздел.

file_name – это имя файла, из которого загружаются данные реестра. Этот файл должен быть создан с помощью функции SaveKey(). В файловой системе FAT имя файла может не иметь расширения.

Вызов LoadKey() завершается ошибкой, если вызывающий процесс не имеет привилегии SE_RESTORE_PRIVILEGE. Обратите внимание, что привилегии отличаются от прав доступа – см. документацию RegLoadKey для подробностей.

Если key – это дескриптор, возвращённый ConnectRegistry(), то путь, указанный в file_name, считается относительно удалённого компьютера.

Вызывает событие аудита winreg.LoadKey с аргументами key, sub_key, file_name.

winreg.OpenKey(key, sub_key, reserved=0, access=KEY_READ)¶

winreg.OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ)¶

Открывает указанный раздел и возвращает объект-дескриптор.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – это строка, идентифицирующая открываемый подраздел.

reserved – зарезервированное целое число, должно быть равно нулю. Значение по умолчанию – ноль.

access – целое число, задающее маску доступа, описывающую желаемый уровень безопасности для раздела. По умолчанию KEY_READ. См. права доступа для других допустимых значений.

Результат – новый дескриптор указанного раздела.

Если функция завершается ошибкой, возбуждается исключение OSError.

Вызывает событие аудита winreg.OpenKey с аргументами key, sub_key, access.

Вызывает событие аудита winreg.OpenKey/result с аргументом key.

Изменено в версии 3.2: Разрешено использование именованных аргументов.

Изменено в версии 3.3: См. выше.

winreg.QueryInfoKey(key)¶

Возвращает информацию о разделе в виде кортежа.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

Результат – кортеж из 3 элементов:

Индекс	Значение
0	Целое число, указывающее количество подразделов, которые есть у этого раздела.
1	Целое число, указывающее количество значений, которые есть у этого раздела.
2	Целое число, указывающее время последнего изменения раздела (если доступно), в единицах по 100 наносекунд с 1 января 1601 года.

Вызывает событие аудита winreg.QueryInfoKey с аргументом key.

winreg.QueryValue(key, sub_key)¶

Извлекает безымянное значение для раздела в виде строки.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – строка, содержащая имя подраздела, с которым связано значение. Если этот параметр равен None или пустой строке, функция извлекает значение, заданное методом SetValue() для раздела, указанного в key.

Значения в реестре имеют компоненты: имя, тип и данные. Этот метод извлекает данные первого значения с именем NULL для заданного раздела. Однако соответствующий вызов API не возвращает тип, поэтому всегда используйте QueryValueEx(), если это возможно.

Вызывает событие аудита winreg.QueryValue с аргументами key, sub_key, value_name.

winreg.QueryValueEx(key, value_name)¶

Извлекает тип и данные для указанного имени значения, связанного с открытым разделом реестра.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

value_name – строка, указывающая имя запрашиваемого значения.

Результат – кортеж из 2 элементов:

Индекс	Значение
0	Значение элемента реестра.
1	Целое число, указывающее тип реестра для этого значения (см. таблицу в документации для SetValueEx())

Вызывает событие аудита winreg.QueryValue с аргументами key, sub_key, value_name.

winreg.SaveKey(key, file_name)¶

Сохраняет указанный раздел и все его подразделы в указанный файл.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

file_name – имя файла для сохранения данных реестра. Этот файл не должен существовать. Если имя файла содержит расширение, его нельзя использовать в файловых системах FAT с методом LoadKey().

Если key представляет раздел на удалённом компьютере, путь, указанный в file_name, считается относительным этого удалённого компьютера. Вызывающий этот метод должен обладать привилегией безопасности SeBackupPrivilege. Обратите внимание: привилегии отличаются от разрешений – см. документацию «Conflicts Between User Rights and Permissions» для подробностей.

Эта функция передаёт NULL для security_attributes в API.

Возбуждает событие аудита winreg.SaveKey с аргументами key, file_name.

winreg.SetValue(key, sub_key, type, value)¶

Связывает значение с указанным разделом.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

sub_key – строка, задающая имя подраздела, с которым связывается значение.

type – целое число, указывающее тип данных. В настоящее время это должно быть REG_SZ, то есть поддерживаются только строки. Используйте функцию SetValueEx() для поддержки других типов данных.

value – это строка, задающая новое значение.

Если раздел, указанный параметром sub_key, не существует, функция SetValue создаёт его.

Длина значений ограничена доступной памятью. Длинные значения (более 2048 байт) следует хранить в виде файлов, имена которых сохраняются в конфигурационном реестре. Это помогает реестру работать эффективно.

Раздел, указанный параметром key, должен быть открыт с доступом KEY_SET_VALUE.

Возбуждает событие аудита winreg.SetValue с аргументами key, sub_key, type, value.

winreg.SetValueEx(key, value_name, reserved, type, value)¶

Сохраняет данные в поле значения открытого ключа реестра.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

value_name – это строка, задающая имя подключа, с которым связано значение.

reserved может быть любым – в API всегда передаётся ноль.

type – это целое число, задающее тип данных. Смотрите Value Types для получения списка доступных типов.

value – это строка, задающая новое значение.

Этот метод также может задавать дополнительную информацию о значении и типе для указанного ключа. Ключ, указанный параметром key, должен быть открыт с доступом KEY_SET_VALUE.

Чтобы открыть ключ, используйте методы CreateKey() или OpenKey().

Длина значений ограничена доступной памятью. Длинные значения (более 2048 байт) следует хранить в виде файлов, имена которых сохраняются в конфигурационном реестре. Это помогает реестру работать эффективно.

Возбуждает событие аудита winreg.SetValue с аргументами key, sub_key, type, value.

winreg.DisableReflectionKey(key)¶

Отключает отражение реестра для 32-разрядных процессов, работающих в 64-разрядной операционной системе.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

Обычно вызывает NotImplementedError при выполнении в 32-разрядной операционной системе.

Если ключ отсутствует в списке отражения, функция выполняется успешно, но не оказывает никакого эффекта. Отключение отражения для ключа не влияет на отражение каких-либо подключачей.

Вызывает событие аудита winreg.DisableReflectionKey с аргументом key.

winreg.EnableReflectionKey(key)¶

Восстанавливает отражение реестра для указанного отключённого ключа.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

Обычно вызывает NotImplementedError при выполнении в 32-разрядной операционной системе.

Восстановление отражения для ключа не влияет на отражение каких-либо подключачей.

Вызывает событие аудита winreg.EnableReflectionKey с аргументом key.

winreg.QueryReflectionKey(key)¶

Определяет состояние отражения для указанного ключа.

key – это уже открытый ключ или одна из предопределённых констант HKEY_*.

Возвращает True, если отражение отключено.

Обычно вызывает NotImplementedError при выполнении в 32-разрядной операционной системе.

Вызывает событие аудита winreg.QueryReflectionKey с аргументом key.

Константы¶Constants

Следующие константы определены для использования во многих функциях winreg.

Объекты дескрипторов реестра¶Registry Handle Objects

Этот объект оборачивает объект HKEY Windows и автоматически закрывает его при уничтожении. Чтобы гарантированно выполнить очистку, можно вызвать либо метод Close() этого объекта, либо функцию CloseKey().

Все функции реестра в этом модуле возвращают один из таких объектов.

Все функции реестра в этом модуле, которые принимают объект дескриптора, также принимают целое число, однако рекомендуется использовать объект дескриптора.

Объекты дескрипторов поддерживают семантику __bool__() – поэтому

if handle:
    print("Yes")

будет выведено Yes, если дескриптор в данный момент действителен (не был закрыт или отсоединён).

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

Объекты дескрипторов можно преобразовать в целое число (например, с помощью встроенной функции int()), в этом случае возвращается соответствующее значение дескриптора Windows. Также можно использовать метод Detach(), чтобы вернуть целочисленный дескриптор и отсоединить дескриптор Windows от объекта дескриптора.

PyHKEY.Close()¶

Закрывает соответствующий дескриптор Windows.

Если дескриптор уже закрыт, ошибка не возникает.

PyHKEY.Detach()¶

Отсоединяет дескриптор Windows от объекта дескриптора.

Результат – целое число, содержащее значение дескриптора до его отсоединения. Если дескриптор уже отсоединён или закрыт, возвращается ноль.

После вызова этой функции дескриптор фактически становится недействительным, но не закрывается. Эту функцию следует вызывать, когда требуется, чтобы базовый дескриптор Win32 существовал дольше, чем объект дескриптора.

Вызывает событие аудита winreg.PyHKEY.Detach с аргументом key.

PyHKEY.__enter__()¶

PyHKEY.__exit__(*exc_info)¶

Объект HKEY реализует __enter__() и __exit__() и, таким образом, поддерживает протокол контекста для оператора with:

with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    ...  # работа с ключом

будет автоматически закрывать key при выходе управления из блока with.