diff --git a/Doc/library/winreg.rst b/Doc/library/winreg.rst --- a/Doc/library/winreg.rst +++ b/Doc/library/winreg.rst @@ -12,6 +12,18 @@ 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: @@ -37,12 +49,11 @@ *key* is the predefined handle to connect to. - The return value is the handle of the opened key. If the function fails, a + The return value is the handle of the opened key. If the function fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: CreateKey(key, sub_key) @@ -60,12 +71,11 @@ 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, a + The return value is the handle of the opened key. If the function fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE) @@ -89,14 +99,13 @@ 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, a + 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 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: DeleteKey(key, sub_key) @@ -112,11 +121,10 @@ *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, a :exc:`OSError` exception is raised. + If the method fails, an :exc:`OSError` exception is raised. .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0) @@ -145,15 +153,14 @@ *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, a :exc:`OSError` exception is raised. + 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 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: DeleteValue(key, value) @@ -176,12 +183,11 @@ *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 a :exc:`OSError` exception is + typically called repeatedly until an :exc:`OSError` exception is raised, indicating, no more values are available. .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: EnumValue(key, index) @@ -194,7 +200,7 @@ *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 a :exc:`OSError` exception is + typically called repeatedly, until an :exc:`OSError` exception is raised, indicating no more values. The result is a tuple of 3 items: @@ -214,8 +220,7 @@ +-------+--------------------------------------------+ .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: ExpandEnvironmentStrings(str) @@ -295,8 +300,7 @@ Allow the use of named arguments. .. versionchanged:: 3.3 - This function used to raise a :exc:`WindowsError`, which is now an - alias of :exc:`OSError`. + See :ref:`above `. .. function:: QueryInfoKey(key) diff --git a/PC/winreg.c b/PC/winreg.c --- a/PC/winreg.c +++ b/PC/winreg.c @@ -89,7 +89,7 @@ "key is the predefined handle to connect to.\n" "\n" "The return value is the handle of the opened key.\n" -"If the function fails, a WindowsError exception is raised."); +"If the function fails, an OSError exception is raised."); PyDoc_STRVAR(CreateKey_doc, "CreateKey(key, sub_key) -> key\n" @@ -104,7 +104,7 @@ "If the key already exists, this function opens the existing key.\n" "\n" "The return value is the handle of the opened key.\n" -"If the function fails, a WindowsError exception is raised."); +"If the function fails, an OSError exception is raised."); PyDoc_STRVAR(CreateKeyEx_doc, "CreateKeyEx(key, sub_key, reserved=0, access=KEY_WRITE) -> key\n" @@ -122,7 +122,7 @@ "If the key already exists, this function opens the existing key\n" "\n" "The return value is the handle of the opened key.\n" -"If the function fails, a WindowsError exception is raised."); +"If the function fails, an OSError exception is raised."); PyDoc_STRVAR(DeleteKey_doc, "DeleteKey(key, sub_key)\n" @@ -136,7 +136,7 @@ "This method can not delete keys with subkeys.\n" "\n" "If the function succeeds, the entire key, including all of its values,\n" -"is removed. If the function fails, a WindowsError exception is raised."); +"is removed. If the function fails, an OSError exception is raised."); PyDoc_STRVAR(DeleteKeyEx_doc, "DeleteKeyEx(key, sub_key, access=KEY_WOW64_64KEY, reserved=0)\n" @@ -153,7 +153,7 @@ "This method can not delete keys with subkeys.\n" "\n" "If the function succeeds, the entire key, including all of its values,\n" -"is removed. If the function fails, a WindowsError exception is raised.\n" +"is removed. If the function fails, an OSError exception is raised.\n" "On unsupported Windows versions, NotImplementedError is raised."); PyDoc_STRVAR(DeleteValue_doc, @@ -171,7 +171,7 @@ "index is an integer that identifies the index of the key to retrieve.\n" "\n" "The function retrieves the name of one subkey each time it is called.\n" -"It is typically called repeatedly until a WindowsError exception is\n" +"It is typically called repeatedly until an OSError exception is\n" "raised, indicating no more values are available."); PyDoc_STRVAR(EnumValue_doc, @@ -181,7 +181,7 @@ "index is an integer that identifies the index of the value to retrieve.\n" "\n" "The function retrieves the name of one subkey each time it is called.\n" -"It is typically called repeatedly, until a WindowsError exception\n" +"It is typically called repeatedly, until an OSError exception\n" "is raised, indicating no more values.\n" "\n" "The result is a tuple of 3 items:\n" @@ -240,7 +240,7 @@ " security access for the key. Default is KEY_READ\n" "\n" "The result is a new handle to the specified key\n" -"If the function fails, a WindowsError exception is raised."); +"If the function fails, an OSError exception is raised."); PyDoc_STRVAR(OpenKeyEx_doc, "See OpenKey()");