improve state management in speech.py#12395
Merged
Merged
Conversation
7 tasks
See test results for failed build of commit 46cab6a7b4 |
feerrenrut
approved these changes
May 11, 2021
feerrenrut
left a comment
Contributor
There was a problem hiding this comment.
Generally looks good!
|
|
||
|
|
||
| def initialize(): | ||
| global _SpeechState |
Contributor
There was a problem hiding this comment.
I think this should be lower case: _speechState
AAClause
added a commit
to AAClause/BrailleExtender
that referenced
this pull request
May 14, 2021
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
Fixes #12393, follow up of #12251
Summary of the issue:
Using shift to resume speech after using shift to pause speech does not resume speech.
This is because when
isPausedis imported throughspeech\__init__.pyit is does not reference the global variable used inspeech.pyDescription of how this pull request fixes the issue:
Removes the use of top level variables in
speech.pyin favour of a private dataclass to manage state, and an enum for certain modes. Constants (or rather, variables with names in all capitals) remain as is.Testing strategy:
Using reproduction steps in #12393 to manually test the pausing and resuming of speech.
System tests for this may be useful, but require a change to the system test spy synth driver.
Known issues with pull request:
None
Change log entries:
Developer changes:
speech.curWordCharshas been renamedspeech._curWordCharsspeechand can be accessed throughspeech.getState(). These are readonly values now.speech.speechModeusespeech.setSpeechModespeech.SpeechModespeech.speechMode_offbecomesspeech.SpeechMode.offspeech.speechMode_beepsbecomesspeech.SpeechMode.beepsspeech.speechMode_talkbecomesspeech.SpeechMode.talkCode Review Checklist: