Hide most UIA specific logging behind debug logging category UIA, and add new log entries #10397
Conversation
This file contains 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
|
PR introduces Flake8 errors 😲 See test results for Failed build of commit 713d1448ea |
|
@michaelDCurran, this is ready for review. |
michaelDCurran
approved these changes
Nov 19, 2019
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 #10491
Fixes #10422
Summary of the issue:
UIA TextInfo code in particular logs many entries at the debug level. This can be very noisy if you want to debug an issue in an UIA text control that is unrelated to the UIA text field fetching itself.
Description of how this pull request fixes the issue:
Add a new UIA debug logging category to the advanced settings, which is off by default. If on, not only TextInfo field fetching is logged, but also several things within the handler, such as ignored win events, events that are unknown to NVDA, etc.
While working on this, I added proper debug logging on the UIAHandler event handler methods, thereby avoiding errors logged by comtypes.
Testing performed:
Tested that several new log entries appear in the log and that getTextWithFields logs UIA specific details when the UIA debug logging is enabled.
Known issues with pull request:
None
Change log entry:
May be not worth mentioning