Use static ids in Poedit 3.5+ by LeonarddeR · Pull Request #16889 · nvaccess/nvda

LeonarddeR · 2024-07-20T10:51:32Z

Link to issue number:

Summary of the issue:

The Poedit appmodule relies on some complex calculation logic to announce several pieces of information with shortcuts, e.g. translator notes/comments/warnings.

Description of user facing changes

None

Description of development approach

@vslavik kindly introduced static ids for the controls we need for our appModule. That work is in vslavik/poedit#850

Testing strategy:

Test with https://download.poedit.net/tmp/Poedit-3.5nvda-setup.exe

Known issues with pull request:

Breaks compatibility with Poedit versions before this fix, but should stay compatible with all versions to come, as long as these ids stay static.

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.
-x[ ] Security precautions taken.

Summary by CodeRabbit

New Features
- Consolidated control ID management into a single class for improved maintainability and clarity.
- Streamlined method signatures for retrieving objects associated with control IDs.
Bug Fixes
- Refined string formatting in the CancellableSpeech class to improve output consistency.
Refactor
- Removed redundant classes and updated method implementations to enhance code readability and structure.

LeonarddeR · 2024-07-20T11:06:02Z

@ruifontes I recall you have the pro version. Would you be able to test with this build of poedit along with this pr?

CyrilleB79 · 2024-07-20T21:39:08Z

@LeonarddeR in addition, would you test strings with plurals for:

languages with 2 forms (e.g. English); probably already done
language with only one form (e.g. Chinese)
language with more than 2 forms, e.g. Slovenian.

vslavik · 2024-07-22T10:00:41Z

@LeonarddeR in addition, would you test strings with plurals for:

Ah, this is something I meant to ask: do you need static IDs for some or all of the text fields (source plural + singular; translation singular or translation plurals (variable count))?

LeonarddeR · 2024-07-22T16:06:57Z

I don't think we need these now, but people might have different opinions about that

vslavik · 2024-07-26T17:48:55Z

I don't think we need these now, but people might have different opinions about that

OK, so let's only add fixed IDs when they become useful for something (feel free to e.g. add comment there to file an issue at poedit in such cases).

for more information, see https://pre-commit.ci

coderabbitai · 2024-08-21T09:47:24Z

Walkthrough

The recent updates streamline the poedit.py module by consolidating control ID management into a single class, _WindowControlId. This change simplifies method signatures and enhances code clarity by replacing outdated naming conventions. Additionally, minor adjustments in formatting were made to the CancellableSpeech class in commands.py, improving string representation without affecting functionality.

Changes

Files	Change Summary
`source/appModules/poedit.py`	Restructured control ID management by renaming `_WindowControlIdOffsetFromDataView` to `_WindowControlId`, removing `_WindowControlIdOffsetFromSidebar`, and updating related method signatures for clarity and maintainability.
`source/speech/commands.py`	Modified string formatting in the `__repr__` method of the `CancellableSpeech` class to remove unnecessary space before the closing brace, enhancing output appearance.

Tip

Early access features: enabled

We are currently testing the following features in early access:

Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. We're excited to hear your feedback as we evaluate its performance over the next few days.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
Please join our Discord Community to provide feedback and report issues on the discussion post.

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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

LeonarddeR · 2024-08-21T09:47:46Z

vslavik/poedit#850 was just merged.

CyrilleB79 · 2024-08-21T10:44:39Z

If the first compatible poedit version changes with this PR, it should be mentioned in the change log.

LeonarddeR · 2024-08-21T16:39:46Z

The first compatible version is not yet released. @vslavik is not sure about its release date.
That said, the milestone for 2024.4 is due october 28, I guess it is safe to assume that version 3.5 will be release before then.

CyrilleB79 · 2024-08-21T19:52:10Z

This PR can be reviewed but it should not be merged until poedit 3.5 is available.

LeonarddeR · 2024-08-29T16:07:57Z

@seanbudd This pr needs to go in the earliest possible release after the release of Poedit 3.5, which release date is unfortunately not yet known.

vslavik · 2024-08-29T16:11:33Z

Poedit 3.5, which release date is unfortunately not yet known.

August 30.

SaschaCowley · 2024-08-29T23:17:08Z

@LeonarddeR will Poedit 3.5 support be broken without this PR?

seanbudd

Generally looks good to me

LeonarddeR · 2024-08-30T04:59:48Z

@LeonarddeR will Poedit 3.5 support be broken without this PR?

Yes.

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

seanbudd

note changes to liblouis have been pushed

LeonarddeR · 2024-08-30T05:52:56Z

@seanbudd wrote:

note changes to liblouis have been pushed

How are those changes related to this pr?

seanbudd · 2024-08-30T05:57:18Z

@LeonarddeR - you may have committed something by mistake it was pushed in e91216d

LeonarddeR · 2024-08-30T06:39:31Z

I'm sorry. Should've been fixed now.

LeonarddeR · 2024-08-30T18:19:09Z

Poedit 3.5 is there!

SaschaCowley

Please edit the Poedit section of the User Guide to state version 3.5 is the minimum supported version.

Use static ids in Poedit 3.5+

16f15d3

LeonarddeR added blocked/needs-external-fix app-specific labels Jul 20, 2024

Fix order for needs work reporting with beeps

9d20f50

LeonarddeR mentioned this pull request Jul 20, 2024

Use static IDs for controls needed by NVDA vslavik/poedit#850

Merged

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jul 30, 2024

LeonarddeR and others added 2 commits August 1, 2024 07:35

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

4d6f508

[pre-commit.ci] auto fixes from pre-commit.com hooks

4ce2b99

for more information, see https://pre-commit.ci

LeonarddeR removed the blocked/needs-external-fix label Aug 21, 2024

LeonarddeR marked this pull request as ready for review August 21, 2024 09:47

LeonarddeR requested a review from a team as a code owner August 21, 2024 09:47

LeonarddeR requested a review from SaschaCowley August 21, 2024 09:47

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

b6fcecd

LeonarddeR added this to the 2024.4 milestone Aug 21, 2024

LeonarddeR added 2 commits August 21, 2024 18:41

Update changelog

92b96bf

Fix changes

4b30f4b

seanbudd added the blocked label Aug 27, 2024

LeonarddeR changed the base branch from master to beta August 29, 2024 16:06

seanbudd reviewed Aug 29, 2024

View reviewed changes

Comment thread source/appModules/poedit.py Outdated

Comment thread source/appModules/poedit.py

seanbudd requested a review from michaelDCurran August 30, 2024 00:36

seanbudd removed the blocked label Aug 30, 2024

Apply suggestions from code review

62e214b

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

seanbudd reviewed Aug 30, 2024

View reviewed changes

Comment thread user_docs/en/changes.md

LeonarddeR added 3 commits August 30, 2024 07:21

Add new line separators

e91216d

Merge remote-tracking branch 'origin/beta' into poeditStaticIds

5b287c7

Update release blurp

6c2ab01

seanbudd reviewed Aug 30, 2024

View reviewed changes

Comment thread user_docs/en/changes.md Outdated

Update user_docs/en/changes.md

a2e1ad4

seanbudd reviewed Aug 30, 2024

View reviewed changes

Fix accidental liblouis change

f4c9a46

seanbudd approved these changes Aug 30, 2024

View reviewed changes

michaelDCurran approved these changes Sep 1, 2024

View reviewed changes

SaschaCowley requested changes Sep 1, 2024

View reviewed changes

seanbudd mentioned this pull request Sep 1, 2024

Fix TextInfo.moveToCodepointOffset() in PoEdit #16484

Closed

5 tasks

Update user guide

c117d5e

SaschaCowley requested a review from a team as a code owner September 2, 2024 00:42

SaschaCowley requested review from Qchristensen and seanbudd September 2, 2024 00:42

SaschaCowley approved these changes Sep 2, 2024

View reviewed changes

seanbudd merged commit 4015f1c into nvaccess:beta Sep 2, 2024

LeonarddeR deleted the poeditStaticIds branch August 23, 2025 06:27

Uh oh!

Conversation

LeonarddeR commented Jul 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

LeonarddeR commented Jul 20, 2024

Uh oh!

CyrilleB79 commented Jul 20, 2024

Uh oh!

vslavik commented Jul 22, 2024

Uh oh!

LeonarddeR commented Jul 22, 2024

Uh oh!

vslavik commented Jul 26, 2024

Uh oh!

coderabbitai Bot commented Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

LeonarddeR commented Aug 21, 2024

Uh oh!

CyrilleB79 commented Aug 21, 2024

Uh oh!

LeonarddeR commented Aug 21, 2024

Uh oh!

CyrilleB79 commented Aug 21, 2024

Uh oh!

LeonarddeR commented Aug 29, 2024

Uh oh!

vslavik commented Aug 29, 2024

Uh oh!

SaschaCowley commented Aug 29, 2024

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LeonarddeR commented Aug 30, 2024

Uh oh!

Uh oh!

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

LeonarddeR commented Aug 30, 2024

Uh oh!

seanbudd commented Aug 30, 2024

Uh oh!

LeonarddeR commented Aug 30, 2024

Uh oh!

LeonarddeR commented Aug 30, 2024

Uh oh!

SaschaCowley left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

LeonarddeR commented Jul 20, 2024 •

edited

Loading

coderabbitai Bot commented Aug 21, 2024 •

edited

Loading