Skip to content

Add Anti-Moniker behavior and composition tests. #922

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

Merged
junkmd merged 9 commits into from
Feb 10, 2026
Merged

Add Anti-Moniker behavior and composition tests. #922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6ed5107
test: Add anti-moniker behavior tests to `test_moniker.py`.
junkmd Feb 10, 2026
76dc2ef
test: Add anti-moniker composition tests to `test_moniker.py`.
junkmd Feb 10, 2026
debb601
test: Rename test method for clarity in `test_moniker.py`.
junkmd Feb 10, 2026
5937299
test: Clarify moniker variable names in `test_moniker.py`.
junkmd Feb 10, 2026
49dd3a6
test: Add tests for composing anti-moniker with file moniker.
junkmd Feb 10, 2026
7288dd4
feat: Add test for anti-moniker with item moniker composition.
junkmd Feb 10, 2026
6388e3b
feat: Add test for file moniker composition with `MK_E_SYNTAX` error.
junkmd Feb 10, 2026
4b756f0
test: Refine file moniker composition tests.
junkmd Feb 10, 2026
1265df0
test: Refine item moniker composition tests.
junkmd Feb 10, 2026
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
7 changes: 7 additions & 0 deletions comtypes/test/monikers_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
# https://learn.microsoft.com/en-us/windows/win32/api/objidl/ne-objidl-mksys
MKSYS_GENERICCOMPOSITE = 1
MKSYS_FILEMONIKER = 2
MKSYS_ANTIMONIKER = 3
MKSYS_ITEMMONIKER = 4

CLSID_CompositeMoniker = GUID("{00000309-0000-0000-c000-000000000046}")
Expand All @@ -31,6 +32,10 @@
_CreateFileMoniker.argtypes = [LPCOLESTR, POINTER(POINTER(IUnknown))]
_CreateFileMoniker.restype = HRESULT

_CreateAntiMoniker = _ole32.CreateAntiMoniker
_CreateAntiMoniker.argtypes = [POINTER(POINTER(IUnknown))]
_CreateAntiMoniker.restype = HRESULT

_CreateItemMoniker = _ole32.CreateItemMoniker
_CreateItemMoniker.argtypes = [LPCOLESTR, LPCOLESTR, POINTER(POINTER(IUnknown))]
_CreateItemMoniker.restype = HRESULT
Expand All @@ -44,5 +49,7 @@
_GetRunningObjectTable.restype = HRESULT

# Common COM Errors from Moniker/Binding Context operations
MK_E_NOINVERSE = -2147221012 # 0x800401EC
MK_E_NEEDGENERIC = -2147221022 # 0x800401E2
MK_E_SYNTAX = -2147221020 # 0x800401E4
MK_E_UNAVAILABLE = -2147221021 # 0x800401E3
95 changes: 89 additions & 6 deletions comtypes/test/test_moniker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from comtypes.persist import IPersistFile
from comtypes.test.monikers_helper import (
MK_E_NEEDGENERIC,
MK_E_NOINVERSE,
MK_E_SYNTAX,
MKSYS_ANTIMONIKER,
MKSYS_FILEMONIKER,
MKSYS_GENERICCOMPOSITE,
MKSYS_ITEMMONIKER,
Expand All @@ -22,6 +25,7 @@
CLSID_CompositeMoniker,
CLSID_FileMoniker,
CLSID_ItemMoniker,
_CreateAntiMoniker,
_CreateBindCtx,
_CreateFileMoniker,
_CreateGenericComposite,
Expand Down Expand Up @@ -60,6 +64,12 @@ def _create_generic_composite(mk_first: IMoniker, mk_rest: IMoniker) -> IMoniker
return mon # type: ignore


def _create_anti_moniker() -> IMoniker:
mon = POINTER(IMoniker)()
_CreateAntiMoniker(byref(mon))
return mon # type: ignore


def _create_file_moniker(path: str) -> IMoniker:
mon = POINTER(IMoniker)()
_CreateFileMoniker(path, byref(mon))
Expand Down Expand Up @@ -116,6 +126,17 @@ def test_file(self):
self.assertEqual(mon.GetClassID(), CLSID_FileMoniker)
self.assertEqual(mon.Inverse().GetClassID(), CLSID_AntiMoniker)

def test_anti(self):
mon = _create_anti_moniker()
self.assertEqual(mon.IsSystemMoniker(), MKSYS_ANTIMONIKER)
bctx = _create_bctx()
self.assertEqual(mon.GetDisplayName(bctx, None), "\\..")
self.assertEqual(mon.GetClassID(), CLSID_AntiMoniker)
# Anti-moniker has NO inverse.
with self.assertRaises(COMError) as cm:
mon.Inverse()
self.assertEqual(cm.exception.hresult, MK_E_NOINVERSE)

def test_item(self):
item_id = str(GUID.create_new())
mon = _create_item_moniker("!", item_id)
Expand All @@ -127,16 +148,78 @@ def test_item(self):


class Test_ComposeWith(unittest.TestCase):
def test_item(self):
item_id = str(GUID.create_new())
mon = _create_item_moniker("!", item_id)
item_mon2 = _create_item_moniker("!", str(GUID.create_new()))
def test_file_with_same_type(self):
with tempfile.TemporaryDirectory() as t:
tmpdir = Path(t)
tmpfile = tmpdir / "tmp.txt"
left_mon = _create_file_moniker(str(tmpfile))
# Composing two distinct absolute file monikers results in error.
for right_mon, only_if_not_generic in [
(_create_file_moniker(str(tmpfile)), False),
(_create_file_moniker(str(tmpfile)), True),
(_create_file_moniker(str(tmpdir / "tmp2.txt")), False),
(_create_file_moniker(str(tmpdir / "tmp2.txt")), True),
]:
with self.assertRaises(COMError) as cm:
left_mon.ComposeWith(right_mon, only_if_not_generic)
self.assertEqual(cm.exception.hresult, MK_E_SYNTAX)

def test_anti_with_same_type(self):
left_mon = _create_anti_moniker()
right_mon = _create_anti_moniker()
self.assertEqual(
mon.ComposeWith(item_mon2, False).GetClassID(),
left_mon.ComposeWith(right_mon, False).GetClassID(),
CLSID_CompositeMoniker,
)
with self.assertRaises(COMError) as cm:
mon.ComposeWith(item_mon2, True)
left_mon.ComposeWith(right_mon, True)
self.assertEqual(cm.exception.hresult, MK_E_NEEDGENERIC)

def test_anti_with_file(self):
anti_mon = _create_anti_moniker()
with tempfile.TemporaryDirectory() as t:
tmpdir = Path(t)
tmpfile = tmpdir / "tmp.txt"
file_mon = _create_file_moniker(str(tmpfile))
# https://learn.microsoft.com/en-us/windows/win32/api/objidl/nf-objidl-imoniker-composewith#implementation-specific-notes
comp_mon = anti_mon.ComposeWith(file_mon, False)
self.assertEqual(comp_mon.IsSystemMoniker(), MKSYS_GENERICCOMPOSITE)
self.assertEqual(comp_mon.GetClassID(), CLSID_CompositeMoniker)
self.assertEqual(
comp_mon.GetDisplayName(_create_bctx(), None), f"\\..{tmpfile}"
)
with self.assertRaises(COMError) as cm:
anti_mon.ComposeWith(file_mon, True)
self.assertEqual(cm.exception.hresult, MK_E_NEEDGENERIC)
self.assertFalse(file_mon.ComposeWith(anti_mon, False))
self.assertFalse(file_mon.ComposeWith(anti_mon, True))

def test_anti_with_item(self):
anti_mon = _create_anti_moniker()
item_mon = _create_item_moniker("!", str(GUID.create_new()))
self.assertEqual(
anti_mon.ComposeWith(item_mon, False).GetClassID(),
CLSID_CompositeMoniker,
)
with self.assertRaises(COMError) as cm:
anti_mon.ComposeWith(item_mon, True)
self.assertEqual(cm.exception.hresult, MK_E_NEEDGENERIC)
self.assertFalse(item_mon.ComposeWith(anti_mon, False))
self.assertFalse(item_mon.ComposeWith(anti_mon, True))

def test_item_with_same_type(self):
left_id = str(GUID.create_new())
left_mon = _create_item_moniker("!", left_id)
right_id = str(GUID.create_new())
right_mon = _create_item_moniker("!", right_id)
comp_mon = left_mon.ComposeWith(right_mon, False)
self.assertEqual(comp_mon.IsSystemMoniker(), MKSYS_GENERICCOMPOSITE)
self.assertEqual(comp_mon.GetClassID(), CLSID_CompositeMoniker)
self.assertEqual(
comp_mon.GetDisplayName(_create_bctx(), None), f"!{left_id}!{right_id}"
)
with self.assertRaises(COMError) as cm:
left_mon.ComposeWith(right_mon, True)
self.assertEqual(cm.exception.hresult, MK_E_NEEDGENERIC)


Expand Down