Remove internal usage of deprecated controlTypes constants #12549
Labels
deprecated/2022.1
Label used to track deprecations due for removal in the 2022.1 release
p2
https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority
Milestone
Comments
seanbudd
added
the
deprecated/2022.1
feerrenrut
changed the title
|
This has to be completed before 2022.1 is started (milestones are usually used to signify "before completion"). These changes should be started early, ideally considering this work for every release until it is complete. |
|
Since this code will become part of the 2021.2 API. It needs to be proved before release. If there are currently no usages of the new |
8 tasks
8 tasks
feerrenrut
pushed a commit
that referenced
this issue
Jul 27, 2021
Part of #12549 # Summary: controlTypes.ROLE_* are deprecated, to be replaced by controlTypes.ROLE.* # Description of fix: Replaced all instances of controlTypes.ROLE_ with controlTypes.Role. across .py files Search and manually replace final ROLE_ constant usages. Used regex: [^\.]\bROLE_ Because of: - oleacc.ROLE_* the regex excludes the form <Foo>.ROLE_ - IA2_ROLE_* the regex ensures ROLE_ is the prefix of the symbol. # Testing: - Manually inspect regex results. - Existing unit tests exist for controlTypes - Unit tests added for DisplayStringEnum, and test_roleLabels to ensure all enum values have a label.
8 tasks
feerrenrut
pushed a commit
that referenced
this issue
Aug 10, 2021
Part of #12549 # Summary: controlTypes.STATE_* are deprecated, to be replaced by controlTypes.State.* # Description of fix: Replaced all instances of controlTypes.STATE_ with controlTypes.State. across .py files Searched and manually replaced final STATE_ constant usages - using the regex: [^\.]\bSTATE_ - which finds STATE_ instances Because other usages of "STATE_" are common such as: - oleacc.STATE_*, the regex excludes the form <Foo>.STATE_ - IA2_STATE_*, the regex ensures STATE_ is the prefix of the symbol. # Testing: - Manually inspect regex results. - Existing unit tests exist for controlTypes - New unit tests are written for displayString and negativeDisplayString, checking the labels of enum members
|
Bumping this to 2022.1. However it is important to get this done early in the dev cycle, marking as high priority. Additionally, when updating the version, the "auto deprecations" for the remaining work will need be disabled. |
feerrenrut
added
the
p2
This was referenced Sep 8, 2021
seanbudd
added a commit
that referenced
this issue
Sep 13, 2021
…2821) Part of #12549 Summary of the issue: controlTypes.stateLabels has been deprecated, usages such as controlTypes.stateLabels[controlTypes.State.*] should be replaced to their equivalent controlTypes.State.*.displayString Description of how this pull request fixes the issue: Use displayString and negativeDisplayString instead of stateLabels and negativeStateLabels.
9 tasks
seanbudd
added a commit
that referenced
this issue
Sep 13, 2021
… controlTypes helper functions (#12836) Closes #12549 Summary of the issue: characterProcessing.SYMLVL_* constants should be replaced using their equivalent SymbolLevel.* before 2022.1. Unit testing for controlTypes helper functions needed updating for soon to be removed processNegativeStates and processPositiveStates. Update the usages of these constants and helper functions Testing strategy: Search the repo for 2022 usages and noted deprecations in changes for developers. Ensure all code deprecated for removal in 2022.1 is not used in the codebase.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In #12510 several
enums were introduced to replace constants. The usage of those constants was deprecated, the constants will be removed in 2022.1. Before the 2022.1 release process starts, the usages of the constants must be converted to use the enums instead.ROLE_*constants should be replaced to their equivalentRole.*before 2022.1. (caused by Backwards compatible control types refactor #12510, work done by Replace internal controlTypes.ROLE_* usages with controlTypes.Role.* #12649)STATE_*constants should be replaced to their equivalentState.*before 2022.1. (caused by Backwards compatible control types refactor #12510, fixed by replace controlTypes.STATE_* with controlTypes.State.* #12712)roleLabelshave been deprecated, usages such asroleLabels[ROLE_*]should be replaced to their equivalentRole.*.displayStringbefore 2022.1. (Backwards compatible control types refactor #12510, fixed by remove usages of controlTypes.roleLabels #12814)stateLabelshave been deprecated, usages such asstateLabels[STATE_*]should be replaced to their equivalentState.*.displayStringbefore 2022.1. (Backwards compatible control types refactor #12510, fixed by remove usages of controlTypes.stateLabels and negativeStateLabels #12821)characterProcessing.SYMLVL_*constants should be replaced using their equivalentSymbolLevel.*before 2022.1. (Speak all symbols when moving by words (#11779) #11856, fixed by Remove usages of deprecated characterProcessing.SYMLVL_ constants and controlTypes helper functions #12836)The text was updated successfully, but these errors were encountered: