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 old winTerminalUIA module attribute #16820

Merged
merged 3 commits into from
Sep 5, 2024

Conversation

codeofdusk
Copy link
Contributor

@codeofdusk codeofdusk commented Jul 4, 2024

Link to issue number:

Fix-up of #14047.

Summary of the issue:

Code to support a previously used WinTerminalUIA class name was added during a deprecation period, now over a year. See the deprecation note in 2023.1 developer changes.

Description of how this pull request fixes the issue:

Remove the attribute. This code is unlikely to be used by add-ons.

Testing strategy:

Verified functionality of terminal support.

Known issues with pull request:

None known

Change log entry:

In PR

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

  • Refactor
    • Removed backward compatibility logic related to WinTerminalUIA deprecation.

@codeofdusk codeofdusk requested a review from a team as a code owner July 4, 2024 19:21
Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

The primary change involves removing the __getattr__ function from the winConsoleUIA.py file. This function previously handled backward compatibility for the deprecated WinTerminalUIA. The removal simplifies the codebase but impacts backward compatibility.

Changes

File Path Change Summary
source/NVDAObjects/UIA/... Removal of the __getattr__ function, eliminating compatibility logic for WinTerminalUIA.

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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@seanbudd
Copy link
Member

seanbudd commented Jul 4, 2024

This API breaking change will need a change log entry in the 2025.1 changes

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jul 15, 2024
@seanbudd
Copy link
Member

Can you fix merge any conflicts and add an API removal notice to the changes for developers for 2025.1?

@seanbudd seanbudd removed the blocked label Aug 28, 2024
@SaschaCowley SaschaCowley marked this pull request as draft September 4, 2024 05:28
@SaschaCowley
Copy link
Member

@codeofdusk per #16820 (comment), can you please add an API removal notice to the "Changes for developers" section of the changelog for 2025.1?

@codeofdusk codeofdusk marked this pull request as ready for review September 4, 2024 20:05
Copy link
Member

@SaschaCowley SaschaCowley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @codeofdusk

@SaschaCowley SaschaCowley merged commit f7e7415 into nvaccess:master Sep 5, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-breaking-change conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants