Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move CallCancelled from core and all RPC constants into an enum #12940


Copy link

Keeping as a draft until development cycle for 2022.1 starts.

Link to issue number:


Summary of the issue:

Currently various RPC constants we use are scattered through out the code base. Also some stuff is defined in core but is not related to core in any way.

Description of how this pull request fixes the issue:

  • CallCancelled is moved to the new exceptions module
  • All RPC constants both from core and from logHandler are moved into an enum .

Testing strategy:

Made sure that logging still works and that CallCancelled is raised when appropriate.

Known issues with pull request:

This breaks backwards compatibility - while these moves are nice from the code layout perspective I don't think they are important enough to justify providing backwards compat.

Change log entries:

For Developers

  • core.CallCancelled becomes exceptions.CallCancelled
  • All constants starting with RPC from core and logHandler are moved into RPCConstants.RPC enum.

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

Copy link
Contributor Author

Given development cycle for 2022.1 has began I'm marking this as ready for review.

@lukaszgo1 lukaszgo1 marked this pull request as ready for review October 19, 2021 09:00
@lukaszgo1 lukaszgo1 requested a review from a team as a code owner October 19, 2021 09:00
@michaelDCurran michaelDCurran merged commit 269224e into nvaccess:master Oct 20, 2021
@nvaccessAuto nvaccessAuto added this to the 2022.1 milestone Oct 20, 2021
@lukaszgo1 lukaszgo1 deleted the separate-core-exceptions-and-constants branch October 20, 2021 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

3 participants