Update comtypes to version 1.4.6 #17061

LeonarddeR · 2024-08-27T07:36:02Z

Link to issue number:

None

Summary of the issue:

There have been many updates to Comtypes since last time we updated.

Description of user facing changes

None

Description of development approach

Updated comtypes to 1.4.6.
Updated the UIAutomation comtypes wrapper.

Testing strategy:

Should be tested during daily use.

Known issues with pull request:

None known

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

Summary by CodeRabbit

New Features
- Updated the Comtypes library to version 1.4.6, enhancing functionality and performance.
- Introduced new enumerations in UI automation to improve type safety and code clarity.
Bug Fixes
- Improved import structure in UIAutomationClient.py for better reliability.
Documentation
- Added notes on breaking changes in the Add-on API, advising developers to re-test and update their Add-ons.

coderabbitai · 2024-08-27T07:53:29Z

Walkthrough

The recent updates involve modifications to the requirements.txt file, upgrading the comtypes library version from 1.2.0 to 1.4.6. The UIAutomationClient.py file has undergone significant enhancements, including a direct import structure and the introduction of new classes using the IntFlag enumeration for better clarity. Additionally, the comtypesMonkeyPatches.py file has updated copyright years and restructured an import statement. A breaking change for the Add-on API is also noted in the documentation.

Changes

Files	Change Summary
`requirements.txt`	Updated `comtypes` version from `1.2.0` to `1.4.6`.
`source/comInterfaces/UIAutomationClient.py`	Replaced import mechanism, defined multiple new classes using `IntFlag` for UI automation states and options.
`source/monkeyPatches/comtypesMonkeyPatches.py`	Updated copyright notice to 2009-2024; modified import of `_compointer_base` from `comtypes` to `comtypes._post_coinit.unknwn`.
`user_docs/en/changes.md`	Noted breaking change for Add-on API compatibility, requiring developers to re-test and update their manifests; mentioned update to `comtypes` version `1.4.6`.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai · 2024-08-27T08:12:06Z

Oops, something went wrong! Please try again later. 🐰 💔

LeonarddeR · 2024-08-27T16:21:05Z

@coderabbitai you'wrote:

Added notes on breaking changes in the Add-on API, advising developers to re-test and update their Add-ons.

You're erroneously suggesting that this info is part of this pr.

coderabbitai · 2024-08-27T16:21:19Z

Tip

For best results, initiate chat on the files or code changes.

@LeonarddeR, my apologies for the mistake. I incorrectly suggested that the PR includes notes on breaking changes in the Add-on API. Thank you for pointing this out, and I will ensure that this error is not repeated in the future.

Learnings added

Learnt from: LeonarddeR
URL: https://github.com/nvaccess/nvda/pull/17061

Timestamp: 2024-08-27T16:21:18.344Z
Learning: Ensure that the AI-generated summary accurately reflects the changes in the PR and does not include erroneous information, such as suggesting breaking changes in the Add-on API when they are not part of the PR.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

seanbudd · 2024-08-28T04:35:13Z

How are these files generated / where are you adding them from? can you please add this to the dev approach and/or docs somewhere

LeonarddeR · 2024-08-28T05:42:59Z

Any suggestions where I should add this?

seanbudd · 2024-08-28T05:45:49Z

@LeonarddeR either in projectDocs\dev\createDevEnvironment.md or in a separate doc referenced by this

seanbudd · 2024-08-28T05:46:25Z

Actually, probably source\comInterfaces\readme.md but please add a reference to it from projectDocs\dev\createDevEnvironment.md

LeonarddeR · 2024-08-28T05:55:42Z

That file reads:

Only UIAutomation.py is not generated, UIA has historically been updated regularly and the version on
Appveyor build servers could not be guaranteed.

I wonder whether we should reconsider this position for two reasons:

It has been quite some time since this wrapper needed an update
I'm pretty sure Server 2022 has the right version on board.

LeonarddeR · 2024-08-28T06:01:51Z

Note that you suggested this in #15522 (comment), but then @lukaszgo1 pointed out in #15522 (review) that Server 2019 contained an outdated version. However, appveyor is on server 2022 now.

