Skip to content

Fix up braille deprecations#20458

Draft
SaschaCowley wants to merge 15 commits into
masterfrom
braille-deprecations
Draft

Fix up braille deprecations#20458
SaschaCowley wants to merge 15 commits into
masterfrom
braille-deprecations

Conversation

@SaschaCowley

@SaschaCowley SaschaCowley commented Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Link to issue number:

Closes #20431
Follow-up to #20390

Summary of the issue:

In #20252, source/braille.py was split into the source/braille/ package. In #20390, the moved symbols were marked as deprecated. Internal code that uses these symbols was not updated to use the new paths, so logs are being flooded with deprecation warnings.

Description of user facing changes:

None.

Description of developer facing changes:

NVDA's logs should once again be useable.

Description of development approach:

Marked the tests.unit.test_braille.test_publicSurface.TestBraillePublicSurface.test_deprecatedNamesReturnCorrectObject test as skipped.

For each symbol in:

  • Searched NVDA's python code (source/ and tests/) for that symbol.
  • For each found instance:
    • Updated it to use the new path; and
    • Where the calling module did not already do so, imported the new symbol's module.
  • Commented out the redirect.
  • Ran unit tests.

Testing strategy:

Unit and system tests.

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.

github-code-quality[bot]
github-code-quality Bot found potential problems Jul 7, 2026
View reviewed changes
Comment thread source/brailleDisplayDrivers/alva.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/baum.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/brailleNote.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/brailliantB.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/eurobraille/gestures.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/handyTech.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/hidBrailleStandard.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/hims.py


class KeyInputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class KeyInputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/_remoteClient/input.py


class BrailleInputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class BrailleInputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
Comment thread source/brailleDisplayDrivers/nlseReaderZoomax.py


class InputGesture(braille.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
class InputGesture(braille.display.gesture.BrailleDisplayGesture, brailleInput.BrailleInputGesture):
@LeonarddeR

LeonarddeR commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

@SaschaCowley Thanks for taking this!

@hwf1324

hwf1324 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

I noticed that there are still some deprecation warnings in the logs.

@seanbudd

seanbudd commented Jul 9, 2026

Copy link
Copy Markdown
Member

That's okay - several smaller PRs that tackle these individually is much easier to review

SaschaCowley added 14 commits July 9, 2026 19:39
@SaschaCowley
braille.display.driver.BrailleDisplayDriver
8b46496
@SaschaCowley
braille.display.gesture.BrailleDisplayGesture
b90a5ad
@SaschaCowley
braille.display.{DisplayDimensions, getDisplayDrivers, getDisplayList…
c790b08 
…, getSerialPorts, RENAMED_DRIVERS}
@SaschaCowley
braille.regions.base.Region
cdb445d
@SaschaCowley
braille.regions.NVDAObject.NVDAObjectRegion
3d91c34
@SaschaCowley
braille.regions.textInfo.TextInfoRegion
86b0133
@SaschaCowley
braille.regions.properties.{getControlFieldBraille, getPropertiesBrai…
063094d 
…lle}
@SaschaCowley
braille.regions.focus.invalidateCachedFocusAncestors
7334893
@SaschaCowley
braille.labels.{landmarkLabels, roleLabels}
82d0b69
@SaschaCowley
braille.constants.{AUTO_DISPLAY_NAME, AUTOMATIC_PORT, CONTEXTPRES_CHA…
3f30546 
…NGEDCONTEXT, CONTEXTPRES_FILL, CONTEXTPRES_SCROLL, CONTINUATION_SHAPE, CURSOR_SHAPES, TEXT_SEPARATOR, focusContextPresentations}
@SaschaCowley
braille.extensions.{decide_enabled, displayChanged, displaySizeChange…
a4e2338 
…d, filter_displayDimensions, filter_displaySize, pre_writeCells}
@SaschaCowley
config.configFlags.{BrailleMode, TetherTo}
76a47ff
@SaschaCowley
Replace backcompat shim and tests
a5097d5
@SaschaCowley
Merge remote-tracking branch 'origin/master' into braille-deprecations
ddb470f
@SaschaCowley SaschaCowley force-pushed the braille-deprecations branch from 09160f5 to ddb470f Compare July 9, 2026 10:04
@SaschaCowley SaschaCowley requested a review from LeonarddeR July 9, 2026 10:07
@SaschaCowley

SaschaCowley commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

I believe this is done, pending system tests

@LeonarddeR

LeonarddeR commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

I'm not sure how to review this properly, at first sight this looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LeonarddeR LeonarddeR Awaiting requested review from LeonarddeR
1 more reviewer
@github-code-quality github-code-quality[bot] github-code-quality[bot] left review comments
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

A large number of deprecation warnings are flooding the logs.

4 participants

@SaschaCowley @LeonarddeR @hwf1324 @seanbudd