Update poedit appmodule for version 3.4+ by LeonarddeR · Pull Request #15313 · nvaccess/nvda

LeonarddeR · 2023-08-19T13:44:41Z

Link to issue number:

Summary of the issue:

NVDA has specific functionality for Poedit, but this is only supported in version 1.

Description of user facing changes

Add support for Poedit 3.4 while dropping support for Poedit 1. Compared to the previous Poedit 1 support, support has been added to report the old source text and any translation warning. There is also an audio indication when the needs work checkbox is enabled (fuzzy messages).

Description of development approach

Created a revamped module for Poedit 3.

Testing strategy:

Tested reporting of:

Translation notes
Comments
Warnings
Old source text (for fuzzy messages)
Needs work check box (Poedit 3.4+)

I tested with Poedit 3.0, 3.3.2 and 3.4 to ensure the logic to calculate window control ids would be stable across releases.

Known issues with pull request:

This drops support for Poedit 1, but as Poedit 3 is perfectly accessible, I think we shouldn't bother. It might be nice to encourage translators to update their Poedit

Code Review Checklist:

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

AppVeyorBot · 2023-08-19T14:45:55Z

FAIL: Translation comments check. Translation comments missing or unexpectedly included. See build log for more information.
PASS: Unit tests.
PASS: Lint check.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/n4x4cm2tfsfkoitx/artifacts/output/nvda_snapshot_pr15313-28907,f5c2cba9.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 25.5,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 22.8,
FINISH_END 0.2

See test results for failed build of commit f5c2cba967

AppVeyorBot · 2023-08-19T17:06:47Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/94jeehkhr5h2cyd8/artifacts/output/nvda_snapshot_pr15313-28911,9b26ce53.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 22.0,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 21.7,
FINISH_END 0.2

See test results for failed build of commit 9b26ce53f7

gregjozk · 2023-08-20T21:48:21Z

Hello,

thanks for much needed upgrade.
just a question, will upgraded modul incorporated features from Poedit addons (one from portugal and one from Nepal) - excuse me I don't know names of all contributers for mensioned addons... See: https://groups.io/g/nvda-translations/topic/new_poedit_add_on/90806613?p=,,,100,0,0,0::recentpostdate/sticky,,,100,2,0,90806613,previd%3D1692558197340101298,nextid%3D1659276346104250870&previd=1692558197340101298&nextid=1659276346104250870

Thanks again.

regards
Jožef

LeonarddeR · 2023-08-21T06:16:59Z

It's a pity this add-on was never contributed to core. I'm open for suggestions to enhance this, though. I probably need to look into the singular and plural translations first.

LeonarddeR · 2023-08-21T06:26:54Z

cc @ruifontes

DraganRatkovich · 2023-08-22T15:48:15Z

Hello,
@LeonarddeR Many thanks for the much needed update. Now that I have checked the build with the latest version of Poedit, I can easily read any translator note, however, without the Poedit add-on, I cannot read any of the errors presented in the translation.
When I enable the Poedit add-on and press ctrl+shift+e it reads all the errors if there are any, however in this case I can't read the notes for the translators.
Is it possible to fix these conflicts because it would be a huge step in the usability of Poedit as translator notes are a really important feature in translatable strings and because of this feature I think going back to the old version is really useless.

@LeonarddeR Maybe you can contribute to the development of the add-on and make it possible to properly obtain IDs, because as far as I know, the free version has different IDs (or whatever they are called) compared to the Pro version.

LeonarddeR · 2023-08-22T15:50:18Z

@DraganRatkovich Are you using the fre or the pro version? I have no access to the pro version so I can't test with that.

DraganRatkovich · 2023-08-22T15:53:34Z

@LeonarddeR I am using the free version.

zstanecic · 2023-08-22T16:11:28Z

I am using the pro version @LeonarddeR From: Leonard de Ruijter ***@***.***> Sent: Tuesday, August 22, 2023 5:51 PM To: nvaccess/nvda ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [nvaccess/nvda] Update poedit appmodule for version 3 (PR #15313) @DraganRatkovich <https://github.com/DraganRatkovich> Are you using the fre or the pro version? I have no access to the pro version so I can't test with that. — Reply to this email directly, view it on GitHub <#15313 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACVCDE55I4ROIVAXJRZP4MLXWTIMVANCNFSM6AAAAAA3WS5KYI> . You are receiving this because you are subscribed to this thread. <https://github.com/notifications/beacon/ACVCDE5CBS2O3YQEPUHB6LLXWTIMVA5CNFSM6AAAAAA3WS5KYKWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTTEUQHIA.gif> Message ID: ***@***.*** ***@***.***> >

LeonarddeR · 2023-08-22T16:18:50Z

@zstanecic How does it behave for you?

Adriani90 · 2023-08-23T22:12:53Z

Will the new updated app module handle #4371 as well?

LeonarddeR · 2023-08-24T08:07:15Z

Good catch, thanks @Adriani90

LeonarddeR · 2023-08-24T16:27:53Z

@gregjozk and @DraganRatkovich
I had a brief look into the add-on. I'm inclined not to change anything in the current pull request for now.

Errors (or translation warnings) can be accessed by pressing ctrl+shift+w
There is some logic in the add-on to report additional errors (e.g. missmatch in string replacement parameters), but IMO that's a responsibility of poedit to report as a translation warning, if it not already does so.
There is also logic to clear translations or copy source/translated text to the clipboard. This is also out of scope for a rewrite of the add-on.
Some things in the add-on seem to be buggy, such as reporting comments and fuzzy status. This module also reports fuzzy status and ctrl+shift+o allows you to report the previous text.

I'd suggest @ruifontes to update the add-on after this pr is merged into an official release, basing the appModule with the additions on the module in NVDA core.

gregjozk · 2023-08-24T19:46:22Z

Hello, thx for your good work. I just wanted to help you when I linked a poedit topic from translation list. Can I have another question, will b dialogs (more spacifically) some checkable elements in them accessible for NVDA? example: view -> customize wornings, where (I believe) you can check/uncheck, which wornings would be shown. best regards Jožef 2023-08-24 18:28 GMT+02.00, Leonard de Ruijter ***@***.***>:

…

@gregjozkand @DraganRatkovich I had a brief look into the add-on. I'm inclined not to change anything in the current pull request for now. 1. Errors (or translation warnings) can be accessed by pressing ctrl+shift+w 2. There is some logic in the add-on to report additional errors (e.g. missmatch in string replacement parameters), but IMO that's a responsibility of poedit to report as a translation warning, if it not already does so. 3. There is also logic to clear translations or copy source/translated text to the clipboard. This is also out of scope for a rewrite of the add-on. 4. Some things in the add-on seem to be buggy, such as reporting comments and fuzzy status. This module also reports fuzzy status and ctrl+shift+o allows you to report the previous text. I'd suggest @ruifontes to update the add-on after this pr is merged into an official release, basing the appModule with the additions on the module in NVDA core. -- Reply to this email directly or view it on GitHub: #15313 (comment) You are receiving this because you are subscribed to this thread. Message ID: ***@***.***>

seanbudd · 2023-08-25T01:07:06Z

-				obj = None
-		elif obj:
-			obj = obj.firstChild
+	def _getNVDAObjectForWindowControlIdOffset(self, windowControlIdOffset: WindowControlIdOffset):


can this get a return type added please

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

LeonarddeR · 2023-08-25T19:41:52Z

I've had another round of testing with the app module and it seems that fuzzy messages aren't yet covered correctly. I have no idea how to fix this though. It seems like the only thing happening is that the icon displayed on the needs work button changes, as well as the text colors change to orange, but these are colors we couldn't detect.

ruifontes · 2023-08-26T11:37:41Z

@LeonarddeR you can check if an entry is classified as "Fuzzy" by checking the 3 new fields that are shown.
They have an ID with a value of more 59, 60 and 61 in relation to the entries list ID...

ruifontes · 2023-10-06T14:37:03Z

@LeonarddeR , I found one thing that can change the game...
The controlID difference between the paid and free version is 1, meaning by instance, that controlID for translated text in free version is -31901 then in paid version will be -31902.
So, checking the difference between the first sub window and translation list IDs, we can determine if it is a paid or free version.
Regarding your comment:

how was it working before this PR?
The only controlID equals in free and paid version is the first sub window...
All controls we need to check the ID are afected by free or paid version.

ruifontes · 2023-10-06T14:44:14Z

@cyrille, thanks!
I did knew about that, but is always good to refresh the memory, and I an not even close so knowledgeable as you and others about NVDA and Python...
Waiting this PR is closed to work on that...

LeonarddeR · 2023-10-06T16:13:17Z

* The only controlID equals in free and paid version is the first sub window...
  All controls we need to check the ID are afected by free or paid version.

So are you saying that if we take the translations list control id as a reference, that will work across the paid and free versions?

ruifontes · 2023-10-06T16:18:30Z

Yes, all controls, except the one you have choosen, change across free and paid version...

LeonarddeR · 2023-10-06T17:05:39Z

Let's hope the new build that is currently underway also works for the pro version.

AppVeyorBot · 2023-10-06T17:15:45Z

FAIL: Translation comments check. Translation comments missing or unexpectedly included. See build log for more information.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/mkvcelxqtfp4o8r8/artifacts/output/nvda_snapshot_pr15313-29543,566b9817.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 24.6,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 5.1,
FINISH_END 0.1

See test results for failed build of commit 566b981725

AppVeyorBot · 2023-10-09T18:18:07Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/cyc2xbr4qwht8jtm/artifacts/output/nvda_snapshot_pr15313-29572,fc55bd78.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 23.8,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 5.0,
FINISH_END 0.1

See test results for failed build of commit fc55bd7847

AppVeyorBot · 2023-10-26T12:22:55Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/nb0rrg7odm58g7ih/artifacts/output/nvda_snapshot_pr15313-29750,db86bf0a.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 26.3,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 5.1,
FINISH_END 0.1

See test results for failed build of commit db86bf0a3a

seanbudd · 2023-10-26T23:37:58Z

Could this get a changelog entry please

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

seanbudd

Thanks @LeonarddeR

AppVeyorBot · 2023-10-30T02:09:03Z

PASS: Translation comments check.
PASS: Unit tests.
FAIL: Lint check. See test results for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/9mxr4tu6dvfnm5qj/artifacts/output/nvda_snapshot_pr15313-29781,cb098a66.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 24.8,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 7.7,
FINISH_END 0.1

See test results for failed build of commit cb098a6673

Qchristensen

Userguide looks good.

seanbudd · 2023-10-30T02:24:12Z

Just needs a lint fix and then this can be merged

Update poedit appmodule for version 3

2935e37

LeonarddeR requested review from a team as code owners August 19, 2023 13:44

LeonarddeR requested review from Qchristensen and seanbudd August 19, 2023 13:44

No translation if description of list item is empty

cc329f6

Fix translator comments

3babce3

LeonarddeR marked this pull request as draft August 21, 2023 06:17

LeonarddeR marked this pull request as ready for review August 24, 2023 16:28

seanbudd reviewed Aug 25, 2023

View reviewed changes

LeonarddeR and others added 3 commits August 25, 2023 08:43

Apply suggestions from code review

9d0e63c

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

Restore script names

5238246

Doc updates

802ae8d

LeonarddeR mentioned this pull request Aug 25, 2023

Prepend "needs work" to the accname for fuzzy strings in the list vslavik/poedit#696

Open

Hopefully make the pro version work as well

32e19f5

LeonarddeR removed the blocked/needs-internal-fix label Oct 6, 2023

Fix translator comment

12d20af

LeonarddeR force-pushed the poedit branch from 12d20af to 38dc9df Compare October 9, 2023 16:00

Fix support for pro thanks to @ruifontes

40795d4

LeonarddeR added 2 commits October 26, 2023 13:40

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

4006382

Update for Python 3.11

cb3d5ec

LeonarddeR force-pushed the poedit branch from 19e599b to cb3d5ec Compare October 26, 2023 11:48

LeonarddeR marked this pull request as ready for review October 26, 2023 11:49

seanbudd reviewed Oct 26, 2023

View reviewed changes

LeonarddeR and others added 2 commits October 27, 2023 07:55

Update changelog

a6ef021

Apply suggestions from code review

ae44f4b

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

seanbudd approved these changes Oct 30, 2023

View reviewed changes

Merge branch 'master' into poedit

ec76697

Qchristensen approved these changes Oct 30, 2023

View reviewed changes

Lint

177e6be

seanbudd merged commit 8b90ece into nvaccess:master Oct 31, 2023

LeonarddeR mentioned this pull request Apr 1, 2024

NVDA-2024.1 enhancements to Poedit do not work #16318

Closed

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

Uh oh!

Conversation

LeonarddeR commented Aug 19, 2023 • 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:

Uh oh!

AppVeyorBot commented Aug 19, 2023

Uh oh!

AppVeyorBot commented Aug 19, 2023

Uh oh!

gregjozk commented Aug 20, 2023

Uh oh!

LeonarddeR commented Aug 21, 2023

Uh oh!

LeonarddeR commented Aug 21, 2023

Uh oh!

DraganRatkovich commented Aug 22, 2023

Uh oh!

LeonarddeR commented Aug 22, 2023

Uh oh!

DraganRatkovich commented Aug 22, 2023

Uh oh!

zstanecic commented Aug 22, 2023 via email

Uh oh!

LeonarddeR commented Aug 22, 2023

Uh oh!

Adriani90 commented Aug 23, 2023

Uh oh!

LeonarddeR commented Aug 24, 2023

Uh oh!

LeonarddeR commented Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gregjozk commented Aug 24, 2023 via email

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanbudd Aug 25, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LeonarddeR commented Aug 25, 2023

Uh oh!

ruifontes commented Aug 26, 2023

Uh oh!

ruifontes commented Oct 6, 2023

Uh oh!

ruifontes commented Oct 6, 2023

Uh oh!

LeonarddeR commented Oct 6, 2023

Uh oh!

ruifontes commented Oct 6, 2023

Uh oh!

LeonarddeR commented Oct 6, 2023

Uh oh!

AppVeyorBot commented Oct 6, 2023

Uh oh!

AppVeyorBot commented Oct 9, 2023

Uh oh!

AppVeyorBot commented Oct 26, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanbudd commented Oct 26, 2023

Uh oh!

seanbudd left a comment

LeonarddeR commented Aug 19, 2023 •

edited

Loading

LeonarddeR commented Aug 24, 2023 •

edited

Loading