On-demand speech mode - Do not speak anymore during sayAll when SayAll is not launched by a SayAll script by CyrilleB79 · Pull Request #16826 · nvaccess/nvda

CyrilleB79 · 2024-07-05T14:28:48Z

Link to issue number:

Summary of the issue:

While in on-demand speech mode, NVDA speaks during Say All. This is OK when Say All is launched by a specific Say All script, e.g. NVDA+downArrow. But this should not happen when Say All occurs in other situations, i.e. when a new page is loaded in a browser, when an e-mail is opened or when we go forward in a PowerPoint slideshow.

Description of user facing changes

In on-demand mode, NVDA will not talk anymore during Say All if Say All was not launched by an explicit Say All script.

Description of development approach

In speech/sayAll.py, add a new parameter to SayAllHandler.readObjects and to SayAllHandler.readText to determine if the Say All was started from an explicit Say All script or not. This parameter can be None if SayAll is resumed after a script's execution (skim reading case); in this case the previous value of startedFromScript is kept. This value is then used to know if the speech should be output or not.

While at it, I have added to on-demand scripts an Eclipse script to read the documentation; this script seems to have been forgotten during on-demand development.

Testing strategy:

Manual tests in on-demand speech mode and in normal speech mode:

Should speak in all cases:
- Scripts that only speak, e.g. NVDA+t, `NVDA+numpad5
- Scripts meant to trigger a SayAll: NVDA+downArrow, numpad+, NVDA+B, NVDA+control+alt+downArrow
- During input help
Should not speak in on-demand mode, but only in normal mode:
Scripts that perform an action other than reporting something, e.g. NVDA+numpad4/6, NVDA+2
When a webpage is loaded
When an e-mail message is opened in Outlook
During a PowerPoint slideshow

Known issues with pull request:

None

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.

Summary by CodeRabbit

Bug Fixes
- Fixed an issue where NVDA would speak unexpectedly in Outlook, browsing, or PowerPoint when using on-demand speech mode.
New Features
- Improved control over NVDA's speech output with new parameters for script-initiated actions, enhancing customization and behavior in various contexts.

…l is not launched by a SayAll script

AppVeyorBot · 2024-07-05T15:05:12Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/jty70yed4q4m4q1q/artifacts/output/nvda_snapshot_pr16826-32796,e9f5118b.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.3,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 13.3,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.5,
FINISH_END 0.2

See test results for failed build of commit e9f5118b35

coderabbitai · 2024-07-08T06:42:12Z

Walkthrough

The updates incorporate the speakOnDemand and startedFromScript parameters to various functions across multiple files. These parameters aim to modify the behavior of speech in the NVDA screen reader, particularly in on-demand speech mode. These changes ensure that speech is executed conditionally based on whether the function was triggered by a script and the mode of operation.

Changes

File	Change Summary
source/appModules/eclipse.py	Added `speakOnDemand=True` parameter to `script_closeAutocompleter` function.
source/documentBase.py	Updated `readText` method in `SayAllHandler` class with `startedFromScript=True` parameter.
source/globalCommands.py	Added `startedFromScript=True` parameter to `script_review_sayAll`, `script_sayAll`, and `script_speakForeground` functions.
source/scriptHandler.py	Included `startedFromScript=None` parameter in `readText` function call inside `executeScript` function.
source/speech/sayAll.py	Added `startedFromScript` parameter to `readObjects` and `readText` functions.
source/speech/speech.py	Modified the `speak` function's conditional logic to include checks involving `SayAllHandler.isRunning()` and `SayAllHandler.startedFromScript`.
user_docs/en/changes.md	Documented the bug fix related to on-demand speech mode and developer changes.

Assessment against linked issues

Objective	Addressed	Explanation
NVDA should not speak in on-demand speech mode when navigating PowerPoint slides (#16825)	✅
Inclusion of `speakOnDemand` and `startedFromScript` parameters to control speech behavior (#16825)	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

seanbudd · 2024-07-11T03:42:31Z

 		_isScriptRunning = False
 		if resumeSayAllMode is not None:
-			sayAll.SayAllHandler.readText(resumeSayAllMode)
+			sayAll.SayAllHandler.readText(resumeSayAllMode, startedFromScript=None)


Shouldn't this be

Suggested change

sayAll.SayAllHandler.readText(resumeSayAllMode, startedFromScript=None)

sayAll.SayAllHandler.readText(resumeSayAllMode, startedFromScript=False)

or is this meant to be True?

It's None meaning that sayAll.SayAllHandler.startedFromScript should not be modified with this action. It should not be modified because this call is to resume an existing say all action, not to start it.

Should I make it somewhat more explicit? With a comment or otherwise?

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

CyrilleB79 · 2024-07-14T21:35:22Z

 		shouldUpdateCaret: bool = True,
+		startedFromScript: bool | None = False,
 	) -> None:
+		"""Start or restarts the reader


@seanbudd, @LeonarddeR, not sure that my Sphinx formatting of docstring is OK. As requested in the past, an example directly in NVDA's codingStandards.md file would be appreciated; the Sphinx tutorial that is linked instead does not match exactly our recommendations since the examples are with types.

CyrilleB79 · 2024-07-14T21:36:45Z

+		"""Start or restarts the reader
+		:cursor: the type of cursor used for say all
+		:startPos: start position (only used for table say all)
+		:nextLineFunc: function called to read the next line (only used for table say all)


@mltony some of the parameters of this functions have been introduced with table say all. Does the description seems OK to you or would you suggest something different or more precise? Thanks.

On-demand speech mode - Do not speak anymore during sayAll when SayAl…

e7ba08d

…l is not launched by a SayAll script

Linting

5ae219f

CyrilleB79 marked this pull request as ready for review July 8, 2024 06:42

CyrilleB79 requested a review from a team as a code owner July 8, 2024 06:42

CyrilleB79 requested a review from michaelDCurran July 8, 2024 06:42

coderabbitai Bot reviewed Jul 8, 2024

View reviewed changes

Comment thread source/appModules/eclipse.py

seanbudd approved these changes Jul 11, 2024

View reviewed changes

seanbudd reviewed Jul 12, 2024

View reviewed changes

Comment thread source/speech/sayAll.py Outdated

Comment thread source/speech/sayAll.py Outdated

seanbudd marked this pull request as draft July 12, 2024 00:15

CyrilleB79 and others added 2 commits July 14, 2024 22:38

Apply suggestions from code review

702702e

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

Docstrings

ff40628

CyrilleB79 commented Jul 14, 2024

View reviewed changes

seanbudd marked this pull request as ready for review July 15, 2024 01:55

seanbudd approved these changes Jul 15, 2024

View reviewed changes

Comment thread source/speech/sayAll.py Outdated

Comment thread source/speech/sayAll.py Outdated

Comment thread source/speech/sayAll.py Outdated

seanbudd and others added 4 commits July 15, 2024 12:07

Update source/speech/sayAll.py

746e567

Update source/speech/sayAll.py

0caeb30

Update source/speech/sayAll.py

5c6d5a2

Merge branch 'master' into speakOnDemFixes

4e17100

seanbudd merged commit 76a4d9b into nvaccess:master Jul 15, 2024

CyrilleB79 deleted the speakOnDemFixes branch July 15, 2024 20:53

cary-rowen mentioned this pull request Jul 21, 2024

SayAll is broken in NVDA Alpha. tsengwoody/WorldVoice#20

Closed

	sayAll.SayAllHandler.readText(resumeSayAllMode, startedFromScript=None)
	sayAll.SayAllHandler.readText(resumeSayAllMode, startedFromScript=False)

Uh oh!

Conversation

CyrilleB79 commented Jul 5, 2024 • edited by coderabbitai Bot 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 development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Summary by CodeRabbit

Uh oh!

AppVeyorBot commented Jul 5, 2024

Uh oh!

coderabbitai Bot commented Jul 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

seanbudd Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

seanbudd Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

CyrilleB79 Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

CyrilleB79 Jul 14, 2024

Choose a reason for hiding this comment

Uh oh!

CyrilleB79 Jul 14, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CyrilleB79 commented Jul 5, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 8, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)