FM / library

/usr/share/doc/python3-docs/html/_sources/library/

/usr/share/doc/python3-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	edit dl rm
abc.rst.txt	11805	0644	edit dl rm
aifc.rst.txt	7503	0644	edit dl rm
allos.rst.txt	678	0644	edit dl rm
archiving.rst.txt	440	0644	edit dl rm
argparse.rst.txt	77480	0644	edit dl rm
array.rst.txt	10812	0644	edit dl rm
ast.rst.txt	10159	0644	edit dl rm
asynchat.rst.txt	8528	0644	edit dl rm
asyncio-dev.rst.txt	13398	0644	edit dl rm
asyncio-eventloop.rst.txt	33701	0644	edit dl rm
asyncio-eventloops.rst.txt	7660	0644	edit dl rm
asyncio-protocol.rst.txt	25170	0644	edit dl rm
asyncio-queue.rst.txt	4328	0644	edit dl rm
asyncio-stream.rst.txt	14363	0644	edit dl rm
asyncio-subprocess.rst.txt	15544	0644	edit dl rm
asyncio-sync.rst.txt	9078	0644	edit dl rm
asyncio-task.rst.txt	25406	0644	edit dl rm
asyncio.rst.txt	2272	0644	edit dl rm
asyncore.rst.txt	13624	0644	edit dl rm
atexit.rst.txt	3669	0644	edit dl rm
audioop.rst.txt	10712	0644	edit dl rm
base64.rst.txt	10371	0644	edit dl rm
bdb.rst.txt	12985	0644	edit dl rm
binary.rst.txt	654	0644	edit dl rm
binascii.rst.txt	6539	0644	edit dl rm
binhex.rst.txt	1709	0644	edit dl rm
bisect.rst.txt	5398	0644	edit dl rm
builtins.rst.txt	1465	0644	edit dl rm
bz2.rst.txt	8825	0644	edit dl rm
calendar.rst.txt	10988	0644	edit dl rm
cgi.rst.txt	22650	0644	edit dl rm
cgitb.rst.txt	2918	0644	edit dl rm
chunk.rst.txt	5094	0644	edit dl rm
cmath.rst.txt	9326	0644	edit dl rm
cmd.rst.txt	13795	0644	edit dl rm
code.rst.txt	7817	0644	edit dl rm
codecs.rst.txt	75564	0644	edit dl rm
codeop.rst.txt	3021	0644	edit dl rm
collections.abc.rst.txt	12861	0644	edit dl rm
collections.rst.txt	46063	0644	edit dl rm
colorsys.rst.txt	1820	0644	edit dl rm
compileall.rst.txt	8975	0644	edit dl rm
concurrency.rst.txt	673	0644	edit dl rm
concurrent.futures.rst.txt	16910	0644	edit dl rm
concurrent.rst.txt	171	0644	edit dl rm
configparser.rst.txt	48756	0644	edit dl rm
constants.rst.txt	3331	0644	edit dl rm
contextlib.rst.txt	28175	0644	edit dl rm
copy.rst.txt	3378	0644	edit dl rm
copyreg.rst.txt	2182	0644	edit dl rm
crypt.rst.txt	5122	0644	edit dl rm
crypto.rst.txt	411	0644	edit dl rm
csv.rst.txt	19902	0644	edit dl rm
ctypes.rst.txt	88613	0644	edit dl rm
curses.ascii.rst.txt	8920	0644	edit dl rm
curses.panel.rst.txt	2764	0644	edit dl rm
curses.rst.txt	76397	0644	edit dl rm
custominterp.rst.txt	569	0644	edit dl rm
datatypes.rst.txt	751	0644	edit dl rm
datetime.rst.txt	90524	0644	edit dl rm
dbm.rst.txt	14293	0644	edit dl rm
debug.rst.txt	471	0644	edit dl rm
decimal.rst.txt	74869	0644	edit dl rm
development.rst.txt	704	0644	edit dl rm
difflib.rst.txt	29861	0644	edit dl rm
dis.rst.txt	32567	0644	edit dl rm
distribution.rst.txt	452	0644	edit dl rm
distutils.rst.txt	1974	0644	edit dl rm
doctest.rst.txt	71743	0644	edit dl rm
dummy_threading.rst.txt	784	0644	edit dl rm
email.charset.rst.txt	9293	0644	edit dl rm
email.compat32-message.rst.txt	33493	0644	edit dl rm
email.contentmanager.rst.txt	9112	0644	edit dl rm
email.encoders.rst.txt	2715	0644	edit dl rm
email.errors.rst.txt	4792	0644	edit dl rm
email.examples.rst.txt	1915	0644	edit dl rm
email.generator.rst.txt	13637	0644	edit dl rm
email.header.rst.txt	9188	0644	edit dl rm
email.headerregistry.rst.txt	17957	0644	edit dl rm
email.iterators.rst.txt	2795	0644	edit dl rm
email.message.rst.txt	33008	0644	edit dl rm
email.mime.rst.txt	11721	0644	edit dl rm
email.parser.rst.txt	14092	0644	edit dl rm
email.policy.rst.txt	27022	0644	edit dl rm
email.rst.txt	6785	0644	edit dl rm
email.util.rst.txt	9214	0644	edit dl rm
ensurepip.rst.txt	4987	0644	edit dl rm
enum.rst.txt	32751	0644	edit dl rm
errno.rst.txt	6811	0644	edit dl rm
exceptions.rst.txt	25570	0644	edit dl rm
faulthandler.rst.txt	6136	0644	edit dl rm
fcntl.rst.txt	7152	0644	edit dl rm
filecmp.rst.txt	5623	0644	edit dl rm
fileformats.rst.txt	287	0644	edit dl rm
fileinput.rst.txt	8051	0644	edit dl rm
filesys.rst.txt	961	0644	edit dl rm
fnmatch.rst.txt	3103	0644	edit dl rm
formatter.rst.txt	13242	0644	edit dl rm
fpectl.rst.txt	4180	0644	edit dl rm
fractions.rst.txt	6364	0644	edit dl rm
frameworks.rst.txt	391	0644	edit dl rm
ftplib.rst.txt	17552	0644	edit dl rm
functional.rst.txt	365	0644	edit dl rm
functions.rst.txt	71621	0644	edit dl rm
functools.rst.txt	18503	0644	edit dl rm
gc.rst.txt	9694	0644	edit dl rm
getopt.rst.txt	6557	0644	edit dl rm
getpass.rst.txt	1882	0644	edit dl rm
gettext.rst.txt	25588	0644	edit dl rm
glob.rst.txt	3508	0644	edit dl rm
grp.rst.txt	2417	0644	edit dl rm
gzip.rst.txt	8301	0644	edit dl rm
hashlib.rst.txt	26523	0644	edit dl rm
heapq.rst.txt	13402	0644	edit dl rm
hmac.rst.txt	4020	0644	edit dl rm
html.entities.rst.txt	1319	0644	edit dl rm
html.parser.rst.txt	11275	0644	edit dl rm
html.rst.txt	1304	0644	edit dl rm
http.client.rst.txt	18870	0644	edit dl rm
http.cookiejar.rst.txt	27832	0644	edit dl rm
http.cookies.rst.txt	8645	0644	edit dl rm
http.rst.txt	7096	0644	edit dl rm
http.server.rst.txt	17639	0644	edit dl rm
i18n.rst.txt	408	0644	edit dl rm
idle.rst.txt	25834	0644	edit dl rm
imaplib.rst.txt	20367	0644	edit dl rm
imghdr.rst.txt	2938	0644	edit dl rm
imp.rst.txt	15548	0644	edit dl rm
importlib.rst.txt	53563	0644	edit dl rm
index.rst.txt	2258	0644	edit dl rm
inspect.rst.txt	53928	0644	edit dl rm
internet.rst.txt	992	0644	edit dl rm
intro.rst.txt	2645	0644	edit dl rm
io.rst.txt	40328	0644	edit dl rm
ipaddress.rst.txt	32340	0644	edit dl rm
ipc.rst.txt	649	0644	edit dl rm
itertools.rst.txt	38459	0644	edit dl rm
json.rst.txt	27876	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	522	0644	edit dl rm
linecache.rst.txt	2408	0644	edit dl rm
locale.rst.txt	25470	0644	edit dl rm
logging.config.rst.txt	33886	0644	edit dl rm
logging.handlers.rst.txt	42497	0644	edit dl rm
logging.rst.txt	60479	0644	edit dl rm
lzma.rst.txt	17361	0644	edit dl rm
macpath.rst.txt	707	0644	edit dl rm
mailbox.rst.txt	63055	0644	edit dl rm
mailcap.rst.txt	3691	0644	edit dl rm
markup.rst.txt	679	0644	edit dl rm
marshal.rst.txt	4855	0644	edit dl rm
math.rst.txt	14375	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
misc.rst.txt	247	0644	edit dl rm
mm.rst.txt	431	0644	edit dl rm
mmap.rst.txt	11232	0644	edit dl rm
modulefinder.rst.txt	3240	0644	edit dl rm
modules.rst.txt	355	0644	edit dl rm
msilib.rst.txt	18612	0644	edit dl rm
msvcrt.rst.txt	4392	0644	edit dl rm
multiprocessing.rst.txt	104494	0644	edit dl rm
netdata.rst.txt	339	0644	edit dl rm
netrc.rst.txt	3007	0644	edit dl rm
nis.rst.txt	1993	0644	edit dl rm
nntplib.rst.txt	21821	0644	edit dl rm
numbers.rst.txt	8089	0644	edit dl rm
numeric.rst.txt	696	0644	edit dl rm
operator.rst.txt	18989	0644	edit dl rm
optparse.rst.txt	76996	0644	edit dl rm
os.path.rst.txt	16419	0644	edit dl rm
os.rst.txt	137534	0644	edit dl rm
ossaudiodev.rst.txt	17845	0644	edit dl rm
othergui.rst.txt	2822	0644	edit dl rm
parser.rst.txt	15148	0644	edit dl rm
pathlib.rst.txt	30045	0644	edit dl rm
pdb.rst.txt	19454	0644	edit dl rm
persistence.rst.txt	591	0644	edit dl rm
pickle.rst.txt	37440	0644	edit dl rm
pickletools.rst.txt	3729	0644	edit dl rm
pipes.rst.txt	2557	0644	edit dl rm
pkgutil.rst.txt	8730	0644	edit dl rm
platform.rst.txt	9624	0644	edit dl rm
plistlib.rst.txt	7398	0644	edit dl rm
poplib.rst.txt	8197	0644	edit dl rm
posix.rst.txt	3694	0644	edit dl rm
pprint.rst.txt	14274	0644	edit dl rm
profile.rst.txt	27969	0644	edit dl rm
pty.rst.txt	3123	0644	edit dl rm
pwd.rst.txt	2739	0644	edit dl rm
pyclbr.rst.txt	3297	0644	edit dl rm
pydoc.rst.txt	4688	0644	edit dl rm
pyexpat.rst.txt	28620	0644	edit dl rm
python.rst.txt	475	0644	edit dl rm
py_compile.rst.txt	3851	0644	edit dl rm
queue.rst.txt	7268	0644	edit dl rm
quopri.rst.txt	2571	0644	edit dl rm
random.rst.txt	18503	0644	edit dl rm
re.rst.txt	64936	0644	edit dl rm
readline.rst.txt	11943	0644	edit dl rm
reprlib.rst.txt	5162	0644	edit dl rm
resource.rst.txt	12291	0644	edit dl rm
rlcompleter.rst.txt	2294	0644	edit dl rm
runpy.rst.txt	8285	0644	edit dl rm
sched.rst.txt	4842	0644	edit dl rm
secrets.rst.txt	5930	0644	edit dl rm
select.rst.txt	28175	0644	edit dl rm
selectors.rst.txt	8925	0644	edit dl rm
shelve.rst.txt	8390	0644	edit dl rm
shlex.rst.txt	16441	0644	edit dl rm
shutil.rst.txt	26014	0644	edit dl rm
signal.rst.txt	17218	0644	edit dl rm
site.rst.txt	9628	0644	edit dl rm
smtpd.rst.txt	10806	0644	edit dl rm
smtplib.rst.txt	23439	0644	edit dl rm
sndhdr.rst.txt	1994	0644	edit dl rm
socket.rst.txt	68202	0644	edit dl rm
socketserver.rst.txt	23712	0644	edit dl rm
spwd.rst.txt	2958	0644	edit dl rm
sqlite3.rst.txt	39215	0644	edit dl rm
ssl.rst.txt	96021	0644	edit dl rm
stat.rst.txt	9805	0644	edit dl rm
statistics.rst.txt	15301	0644	edit dl rm
stdtypes.rst.txt	179240	0644	edit dl rm
string.rst.txt	35374	0644	edit dl rm
stringprep.rst.txt	4279	0644	edit dl rm
struct.rst.txt	19581	0644	edit dl rm
subprocess.rst.txt	45793	0644	edit dl rm
sunau.rst.txt	7390	0644	edit dl rm
superseded.rst.txt	258	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	4964	0644	edit dl rm
sys.rst.txt	58273	0644	edit dl rm
sysconfig.rst.txt	8749	0644	edit dl rm
syslog.rst.txt	4302	0644	edit dl rm
tabnanny.rst.txt	2007	0644	edit dl rm
tarfile.rst.txt	31749	0644	edit dl rm
telnetlib.rst.txt	7899	0644	edit dl rm
tempfile.rst.txt	13857	0644	edit dl rm
termios.rst.txt	3751	0644	edit dl rm
test.rst.txt	25764	0644	edit dl rm
text.rst.txt	584	0644	edit dl rm
textwrap.rst.txt	10519	0644	edit dl rm
threading.rst.txt	39257	0644	edit dl rm
time.rst.txt	32967	0644	edit dl rm
timeit.rst.txt	13000	0644	edit dl rm
tk.rst.txt	1639	0644	edit dl rm
tkinter.rst.txt	33027	0644	edit dl rm
tkinter.scrolledtext.rst.txt	1255	0644	edit dl rm
tkinter.tix.rst.txt	22653	0644	edit dl rm
tkinter.ttk.rst.txt	58489	0644	edit dl rm
token.rst.txt	2607	0644	edit dl rm
tokenize.rst.txt	10002	0644	edit dl rm
trace.rst.txt	6914	0644	edit dl rm
traceback.rst.txt	17854	0644	edit dl rm
tracemalloc.rst.txt	22089	0644	edit dl rm
tty.rst.txt	1097	0644	edit dl rm
turtle.rst.txt	71221	0644	edit dl rm
types.rst.txt	9999	0644	edit dl rm
typing.rst.txt	34332	0644	edit dl rm
undoc.rst.txt	780	0644	edit dl rm
unicodedata.rst.txt	5762	0644	edit dl rm
unittest.mock-examples.rst.txt	46206	0644	edit dl rm
unittest.mock.rst.txt	85991	0644	edit dl rm
unittest.rst.txt	93304	0644	edit dl rm
unix.rst.txt	446	0644	edit dl rm
urllib.error.rst.txt	2199	0644	edit dl rm
urllib.parse.rst.txt	27332	0644	edit dl rm
urllib.request.rst.txt	59360	0644	edit dl rm
urllib.robotparser.rst.txt	2969	0644	edit dl rm
urllib.rst.txt	466	0644	edit dl rm
uu.rst.txt	2387	0644	edit dl rm
uuid.rst.txt	8760	0644	edit dl rm
venv.rst.txt	20621	0644	edit dl rm
warnings.rst.txt	20152	0644	edit dl rm
wave.rst.txt	6870	0644	edit dl rm
weakref.rst.txt	21328	0644	edit dl rm
webbrowser.rst.txt	9783	0644	edit dl rm
windows.rst.txt	272	0644	edit dl rm
winreg.rst.txt	24073	0644	edit dl rm
winsound.rst.txt	5134	0644	edit dl rm
wsgiref.rst.txt	33047	0644	edit dl rm
xdrlib.rst.txt	8078	0644	edit dl rm
xml.dom.minidom.rst.txt	10198	0644	edit dl rm
xml.dom.pulldom.rst.txt	5186	0644	edit dl rm
xml.dom.rst.txt	39507	0644	edit dl rm
xml.etree.elementtree.rst.txt	43871	0644	edit dl rm
xml.rst.txt	6071	0644	edit dl rm
xml.sax.handler.rst.txt	15399	0644	edit dl rm
xml.sax.reader.rst.txt	12133	0644	edit dl rm
xml.sax.rst.txt	7159	0644	edit dl rm
xml.sax.utils.rst.txt	3901	0644	edit dl rm
xmlrpc.client.rst.txt	23071	0644	edit dl rm
xmlrpc.rst.txt	475	0644	edit dl rm
xmlrpc.server.rst.txt	14990	0644	edit dl rm
zipapp.rst.txt	17392	0644	edit dl rm
zipfile.rst.txt	24005	0644	edit dl rm
zipimport.rst.txt	5805	0644	edit dl rm
zlib.rst.txt	13912	0644	edit dl rm
_dummy_thread.rst.txt	762	0644	edit dl rm
_thread.rst.txt	6886	0644	edit dl rm
__future__.rst.txt	5245	0644	edit dl rm
__main__.rst.txt	904	0644	edit dl rm

Edit: /usr/share/doc/python3-docs/html/_sources/library/winreg.rst.txt (24073B)

:mod:`winreg` --- Windows registry access
=========================================

.. module:: winreg
   :platform: Windows
   :synopsis: Routines and objects for manipulating the Windows registry.

.. sectionauthor:: Mark Hammond <MarkH@ActiveState.com>

--------------

These functions expose the Windows registry API to Python.  Instead of using an
integer as the registry handle, a :ref:`handle object <handle-object>` is used
to ensure that the handles are closed correctly, even if the programmer neglects
to explicitly close them.

.. _exception-changed:

.. versionchanged:: 3.3
   Several functions in this module used to raise a
   :exc:`WindowsError`, which is now an alias of :exc:`OSError`.

.. _functions:

Functions
------------------

This module offers the following functions:

.. function:: CloseKey(hkey)

Closes a previously opened registry key.  The *hkey* argument specifies a
   previously opened key.

.. note::

If *hkey* is not closed using this method (or via :meth:`hkey.Close()
      <PyHKEY.Close>`), it is closed when the *hkey* object is destroyed by
      Python.

.. function:: ConnectRegistry(computer_name, key)

Establishes a connection to a predefined registry handle on another computer,
   and returns a :ref:`handle object <handle-object>`.

*computer_name* is the name of the remote computer, of the form
   ``r"\\computername"``.  If ``None``, the local computer is used.

*key* is the predefined handle to connect to.

The return value is the handle of the opened key. If the function fails, an
   :exc:`OSError` exception is raised.

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: CreateKey(key, sub_key)

Creates or opens the specified key, returning a
   :ref:`handle object <handle-object>`.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that names the key this method opens or creates.

If *key* is one of the predefined keys, *sub_key* may be ``None``. In that
   case, the handle returned is the same key handle passed in to the function.

If the key already exists, this function opens the existing key.

The return value is the handle of the opened key. If the function fails, an
   :exc:`OSError` exception is raised.

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE)

Creates or opens the specified key, returning a
   :ref:`handle object <handle-object>`.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that names the key this method opens or creates.

*reserved* is a reserved integer, and must be zero. The default is zero.

*access* is an integer that specifies an access mask that describes the desired
   security access for the key.  Default is :const:`KEY_WRITE`.  See
   :ref:`Access Rights <access-rights>` for other allowed values.

If *key* is one of the predefined keys, *sub_key* may be ``None``. In that
   case, the handle returned is the same key handle passed in to the function.

If the key already exists, this function opens the existing key.

The return value is the handle of the opened key. If the function fails, an
   :exc:`OSError` exception is raised.

.. versionadded:: 3.2

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: DeleteKey(key, sub_key)

Deletes the specified key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that must be a subkey of the key identified by the *key*
   parameter.  This value must not be ``None``, and the key may not have subkeys.

*This method can not delete keys with subkeys.*

If the method succeeds, the entire key, including all of its values, is removed.
   If the method fails, an :exc:`OSError` exception is raised.

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)

Deletes the specified key.

.. note::
      The :func:`DeleteKeyEx` function is implemented with the RegDeleteKeyEx
      Windows API function, which is specific to 64-bit versions of Windows.
      See the `RegDeleteKeyEx documentation
      <https://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx>`__.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that must be a subkey of the key identified by the
   *key* parameter. This value must not be ``None``, and the key may not have
   subkeys.

*reserved* is a reserved integer, and must be zero. The default is zero.

*access* is an integer that specifies an access mask that describes the desired
   security access for the key.  Default is :const:`KEY_WOW64_64KEY`.  See
   :ref:`Access Rights <access-rights>` for other allowed values.

*This method can not delete keys with subkeys.*

If the method succeeds, the entire key, including all of its values, is
   removed. If the method fails, an :exc:`OSError` exception is raised.

On unsupported Windows versions, :exc:`NotImplementedError` is raised.

.. versionadded:: 3.2

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: DeleteValue(key, value)

Removes a named value from a registry key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*value* is a string that identifies the value to remove.

.. function:: EnumKey(key, index)

Enumerates subkeys of an open registry key, returning a string.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*index* is an integer that identifies the index of the key to retrieve.

The function retrieves the name of one subkey each time it is called.  It is
   typically called repeatedly until an :exc:`OSError` exception is
   raised, indicating, no more values are available.

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: EnumValue(key, index)

Enumerates values of an open registry key, returning a tuple.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*index* is an integer that identifies the index of the value to retrieve.

The function retrieves the name of one subkey each time it is called. It is
   typically called repeatedly, until an :exc:`OSError` exception is
   raised, indicating no more values.

The result is a tuple of 3 items:

+-------+--------------------------------------------+
   | Index | Meaning                                    |
   +=======+============================================+
   | ``0`` | A string that identifies the value name    |
   +-------+--------------------------------------------+
   | ``1`` | An object that holds the value data, and   |
   |       | whose type depends on the underlying       |
   |       | registry type                              |
   +-------+--------------------------------------------+
   | ``2`` | An integer that identifies the type of the |
   |       | value data (see table in docs for          |
   |       | :meth:`SetValueEx`)                        |
   +-------+--------------------------------------------+

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: ExpandEnvironmentStrings(str)

Expands environment variable placeholders ``%NAME%`` in strings like
   :const:`REG_EXPAND_SZ`::

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

.. function:: FlushKey(key)

Writes all the attributes of a key to the registry.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

It is not necessary to call :func:`FlushKey` to change a key. Registry changes are
   flushed to disk by the registry using its lazy flusher.  Registry changes are
   also flushed to disk at system shutdown.  Unlike :func:`CloseKey`, the
   :func:`FlushKey` method returns only when all the data has been written to the
   registry. An application should only call :func:`FlushKey` if it requires
   absolute certainty that registry changes are on disk.

.. note::

If you don't know whether a :func:`FlushKey` call is required, it probably
      isn't.

.. function:: LoadKey(key, sub_key, file_name)

Creates a subkey under the specified key and stores registration information
   from a specified file into that subkey.

*key* is a handle returned by :func:`ConnectRegistry` or one of the constants
   :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`.

*sub_key* is a string that identifies the subkey to load.

*file_name* is the name of the file to load registry data from. This file must
   have been created with the :func:`SaveKey` function. Under the file allocation
   table (FAT) file system, the filename may not have an extension.

A call to :func:`LoadKey` fails if the calling process does not have the
   :const:`SE_RESTORE_PRIVILEGE` privilege.  Note that privileges are different
   from permissions -- see the `RegLoadKey documentation
   <https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx>`__ for
   more details.

If *key* is a handle returned by :func:`ConnectRegistry`, then the path
   specified in *file_name* is relative to the remote computer.

.. function:: OpenKey(key, sub_key, reserved=0, access=KEY_READ)
              OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ)

Opens the specified key, returning a :ref:`handle object <handle-object>`.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that identifies the sub_key to open.

*reserved* is a reserved integer, and must be zero.  The default is zero.

*access* is an integer that specifies an access mask that describes the desired
   security access for the key.  Default is :const:`KEY_READ`.  See :ref:`Access
   Rights <access-rights>` for other allowed values.

The result is a new handle to the specified key.

If the function fails, :exc:`OSError` is raised.

.. versionchanged:: 3.2
      Allow the use of named arguments.

.. versionchanged:: 3.3
      See :ref:`above <exception-changed>`.

.. function:: QueryInfoKey(key)

Returns information about a key, as a tuple.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

The result is a tuple of 3 items:

+-------+---------------------------------------------+
   | Index | Meaning                                     |
   +=======+=============================================+
   | ``0`` | An integer giving the number of sub keys    |
   |       | this key has.                               |
   +-------+---------------------------------------------+
   | ``1`` | An integer giving the number of values this |
   |       | key has.                                    |
   +-------+---------------------------------------------+
   | ``2`` | An integer giving when the key was last     |
   |       | modified (if available) as 100's of         |
   |       | nanoseconds since Jan 1, 1601.              |
   +-------+---------------------------------------------+

.. function:: QueryValue(key, sub_key)

Retrieves the unnamed value for a key, as a string.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that holds the name of the subkey with which the value is
   associated.  If this parameter is ``None`` or empty, the function retrieves the
   value set by the :func:`SetValue` method for the key identified by *key*.

Values in the registry have name, type, and data components. This method
   retrieves the data for a key's first value that has a NULL name. But the
   underlying API call doesn't return the type, so always use
   :func:`QueryValueEx` if possible.

.. function:: QueryValueEx(key, value_name)

Retrieves the type and data for a specified value name associated with
   an open registry key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*value_name* is a string indicating the value to query.

The result is a tuple of 2 items:

+-------+-----------------------------------------+
   | Index | Meaning                                 |
   +=======+=========================================+
   | ``0`` | The value of the registry item.         |
   +-------+-----------------------------------------+
   | ``1`` | An integer giving the registry type for |
   |       | this value (see table in docs for       |
   |       | :meth:`SetValueEx`)                     |
   +-------+-----------------------------------------+

.. function:: SaveKey(key, file_name)

Saves the specified key, and all its subkeys to the specified file.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*file_name* is the name of the file to save registry data to.  This file
   cannot already exist. If this filename includes an extension, it cannot be
   used on file allocation table (FAT) file systems by the :meth:`LoadKey`
   method.

If *key* represents a key on a remote computer, the path described by
   *file_name* is relative to the remote computer. The caller of this method must
   possess the :const:`SeBackupPrivilege` security privilege.  Note that
   privileges are different than permissions -- see the
   `Conflicts Between User Rights and Permissions documentation
   <https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__
   for more details.

This function passes NULL for *security_attributes* to the API.

.. function:: SetValue(key, sub_key, type, value)

Associates a value with a specified key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*sub_key* is a string that names the subkey with which the value is associated.

*type* is an integer that specifies the type of the data. Currently this must be
   :const:`REG_SZ`, meaning only strings are supported.  Use the :func:`SetValueEx`
   function for support for other data types.

*value* is a string that specifies the new value.

If the key specified by the *sub_key* parameter does not exist, the SetValue
   function creates it.

Value lengths are limited by available memory. Long values (more than 2048
   bytes) should be stored as files with the filenames stored in the configuration
   registry.  This helps the registry perform efficiently.

The key identified by the *key* parameter must have been opened with
   :const:`KEY_SET_VALUE` access.

.. function:: SetValueEx(key, value_name, reserved, type, value)

Stores data in the value field of an open registry key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

*value_name* is a string that names the subkey with which the value is
   associated.

*reserved* can be anything -- zero is always passed to the API.

*type* is an integer that specifies the type of the data. See
   :ref:`Value Types <value-types>` for the available types.

*value* is a string that specifies the new value.

This method can also set additional value and type information for the specified
   key.  The key identified by the key parameter must have been opened with
   :const:`KEY_SET_VALUE` access.

To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods.

.. function:: DisableReflectionKey(key)

Disables registry reflection for 32-bit processes running on a 64-bit
   operating system.

*key* is an already open key, or one of the predefined :ref:`HKEY_* constants
   <hkey-constants>`.

Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating
   system.

If the key is not on the reflection list, the function succeeds but has no
   effect.  Disabling reflection for a key does not affect reflection of any
   subkeys.

.. function:: EnableReflectionKey(key)

Restores registry reflection for the specified disabled key.

*key* is an already open key, or one of the predefined :ref:`HKEY_* constants
   <hkey-constants>`.

Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating
   system.

Restoring reflection for a key does not affect reflection of any subkeys.

.. function:: QueryReflectionKey(key)

Determines the reflection state for the specified key.

*key* is an already open key, or one of the predefined
   :ref:`HKEY_* constants <hkey-constants>`.

Returns ``True`` if reflection is disabled.

Will generally raise :exc:`NotImplemented` if executed on a 32-bit
   operating system.

.. _constants:

Constants
------------------

The following constants are defined for use in many :mod:`_winreg` functions.

.. _hkey-constants:

HKEY_* Constants
++++++++++++++++

.. data:: HKEY_CLASSES_ROOT

Registry entries subordinate to this key define types (or classes) of
   documents and the properties associated with those types. Shell and
   COM applications use the information stored under this key.

.. data:: HKEY_CURRENT_USER

Registry entries subordinate to this key define the preferences of
   the current user. These preferences include the settings of
   environment variables, data about program groups, colors, printers,
   network connections, and application preferences.

.. data:: HKEY_LOCAL_MACHINE

Registry entries subordinate to this key define the physical state
   of the computer, including data about the bus type, system memory,
   and installed hardware and software.

.. data:: HKEY_USERS

Registry entries subordinate to this key define the default user
   configuration for new users on the local computer and the user
   configuration for the current user.

.. data:: HKEY_PERFORMANCE_DATA

Registry entries subordinate to this key allow you to access
   performance data. The data is not actually stored in the registry;
   the registry functions cause the system to collect the data from
   its source.

.. data:: HKEY_CURRENT_CONFIG

Contains information about the current hardware profile of the
   local computer system.

.. data:: HKEY_DYN_DATA

This key is not used in versions of Windows after 98.

.. _access-rights:

Access Rights
+++++++++++++

For more information, see `Registry Key Security and Access
<https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx>`__.

.. data:: KEY_ALL_ACCESS

Combines the STANDARD_RIGHTS_REQUIRED, :const:`KEY_QUERY_VALUE`,
   :const:`KEY_SET_VALUE`, :const:`KEY_CREATE_SUB_KEY`,
   :const:`KEY_ENUMERATE_SUB_KEYS`, :const:`KEY_NOTIFY`,
   and :const:`KEY_CREATE_LINK` access rights.

.. data:: KEY_WRITE

Combines the STANDARD_RIGHTS_WRITE, :const:`KEY_SET_VALUE`, and
   :const:`KEY_CREATE_SUB_KEY` access rights.

.. data:: KEY_READ

Combines the STANDARD_RIGHTS_READ, :const:`KEY_QUERY_VALUE`,
   :const:`KEY_ENUMERATE_SUB_KEYS`, and :const:`KEY_NOTIFY` values.

.. data:: KEY_EXECUTE

Equivalent to :const:`KEY_READ`.

.. data:: KEY_QUERY_VALUE

Required to query the values of a registry key.

.. data:: KEY_SET_VALUE

Required to create, delete, or set a registry value.

.. data:: KEY_CREATE_SUB_KEY

Required to create a subkey of a registry key.

.. data:: KEY_ENUMERATE_SUB_KEYS

Required to enumerate the subkeys of a registry key.

.. data:: KEY_NOTIFY

Required to request change notifications for a registry key or for
   subkeys of a registry key.

.. data:: KEY_CREATE_LINK

Reserved for system use.

.. _64-bit-access-rights:

64-bit Specific
***************

For more information, see `Accessing an Alternate Registry View
<https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx>`__.

.. data:: KEY_WOW64_64KEY

Indicates that an application on 64-bit Windows should operate on
   the 64-bit registry view.

.. data:: KEY_WOW64_32KEY

Indicates that an application on 64-bit Windows should operate on
   the 32-bit registry view.

.. _value-types:

Value Types
+++++++++++

For more information, see `Registry Value Types
<https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx>`__.

.. data:: REG_BINARY

Binary data in any form.

.. data:: REG_DWORD

32-bit number.

.. data:: REG_DWORD_LITTLE_ENDIAN

A 32-bit number in little-endian format. Equivalent to :const:`REG_DWORD`.

.. data:: REG_DWORD_BIG_ENDIAN

A 32-bit number in big-endian format.

.. data:: REG_EXPAND_SZ

Null-terminated string containing references to environment
   variables (``%PATH%``).

.. data:: REG_LINK

A Unicode symbolic link.

.. data:: REG_MULTI_SZ

A sequence of null-terminated strings, terminated by two null characters.
   (Python handles this termination automatically.)

.. data:: REG_NONE

No defined value type.

.. data:: REG_QWORD

A 64-bit number.

.. versionadded:: 3.6

.. data:: REG_QWORD_LITTLE_ENDIAN

A 64-bit number in little-endian format. Equivalent to :const:`REG_QWORD`.

.. versionadded:: 3.6

.. data:: REG_RESOURCE_LIST

A device-driver resource list.

.. data:: REG_FULL_RESOURCE_DESCRIPTOR

A hardware setting.

.. data:: REG_RESOURCE_REQUIREMENTS_LIST

A hardware resource list.

.. data:: REG_SZ

A null-terminated string.

.. _handle-object:

Registry Handle Objects
-----------------------

This object wraps a Windows HKEY object, automatically closing it when the
object is destroyed.  To guarantee cleanup, you can call either the
:meth:`~PyHKEY.Close` method on the object, or the :func:`CloseKey` function.

All registry functions in this module return one of these objects.

All registry functions in this module which accept a handle object also accept
an integer, however, use of the handle object is encouraged.

Handle objects provide semantics for :meth:`__bool__` -- thus ::

if handle:
       print("Yes")

will print ``Yes`` if the handle is currently valid (has not been closed or
detached).

The object also support comparison semantics, so handle objects will compare
true if they both reference the same underlying Windows handle value.

Handle objects can be converted to an integer (e.g., using the built-in
:func:`int` function), in which case the underlying Windows handle value is
returned.  You can also use the :meth:`~PyHKEY.Detach` method to return the
integer handle, and also disconnect the Windows handle from the handle object.

.. method:: PyHKEY.Close()

Closes the underlying Windows handle.

If the handle is already closed, no error is raised.

.. method:: PyHKEY.Detach()

Detaches the Windows handle from the handle object.

The result is an integer that holds the value of the handle before it is
   detached.  If the handle is already detached or closed, this will return
   zero.

After calling this function, the handle is effectively invalidated, but the
   handle is not closed.  You would call this function when you need the
   underlying Win32 handle to exist beyond the lifetime of the handle object.

.. method:: PyHKEY.__enter__()
            PyHKEY.__exit__(\*exc_info)

The HKEY object implements :meth:`~object.__enter__` and
   :meth:`~object.__exit__` and thus supports the context protocol for the
   :keyword:`with` statement::

with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
          ...  # work with key

will automatically close *key* when control leaves the :keyword:`with` block.

