Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split __init__.py into some modules (only NOT tightly coupled) #559

Merged
merged 6 commits into from
Jun 8, 2024
Merged

Split __init__.py into some modules (only NOT tightly coupled) #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8539e9a
revert
junkmd Jun 8, 2024
d455d16
import `_check_version` from `_check_version`
junkmd Jun 8, 2024
40ab964
import `BSTR` from `_bstr`
junkmd Jun 8, 2024
c00cf81
import `instancemethod` from `_py_instance_method`
junkmd Jun 8, 2024
f21b6d0
import idl stuffs from `_idl_stuff`
junkmd Jun 8, 2024
adfa1c7
remove `base.py`
junkmd Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 5 additions & 131 deletions comtypes/___init__.py → comtypes/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@
_encode_idl,
_resolve_argspec,
)

from comtypes._tlib_version_checker import _check_version # noqa
from comtypes._bstr import BSTR # noqa
from comtypes._py_instance_method import instancemethod
from comtypes._idl_stuff import defaultvalue, helpstring, dispid # noqa
from comtypes._idl_stuff import STDMETHOD, DISPMETHOD, DISPPROPERTY, COMMETHOD # noqa

_all_slice = slice(None, None, None)

Expand All @@ -71,34 +75,6 @@ def emit(self, record):
logger.addHandler(NullHandler())


def _check_version(actual, tlib_cached_mtime=None):
from comtypes.tools.codegenerator import version as required

if actual != required:
raise ImportError("Wrong version")
if not hasattr(sys, "frozen"):
g = sys._getframe(1).f_globals
tlb_path = g.get("typelib_path")
try:
tlib_curr_mtime = os.stat(tlb_path).st_mtime
except (OSError, TypeError):
return
if not tlib_cached_mtime or abs(tlib_curr_mtime - tlib_cached_mtime) >= 1:
raise ImportError("Typelib different than module")


pythonapi.PyInstanceMethod_New.argtypes = [py_object]
pythonapi.PyInstanceMethod_New.restype = py_object
PyInstanceMethod_Type = type(pythonapi.PyInstanceMethod_New(id))


def instancemethod(func, inst, cls):
mth = PyInstanceMethod_Type(func)
if inst is None:
return mth
return mth.__get__(inst)


class ReturnHRESULT(Exception):
"""ReturnHRESULT(hresult, text)

Expand Down Expand Up @@ -665,108 +641,6 @@ def from_param(cls, value):
return value.QueryInterface(cls.__com_interface__)


################################################################


class BSTR(_SimpleCData):
"The windows BSTR data type"
_type_ = "X"
_needsfree = False

def __repr__(self):
return "%s(%r)" % (self.__class__.__name__, self.value)

def __ctypes_from_outparam__(self):
self._needsfree = True
return self.value

def __del__(self, _free=windll.oleaut32.SysFreeString):
# Free the string if self owns the memory
# or if instructed by __ctypes_from_outparam__.
if self._b_base_ is None or self._needsfree:
_free(self)

@classmethod
def from_param(cls, value):
"""Convert into a foreign function call parameter."""
if isinstance(value, cls):
return value
# Although the builtin SimpleCData.from_param call does the
# right thing, it doesn't ensure that SysFreeString is called
# on destruction.
return cls(value)


################################################################
# IDL stuff


class helpstring(str):
"Specifies the helpstring for a COM method or property."


class defaultvalue(object):
"Specifies the default value for parameters marked optional."

def __init__(self, value):
self.value = value


class dispid(int):
"Specifies the DISPID of a method or property."


# XXX STDMETHOD, COMMETHOD, DISPMETHOD, and DISPPROPERTY should return
# instances with more methods or properties, and should not behave as an unpackable.


def STDMETHOD(restype, name, argtypes=()) -> _ComMemberSpec:
"Specifies a COM method slot without idlflags"
return _ComMemberSpec(restype, name, argtypes, None, (), None)


def DISPMETHOD(idlflags, restype, name, *argspec) -> _DispMemberSpec:
"Specifies a method of a dispinterface"
return _DispMemberSpec("DISPMETHOD", name, tuple(idlflags), restype, argspec)


def DISPPROPERTY(idlflags, proptype, name) -> _DispMemberSpec:
"Specifies a property of a dispinterface"
return _DispMemberSpec("DISPPROPERTY", name, tuple(idlflags), proptype, ())


# tuple(idlflags) is for the method itself: (dispid, 'readonly')

# sample generated code:
# DISPPROPERTY([5, 'readonly'], OLE_YSIZE_HIMETRIC, 'Height'),
# DISPMETHOD(
# [6], None, 'Render', ([], c_int, 'hdc'), ([], c_int, 'x'), ([], c_int, 'y')
# )


def COMMETHOD(idlflags, restype, methodname, *argspec) -> _ComMemberSpec:
"""Specifies a COM method slot with idlflags.

XXX should explain the sematics of the arguments.
"""
# collect all helpstring instances
# We should suppress docstrings when Python is started with -OO
# join them together(does this make sense?) and replace by None if empty.
helptext = "".join(t for t in idlflags if isinstance(t, helpstring)) or None
paramflags, argtypes = _resolve_argspec(argspec)
if "propget" in idlflags:
name = "_get_%s" % methodname
elif "propput" in idlflags:
name = "_set_%s" % methodname
elif "propputref" in idlflags:
name = "_setref_%s" % methodname
else:
name = methodname
return _ComMemberSpec(
restype, name, argtypes, paramflags, tuple(idlflags), helptext
)


################################################################
# IUnknown, the root of all evil...

Expand Down
Loading