comtypes 1.4.7__zip → 1.4.9__zip

comtypes-1.4.9/comtypes/_vtbl.py

@@ -0,0 +1,448 @@
+import logging
+from _ctypes import COMError
+from ctypes import WINFUNCTYPE, Structure, c_void_p
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Dict,
+    Iterator,
+    List,
+    Optional,
+    Sequence,
+    Tuple,
+    Type,
+)
+from typing import Union as _UnionT
+
+import comtypes
+from comtypes import GUID, IUnknown, hresult
+from comtypes._memberspec import _encode_idl
+from comtypes.errorinfo import ReportError, ReportException
+
+if TYPE_CHECKING:
+    from ctypes import _FuncPointer
+
+    from comtypes import hints  # type: ignore
+    from comtypes._memberspec import _ArgSpecElmType, _DispMemberSpec, _ParamFlagType
+
+logger = logging.getLogger(__name__)
+_debug = logger.debug
+_warning = logger.warning
+_error = logger.error
+
+################################################################
+# COM object implementation
+
+# so we don't have to import comtypes.automation
+DISPATCH_METHOD = 1
+DISPATCH_PROPERTYGET = 2
+DISPATCH_PROPERTYPUT = 4
+DISPATCH_PROPERTYPUTREF = 8
+
+
+class E_NotImplemented(Exception):
+    """COM method is not implemented"""
+
+
+def HRESULT_FROM_WIN32(errcode: Optional[int]) -> int:
+    "Convert a Windows error code into a HRESULT value."
+    if errcode is None:
+        return 0x80000000
+    if errcode & 0x80000000:
+        return errcode
+    return (errcode & 0xFFFF) | 0x80070000
+
+
+def winerror(exc: Exception) -> int:
+    """Return the windows error code from a WindowsError or COMError
+    instance."""
+    if isinstance(exc, COMError):
+        return exc.hresult
+    elif isinstance(exc, WindowsError):
+        code = exc.winerror
+        if isinstance(code, int):
+            return code
+        # Sometimes, a WindowsError instance has no error code.  An access
+        # violation raised by ctypes has only text, for example.  In this
+        # cases we return a generic error code.
+        return hresult.E_FAIL
+    raise TypeError(
+        f"Expected comtypes.COMERROR or WindowsError instance, got {type(exc).__name__}"
+    )
+
+
+def _do_implement(interface_name: str, method_name: str) -> Callable[..., int]:
+    def _not_implemented(*args):
+        """Return E_NOTIMPL because the method is not implemented."""
+        _debug("unimplemented method %s_%s called", interface_name, method_name)
+        return hresult.E_NOTIMPL
+
+    return _not_implemented
+
+
+def catch_errors(
+    obj: "hints.COMObject",
+    mth: Callable[..., Any],
+    paramflags: Optional[Tuple["_ParamFlagType", ...]],
+    interface: Type[IUnknown],
+    mthname: str,
+) -> Callable[..., Any]:
+    clsid = getattr(obj, "_reg_clsid_", None)
+
+    def call_with_this(*args, **kw):
+        try:
+            result = mth(*args, **kw)
+        except comtypes.ReturnHRESULT as err:
+            (hr, text) = err.args
+            return ReportError(text, iid=interface._iid_, clsid=clsid, hresult=hr)
+        except (COMError, WindowsError) as details:
+            _error(
+                "Exception in %s.%s implementation:",
+                interface.__name__,
+                mthname,
+                exc_info=True,
+            )
+            return HRESULT_FROM_WIN32(winerror(details))
+        except E_NotImplemented:
+            _warning("Unimplemented method %s.%s called", interface.__name__, mthname)
+            return hresult.E_NOTIMPL
+        except:
+            _error(
+                "Exception in %s.%s implementation:",
+                interface.__name__,
+                mthname,
+                exc_info=True,
+            )
+            return ReportException(hresult.E_FAIL, interface._iid_, clsid=clsid)
+        if result is None:
+            return hresult.S_OK
+        return result
+
+    if paramflags is None:
+        has_outargs = False
+    else:
+        has_outargs = bool([x[0] for x in paramflags if x[0] & 2])
+    call_with_this.has_outargs = has_outargs
+    return call_with_this
+
+
+################################################################
+
+
+def hack(
+    inst: "hints.COMObject",
+    mth: Callable[..., Any],
+    paramflags: Optional[Tuple["_ParamFlagType", ...]],
+    interface: Type[IUnknown],
+    mthname: str,
+) -> Callable[..., Any]:
+    if paramflags is None:
+        return catch_errors(inst, mth, paramflags, interface, mthname)
+    code = mth.__code__
+    if code.co_varnames[1:2] == ("this",):
+        return catch_errors(inst, mth, paramflags, interface, mthname)
+    dirflags = [f[0] for f in paramflags]
+    # An argument is an input arg either if flags are NOT set in the
+    # idl file, or if the flags contain 'in'. In other words, the
+    # direction flag is either exactly '0' or has the '1' bit set:
+    # Output arguments have flag '2'
+
+    args_out_idx = []
+    args_in_idx = []
+    for i, a in enumerate(dirflags):
+        if a & 2:
+            args_out_idx.append(i)
+        if a & 1 or a == 0:
+            args_in_idx.append(i)
+    args_out = len(args_out_idx)
+
+    ## XXX Remove this:
+    # if args_in != code.co_argcount - 1:
+    #     return catch_errors(inst, mth, interface, mthname)
+
+    clsid = getattr(inst, "_reg_clsid_", None)
+
+    def call_without_this(this, *args):
+        # Method implementations could check for and return E_POINTER
+        # themselves.  Or an error will be raised when
+        # 'outargs[i][0] = value' is executed.
+        # for a in outargs:
+        #     if not a:
+        #         return E_POINTER
+
+        # make argument list for handler by index array built above
+        inargs = []
+        for a in args_in_idx:
+            inargs.append(args[a])
+        try:
+            result = mth(*inargs)
+            if args_out == 1:
+                args[args_out_idx[0]][0] = result
+            elif args_out != 0:
+                if len(result) != args_out:
+                    msg = f"Method should have returned a {args_out}-tuple"
+                    raise ValueError(msg)
+                for i, value in enumerate(result):
+                    args[args_out_idx[i]][0] = value
+        except comtypes.ReturnHRESULT as err:
+            (hr, text) = err.args
+            return ReportError(text, iid=interface._iid_, clsid=clsid, hresult=hr)
+        except COMError as err:
+            (hr, text, details) = err.args
+            _error(
+                "Exception in %s.%s implementation:",
+                interface.__name__,
+                mthname,
+                exc_info=True,
+            )
+            try:
+                descr, source, helpfile, helpcontext, progid = details
+            except (ValueError, TypeError):
+                msg = str(details)
+            else:
+                msg = f"{source}: {descr}"
+            hr = HRESULT_FROM_WIN32(hr)
+            return ReportError(msg, iid=interface._iid_, clsid=clsid, hresult=hr)
+        except WindowsError as details:
+            _error(
+                "Exception in %s.%s implementation:",
+                interface.__name__,
+                mthname,
+                exc_info=True,
+            )
+            hr = HRESULT_FROM_WIN32(winerror(details))
+            return ReportException(hr, interface._iid_, clsid=clsid)
+        except E_NotImplemented:
+            _warning("Unimplemented method %s.%s called", interface.__name__, mthname)
+            return hresult.E_NOTIMPL
+        except:
+            _error(
+                "Exception in %s.%s implementation:",
+                interface.__name__,
+                mthname,
+                exc_info=True,
+            )
+            return ReportException(hresult.E_FAIL, interface._iid_, clsid=clsid)
+        return hresult.S_OK
+
+    if args_out:
+        call_without_this.has_outargs = True
+    return call_without_this
+
+
+class _MethodFinder(object):
+    def __init__(self, inst: "hints.COMObject") -> None:
+        self.inst = inst
+        # map lower case names to names with correct spelling.
+        self.names = dict([(n.lower(), n) for n in dir(inst)])
+
+    def get_impl(
+        self,
+        interface: Type[IUnknown],
+        mthname: str,
+        paramflags: Optional[Tuple["_ParamFlagType", ...]],
+        idlflags: Tuple[_UnionT[str, int], ...],
+    ) -> Callable[..., Any]:
+        mth = self.find_impl(interface, mthname, paramflags, idlflags)
+        if mth is None:
+            return _do_implement(interface.__name__, mthname)
+        return hack(self.inst, mth, paramflags, interface, mthname)
+
+    def find_method(self, fq_name: str, mthname: str) -> Callable[..., Any]:
+        # Try to find a method, first with the fully qualified name
+        # ('IUnknown_QueryInterface'), if that fails try the simple
+        # name ('QueryInterface')
+        try:
+            return getattr(self.inst, fq_name)
+        except AttributeError:
+            pass
+        return getattr(self.inst, mthname)
+
+    def find_impl(
+        self,
+        interface: Type[IUnknown],
+        mthname: str,
+        paramflags: Optional[Tuple["_ParamFlagType", ...]],
+        idlflags: Tuple[_UnionT[str, int], ...],
+    ) -> Optional[Callable[..., Any]]:
+        fq_name = f"{interface.__name__}_{mthname}"
+        if interface._case_insensitive_:
+            # simple name, like 'QueryInterface'
+            mthname = self.names.get(mthname.lower(), mthname)
+            # qualified name, like 'IUnknown_QueryInterface'
+            fq_name = self.names.get(fq_name.lower(), fq_name)
+
+        try:
+            return self.find_method(fq_name, mthname)
+        except AttributeError:
+            pass
+        propname = mthname[5:]  # strip the '_get_' or '_set' prefix
+        if interface._case_insensitive_:
+            propname = self.names.get(propname.lower(), propname)
+        # propput and propget is done with 'normal' attribute access,
+        # but only for COM properties that do not take additional
+        # arguments:
+
+        if "propget" in idlflags and len(paramflags) == 1:
+            return self.getter(propname)
+        if "propput" in idlflags and len(paramflags) == 1:
+            return self.setter(propname)
+        _debug("%r: %s.%s not implemented", self.inst, interface.__name__, mthname)
+        return None
+
+    def setter(self, propname: str) -> Callable[[Any], Any]:
+        #
+        def set(self, value):
+            try:
+                # XXX this may not be correct is the object implements
+                # _get_PropName but not _set_PropName
+                setattr(self, propname, value)
+            except AttributeError:
+                raise E_NotImplemented()
+
+        return comtypes.instancemethod(set, self.inst, type(self.inst))
+
+    def getter(self, propname: str) -> Callable[[], Any]:
+        def get(self):
+            try:
+                return getattr(self, propname)
+            except AttributeError:
+                raise E_NotImplemented()
+
+        return comtypes.instancemethod(get, self.inst, type(self.inst))
+
+
+def _create_vtbl_type(
+    fields: Tuple[Tuple[str, Type["_FuncPointer"]], ...], itf: Type[IUnknown]
+) -> Type[Structure]:
+    try:
+        return _vtbl_types[fields]
+    except KeyError:
+
+        class Vtbl(Structure):
+            _fields_ = fields
+
+        Vtbl.__name__ = f"Vtbl_{itf.__name__}"
+        _vtbl_types[fields] = Vtbl
+        return Vtbl
+
+
+# Ugh. Another type cache to avoid leaking types.
+_vtbl_types: Dict[Tuple[Tuple[str, Type["_FuncPointer"]], ...], Type[Structure]] = {}
+
+################################################################
+
+
+def create_vtbl_mapping(
+    itf: Type[IUnknown], finder: _MethodFinder
+) -> Tuple[Sequence[GUID], Structure]:
+    methods: List[Callable[..., Any]] = []  # method implementations
+    fields: List[Tuple[str, Type["_FuncPointer"]]] = []  # virtual function table
+    iids: List[GUID] = []  # interface identifiers.
+    # iterate over interface inheritance in reverse order to build the
+    # virtual function table, and leave out the 'object' base class.
+    for interface in itf.__mro__[-2::-1]:
+        iids.append(interface._iid_)
+        for m in interface._methods_:
+            restype, mthname, argtypes, paramflags, idlflags, helptext = m
+            proto = WINFUNCTYPE(restype, c_void_p, *argtypes)
+            fields.append((mthname, proto))
+            mth = finder.get_impl(interface, mthname, paramflags, idlflags)
+            methods.append(proto(mth))
+    Vtbl = _create_vtbl_type(tuple(fields), itf)
+    vtbl = Vtbl(*methods)
+    return (iids, vtbl)
+
+
+def create_dispimpl(
+    itf: Type[IUnknown], finder: _MethodFinder
+) -> Dict[Tuple[int, int], Callable[..., Any]]:
+    dispimpl: Dict[Tuple[int, int], Callable[..., Any]] = {}
+    for m in itf._disp_methods_:
+        #################
+        # What we have:
+        #
+        # restypes is a ctypes type or None
+        # argspec is seq. of (['in'], paramtype, paramname) tuples (or
+        # lists?)
+        #################
+        # What we need:
+        #
+        # idlflags must contain 'propget', 'propset' and so on:
+        # Must be constructed by converting disptype
+        #
+        # paramflags must be a sequence
+        # of (F_IN|F_OUT|F_RETVAL, paramname[, default-value]) tuples
+        #
+        # comtypes has this function which helps:
+        #    def _encode_idl(names):
+        #        # convert to F_xxx and sum up "in", "out",
+        #        # "retval" values found in _PARAMFLAGS, ignoring
+        #        # other stuff.
+        #        return sum([_PARAMFLAGS.get(n, 0) for n in names])
+        #################
+
+        if m.what == "DISPMETHOD":
+            dispimpl.update(_make_dispmthentry(itf, finder, m))
+        elif m.what == "DISPPROPERTY":
+            dispimpl.update(_make_disppropentry(itf, finder, m))
+    return dispimpl
+
+
+def _make_dispmthentry(
+    itf: Type[IUnknown], finder: _MethodFinder, m: "_DispMemberSpec"
+) -> Iterator[Tuple[Tuple[int, int], Callable[..., Any]]]:
+    _, mthname, idlflags, restype, argspec = m
+    if "propget" in idlflags:
+        invkind = DISPATCH_PROPERTYGET
+        mthname = f"_get_{mthname}"
+    elif "propput" in idlflags:
+        invkind = DISPATCH_PROPERTYPUT
+        mthname = f"_set_{mthname}"
+    elif "propputref" in idlflags:
+        invkind = DISPATCH_PROPERTYPUTREF
+        mthname = f"_setref_{mthname}"
+    else:
+        invkind = DISPATCH_METHOD
+        if restype:
+            argspec = argspec + ((["out"], restype, ""),)
+    yield from _make_dispentry(finder, itf, mthname, idlflags, argspec, invkind)
+
+
+def _make_disppropentry(
+    itf: Type[IUnknown], finder: _MethodFinder, m: "_DispMemberSpec"
+) -> Iterator[Tuple[Tuple[int, int], Callable[..., Any]]]:
+    _, mthname, idlflags, restype, argspec = m
+    # DISPPROPERTY have implicit "out"
+    if restype:
+        argspec += ((["out"], restype, ""),)
+    yield from _make_dispentry(
+        finder, itf, f"_get_{mthname}", idlflags, argspec, DISPATCH_PROPERTYGET
+    )
+    if "readonly" not in idlflags:
+        yield from _make_dispentry(
+            finder, itf, f"_set_{mthname}", idlflags, argspec, DISPATCH_PROPERTYPUT
+        )
+        # Add DISPATCH_PROPERTYPUTREF also?
+
+
+def _make_dispentry(
+    finder: _MethodFinder,
+    interface: Type[IUnknown],
+    mthname: str,
+    idlflags: Tuple[_UnionT[str, int], ...],
+    argspec: Tuple["_ArgSpecElmType", ...],
+    invkind: int,
+) -> Iterator[Tuple[Tuple[int, int], Callable[..., Any]]]:
+    # We build a _dispmap_ entry now that maps invkind and dispid to
+    # implementations that the finder finds; IDispatch_Invoke will later call it.
+    paramflags = tuple(((_encode_idl(x[0]), x[1]) + tuple(x[3:])) for x in argspec)
+    # XXX can the dispid be at a different index?  Check codegenerator.
+    dispid = idlflags[0]
+    impl = finder.get_impl(interface, mthname, paramflags, idlflags)  # type: ignore
+    yield ((dispid, invkind), impl)  # type: ignore
+    # invkind is really a set of flags; we allow both DISPATCH_METHOD and
+    # DISPATCH_PROPERTYGET (win32com uses this, maybe other languages too?)
+    if invkind in (DISPATCH_METHOD, DISPATCH_PROPERTYGET):
+        yield ((dispid, DISPATCH_METHOD | DISPATCH_PROPERTYGET), impl)  # type: ignore

