Make runningAsSource a global variable#14015
Merged
Merged
Conversation
34 tasks
lukaszgo1
reviewed
Aug 15, 2022
lukaszgo1
left a comment
Contributor
There was a problem hiding this comment.
It looks like there are some checks for source VS binary copy in nvda.pyw and nvda_slave.pyw. Have you considered converting these to the new approach while at it?
Member
Author
|
Thanks @lukaszgo1 missed these the first time around, fixed now |
feerrenrut
approved these changes
Aug 18, 2022
See test results for failed build of commit 7fc478d2c8 |
6 tasks
seanbudd
added a commit
that referenced
this pull request
Aug 30, 2022
Supersedes #14037 See also #14049 Summary of the issue: #14037 was closed because there was no way to preserve backwards compatibility. This is the case for any module level variable which the NVDA API expects to support assignment (see also #14049). globalVars contains many NVDA state variables which should not be changed by add-on authors. As a result, globalVars should eventually be deprecated, in favour of encapsulation of these variables. This will make retaining backwards compatibility possible in the future. Description of user facing changes None Description of development approach Added a deprecation warning and strategy to the docstring of globalVars. Encapsulated some less used globalVars to provide an example of what the future API should look like. runningAsSource was moved from globalVars as this is an unreleased variable. (#14015) _allowDeprecatedAPI was moved as it is internal code.
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
5 participants
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:
Blocking #13254, as this PR needs to check if NVDA is running as source
Summary of the issue:
NVDA checks in various places if it is running as source.
This check should be abstracted out, as the check is dependent on py2exe behaviour.
When viewing code, it is also not immediately clear what
getattr(sys, 'frozen')means, whereas a named variable will be clearer.Description of user facing changes
A named variable with documentation for code contributors.
Description of development approach
Checked what
import sys; getattr(sys, 'frozen', None)returns in the python console of an installed copy of NVDA and a source copy of NVDA.Testing strategy:
Smoke test running NVDA from installed and source.
Known issues with pull request:
None
Change log entries:
N/A
Code Review Checklist: