fix(python): improved namespace/accessor behaviour (resolves VSCode autocomplete issue) #5469
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
|
(Squashed, and added some explanatory inline comments). |
2 tasks
zundertj
pushed a commit
to zundertj/polars
that referenced
this pull request
Jan 7, 2023
…utocomplete issue) (pola-rs#5469)
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.
Closes #5460.
Building the docs properly requires access to the
Expr&Seriesnamespaces from the class-level, so the@accessordecorator (which is capable of also behaving as a classproperty) was introduced. PyCharm autocomplete is fine with this, but apparently VSCode is not.Given that this access pattern is only required for sphinx docs to build, I've reworked it so that the docs build exports a temporary environment variable, allowing the
@accessorto function as such only when building docs, and to map to a vanilla@propertyin all other cases (eg: developing/editing, runtime, etc).With this new approach I have confirmed that the docs still correctly generate namespaced methods (without exposing the internal/private paths) and that proper autocomplete is preserved for both VSCode & PyCharm (screenshots below). Best of both worlds...
(Also fixes several accessor-related linting issues).