Skip to content

Refactor more speech functions #10593

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.

Sign up for GitHub

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

Merged
feerrenrut merged 18 commits into from
Jan 29, 2020
Merged

Refactor more speech functions #10593

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
01a56c0
Fix getTextWithFields docstring
feerrenrut Dec 5, 2019
e7a18f5
Add names for callback commands to give context in logging.
feerrenrut Dec 18, 2019
94ba656
Add debug logging and formatting to sayAllHandler
feerrenrut Dec 16, 2019
c7b9ac8
Rename _speakTextInfo_addMath -> _extendSpeechSequence_addMathForText…
feerrenrut Dec 5, 2019
e15b907
Add return type annotation: getSpeechForSpelling
feerrenrut Dec 6, 2019
c9812f1
Rename getSpeechForSpelling -> getSpellingSpeech
feerrenrut Dec 16, 2019
2b49f68
Encapsulate speakWithoutPauses in a class
feerrenrut Dec 5, 2019
761179d
Extract stages of speakWithoutPauses
feerrenrut Dec 27, 2019
ca361cb
Remove recursive calls
feerrenrut Dec 27, 2019
e1974d8
Use flush instead of directly manipulating member var
feerrenrut Dec 17, 2019
0f6a7b0
Refactor getSpeechWithoutPauses to use generators
feerrenrut Dec 27, 2019
1270083
Split speakTextInfo: getTextInfoSpeech is a generator with return value.
feerrenrut Dec 6, 2019
d6b36d7
Split speakObjectProperties to return a speech sequence
feerrenrut Dec 6, 2019
2fe9e9a
Split speakMessage to return speechSequence
feerrenrut Dec 6, 2019
ed9b9ff
Split speakSelectionMessage and speakPreselectedText to return speech…
feerrenrut Dec 7, 2019
c47c346
Extract 'allowed properties' calc from speakObject
feerrenrut Dec 7, 2019
cd203bd
Format extracted 'allowed properties' calc
feerrenrut Dec 7, 2019
9a884eb
Split speakObject to return a speech sequence
feerrenrut Dec 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Split speakSelectionMessage and speakPreselectedText to return speech… 
… sequences
  • Loading branch information
@feerrenrut
feerrenrut committed Jan 29, 2020
commit ed9b9ff145d132ce34ca9b953bd06fb51a434bec
51 changes: 40 additions & 11 deletions source/speech/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,13 +721,33 @@ def speakPreselectedText(
inform a user that the newly focused control has content that is selected,
which they may unintentionally overwrite.

@remarks: Implemented using L{speakSelectionMessage}, which allows for
speaking text with an arbitrary attached message.
@remarks: Implemented using L{getPreselectedTextSpeech}
"""
seq = getPreselectedTextSpeech(text)
if seq:
speak(seq, symbolLevel=None, priority=priority)


def getPreselectedTextSpeech(
text: str
) -> SpeechSequence:
""" Helper method to get the speech sequence to announce a newly focused control already has
text selected.
This method will speak the word "selected" with the provided text appended.
The announcement order is different from L{speakTextSelected} in order to
inform a user that the newly focused control has content that is selected,
which they may unintentionally overwrite.

@remarks: Implemented using L{_getSelectionMessageSpeech}, which allows for
creating a speech sequence with an arbitrary attached message.
"""
# Translators: This is spoken to indicate that some text is already selected.
# 'selected' preceding text is intentional.
# For example 'selected hello world'
speakSelectionMessage(_("selected %s"), text, priority)
return _getSelectionMessageSpeech(
# Translators: This is spoken to indicate that some text is already selected.
# 'selected' preceding text is intentional.
# For example 'selected hello world'
_("selected %s"),
text
)


def speakTextSelected(
Expand All @@ -752,13 +772,22 @@ def speakSelectionMessage(
text: str,
priority: Optional[Spri] = None
):
if len(text) < 512:
speakMessage(message % text,priority=priority)
else:
# Translators: This is spoken when the user has selected a large portion of text. Example output "1000 characters"
speakMessage(message % _("%d characters") % len(text),priority=priority)
seq = _getSelectionMessageSpeech(message, text)
if seq:
speak(seq, symbolLevel=None, priority=priority)


def _getSelectionMessageSpeech(
message: str,
text: str,
) -> SpeechSequence:
if len(text) < 512:
return _getSpeakMessageSpeech(message % text)
# Translators: This is spoken when the user has selected a large portion of text.
# Example output "1000 characters"
numCharactersText = _("%d characters") % len(text)
return _getSpeakMessageSpeech(message % numCharactersText)

# C901 'speakSelectionChange' is too complex
# Note: when working on speakSelectionChange, look for opportunities to simplify
# and move logic out into smaller helper functions.
Expand Down