{comtypes-1.4.7 → comtypes-1.4.9}/comtypes/automation.py

@@ -2,31 +2,26 @@
 import array
 import datetime
 import decimal
-import sys
+from _ctypes import COMError, CopyComPointer
 from ctypes import *
-from ctypes import _Pointer, Array as _CArrayType
-from _ctypes import CopyComPointer
+from ctypes import Array as _CArrayType
+from ctypes import _Pointer
 from ctypes.wintypes import DWORD, LONG, UINT, VARIANT_BOOL, WCHAR, WORD
-from typing import Any, ClassVar, Dict, List, Optional, TYPE_CHECKING, Type
+from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional, Type
 
-from comtypes import _CData, BSTR, COMError, COMMETHOD, GUID, IID, IUnknown, STDMETHOD
-from comtypes.hresult import *
-from comtypes._memberspec import _DispMemberSpec
-import comtypes.patcher
 import comtypes
+import comtypes.patcher
+from comtypes import BSTR, COMMETHOD, GUID, IID, STDMETHOD, IUnknown, _CData, _safearray
+from comtypes import hresult as hresult
+from comtypes.safearray import _midlSAFEARRAY
 
 if TYPE_CHECKING:
     from ctypes import _CArgObject
+
     from comtypes import hints  # type: ignore
-    from comtypes import _safearray
+    from comtypes._memberspec import _DispMemberSpec
 else:
     _CArgObject = type(byref(c_int()))
-    try:
-        from comtypes import _safearray
-    except (ImportError, AttributeError):
-
-        class _safearray(object):
-            tagSAFEARRAY = None
 
 
 LCID = DWORD
@@ -212,14 +207,14 @@ class tagVARIANT(Structure):
 
     def __repr__(self):
         if self.vt & VT_BYREF:
-            return "VARIANT(vt=0x%x, byref(%r))" % (self.vt, self[0])
+            return f"VARIANT(vt=0x{self.vt:x}, byref({self[0]!r}))"
         elif self is type(self).null:
             return "VARIANT.null"
         elif self is type(self).empty:
             return "VARIANT.empty"
         elif self is type(self).missing:
             return "VARIANT.missing"
-        return "VARIANT(vt=0x%x, %r)" % (self.vt, self.value)
+        return f"VARIANT(vt=0x{self.vt:x}, {self.value!r})"
 
     @classmethod
     def from_param(cls, value):
@@ -428,7 +423,7 @@ class tagVARIANT(Structure):
             else:
                 self.vt = _ctype_to_vartype[type(ref)] | VT_BYREF
         else:
-            raise TypeError("Cannot put %r in VARIANT" % value)
+            raise TypeError(f"Cannot put {value!r} in VARIANT")
         # buffer ->  SAFEARRAY of VT_UI1 ?
 
     # c:/sf/pywin32/com/win32com/src/oleargs.cpp 197
@@ -524,7 +519,7 @@ class tagVARIANT(Structure):
             typ = _vartype_to_ctype[self.vt & ~VT_ARRAY]
             return cast(self._.pparray, _midlSAFEARRAY(typ)).unpack()
         else:
-            raise NotImplementedError("typecode %d = 0x%x)" % (vt, vt))
+            raise NotImplementedError(f"typecode {vt} = 0x{vt:x})")
 
     def __getitem__(self, index):
         if index != 0:
@@ -714,17 +709,16 @@ class tagEXCEPINFO(Structure):
         scode: int
 
     def __repr__(self):
-        return "<EXCEPINFO %s>" % (
-            (
-                self.wCode,
-                self.bstrSource,
-                self.bstrDescription,
-                self.bstrHelpFile,
-                self.dwHelpContext,
-                self.pfnDeferredFillIn,
-                self.scode,
-            ),
+        info = (
+            self.wCode,
+            self.bstrSource,
+            self.bstrDescription,
+            self.bstrHelpFile,
+            self.dwHelpContext,
+            self.pfnDeferredFillIn,
+            self.scode,
         )
+        return f"<EXCEPINFO {info}>"
 
 
 tagEXCEPINFO._fields_ = [
@@ -775,7 +769,7 @@ DISPID_COLLECT = -8
 
 
 class IDispatch(IUnknown):
-    _disp_methods_: ClassVar[List[_DispMemberSpec]]
+    _disp_methods_: ClassVar[List["_DispMemberSpec"]]
 
     _iid_ = GUID("{00020400-0000-0000-C000-000000000046}")
     _methods_ = [
@@ -812,6 +806,10 @@ class IDispatch(IUnknown):
         ),
     ]
 
+    if TYPE_CHECKING:
+
+        def GetTypeInfoCount(self) -> int: ...
+
     def GetTypeInfo(self, index: int, lcid: int = 0) -> "hints.ITypeInfo":
         """Return type information.  Index 0 specifies typeinfo for IDispatch"""
         import comtypes.typeinfo
@@ -894,8 +892,8 @@ class IDispatch(IUnknown):
                 byref(argerr),
             )
         except COMError as err:
-            (hresult, text, details) = err.args
-            if hresult == DISP_E_EXCEPTION:
+            (hr, text, details) = err.args
+            if hr == hresult.DISP_E_EXCEPTION:
                 details = (
                     excepinfo.bstrDescription,
                     excepinfo.bstrSource,
@@ -903,24 +901,22 @@ class IDispatch(IUnknown):
                     excepinfo.dwHelpContext,
                     excepinfo.scode,
                 )
-                raise COMError(hresult, text, details)
-            elif hresult == DISP_E_PARAMNOTFOUND:
+                raise COMError(hr, text, details)
+            elif hr == hresult.DISP_E_PARAMNOTFOUND:
                 # MSDN says: You get the error DISP_E_PARAMNOTFOUND
                 # when you try to set a property and you have not
                 # initialized the cNamedArgs and rgdispidNamedArgs
                 # elements of your DISPPARAMS structure.
                 #
                 # So, this looks like a bug.
-                raise COMError(hresult, text, argerr.value)
-            elif hresult == DISP_E_TYPEMISMATCH:
+                raise COMError(hr, text, argerr.value)
+            elif hr == hresult.DISP_E_TYPEMISMATCH:
                 # MSDN: One or more of the arguments could not be
                 # coerced.
                 #
                 # Hm, should we raise TypeError, or COMError?
                 raise COMError(
-                    hresult,
-                    text,
-                    ("TypeError: Parameter %s" % (argerr.value + 1), args),
+                    hr, text, (f"TypeError: Parameter {argerr.value + 1}", args)
                 )
             raise
         return result._get_value(dynamic=True)
@@ -960,6 +956,7 @@ _ctype_to_vartype: Dict[Type[_CData], int] = {
     c_ulonglong: VT_UI8,
     VARIANT_BOOL: VT_BOOL,
     BSTR: VT_BSTR,
+    HRESULT: VT_HRESULT,
     VARIANT: VT_VARIANT,
     # SAFEARRAY(VARIANT *)
     #
@@ -991,12 +988,6 @@ _vartype_to_ctype[VT_UINT] = _vartype_to_ctype[VT_UI4]
 _ctype_to_vartype[c_char] = VT_UI1
 
 
-try:
-    from comtypes.safearray import _midlSAFEARRAY
-except (ImportError, AttributeError):
-    pass
-
-
 # fmt: off
 __known_symbols__ = [
     "CURRENCY", "CY", "tagCY", "DECIMAL", "tagDEC", "DISPATCH_METHOD",