:mod:`winreg` --- Windows registry access ========================================= .. module:: winreg :platform: Windows :synopsis: Routines and objects for manipulating the Windows registry. .. sectionauthor:: Mark Hammond -------------- These functions expose the Windows registry API to Python. Instead of using an integer as the registry handle, a :ref:`handle object ` is used to ensure that the handles are closed correctly, even if the programmer neglects to explicitly close them. .. _exception-changed: .. versionchanged:: 3.3 Several functions in this module used to raise a :exc:`WindowsError`, which is now an alias of :exc:`OSError`. .. _functions: Functions ------------------ This module offers the following functions: .. function:: CloseKey(hkey) Closes a previously opened registry key. The *hkey* argument specifies a previously opened key. .. note:: If *hkey* is not closed using this method (or via :meth:`hkey.Close() `), it is closed when the *hkey* object is destroyed by Python. .. function:: ConnectRegistry(computer_name, key) Establishes a connection to a predefined registry handle on another computer, and returns a :ref:`handle object `. *computer_name* is the name of the remote computer, of the form ``r"\\computername"``. If ``None``, the local computer is used. *key* is the predefined handle to connect to. The return value is the handle of the opened key. If the function fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 See :ref:`above `. .. function:: CreateKey(key, sub_key) Creates or opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that names the key this method opens or creates. If *key* is one of the predefined keys, *sub_key* may be ``None``. In that case, the handle returned is the same key handle passed in to the function. If the key already exists, this function opens the existing key. The return value is the handle of the opened key. If the function fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 See :ref:`above `. .. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE) Creates or opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that names the key this method opens or creates. *reserved* is a reserved integer, and must be zero. The default is zero. *access* is an integer that specifies an access mask that describes the desired security access for the key. Default is :const:`KEY_WRITE`. See :ref:`Access Rights ` for other allowed values. If *key* is one of the predefined keys, *sub_key* may be ``None``. In that case, the handle returned is the same key handle passed in to the function. If the key already exists, this function opens the existing key. The return value is the handle of the opened key. If the function fails, an :exc:`OSError` exception is raised. .. versionadded:: 3.2 .. versionchanged:: 3.3 See :ref:`above `. .. function:: DeleteKey(key, sub_key) Deletes the specified key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that must be a subkey of the key identified by the *key* parameter. This value must not be ``None``, and the key may not have subkeys. *This method can not delete keys with subkeys.* If the method succeeds, the entire key, including all of its values, is removed. If the method fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 See :ref:`above `. .. function:: DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0) Deletes the specified key. .. note:: The :func:`DeleteKeyEx` function is implemented with the RegDeleteKeyEx Windows API function, which is specific to 64-bit versions of Windows. See the `RegDeleteKeyEx documentation `__. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that must be a subkey of the key identified by the *key* parameter. This value must not be ``None``, and the key may not have subkeys. *reserved* is a reserved integer, and must be zero. The default is zero. *access* is an integer that specifies an access mask that describes the desired security access for the key. Default is :const:`KEY_WOW64_64KEY`. See :ref:`Access Rights ` for other allowed values. *This method can not delete keys with subkeys.* If the method succeeds, the entire key, including all of its values, is removed. If the method fails, an :exc:`OSError` exception is raised. On unsupported Windows versions, :exc:`NotImplementedError` is raised. .. versionadded:: 3.2 .. versionchanged:: 3.3 See :ref:`above `. .. function:: DeleteValue(key, value) Removes a named value from a registry key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *value* is a string that identifies the value to remove. .. function:: EnumKey(key, index) Enumerates subkeys of an open registry key, returning a string. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *index* is an integer that identifies the index of the key to retrieve. The function retrieves the name of one subkey each time it is called. It is typically called repeatedly until an :exc:`OSError` exception is raised, indicating, no more values are available. .. versionchanged:: 3.3 See :ref:`above `. .. function:: EnumValue(key, index) Enumerates values of an open registry key, returning a tuple. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *index* is an integer that identifies the index of the value to retrieve. The function retrieves the name of one subkey each time it is called. It is typically called repeatedly, until an :exc:`OSError` exception is raised, indicating no more values. The result is a tuple of 3 items: +-------+--------------------------------------------+ | Index | Meaning | +=======+============================================+ | ``0`` | A string that identifies the value name | +-------+--------------------------------------------+ | ``1`` | An object that holds the value data, and | | | whose type depends on the underlying | | | registry type | +-------+--------------------------------------------+ | ``2`` | An integer that identifies the type of the | | | value data (see table in docs for | | | :meth:`SetValueEx`) | +-------+--------------------------------------------+ .. versionchanged:: 3.3 See :ref:`above `. .. function:: ExpandEnvironmentStrings(str) Expands environment variable placeholders ``%NAME%`` in strings like :const:`REG_EXPAND_SZ`:: >>> ExpandEnvironmentStrings('%windir%') 'C:\\Windows' .. function:: FlushKey(key) Writes all the attributes of a key to the registry. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. It is not necessary to call :func:`FlushKey` to change a key. Registry changes are flushed to disk by the registry using its lazy flusher. Registry changes are also flushed to disk at system shutdown. Unlike :func:`CloseKey`, the :func:`FlushKey` method returns only when all the data has been written to the registry. An application should only call :func:`FlushKey` if it requires absolute certainty that registry changes are on disk. .. note:: If you don't know whether a :func:`FlushKey` call is required, it probably isn't. .. function:: LoadKey(key, sub_key, file_name) Creates a subkey under the specified key and stores registration information from a specified file into that subkey. *key* is a handle returned by :func:`ConnectRegistry` or one of the constants :const:`HKEY_USERS` or :const:`HKEY_LOCAL_MACHINE`. *sub_key* is a string that identifies the subkey to load. *file_name* is the name of the file to load registry data from. This file must have been created with the :func:`SaveKey` function. Under the file allocation table (FAT) file system, the filename may not have an extension. A call to :func:`LoadKey` fails if the calling process does not have the :const:`SE_RESTORE_PRIVILEGE` privilege. Note that privileges are different from permissions -- see the `RegLoadKey documentation `__ for more details. If *key* is a handle returned by :func:`ConnectRegistry`, then the path specified in *file_name* is relative to the remote computer. .. function:: OpenKey(key, sub_key, reserved=0, access=KEY_READ) OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ) Opens the specified key, returning a :ref:`handle object `. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that identifies the sub_key to open. *reserved* is a reserved integer, and must be zero. The default is zero. *access* is an integer that specifies an access mask that describes the desired security access for the key. Default is :const:`KEY_READ`. See :ref:`Access Rights ` for other allowed values. The result is a new handle to the specified key. If the function fails, :exc:`OSError` is raised. .. versionchanged:: 3.2 Allow the use of named arguments. .. versionchanged:: 3.3 See :ref:`above `. .. function:: QueryInfoKey(key) Returns information about a key, as a tuple. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. The result is a tuple of 3 items: +-------+---------------------------------------------+ | Index | Meaning | +=======+=============================================+ | ``0`` | An integer giving the number of sub keys | | | this key has. | +-------+---------------------------------------------+ | ``1`` | An integer giving the number of values this | | | key has. | +-------+---------------------------------------------+ | ``2`` | An integer giving when the key was last | | | modified (if available) as 100's of | | | nanoseconds since Jan 1, 1601. | +-------+---------------------------------------------+ .. function:: QueryValue(key, sub_key) Retrieves the unnamed value for a key, as a string. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that holds the name of the subkey with which the value is associated. If this parameter is ``None`` or empty, the function retrieves the value set by the :func:`SetValue` method for the key identified by *key*. Values in the registry have name, type, and data components. This method retrieves the data for a key's first value that has a NULL name. But the underlying API call doesn't return the type, so always use :func:`QueryValueEx` if possible. .. function:: QueryValueEx(key, value_name) Retrieves the type and data for a specified value name associated with an open registry key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *value_name* is a string indicating the value to query. The result is a tuple of 2 items: +-------+-----------------------------------------+ | Index | Meaning | +=======+=========================================+ | ``0`` | The value of the registry item. | +-------+-----------------------------------------+ | ``1`` | An integer giving the registry type for | | | this value (see table in docs for | | | :meth:`SetValueEx`) | +-------+-----------------------------------------+ .. function:: SaveKey(key, file_name) Saves the specified key, and all its subkeys to the specified file. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *file_name* is the name of the file to save registry data to. This file cannot already exist. If this filename includes an extension, it cannot be used on file allocation table (FAT) file systems by the :meth:`LoadKey` method. If *key* represents a key on a remote computer, the path described by *file_name* is relative to the remote computer. The caller of this method must possess the :const:`SeBackupPrivilege` security privilege. Note that privileges are different than permissions -- see the `Conflicts Between User Rights and Permissions documentation `__ for more details. This function passes NULL for *security_attributes* to the API. .. function:: SetValue(key, sub_key, type, value) Associates a value with a specified key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *sub_key* is a string that names the subkey with which the value is associated. *type* is an integer that specifies the type of the data. Currently this must be :const:`REG_SZ`, meaning only strings are supported. Use the :func:`SetValueEx` function for support for other data types. *value* is a string that specifies the new value. If the key specified by the *sub_key* parameter does not exist, the SetValue function creates it. Value lengths are limited by available memory. Long values (more than 2048 bytes) should be stored as files with the filenames stored in the configuration registry. This helps the registry perform efficiently. The key identified by the *key* parameter must have been opened with :const:`KEY_SET_VALUE` access. .. function:: SetValueEx(key, value_name, reserved, type, value) Stores data in the value field of an open registry key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. *value_name* is a string that names the subkey with which the value is associated. *reserved* can be anything -- zero is always passed to the API. *type* is an integer that specifies the type of the data. See :ref:`Value Types ` for the available types. *value* is a string that specifies the new value. This method can also set additional value and type information for the specified key. The key identified by the key parameter must have been opened with :const:`KEY_SET_VALUE` access. To open the key, use the :func:`CreateKey` or :func:`OpenKey` methods. Value lengths are limited by available memory. Long values (more than 2048 bytes) should be stored as files with the filenames stored in the configuration registry. This helps the registry perform efficiently. .. function:: DisableReflectionKey(key) Disables registry reflection for 32-bit processes running on a 64-bit operating system. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. If the key is not on the reflection list, the function succeeds but has no effect. Disabling reflection for a key does not affect reflection of any subkeys. .. function:: EnableReflectionKey(key) Restores registry reflection for the specified disabled key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. Restoring reflection for a key does not affect reflection of any subkeys. .. function:: QueryReflectionKey(key) Determines the reflection state for the specified key. *key* is an already open key, or one of the predefined :ref:`HKEY_* constants `. Returns ``True`` if reflection is disabled. Will generally raise :exc:`NotImplemented` if executed on a 32-bit operating system. .. _constants: Constants ------------------ The following constants are defined for use in many :mod:`_winreg` functions. .. _hkey-constants: HKEY_* Constants ++++++++++++++++ .. data:: HKEY_CLASSES_ROOT Registry entries subordinate to this key define types (or classes) of documents and the properties associated with those types. Shell and COM applications use the information stored under this key. .. data:: HKEY_CURRENT_USER Registry entries subordinate to this key define the preferences of the current user. These preferences include the settings of environment variables, data about program groups, colors, printers, network connections, and application preferences. .. data:: HKEY_LOCAL_MACHINE Registry entries subordinate to this key define the physical state of the computer, including data about the bus type, system memory, and installed hardware and software. .. data:: HKEY_USERS Registry entries subordinate to this key define the default user configuration for new users on the local computer and the user configuration for the current user. .. data:: HKEY_PERFORMANCE_DATA Registry entries subordinate to this key allow you to access performance data. The data is not actually stored in the registry; the registry functions cause the system to collect the data from its source. .. data:: HKEY_CURRENT_CONFIG Contains information about the current hardware profile of the local computer system. .. data:: HKEY_DYN_DATA This key is not used in versions of Windows after 98. .. _access-rights: Access Rights +++++++++++++ For more information, see `Registry Key Security and Access `__. .. data:: KEY_ALL_ACCESS Combines the STANDARD_RIGHTS_REQUIRED, :const:`KEY_QUERY_VALUE`, :const:`KEY_SET_VALUE`, :const:`KEY_CREATE_SUB_KEY`, :const:`KEY_ENUMERATE_SUB_KEYS`, :const:`KEY_NOTIFY`, and :const:`KEY_CREATE_LINK` access rights. .. data:: KEY_WRITE Combines the STANDARD_RIGHTS_WRITE, :const:`KEY_SET_VALUE`, and :const:`KEY_CREATE_SUB_KEY` access rights. .. data:: KEY_READ Combines the STANDARD_RIGHTS_READ, :const:`KEY_QUERY_VALUE`, :const:`KEY_ENUMERATE_SUB_KEYS`, and :const:`KEY_NOTIFY` values. .. data:: KEY_EXECUTE Equivalent to :const:`KEY_READ`. .. data:: KEY_QUERY_VALUE Required to query the values of a registry key. .. data:: KEY_SET_VALUE Required to create, delete, or set a registry value. .. data:: KEY_CREATE_SUB_KEY Required to create a subkey of a registry key. .. data:: KEY_ENUMERATE_SUB_KEYS Required to enumerate the subkeys of a registry key. .. data:: KEY_NOTIFY Required to request change notifications for a registry key or for subkeys of a registry key. .. data:: KEY_CREATE_LINK Reserved for system use. .. _64-bit-access-rights: 64-bit Specific *************** For more information, see `Accessing an Alternate Registry View `__. .. data:: KEY_WOW64_64KEY Indicates that an application on 64-bit Windows should operate on the 64-bit registry view. .. data:: KEY_WOW64_32KEY Indicates that an application on 64-bit Windows should operate on the 32-bit registry view. .. _value-types: Value Types +++++++++++ For more information, see `Registry Value Types `__. .. data:: REG_BINARY Binary data in any form. .. data:: REG_DWORD 32-bit number. .. data:: REG_DWORD_LITTLE_ENDIAN A 32-bit number in little-endian format. Equivalent to :const:`REG_DWORD`. .. data:: REG_DWORD_BIG_ENDIAN A 32-bit number in big-endian format. .. data:: REG_EXPAND_SZ Null-terminated string containing references to environment variables (``%PATH%``). .. data:: REG_LINK A Unicode symbolic link. .. data:: REG_MULTI_SZ A sequence of null-terminated strings, terminated by two null characters. (Python handles this termination automatically.) .. data:: REG_NONE No defined value type. .. data:: REG_QWORD A 64-bit number. .. versionadded:: 3.6 .. data:: REG_QWORD_LITTLE_ENDIAN A 64-bit number in little-endian format. Equivalent to :const:`REG_QWORD`. .. versionadded:: 3.6 .. data:: REG_RESOURCE_LIST A device-driver resource list. .. data:: REG_FULL_RESOURCE_DESCRIPTOR A hardware setting. .. data:: REG_RESOURCE_REQUIREMENTS_LIST A hardware resource list. .. data:: REG_SZ A null-terminated string. .. _handle-object: Registry Handle Objects ----------------------- This object wraps a Windows HKEY object, automatically closing it when the object is destroyed. To guarantee cleanup, you can call either the :meth:`~PyHKEY.Close` method on the object, or the :func:`CloseKey` function. All registry functions in this module return one of these objects. All registry functions in this module which accept a handle object also accept an integer, however, use of the handle object is encouraged. Handle objects provide semantics for :meth:`__bool__` -- thus :: if handle: print("Yes") will print ``Yes`` if the handle is currently valid (has not been closed or detached). The object also support comparison semantics, so handle objects will compare true if they both reference the same underlying Windows handle value. Handle objects can be converted to an integer (e.g., using the built-in :func:`int` function), in which case the underlying Windows handle value is returned. You can also use the :meth:`~PyHKEY.Detach` method to return the integer handle, and also disconnect the Windows handle from the handle object. .. method:: PyHKEY.Close() Closes the underlying Windows handle. If the handle is already closed, no error is raised. .. method:: PyHKEY.Detach() Detaches the Windows handle from the handle object. The result is an integer that holds the value of the handle before it is detached. If the handle is already detached or closed, this will return zero. After calling this function, the handle is effectively invalidated, but the handle is not closed. You would call this function when you need the underlying Win32 handle to exist beyond the lifetime of the handle object. .. method:: PyHKEY.__enter__() PyHKEY.__exit__(\*exc_info) The HKEY object implements :meth:`~object.__enter__` and :meth:`~object.__exit__` and thus supports the context protocol for the :keyword:`with` statement:: with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: ... # work with key will automatically close *key* when control leaves the :keyword:`with` block.