Skip to content
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.

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

Remove backwards compat aliases from PR 10593 #12195

Merged
merged 5 commits into from Mar 22, 2021

Conversation

lukaszgo1
Copy link
Contributor

Link to issue number:

None, Removes code provided for backwards compatibility in PR #10593

Summary of the issue:

PR #10593 introduced speech.speakWithoutPauses as an alias for speech._speakWithoutPauses.speakWithoutPauses and speech.re_last_pause as an alias for speech._speakWithoutPauses.re_last_pause for backwards compatibility. Since 2021.1 is going to be backwards compatibility breaking release it makes sense to remove these.

Description of how this pull request fixes the issue:

These aliases are removed and their usages are replaces with speech.SpeechWithoutPauses(speakFunc=speech.speak).speakWithoutPauses and speech.SpeechWithoutPauses.re_last_pause respectively.

Testing strategy:

  • With git grep inspected usages of these aliases and ensured that all of them are replaced.
  • Performed say all on several text's - ensured that it still works as before.

Known issues with pull request:

None known

Change log entry:

Changes for developers:

  • speech.speakWithoutPauses has been removed - please use speech.SpeechWithoutPauses(speakFunc=speech.speak).speakWithoutPauses instead
  • speech.re_last_pause has been removed - please use speech.SpeechWithoutPauses.re_last_pause instead.

Code Review Checklist:

This checklist is a reminder of things commonly forgotten in a new PR.
Authors, please do a self-review and confirm you have considered the following items.
Mark items you have considered by checking them.
You can do this when editing the Pull request description with an x: [ ] becomes [x].
You can also check the checkboxes after the PR is created.

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual tests.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.

@lukaszgo1
Copy link
Contributor Author

cc @seanbudd

@seanbudd seanbudd added the deprecated/2021.1 Label used to track deprecations due for removal in the 2021.1 release label Mar 19, 2021
@seanbudd seanbudd added this to the 2021.1 milestone Mar 19, 2021
@seanbudd seanbudd mentioned this pull request Mar 19, 2021
18 tasks
@AppVeyorBot
Copy link

See test results for failed build of commit 359295caaf

@seanbudd seanbudd merged commit f2a734b into nvaccess:master Mar 22, 2021
@lukaszgo1 lukaszgo1 deleted the removeDeprecAliases10593 branch March 22, 2021 07:35
seanbudd pushed a commit that referenced this pull request Mar 30, 2021
…uses` which has been used for say all. (#12228)

Fixes #12225

PR #12195 removed speech.speakWithoutPauses which was an alias for speech._speakWithoutPauses. While all usages of speech.speakWithoutPauses were found and fixed it turned out than when cancelling speech during say all speech._speakWithoutPauses was cleared rather than instance of SpeakWithoutPauses used for say all.

Now the instance of SpeechWithoutPauses which is used during say all is cleared. A function is added to sayAllHandler which creates it first if necessary, and ensures that the single instance is being used for say all.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated/2021.1 Label used to track deprecations due for removal in the 2021.1 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants