comtypes 1.4.9__zip → 1.4.11__zip

comtypes-1.4.9/comtypes/server/register.py

@@ -1,419 +0,0 @@
-"""comtypes.server.register - register and unregister a COM object.
-
-Exports the UseCommandLine function.  UseCommandLine is called with
-the COM object classes that a module exposes.  It parses the Windows
-command line and takes the appropriate actions.
-These command line options are supported:
-
-/regserver - register the classes with COM.
-/unregserver - unregister the classes with COM.
-
-/nodebug - remove all logging configuration from the registry.
-
-/l <name>=<level> - configure the logging level for the standard Python loggind module,
-this option may be used several times.
-
-/f <formatter> - specify the formatter string.
-
-Note: Registering and unregistering the objects does remove logging
-entries.  Configuring the logging does not change other registry
-entries, so it is possible to freeze a comobject with py2exe, register
-it, then configure logging afterwards to debug it, and delete the
-logging config afterwards.
-
-Sample usage:
-
-Register the COM object:
-
-  python mycomobj.py /regserver
-
-Configure logging info:
-
-  python mycomobj.py /l comtypes=INFO /l comtypes.server=DEBUG /f %(message)s
-
-Now, debug the object, and when done delete logging info:
-
-  python mycomobj.py /nodebug
-"""
-
-import logging
-import os
-import sys
-import winreg
-from ctypes import WinError, c_ulong, c_wchar_p, create_string_buffer, sizeof, windll
-from typing import Iterator, Tuple
-
-import comtypes
-import comtypes.server.inprocserver
-from comtypes.hresult import *
-from comtypes.server import w_getopt
-from comtypes.typeinfo import REGKIND_REGISTER, LoadTypeLibEx, UnRegisterTypeLib
-
-_debug = logging.getLogger(__name__).debug
-
-
-def get_winerror(exception):
-    try:
-        return exception.winerror
-    except AttributeError:
-        return exception.errno
-
-
-# a SHDeleteKey function, will remove a registry key with all subkeys.
-def _non_zero(retval, func, args):
-    if retval:
-        raise WinError(retval)
-
-
-SHDeleteKey = windll.shlwapi.SHDeleteKeyW
-SHDeleteKey.errcheck = _non_zero
-SHDeleteKey.argtypes = c_ulong, c_wchar_p
-
-Set = set
-
-
-_KEYS = {
-    winreg.HKEY_CLASSES_ROOT: "HKCR",
-    winreg.HKEY_LOCAL_MACHINE: "HKLM",
-    winreg.HKEY_CURRENT_USER: "HKCU",
-}
-
-
-def _explain(hkey):
-    return _KEYS.get(hkey, hkey)
-
-
-class Registrar(object):
-    """COM class registration.
-
-    The COM class can override what this does by implementing
-    _register and/or _unregister class methods.  These methods will be
-    called with the calling instance of Registrar, and so can call the
-    Registrars _register and _unregister methods which do the actual
-    work.
-    """
-
-    def nodebug(self, cls):
-        """Delete logging entries from the registry."""
-        clsid = cls._reg_clsid_
-        try:
-            _debug(
-                'DeleteKey( %s\\CLSID\\%s\\Logging"'
-                % (_explain(winreg.HKEY_CLASSES_ROOT), clsid)
-            )
-            hkey = winreg.OpenKey(winreg.HKEY_CLASSES_ROOT, rf"CLSID\{clsid}")
-            winreg.DeleteKey(hkey, "Logging")
-        except WindowsError as detail:
-            if get_winerror(detail) != 2:
-                raise
-
-    def debug(self, cls, levels, format):
-        """Write entries in the registry to setup logging for this clsid."""
-        # handlers
-        # format
-        clsid = cls._reg_clsid_
-        _debug(
-            'CreateKey( %s\\CLSID\\%s\\Logging"'
-            % (_explain(winreg.HKEY_CLASSES_ROOT), clsid)
-        )
-        hkey = winreg.CreateKey(winreg.HKEY_CLASSES_ROOT, rf"CLSID\{clsid}\Logging")
-        for item in levels:
-            name, value = item.split("=")
-            v = getattr(logging, value)
-            assert isinstance(v, int)
-        _debug("SetValueEx(levels, %s)" % levels)
-        winreg.SetValueEx(hkey, "levels", None, winreg.REG_MULTI_SZ, levels)
-        if format:
-            _debug("SetValueEx(format, %s)" % format)
-            winreg.SetValueEx(hkey, "format", None, winreg.REG_SZ, format)
-        else:
-            _debug("DeleteValue(format)")
-            try:
-                winreg.DeleteValue(hkey, "format")
-            except WindowsError as detail:
-                if get_winerror(detail) != 2:
-                    raise
-
-    def register(self, cls, executable=None):
-        """Register the COM server class."""
-        # First, we unregister the object with force=True, to force removal
-        # of all registry entries, even if we would not write them.
-        # Second, we create new entries.
-        # It seems ATL does the same.
-        mth = getattr(cls, "_register", None)
-        if mth is not None:
-            mth(self)
-        else:
-            self._unregister(cls, force=True)
-            self._register(cls, executable)
-
-    def _register(self, cls, executable=None):
-        table = sorted(RegistryEntries(cls))
-        _debug("Registering %s", cls)
-        for hkey, subkey, valuename, value in table:
-            _debug("[%s\\%s]", _explain(hkey), subkey)
-            _debug('%s="%s"', valuename or "@", value)
-            k = winreg.CreateKey(hkey, subkey)
-            winreg.SetValueEx(k, valuename, None, winreg.REG_SZ, str(value))
-
-        tlib = getattr(cls, "_reg_typelib_", None)
-        if tlib is not None:
-            if hasattr(sys, "frozendllhandle"):
-                dll = _get_serverdll()
-                _debug("LoadTypeLibEx(%s, REGKIND_REGISTER)", dll)
-                LoadTypeLibEx(dll, REGKIND_REGISTER)
-            else:
-                if executable:
-                    path = executable
-                elif hasattr(sys, "frozen"):
-                    path = sys.executable
-                else:
-                    path = cls._typelib_path_
-                _debug("LoadTypeLibEx(%s, REGKIND_REGISTER)", path)
-                LoadTypeLibEx(path, REGKIND_REGISTER)
-        _debug("Done")
-
-    def unregister(self, cls, force=False):
-        """Unregister the COM server class."""
-        mth = getattr(cls, "_unregister", None)
-        if mth is not None:
-            mth(self)
-        else:
-            self._unregister(cls, force=force)
-
-    def _unregister(self, cls, force=False):
-        # If force==False, we only remove those entries that we
-        # actually would have written.  It seems ATL does the same.
-        table = [t[:2] for t in RegistryEntries(cls)]
-        # only unique entries
-        table = list(set(table))
-        table.sort()
-        table.reverse()
-        _debug("Unregister %s", cls)
-        for hkey, subkey in table:
-            try:
-                if force:
-                    _debug("SHDeleteKey %s\\%s", _explain(hkey), subkey)
-                    SHDeleteKey(hkey, subkey)
-                else:
-                    _debug("DeleteKey %s\\%s", _explain(hkey), subkey)
-                    winreg.DeleteKey(hkey, subkey)
-            except WindowsError as detail:
-                if get_winerror(detail) != 2:
-                    raise
-        tlib = getattr(cls, "_reg_typelib_", None)
-        if tlib is not None:
-            try:
-                _debug("UnRegisterTypeLib(%s, %s, %s)", *tlib)
-                UnRegisterTypeLib(*tlib)
-            except WindowsError as detail:
-                if not get_winerror(detail) in (
-                    TYPE_E_REGISTRYACCESS,
-                    TYPE_E_CANTLOADLIBRARY,
-                ):
-                    raise
-        _debug("Done")
-
-
-def _get_serverdll():
-    """Return the pathname of the dll hosting the COM object."""
-    handle = getattr(sys, "frozendllhandle", None)
-    if handle is not None:
-        buf = create_string_buffer(260)
-        windll.kernel32.GetModuleFileNameA(handle, buf, sizeof(buf))
-        return buf[:]
-    import _ctypes
-
-    return _ctypes.__file__
-
-
-class RegistryEntries(object):
-    def __init__(self, cls):
-        self._cls = cls
-
-    def _get_full_classname(self, cls):
-        """Return <modulename>.<classname> for 'cls'."""
-        modname = cls.__module__
-        if modname == "__main__":
-            modname = os.path.splitext(os.path.basename(sys.argv[0]))[0]
-        return f"{modname}.{cls.__name__}"
-
-    def _get_pythonpath(self, cls):
-        """Return the filesystem path of the module containing 'cls'."""
-        modname = cls.__module__
-        dirname = os.path.dirname(sys.modules[modname].__file__)
-        return os.path.abspath(dirname)
-
-    def __iter__(self) -> Iterator[Tuple[int, str, str, str]]:
-        """Return a iterator of tuples containing registry entries.
-
-        The tuples must be (key, subkey, name, value).
-
-        Required entries:
-        =================
-        _reg_clsid_ - a string or GUID instance
-        _reg_clsctx_ - server type(s) to register
-
-        Optional entries:
-        =================
-        _reg_desc_ - a string
-        _reg_progid_ - a string naming the progid, typically 'MyServer.MyObject.1'
-        _reg_novers_progid_ - version independend progid, typically 'MyServer.MyObject'
-        _reg_typelib_ - an tuple (libid, majorversion, minorversion) specifying a typelib.
-        _reg_threading_ - a string specifying the threading model
-
-        Note that the first part of the progid string is typically the
-        IDL library name of the type library containing the coclass.
-        """
-        cls = self._cls
-        HKCR = winreg.HKEY_CLASSES_ROOT
-
-        # basic entry - names the comobject
-
-        # that's the only required attribute for registration
-        reg_clsid = str(cls._reg_clsid_)
-        reg_desc = getattr(cls, "_reg_desc_", "")
-        if not reg_desc:
-            # Simple minded algorithm to construct a description from
-            # the progid:
-            reg_desc = getattr(cls, "_reg_novers_progid_", "") or getattr(
-                cls, "_reg_progid_", ""
-            )
-            if reg_desc:
-                reg_desc = reg_desc.replace(".", " ")
-        yield (HKCR, f"CLSID\\{reg_clsid}", "", reg_desc)
-
-        reg_progid = getattr(cls, "_reg_progid_", None)
-        if reg_progid:
-            # for ProgIDFromCLSID:
-            yield (HKCR, f"CLSID\\{reg_clsid}\\ProgID", "", reg_progid)  # 1
-
-            # for CLSIDFromProgID
-            if reg_desc:
-                yield (HKCR, reg_progid, "", reg_desc)  # 2
-            yield (HKCR, f"{reg_progid}\\CLSID", "", reg_clsid)  # 3
-
-            reg_novers_progid = getattr(cls, "_reg_novers_progid_", None)
-            if reg_novers_progid:
-                yield (
-                    HKCR,
-                    f"CLSID\\{reg_clsid}\\VersionIndependentProgID",  # 1a
-                    "",
-                    reg_novers_progid,
-                )
-                if reg_desc:
-                    yield (HKCR, reg_novers_progid, "", reg_desc)  # 2a
-                yield (HKCR, f"{reg_novers_progid}\\CurVer", "", reg_progid)  #
-                yield (HKCR, f"{reg_novers_progid}\\CLSID", "", reg_clsid)  # 3a
-
-        clsctx: int = getattr(cls, "_reg_clsctx_", 0)
-        localsvr_ctx = bool(clsctx & comtypes.CLSCTX_LOCAL_SERVER)
-        inprocsvr_ctx = bool(clsctx & comtypes.CLSCTX_INPROC_SERVER)
-
-        if localsvr_ctx and not hasattr(sys, "frozendllhandle"):
-            exe = sys.executable
-            if " " in exe:
-                exe = f'"{exe}"'
-            if not hasattr(sys, "frozen"):
-                if not __debug__:
-                    exe = f"{exe} -O"
-                script = os.path.abspath(sys.modules[cls.__module__].__file__)
-                if " " in script:
-                    script = f'"{script}"'
-                yield (HKCR, rf"CLSID\{reg_clsid}\LocalServer32", "", f"{exe} {script}")
-            else:
-                yield (HKCR, rf"CLSID\{reg_clsid}\LocalServer32", "", f"{exe}")
-
-        # Register InprocServer32 only when run from script or from
-        # py2exe dll server, not from py2exe exe server.
-        if inprocsvr_ctx and getattr(sys, "frozen", None) in (None, "dll"):
-            yield (HKCR, rf"CLSID\{reg_clsid}\InprocServer32", "", _get_serverdll())
-            # only for non-frozen inproc servers the PythonPath/PythonClass is needed.
-            if (
-                not hasattr(sys, "frozendllhandle")
-                or not comtypes.server.inprocserver._clsid_to_class
-            ):
-                yield (
-                    HKCR,
-                    rf"CLSID\{reg_clsid}\InprocServer32",
-                    "PythonClass",
-                    self._get_full_classname(cls),
-                )
-                yield (
-                    HKCR,
-                    rf"CLSID\{reg_clsid}\InprocServer32",
-                    "PythonPath",
-                    self._get_pythonpath(cls),
-                )
-
-            reg_threading = getattr(cls, "_reg_threading_", None)
-            if reg_threading is not None:
-                yield (
-                    HKCR,
-                    rf"CLSID\{reg_clsid}\InprocServer32",
-                    "ThreadingModel",
-                    reg_threading,
-                )
-
-        reg_tlib = getattr(cls, "_reg_typelib_", None)
-        if reg_tlib is not None:
-            yield (HKCR, rf"CLSID\{reg_clsid}\Typelib", "", reg_tlib[0])
-
-
-################################################################
-
-
-def register(cls):
-    Registrar().register(cls)
-
-
-def unregister(cls):
-    Registrar().unregister(cls)
-
-
-def UseCommandLine(*classes):
-    usage = f"""Usage: {sys.argv[0]} [-regserver] [-unregserver] [-nodebug] [-f logformat] [-l loggername=level]"""
-    opts, args = w_getopt.w_getopt(
-        sys.argv[1:], "regserver unregserver embedding l: f: nodebug"
-    )
-    if not opts:
-        sys.stderr.write(usage + "\n")
-        return 0  # nothing for us to do
-
-    levels = []
-    format = None
-    nodebug = False
-    runit = False
-    for option, value in opts:
-        if option == "regserver":
-            for cls in classes:
-                register(cls)
-        elif option == "unregserver":
-            for cls in classes:
-                unregister(cls)
-        elif option == "embedding":
-            runit = True
-        elif option == "f":
-            format = value
-        elif option == "l":
-            levels.append(value)
-        elif option == "nodebug":
-            nodebug = True
-
-    if levels or format is not None:
-        for cls in classes:
-            Registrar().debug(cls, levels, format)
-    if nodebug:
-        for cls in classes:
-            Registrar().nodebug(cls)
-
-    if runit:
-        import comtypes.server.localserver
-
-        comtypes.server.localserver.run(classes)
-
-    return 1  # we have done something
-
-
-if __name__ == "__main__":
-    UseCommandLine()

comtypes-1.4.9/comtypes/test/find_memleak.py

@@ -1,76 +0,0 @@
-import unittest, gc
-from ctypes import *
-from ctypes.wintypes import *
-
-################################################################
-
-
-class PROCESS_MEMORY_COUNTERS(Structure):
-    _fields_ = [
-        ("cb", DWORD),
-        ("PageFaultCount", DWORD),
-        ("PeakWorkingSetSize", c_size_t),
-        ("WorkingSetSize", c_size_t),
-        ("QuotaPeakPagedPoolUsage", c_size_t),
-        ("QuotaPagedPoolUsage", c_size_t),
-        ("QuotaPeakNonPagedPoolUsage", c_size_t),
-        ("QuotaNonPagedPoolUsage", c_size_t),
-        ("PagefileUsage", c_size_t),
-        ("PeakPagefileUsage", c_size_t),
-    ]
-
-    def __init__(self):
-        self.cb = sizeof(self)
-
-    def dump(self):
-        for n, _ in self._fields_[2:]:
-            print(n, getattr(self, n) / 1e6)
-
-
-try:
-    windll.psapi.GetProcessMemoryInfo.argtypes = (
-        HANDLE,
-        POINTER(PROCESS_MEMORY_COUNTERS),
-        DWORD,
-    )
-except WindowsError:
-    # cannot search for memory leaks on Windows CE
-    def find_memleak(func, loops=None):
-        return 0
-
-else:
-
-    def wss():
-        # Return the working set size (memory used by process)
-        pmi = PROCESS_MEMORY_COUNTERS()
-        if not windll.psapi.GetProcessMemoryInfo(-1, byref(pmi), sizeof(pmi)):
-            raise WinError()
-        return pmi.WorkingSetSize
-
-    LOOPS = 10, 1000
-
-    def find_memleak(func, loops=LOOPS):
-        # call 'func' several times, so that memory consumption
-        # stabilizes:
-        for j in range(loops[0]):
-            for k in range(loops[1]):
-                func()
-        gc.collect()
-        gc.collect()
-        gc.collect()
-        bytes = wss()
-        # call 'func' several times, recording the difference in
-        # memory consumption before and after the call.  Repeat this a
-        # few times, and return a list containing the memory
-        # consumption differences.
-        for j in range(loops[0]):
-            for k in range(loops[1]):
-                func()
-        gc.collect()
-        gc.collect()
-        gc.collect()
-        # return the increased in process size
-        result = wss() - bytes
-        # Sometimes the process size did decrease, we do not report leaks
-        # in this case:
-        return max(result, 0)