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

Update read only cached property for PyCharm auto-complete support #149

Merged

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Feb 21, 2024

Proposed changes

PyCharm hardcodes the cached_property logic for its auto-complete support. The import statements were updated to allow auto-complete to work properly in PyCharm.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 requested review from a team as code owners February 21, 2024 00:13
Copy link

codecov bot commented Feb 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6c0dcbd) 100.00% compared to head (903c4b3) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #149   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          170       170           
  Lines         3776      3793   +17     
  Branches       648       648           
=========================================
+ Hits          3776      3793   +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 enabled auto-merge (squash) February 21, 2024 00:17
@nfelt14 nfelt14 force-pushed the nfelt14/update-read-only-cached-property-for-pycharm-type-hinting branch from 1084b09 to 903c4b3 Compare February 21, 2024 00:17
@nfelt14 nfelt14 merged commit 3b328b8 into main Feb 21, 2024
37 checks passed
@nfelt14 nfelt14 deleted the nfelt14/update-read-only-cached-property-for-pycharm-type-hinting branch February 21, 2024 01:25
v12ganesh pushed a commit to v12ganesh/tm_devices that referenced this pull request Mar 28, 2024
…ektronix#149)

* fix: Update import statements to allow type hinting and auto-completion to work in the PyCharm IDE.

* refactor: Move regex string into a separate constant in functions.py to prevent PyCharm from showing false syntax errors.
Signed-off-by: v12ganesh [email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants