Make Python console opening more robust

[CyrilleB79]

Link to issue number:

Closes #17391

Summary of the issue:

When opening Python console with NVDA+control+Z, NVDA initialize snapshot variables. If an error occurs during the initialization of these variables, the console cannot open.

Description of user facing changes

The Python console will not fail to open anymore in case an error occurs while retrieving snapshot variables. If an exception occurs while retrieving a snapshot variable, this variable is set to None.

Note: I have imagined to display an error dialog if one or more variable cannot be retrieved successfully, but:

• I have not been able to implement one. My trial lead to a not vocalized dialog, probably because run from the main thread instead of wx one.
• I also wonder if there are side effect having a dialog here. So I'd like to discuss this point before choosing investigating how to implement this design if you agree.

Description of development approach

For each snapshot variable, catch any exception that can occur during its retrieval and initialize the variable to None if retrieval has failed. Also log the corresponding error.

Note: I have added one more #noqa E402. I am tempted to remove all of them but have not done so because I do not know why they have been added in the first place.

Testing strategy:

Manual test: Steps of #17391.

Known issues with pull request:

None

Code Review Checklist:

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

@coderabbitai summary

[AppVeyorBot]

• 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/uetfs9seqh3f2jjm/artifacts/output/l10nUtil.exe nvda_snapshot_pr17392-34556,b8192d5a.exe
• CI timing (mins): INIT 0.0, INSTALL_START 1.6, INSTALL_END 1.2, BUILD_START 0.0, BUILD_END 31.0, TESTSETUP_START 0.0, TESTSETUP_END 0.5, TEST_START 0.0, TEST_END 19.4, FINISH_END 0.2

See test results for failed build of commit b8192d5a63

[CyrilleB79]

@seanbudd thanks for your review. I'll remove alll other lambda function following your example where not necessary.

In addition, I'd like to know your opinion on:

• Should we issue an error message if a variable cannot be retrieved? (see "Description of user facing changes") If yes, how to do this?
• Should I remove #noqa E402's and put the docstring above? See "Description of development approach". If yes, any idea why it was not done so in the first time?

[AppVeyorBot]

• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/0icybh5slt4c9nmp/artifacts/output/
• CI timing (mins): INIT 0.0, INSTALL_START 1.5, INSTALL_END 1.0, BUILD_START 0.0, FINISH_END 17.5

See test results for failed build of commit 4967d080ed

[CyrilleB79]

@seanbudd, finally, I have removed the noqa's for imports; maybe they appeared during Ruff's introduction.

Just let me know for the message box in case of error.