Add winreg stubs (#3794)

stdlib/2/_winreg.pyi

@@ -0,0 +1,99 @@
+
+import sys
+
+from typing import Optional, Type, Union, Tuple, Any
+from types import TracebackType
+
+_KeyType = Union[HKEYType, int]
+
+def CloseKey(hkey: _KeyType): ...
+def ConnectRegistry(computer_name: Optional[str], key: _KeyType) -> HKEYType: ...
+def CreateKey(key: _KeyType, sub_key: Optional[str]) -> HKEYType: ...
+def CreateKeyEx(key: _KeyType, sub_key: Optional[str], reserved: int = ..., access: int = ...) -> HKEYType: ...
+def DeleteKey(key: _KeyType, sub_key: str) -> None: ...
+def DeleteKeyEx(key: _KeyType, sub_key: str, access: int = ..., reserved: int = ...) -> None: ...
+def DeleteValue(key: _KeyType, value: str) -> None: ...
+def EnumKey(key: _KeyType, index: int) -> str: ...
+def EnumValue(key: _KeyType, index: int) -> Tuple[str, Any, int]: ...
+def ExpandEnvironmentStrings(str: str) -> str: ...
+def FlushKey(key: _KeyType) -> None: ...
+def LoadKey(key: _KeyType, sub_key: str, file_name: str) -> None: ...
+def OpenKey(key: _KeyType, sub_key: str, reserved: int = ..., access: int = ...) -> HKEYType: ...
+def OpenKeyEx(key: _KeyType, sub_key: str, reserved: int = ..., access: int = ...) -> HKEYType: ...
+def QueryInfoKey(key: _KeyType) -> Tuple[int, int, int]: ...
+def QueryValue(key: _KeyType, sub_key: Optional[str]) -> str: ...
+def QueryValueEx(key: _KeyType, value_name: str) -> Tuple[Any, int]: ...
+def SaveKey(key: _KeyType, file_name: str) -> None: ...
+def SetValue(key: _KeyType, sub_key: str, type: int, value: str) -> None: ...
+def SetValueEx(key: _KeyType, value_name: str, reserved: Any, type: int, value: str) -> None: ...  # reserved is ignored
+def DisableReflectionKey(key: _KeyType) -> None: ...
+def EnableReflectionKey(key: _KeyType) -> None: ...
+def QueryReflectionKey(key: _KeyType) -> bool: ...
+
+HKEY_CLASSES_ROOT: int
+HKEY_CURRENT_USER: int
+HKEY_LOCAL_MACHINE: int
+HKEY_USERS: int
+HKEY_PERFORMANCE_DATA: int
+HKEY_CURRENT_CONFIG: int
+HKEY_DYN_DATA: int
+
+KEY_ALL_ACCESS: int
+KEY_WRITE: int
+KEY_READ: int
+KEY_EXECUTE: int
+KEY_QUERY_VALUE: int
+KEY_SET_VALUE: int
+KEY_CREATE_SUB_KEY: int
+KEY_ENUMERATE_SUB_KEYS: int
+KEY_NOTIFY: int
+KEY_CREATE_LINK: int
+
+KEY_WOW64_64KEY: int
+KEY_WOW64_32KEY: int
+
+REG_BINARY: int
+REG_DWORD: int
+REG_DWORD_LITTLE_ENDIAN: int
+REG_DWORD_BIG_ENDIAN: int
+REG_EXPAND_SZ: int
+REG_LINK: int
+REG_MULTI_SZ: int
+REG_NONE: int
+if sys.version_info >= (3, 6):
+    REG_QWORD: int
+    REG_QWORD_LITTLE_ENDIAN: int
+REG_RESOURCE_LIST: int
+REG_FULL_RESOURCE_DESCRIPTOR: int
+REG_RESOURCE_REQUIREMENTS_LIST: int
+REG_SZ: int
+
+REG_CREATED_NEW_KEY: int  # undocumented
+REG_LEGAL_CHANGE_FILTER: int  # undocumented
+REG_LEGAL_OPTION: int  # undocumented
+REG_NOTIFY_CHANGE_ATTRIBUTES: int  # undocumented
+REG_NOTIFY_CHANGE_LAST_SET: int  # undocumented
+REG_NOTIFY_CHANGE_NAME: int  # undocumented
+REG_NOTIFY_CHANGE_SECURITY: int  # undocumented
+REG_NO_LAZY_FLUSH: int  # undocumented
+REG_OPENED_EXISTING_KEY: int  # undocumented
+REG_OPTION_BACKUP_RESTORE: int  # undocumented
+REG_OPTION_CREATE_LINK: int  # undocumented
+REG_OPTION_NON_VOLATILE: int  # undocumented
+REG_OPTION_OPEN_LINK: int  # undocumented
+REG_OPTION_RESERVED: int  # undocumented
+REG_OPTION_VOLATILE: int  # undocumented
+REG_REFRESH_HIVE: int  # undocumented
+REG_WHOLE_HIVE_VOLATILE: int  # undocumented
+
+error = OSError
+
+# Though this class has a __name__ of PyHKEY, it's exposed as HKEYType for some reason
+class HKEYType:
+    def __bool__(self) -> bool: ...
+    def __int__(self) -> int: ...
+    def __enter__(self) -> HKEYType: ...
+    def __exit__(self, exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType]) -> Optional[bool]: ...
+
+    def Close(self) -> None: ...
+    def Detach(self) -> int: ...

stdlib/3/winreg.pyi

@@ -0,0 +1,99 @@
+
+import sys
+
+from typing import Optional, Type, Union, Tuple, Any
+from types import TracebackType
+
+_KeyType = Union[HKEYType, int]
+
+def CloseKey(hkey: _KeyType): ...
+def ConnectRegistry(computer_name: Optional[str], key: _KeyType) -> HKEYType: ...
+def CreateKey(key: _KeyType, sub_key: Optional[str]) -> HKEYType: ...
+def CreateKeyEx(key: _KeyType, sub_key: Optional[str], reserved: int = ..., access: int = ...) -> HKEYType: ...
+def DeleteKey(key: _KeyType, sub_key: str) -> None: ...
+def DeleteKeyEx(key: _KeyType, sub_key: str, access: int = ..., reserved: int = ...) -> None: ...
+def DeleteValue(key: _KeyType, value: str) -> None: ...
+def EnumKey(key: _KeyType, index: int) -> str: ...
+def EnumValue(key: _KeyType, index: int) -> Tuple[str, Any, int]: ...
+def ExpandEnvironmentStrings(str: str) -> str: ...
+def FlushKey(key: _KeyType) -> None: ...
+def LoadKey(key: _KeyType, sub_key: str, file_name: str) -> None: ...
+def OpenKey(key: _KeyType, sub_key: str, reserved: int = ..., access: int = ...) -> HKEYType: ...
+def OpenKeyEx(key: _KeyType, sub_key: str, reserved: int = ..., access: int = ...) -> HKEYType: ...
+def QueryInfoKey(key: _KeyType) -> Tuple[int, int, int]: ...
+def QueryValue(key: _KeyType, sub_key: Optional[str]) -> str: ...
+def QueryValueEx(key: _KeyType, value_name: str) -> Tuple[Any, int]: ...
+def SaveKey(key: _KeyType, file_name: str) -> None: ...
+def SetValue(key: _KeyType, sub_key: str, type: int, value: str) -> None: ...
+def SetValueEx(key: _KeyType, value_name: str, reserved: Any, type: int, value: str) -> None: ...  # reserved is ignored
+def DisableReflectionKey(key: _KeyType) -> None: ...
+def EnableReflectionKey(key: _KeyType) -> None: ...
+def QueryReflectionKey(key: _KeyType) -> bool: ...
+
+HKEY_CLASSES_ROOT: int
+HKEY_CURRENT_USER: int
+HKEY_LOCAL_MACHINE: int
+HKEY_USERS: int
+HKEY_PERFORMANCE_DATA: int
+HKEY_CURRENT_CONFIG: int
+HKEY_DYN_DATA: int
+
+KEY_ALL_ACCESS: int
+KEY_WRITE: int
+KEY_READ: int
+KEY_EXECUTE: int
+KEY_QUERY_VALUE: int
+KEY_SET_VALUE: int
+KEY_CREATE_SUB_KEY: int
+KEY_ENUMERATE_SUB_KEYS: int
+KEY_NOTIFY: int
+KEY_CREATE_LINK: int
+
+KEY_WOW64_64KEY: int
+KEY_WOW64_32KEY: int
+
+REG_BINARY: int
+REG_DWORD: int
+REG_DWORD_LITTLE_ENDIAN: int
+REG_DWORD_BIG_ENDIAN: int
+REG_EXPAND_SZ: int
+REG_LINK: int
+REG_MULTI_SZ: int
+REG_NONE: int
+if sys.version_info >= (3, 6):
+    REG_QWORD: int
+    REG_QWORD_LITTLE_ENDIAN: int
+REG_RESOURCE_LIST: int
+REG_FULL_RESOURCE_DESCRIPTOR: int
+REG_RESOURCE_REQUIREMENTS_LIST: int
+REG_SZ: int
+
+REG_CREATED_NEW_KEY: int  # undocumented
+REG_LEGAL_CHANGE_FILTER: int  # undocumented
+REG_LEGAL_OPTION: int  # undocumented
+REG_NOTIFY_CHANGE_ATTRIBUTES: int  # undocumented
+REG_NOTIFY_CHANGE_LAST_SET: int  # undocumented
+REG_NOTIFY_CHANGE_NAME: int  # undocumented
+REG_NOTIFY_CHANGE_SECURITY: int  # undocumented
+REG_NO_LAZY_FLUSH: int  # undocumented
+REG_OPENED_EXISTING_KEY: int  # undocumented
+REG_OPTION_BACKUP_RESTORE: int  # undocumented
+REG_OPTION_CREATE_LINK: int  # undocumented
+REG_OPTION_NON_VOLATILE: int  # undocumented
+REG_OPTION_OPEN_LINK: int  # undocumented
+REG_OPTION_RESERVED: int  # undocumented
+REG_OPTION_VOLATILE: int  # undocumented
+REG_REFRESH_HIVE: int  # undocumented
+REG_WHOLE_HIVE_VOLATILE: int  # undocumented
+
+error = OSError
+
+# Though this class has a __name__ of PyHKEY, it's exposed as HKEYType for some reason
+class HKEYType:
+    def __bool__(self) -> bool: ...
+    def __int__(self) -> int: ...
+    def __enter__(self) -> HKEYType: ...
+    def __exit__(self, exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType]) -> Optional[bool]: ...
+
+    def Close(self) -> None: ...
+    def Detach(self) -> int: ...

tests/check_consistent.py

@@ -28,7 +28,8 @@ consistent_files = [
     {'stdlib/3.7/contextvars.pyi', 'third_party/3/contextvars.pyi'},
     {'stdlib/3/ipaddress.pyi', 'third_party/2/ipaddress.pyi'},
     {'stdlib/2/copy_reg.pyi', 'stdlib/3/copyreg.pyi'},
-    {'stdlib/2and3/threading.pyi', 'stdlib/2and3/_dummy_threading.pyi'}
+    {'stdlib/2and3/threading.pyi', 'stdlib/2and3/_dummy_threading.pyi'},
+    {'stdlib/3/winreg.pyi', 'stdlib/2/_winreg.pyi'}
 ]
 
 

tests/stubtest_whitelists/py3_common.txt

@@ -638,4 +638,5 @@ socket.[A-Z0-9_]+
 (_winapi)?
 (msilib(.[a-z]+)?)?
 (msvcrt)?
+(winreg)?
 (winsound)?