AppVeyorBot · 2024-08-28T12:18:22Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/x5a629em16sr3fv0/artifacts/output/nvda_snapshot_pr17061-33597,cfb74ff2.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 13.4,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.5,
FINISH_END 0.1

See test results for failed build of commit cfb74ff2c6

seanbudd · 2024-08-29T01:15:51Z

@LeonarddeR - you are right, as far as we are aware the UIA interface should be fairly stable now. Lets use AppVeyor now

seanbudd · 2024-08-29T03:00:09Z

Can you please fix up the git excludes and ruff format?

https://results.pre-commit.ci/run/github/45885732/1724844260.36kQ5pFwQpmFQXxO-uMqNw

source/comInterfaces_sconscript

LeonarddeR added 2 commits August 27, 2024 09:34

Update comtypes

110985f

Update docs

6d6bc18

LeonarddeR added the merge-early Merge Early in a developer cycle label Aug 27, 2024

LeonarddeR added 2 commits August 27, 2024 09:40

Update UIAutomationClient wrapper

bb8975f

Update monkey patches

7660567

LeonarddeR marked this pull request as ready for review August 27, 2024 07:53

LeonarddeR requested a review from a team as a code owner August 27, 2024 07:53

LeonarddeR requested a review from SaschaCowley August 27, 2024 07:53

Generate UIAutomationClient at build time

14562c9

seanbudd added the blocked/needs-product-decision A product decision needs to be made. Decisions about NVDA UX or supported use-cases. label Aug 29, 2024

seanbudd removed the blocked/needs-product-decision A product decision needs to be made. Decisions about NVDA UX or supported use-cases. label Aug 29, 2024

LeonarddeR added 2 commits August 29, 2024 07:59

Remove out of date references

3995434

Merge remote-tracking branch 'origin/master' into bumpComtypes

74acbb1

seanbudd reviewed Aug 29, 2024

View reviewed changes

source/comInterfaces_sconscript Outdated Show resolved Hide resolved

seanbudd approved these changes Aug 29, 2024

View reviewed changes

Update source/comInterfaces_sconscript

b146d23

seanbudd merged commit c23aed9 into nvaccess:master Aug 29, 2024
2 checks passed

github-actions bot added this to the 2025.1 milestone Aug 29, 2024

junkmd mentioned this pull request Oct 6, 2024

Documentation should mention that it is unnecessary to release returned objects enthought/comtypes#612

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update comtypes to version 1.4.6 #17061

Update comtypes to version 1.4.6 #17061

LeonarddeR commented Aug 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 27, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

coderabbitai bot commented Aug 27, 2024

LeonarddeR commented Aug 27, 2024

coderabbitai bot commented Aug 27, 2024

seanbudd commented Aug 28, 2024

LeonarddeR commented Aug 28, 2024

seanbudd commented Aug 28, 2024

seanbudd commented Aug 28, 2024 •

edited

Loading

LeonarddeR commented Aug 28, 2024

LeonarddeR commented Aug 28, 2024

AppVeyorBot commented Aug 28, 2024

seanbudd commented Aug 29, 2024

seanbudd commented Aug 29, 2024

Update comtypes to version 1.4.6 #17061

Update comtypes to version 1.4.6 #17061

Conversation

LeonarddeR commented Aug 27, 2024 • edited by coderabbitai bot Loading

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Summary by CodeRabbit

coderabbitai bot commented Aug 27, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

Documentation and Community

coderabbitai bot commented Aug 27, 2024

LeonarddeR commented Aug 27, 2024

coderabbitai bot commented Aug 27, 2024

seanbudd commented Aug 28, 2024

LeonarddeR commented Aug 28, 2024

seanbudd commented Aug 28, 2024

seanbudd commented Aug 28, 2024 • edited Loading

LeonarddeR commented Aug 28, 2024

LeonarddeR commented Aug 28, 2024

AppVeyorBot commented Aug 28, 2024

seanbudd commented Aug 29, 2024

seanbudd commented Aug 29, 2024

LeonarddeR commented Aug 27, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 27, 2024 •

edited

Loading

seanbudd commented Aug 28, 2024 •

edited

Loading