Deprecate options in CreateKey too

Author: aisk

Doc/library/winreg.rst

@@ -315,7 +315,11 @@ This module offers the following functions:
 
    *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.
+   *reserved* is a reserved integer and should be zero.  If it is not zero,
+   it will be treated as the options parameter in :func:`OpenKeyEx`.
+   You should use the :func:`OpenKeyEx` directly instead in this case,
+   this parameter is only included for compatibility reasons.
+   The default value 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
@@ -335,6 +339,10 @@ This module offers the following functions:
    .. versionchanged:: 3.3
       See :ref:`above <exception-changed>`.
 
+   .. deprecated-removed:: 3.14 3.16
+      *reserved* is deprecated and will be removed in the future.
+      Please use :func:`OpenKeyEx` instead.
+
 .. function:: OpenKeyEx(key, sub_key, options=0, access=KEY_READ, reserved=0)
 
    Opens the specified key, returning a :ref:`handle object <handle-object>`.

Lib/test/test_winreg.py

@@ -242,6 +242,11 @@ def test_registry_works_with_options(self):
                                                   reserved=REG_OPTION_VOLATILE)
             self._read_test_data(HKEY_CURRENT_USER, OpenKey=okeo)
 
+        with self.assertWarns(DeprecationWarning):
+            ok = lambda key, sub_key: OpenKey(key, sub_key,
+                                                reserved=REG_OPTION_VOLATILE)
+            self._read_test_data(HKEY_CURRENT_USER, OpenKey=ok)
+
         self._delete_test_data(HKEY_CURRENT_USER)
 
     def test_create_only(self):

PC/clinic/winreg.c.h

@@ -18,6 +18,7 @@
 
 #include <windows.h>
 
+#define MS_WINDOWS_GAMES  // TODO(aisk): DELETE THIS
 #if defined(MS_WINDOWS_DESKTOP) || defined(MS_WINDOWS_SYSTEM) || defined(MS_WINDOWS_GAMES)
 
 typedef struct {
@@ -1411,7 +1412,9 @@ winreg.OpenKey -> HKEY
     sub_key: Py_UNICODE(accept={str, NoneType})
         A string that identifies the sub_key to open.
     reserved: int = 0
-        A reserved integer that must be zero. Default is zero.
+        A reserved integer that be should zero.  If it is not zero,
+        it will be used as the options parameter in OpenKeyEx.
+        You should use OpenKeyEx directly in this case.
     access: REGSAM(c_default='KEY_READ') = winreg.KEY_READ
         An integer that specifies an access mask that describes the desired
         security access for the key.  Default is KEY_READ.
@@ -1425,9 +1428,9 @@ If the function fails, an OSError exception is raised.
 static HKEY
 winreg_OpenKey_impl(PyObject *module, HKEY key, const wchar_t *sub_key,
                     int reserved, REGSAM access)
-/*[clinic end generated code: output=5efbad23b3ffe2e7 input=a2fb7586bbed3b01]*/
+/*[clinic end generated code: output=5efbad23b3ffe2e7 input=8bafb91546317c8e]*/
 {
-    return winreg_OpenKeyEx_impl(module, key, sub_key, reserved, access, 0);
+    return winreg_OpenKeyEx_impl(module, key, sub_key, 0, access, reserved);
 }
 
 /*[clinic input]