Skip to content

Commit 7321eaf

Browse files
authored
fix type hints to inline annotations (enthought#453)
1 parent 6732c26 commit 7321eaf

File tree

1 file changed

+66
-50
lines changed

1 file changed

+66
-50
lines changed

comtypes/__init__.py

Lines changed: 66 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -891,21 +891,18 @@ def QueryService(self, serviceIID, interface):
891891

892892
################################################################
893893

894-
if TYPE_CHECKING:
895894

896-
@overload
897-
def CoGetObject(displayname, interface): # `interface` can't be missing
898-
# type: (str, None) -> IUnknown
899-
pass
895+
@overload
896+
def CoGetObject(displayname: str, interface: None) -> IUnknown:
897+
...
900898

901-
@overload
902-
def CoGetObject(displayname, interface): # it should be called this way
903-
# type: (str, Type[_T_IUnknown]) -> _T_IUnknown
904-
pass
899+
900+
@overload
901+
def CoGetObject(displayname: str, interface: Type[_T_IUnknown]) -> _T_IUnknown:
902+
...
905903

906904

907-
def CoGetObject(displayname, interface):
908-
# type: (str, Optional[Type[IUnknown]]) -> IUnknown
905+
def CoGetObject(displayname: str, interface: Optional[Type[IUnknown]]) -> IUnknown:
909906
"""Convert a displayname to a moniker, then bind and return the object
910907
identified by the moniker."""
911908
if interface is None:
@@ -916,22 +913,35 @@ def CoGetObject(displayname, interface):
916913
return punk # type: ignore
917914

918915

919-
if TYPE_CHECKING:
920-
pUnkOuter = Type[_Pointer[IUnknown]]
916+
_pUnkOuter = Type["_Pointer[IUnknown]"]
921917

922-
@overload
923-
def CoCreateInstance(clsid, interface=None, clsctx=None, punkouter=None):
924-
# type: (GUID, None, Optional[int], Optional[pUnkOuter]) -> IUnknown
925-
pass
926918

927-
@overload
928-
def CoCreateInstance(clsid, interface, clsctx=None, punkouter=None):
929-
# type: (GUID, Type[_T_IUnknown], Optional[int], Optional[pUnkOuter]) -> _T_IUnknown
930-
pass
919+
@overload
920+
def CoCreateInstance(
921+
clsid: GUID,
922+
interface: None = None,
923+
clsctx: Optional[int] = None,
924+
punkouter: Optional[_pUnkOuter] = None,
925+
) -> IUnknown:
926+
...
931927

932928

933-
def CoCreateInstance(clsid, interface=None, clsctx=None, punkouter=None):
934-
# type: (GUID, Optional[Type[IUnknown]], Optional[int], Optional[pUnkOuter]) -> IUnknown
929+
@overload
930+
def CoCreateInstance(
931+
clsid: GUID,
932+
interface: Type[_T_IUnknown],
933+
clsctx: Optional[int] = None,
934+
punkouter: Optional[_pUnkOuter] = None,
935+
) -> _T_IUnknown:
936+
...
937+
938+
939+
def CoCreateInstance(
940+
clsid: GUID,
941+
interface: Optional[Type[IUnknown]] = None,
942+
clsctx: Optional[int] = None,
943+
punkouter: Optional[_pUnkOuter] = None,
944+
) -> IUnknown:
935945
"""The basic windows api to create a COM class object and return a
936946
pointer to an interface.
937947
"""
@@ -971,21 +981,19 @@ def CoGetClassObject(clsid, clsctx=None, pServerInfo=None, interface=None):
971981
return p # type: ignore
972982

973983

974-
if TYPE_CHECKING:
984+
@overload
985+
def GetActiveObject(clsid: GUID, interface: None = None) -> IUnknown:
986+
...
975987

976-
@overload
977-
def GetActiveObject(clsid, interface=None):
978-
# type: (GUID, None) -> IUnknown
979-
pass
980988

981-
@overload
982-
def GetActiveObject(clsid, interface):
983-
# type: (GUID, Type[_T_IUnknown]) -> _T_IUnknown
984-
pass
989+
@overload
990+
def GetActiveObject(clsid: GUID, interface: Type[_T_IUnknown]) -> _T_IUnknown:
991+
...
985992

986993

987-
def GetActiveObject(clsid, interface=None):
988-
# type: (GUID, Optional[Type[IUnknown]]) -> IUnknown
994+
def GetActiveObject(
995+
clsid: GUID, interface: Optional[Type[IUnknown]] = None
996+
) -> IUnknown:
989997
"""Retrieves a pointer to a running object"""
990998
p = POINTER(IUnknown)()
991999
oledll.oleaut32.GetActiveObject(byref(clsid), None, byref(p))
@@ -1124,27 +1132,35 @@ class _SOLE_AUTHENTICATION_LIST(Structure):
11241132
SOLE_AUTHENTICATION_LIST = _SOLE_AUTHENTICATION_LIST
11251133

11261134

1127-
if TYPE_CHECKING:
1135+
@overload
1136+
def CoCreateInstanceEx(
1137+
clsid: GUID,
1138+
interface: None = None,
1139+
clsctx: Optional[int] = None,
1140+
machine: Optional[str] = None,
1141+
pServerInfo: Optional[COSERVERINFO] = None,
1142+
) -> IUnknown:
1143+
...
11281144

1129-
@overload
1130-
def CoCreateInstanceEx(
1131-
clsid, interface=None, clsctx=None, machine=None, pServerInfo=None
1132-
):
1133-
# type: (GUID, None, Optional[int], Optional[str], Optional[COSERVERINFO]) -> IUnknown
1134-
pass
11351145

1136-
@overload
1137-
def CoCreateInstanceEx(
1138-
clsid, interface=None, clsctx=None, machine=None, pServerInfo=None
1139-
):
1140-
# type: (GUID, Type[_T_IUnknown], Optional[int], Optional[str], Optional[COSERVERINFO]) -> _T_IUnknown
1141-
pass
1146+
@overload
1147+
def CoCreateInstanceEx(
1148+
clsid: GUID,
1149+
interface: Type[_T_IUnknown],
1150+
clsctx: Optional[int] = None,
1151+
machine: Optional[str] = None,
1152+
pServerInfo: Optional[COSERVERINFO] = None,
1153+
) -> _T_IUnknown:
1154+
...
11421155

11431156

11441157
def CoCreateInstanceEx(
1145-
clsid, interface=None, clsctx=None, machine=None, pServerInfo=None
1146-
):
1147-
# type: (GUID, Optional[Type[IUnknown]], Optional[int], Optional[str], Optional[COSERVERINFO]) -> IUnknown
1158+
clsid: GUID,
1159+
interface: Optional[Type[IUnknown]] = None,
1160+
clsctx: Optional[int] = None,
1161+
machine: Optional[str] = None,
1162+
pServerInfo: Optional[COSERVERINFO] = None,
1163+
) -> IUnknown:
11481164
"""The basic windows api to create a COM class object and return a
11491165
pointer to an interface, possibly on another machine.
11501166

0 commit comments

Comments
 (0)