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

_restricted_classmethod: add wrapper, to allow inspection #19332

Merged

Conversation

lauritsf
Copy link
Contributor

@lauritsf lauritsf commented Jan 23, 2024

What does this PR do?

This PR resolves an issue where using inspect.getmembers on a LightningModule instance (or any class using _restricted_classmethod_impl) would incorrectly raise a TypeError. The modification introduces a wrapper in the _restricted_classmethod_impl to ensure that the method can be inspected but not called on an instance. This change maintains the intended functionality while improving compatibility with introspection tools like inspect.getmembers.

Fixes #19329

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--19332.org.readthedocs.build/en/19332/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 23, 2024
@lauritsf lauritsf marked this pull request as ready for review January 23, 2024 12:14
@lauritsf lauritsf changed the title [WIP] _restricted_classmethod: add wrapper, to allow inspection _restricted_classmethod: add wrapper, to allow inspection Jan 23, 2024
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

Merging #19332 (9e2a80f) into master (d02009a) will decrease coverage by 35%.
The diff coverage is 100%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #19332      +/-   ##
==========================================
- Coverage      84%      49%     -35%     
==========================================
  Files         446      438       -8     
  Lines       37570    37418     -152     
==========================================
- Hits        31383    18292   -13091     
- Misses       6187    19126   +12939     

@awaelchli awaelchli added bug Something isn't working community This PR is from the community labels Jan 23, 2024
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

Looks great. Thanks for the quick fix. Would you mind adding a line in src/lightning/pytorch/CHANGELOG.md as well?

@awaelchli awaelchli added this to the 2.1.x milestone Jan 23, 2024
@lauritsf lauritsf force-pushed the bugfix/restricted-method-inspect-issue branch from 2fb1795 to 872bee3 Compare January 23, 2024 14:25
@lauritsf lauritsf force-pushed the bugfix/restricted-method-inspect-issue branch from 872bee3 to 498d35f Compare January 23, 2024 14:25
@Borda Borda changed the title _restricted_classmethod: add wrapper, to allow inspection _restricted_classmethod: add wrapper, to allow inspection Jan 23, 2024
@mergify mergify bot added the ready PRs ready to be merged label Jan 23, 2024
@awaelchli awaelchli merged commit 3044e83 into Lightning-AI:master Jan 23, 2024
90 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working community This PR is from the community pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue with _restricted_classmethod_impl Triggering TypeError on inspect.getmembers Call
3 participants