changes magnifier types and function name for clarity by Boumtchack · Pull Request #19882 · nvaccess/nvda

Boumtchack · 2026-03-31T15:06:17Z

Link to issue number:

pre - #19473
parts of #19810

Summary of the issue:

#19810 was still to big so I focused on types changes and some functions renaming to go accordingly.
All these changes are nescessary for futur magnifier implementations.

Description of user facing changes:

"default"s have been removed so it can be seen in the doc

Description of developer facing changes:

replaced MagnifierPosition with MagnifierParameters for better handling of size, place and filter of the magnifier.
added a MagnifierType to handle magnifiers different types.

Description of development approach:

This work was split out from PR #19473 to make review and integration easier.
We first added the new structure: MagnifierParameters for size/position/filter, and MagnifierType for futur mode switching.

Testing strategy:

Unit

Known issues with pull request:

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.

Copilot

Pull request overview

This PR refactors the magnifier configuration and type model to improve clarity and enable future magnifier mode work (e.g., fixed/docked/lens).

Changes:

Renames magnifier config keys/functions to drop the “default” wording (e.g., getDefaultZoomLevel → getZoomLevel) and updates UI bindings accordingly.
Reworks magnifier geometry/type types (introduces MagnifierParameters, Size, Coordinates, expands MagnifierType).
Updates unit tests to align with the refactored APIs and fullscreen magnifier parameter calculation.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
tests/unit/test_magnifier/test_magnifier.py	Updates baseline magnifier tests to reflect removed/abstracted position logic and type changes.
tests/unit/test_magnifier/test_fullscreenMagnifier.py	Updates fullscreen magnifier tests to use `_getMagnifierParameters` and explicit start behavior.
source/gui/settingsDialogs.py	Renames magnifier settings controls/config interactions and updates help IDs/labels.
source/config/configSpec.py	Renames magnifier config keys in the config spec (drops `default*` keys).
source/_magnifier/utils/types.py	Refactors magnifier-related types (parameters/size/coordinates/type/filter).
source/_magnifier/magnifier.py	Updates base magnifier to use renamed config getters and makes parameters computation abstract.
source/_magnifier/fullscreenMagnifier.py	Implements `_getMagnifierParameters` for fullscreen magnifier and adjusts lifecycle behavior.
source/_magnifier/config.py	Renames config accessor functions to match new key names and API names.
source/_magnifier/commands.py	Updates command messaging to use renamed config accessors.

Comments suppressed due to low confidence (1)

source/_magnifier/utils/types.py:145

Coordinates and Filter are defined twice in this module (e.g., Coordinates at ~22 and again at ~140; Filter at ~107 and again at ~171). The later definitions override the earlier ones and can lead to inconsistent types (e.g., MagnifierParameters.filter vs config.getFilter()), plus it’s confusing for maintainers. Remove the duplicate definitions and keep a single canonical Coordinates / Filter (and update references accordingly).

class MagnifierParameters(NamedTuple):
	"""Named tuple representing the size and position of the magnifier"""

	magnifierSize: Size
	coordinates: Coordinates
	filter: Filter


class Coordinates(NamedTuple):
	"""Named tuple representing x and y coordinates"""

	x: int
	y: int

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

hwf1324 · 2026-03-31T17:26:59Z

Hi,

Regarding the types, I have a question: could we use locationHelper.Point instead of Coordinates?

Thanks!

…into typeChanges

hwf1324 · 2026-04-01T15:06:25Z

locationHelper.POINT is actually ctypes.wintypes.POINT, and locationHelper.Point inherits from locationHelper._Point, which provides some helper methods.

hwf1324 · 2026-04-01T15:19:01Z

Regarding Size, there is actually also wx.Size, but would this cause confusion?

seanbudd · 2026-04-01T23:54:33Z

I think we should be using Coordinates.

…typeChanges

seanbudd · 2026-04-07T23:12:15Z

 		self.magnifier._stopTimer()
 		self.assertIsNone(self.magnifier._timer)
-
-	def testMagnifierPosition(self):


why was this test removed?

I plan to do a review of all tests in the future, this one were not really working as intended so I'll look into it soon

seanbudd · 2026-04-07T23:13:07Z

 from dataclasses import dataclass
 from _magnifier.utils.focusManager import FocusManager
-from _magnifier.utils.types import Coordinates, FocusType
+from _magnifier.utils.types import FocusType, Coordinates


why was the order swapped here?

changing back from locationHelper.Point to Coordinates

seanbudd · 2026-04-07T23:15:25Z

 		}


+class Filter(DisplayStringStrEnum):


why was this class duplicated?

it was not, I think changes are weirdly reviewed by git

no Filter exists twice in this file

seanbudd · 2026-04-07T23:15:50Z


-class MagnifierParams(NamedTuple):
-	"""Named tuple representing magnifier parameters for initialization"""
+class Coordinates(NamedTuple):


why was this class duplicated?

same as above

no, Coordinates exists twice in this file

seanbudd · 2026-04-07T23:17:04Z


-class MagnifierPosition(NamedTuple):
-	"""Named tuple representing the position and size of the magnifier window"""
+class MagnifierParameters(NamedTuple):


why was this class moved and renamed?

it takes know the filter and might take others params in the future, it basically gives info on what the settings are for the magnifier.

I mean why was it moved from where MagnifierParams was?

seanbudd · 2026-04-07T23:17:19Z

 import winUser
 import mouseHandler
-from .types import Coordinates, FocusType
+from .types import FocusType, Coordinates


why was this order changed?

Suggested change

from .types import FocusType, Coordinates

from .types import Coordinates, FocusType

changes types and function name for clarity

9f0ec33

Boumtchack marked this pull request as ready for review March 31, 2026 15:21

Boumtchack requested a review from a team as a code owner March 31, 2026 15:21

Boumtchack requested review from Copilot and seanbudd March 31, 2026 15:21

Copilot started reviewing on behalf of Boumtchack March 31, 2026 15:22 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

seanbudd marked this pull request as draft April 1, 2026 02:51

Boumtchack and others added 4 commits April 1, 2026 16:11

Merge branch 'master' into typeChanges

c0eadb5

copilot review

15b72a4

Merge branch 'typeChanges' of https://github.com/France-Travail/nvda …

081209b

…into typeChanges

changed Coordinates to locationHelper.POINT

e8c2999

Boumtchack added 2 commits April 7, 2026 09:35

revert to coordinates

22d7f03

Merge branch 'master' of https://github.com/France-Travail/nvda into …

02c56fa

…typeChanges

Boumtchack marked this pull request as ready for review April 7, 2026 09:15

Boumtchack requested a review from a team as a code owner April 7, 2026 09:15

Boumtchack requested a review from Qchristensen April 7, 2026 09:15

seanbudd reviewed Apr 7, 2026

View reviewed changes

seanbudd marked this pull request as draft April 7, 2026 23:18

This was referenced Apr 7, 2026

preparing the new magnifier types #19915

Closed

initial commit #19913

Closed

seanbudd changed the title ~~changes types and function name for clarity~~ changes magnifier types and function name for clarity Apr 10, 2026

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 10, 2026

Merge branch 'nvaccess:master' into typeChanges

896c9b1

Boumtchack marked this pull request as ready for review April 14, 2026 13:21

seanbudd marked this pull request as draft April 16, 2026 00:29

	from .types import FocusType, Coordinates
	from .types import Coordinates, FocusType

Uh oh!

Conversation

Boumtchack commented Mar 31, 2026 • 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 developer facing changes:

Description of development approach:

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hwf1324 commented Mar 31, 2026

Uh oh!

hwf1324 commented Apr 1, 2026

Uh oh!

hwf1324 commented Apr 1, 2026

Uh oh!

seanbudd commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Boumtchack commented Mar 31, 2026 •

edited

Loading