gh-126384: Add tests to verify the behavior of basic COM methods. by junkmd · Pull Request #126610 · python/cpython · GitHub

I would like to backport this to 3.12 and 3.13 as well.
This is internal-only, so I don’t think it needs a NEWS entry.

Issue: Add tests to verify the behavior of basic COM methods. #126384

I renamed utility functions for testing to conform with PEP8.

Also I added URLs in comments to documentation on COM specifications for developers who may have limited experience with COM and may review or maintain this code in the future.

Thank you for the tests!
I only have a slight idea of how COM works, but, they look good to me!

However, I would like to simplify the supporting Python code, though: we don't need to test CPython internal types, or custom descriptors using __get_name__.

In #126686, COMError became public, but I would like this test to be backported to 3.13 and 3.12, where COMError remains private.

If possible, I would appreciate it if we could merge this as is, and after the backport PR is submitted by the bot, I will prepare a follow-up PR reflecting the fact that COMError is now public.

Can we have assertion equality being tested as actual == expected instead of expected == actual? I think we usually do the first form rather than the second one.

Looks good, thank you!

I don't think it's worth it to reorder assertion arguments, but if you want to do it I won't stop you :)

[Edit: I deleted a misguided suggestion]

!buildbot Windows

🤖 New build scheduled with the buildbot fleet by @encukou for commit cc07c44 🤖

The command will test the builders whose names match following regular expression: Windows

The builders matched are:

ARM64 Windows Non-Debug PR
AMD64 Windows11 Bigmem PR
AMD64 Windows10 PR
AMD64 Windows11 Non-Debug PR
AMD64 Windows Server 2022 NoGIL PR
AMD64 Windows11 Refleaks PR
ARM64 Windows PR

I don’t have a strong preference for the order of actual == expected or expected == actual.
If it’s mergeable as is, please go ahead and merge it.

In my native language, Japanese, the equivalent concept is expressed as “予実” (yojitsu), with the characters for “expected” and “actual” written in that order.
That might be why I wrote it in this order.

Let's not burden ourselves with an additional commit. I was just surprised to see it written like that but I won't die from it :) (and since it's a new file anyway, it can have its own style).

By the way, do we need a if __name__ == '__main__' block executing the unittest as is?

I added the block.

Ah thank you. I wasn't sure whether it was needed or not. But one build bot is failing I think?

I’m not sure which bot you’re referring to, but all the CI checks have passed, and there’s a green ✔ as well.

!buildbot Windows

🤖 New build scheduled with the buildbot fleet by @picnixz for commit 6c60512 🤖

The command will test the builders whose names match following regular expression: Windows

The builders matched are:

ARM64 Windows Non-Debug PR
AMD64 Windows11 Bigmem PR
AMD64 Windows10 PR
AMD64 Windows11 Non-Debug PR
AMD64 Windows Server 2022 NoGIL PR
AMD64 Windows11 Refleaks PR
ARM64 Windows PR

I misunderstood the type of bot running in CI.
I thought all the bots specified with !buildbot Windows were running in CI.

I’m not sure why the bot is failing.
There are no changes to production code this time.
Looking at the bot’s traceback, it seems that something related to f-strings isn’t working correctly, but the test code I added this time doesn’t use any f-strings.

!buildbot Windows

You don't have write permissions to trigger a build

Sorry, I had to step away yesterday.

By the way, do we need a if name == 'main' block executing the unittest as is?

No, that's not necessary in new tests. But it doesn't hurt.

I misunderstood the type of bot running in CI.

The Buildbot tests run after merge, as they can be slow or unreliable. And they run on volunteer-maintained hardware; for security we only run them on reviewed code.
I triggered them in order to check the test on several versions of Windows, e.g. 32-bit or ARM.
Sometimes they find issues in uncommon setups. Usually, some fail for unrelated reasons; those can be ignored. (GitHub unfortunately shows a scary-looking red message if any reported tests fail.)

Thanks @junkmd for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

Thanks @junkmd for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

…s. (pythonGH-126610) (cherry picked from commit 7725c03) Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

GH-127159 is a backport of this pull request to the 3.13 branch.

GH-127160 is a backport of this pull request to the 3.12 branch.

…ds. (GH-126610) (GH-127159) (cherry picked from commit 7725c03) Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

…ds. (GH-126610) (GH-127160) (cherry picked from commit 7725c03) Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

…s. (pythonGH-126610)

junkmd added 2 commits November 9, 2024 02:49

Add tests.

ff06232

Add comments.

8049c1a

bedevere-app Bot added tests Tests in the Lib/test dir awaiting review labels Nov 9, 2024

bedevere-app Bot mentioned this pull request Nov 9, 2024

Add tests to verify the behavior of basic COM methods. #126384

Closed

junkmd added 2 commits November 9, 2024 03:15

Add the platform bridge.

c85bd93

Update IsEqualGUID.

f77b18d

junkmd mentioned this pull request Nov 9, 2024

ctypes: Make COMError, mentioned in the "Function prototypes" section of documentation, public. #126615

Closed

ZeroIntensity added skip news topic-ctypes labels Nov 10, 2024

junkmd added 3 commits November 10, 2024 11:36

Improve naming.

c43dfa4

Add comments.

be31c06

Add comments for typing.

c09a6a1

junkmd mentioned this pull request Nov 11, 2024

gh-126615: Make COMError public and add to ctypes doc. #126686

Merged

encukou reviewed Nov 18, 2024

View reviewed changes

Comment thread Lib/test/test_ctypes/test_win32_com_foreign_func.py

encukou reviewed Nov 18, 2024

View reviewed changes

Comment thread Lib/test/test_ctypes/test_win32_com_foreign_func.py Outdated

encukou reviewed Nov 18, 2024

View reviewed changes

junkmd added 3 commits November 18, 2024 14:12

Improve platform bridges.

f96a1ee

ProtoComMethod -> create_proto_com_method

c90ae51

WindowsError -> OSError

cc07c44

junkmd requested a review from encukou November 18, 2024 14:49

picnixz reviewed Nov 21, 2024

View reviewed changes

Comment thread Lib/test/test_ctypes/test_win32_com_foreign_func.py

encukou approved these changes Nov 21, 2024

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels Nov 21, 2024

picnixz approved these changes Nov 21, 2024

View reviewed changes

Add if __name__ == '__main__'

6c60512

Merge branch 'main' into add_com_method_tests

f0d3ede

encukou merged commit 7725c03 into python:main Nov 22, 2024

bedevere-app Bot removed the awaiting merge label Nov 22, 2024

encukou added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Nov 22, 2024

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Nov 22, 2024

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Nov 22, 2024

junkmd deleted the add_com_method_tests branch November 22, 2024 21:27

encukou pushed a commit that referenced this pull request Nov 25, 2024

[3.13] gh-126384 : Add tests to verify the behavior of basic COM metho…

f0c47ea

…ds. (GH-126610) (GH-127159) (cherry picked from commit 7725c03) Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

encukou pushed a commit that referenced this pull request Nov 25, 2024

[3.12] gh-126384 : Add tests to verify the behavior of basic COM metho…

f7e587d

…ds. (GH-126610) (GH-127160) (cherry picked from commit 7725c03) Co-authored-by: Jun Komoda <45822440+junkmd@users.noreply.github.com>

ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025

pythongh-126384 : Add tests to verify the behavior of basic COM method…

d133868

…s. (pythonGH-126610)

gh-126384: Add tests to verify the behavior of basic COM methods. by junkmd · Pull Request #126610 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-126384: Add tests to verify the behavior of basic COM methods. - #126610

gh-126384: Add tests to verify the behavior of basic COM methods.#126610encukou merged 12 commits intopython:mainpython/cpython:mainfrom junkmd:add_com_method_testsjunkmd/cpython:add_com_method_testsCopy head branch name to clipboard

Conversation

junkmd commented Nov 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

junkmd commented Nov 10, 2024

Uh oh!

Uh oh!

Uh oh!

encukou left a comment

Choose a reason for hiding this comment

Uh oh!

junkmd commented Nov 20, 2024

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

encukou left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

encukou commented Nov 21, 2024

Uh oh!

encukou commented Nov 21, 2024

Uh oh!

bedevere-bot commented Nov 21, 2024

Uh oh!

junkmd commented Nov 21, 2024

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

junkmd commented Nov 21, 2024

Uh oh!

picnixz commented Nov 21, 2024

Uh oh!

junkmd commented Nov 21, 2024

Uh oh!

picnixz commented Nov 21, 2024

Uh oh!

bedevere-bot commented Nov 21, 2024

Uh oh!

junkmd commented Nov 21, 2024

Uh oh!

junkmd commented Nov 22, 2024

Uh oh!

bedevere-bot commented Nov 22, 2024

Uh oh!

encukou commented Nov 22, 2024

Uh oh!

miss-islington-app Bot commented Nov 22, 2024

Uh oh!

miss-islington-app Bot commented Nov 22, 2024

Uh oh!

bedevere-app Bot commented Nov 22, 2024

Uh oh!

bedevere-app Bot commented Nov 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gh-126384: Add tests to verify the behavior of basic COM methods.#126610
encukou merged 12 commits into
python:mainfrom
junkmd:add_com_method_tests

junkmd commented Nov 9, 2024 •
edited
Loading

encukou left a comment •
edited
Loading