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

Improve visibility of Python public APIs to type checkers #6462

Merged
merged 5 commits into from
May 31, 2024

Conversation

abey79
Copy link
Member

@abey79 abey79 commented May 30, 2024

What

#6117 removed many __all__ statements, which cause problem for type checkers when using our public APIs (rr.* and rr.blueprint.*). This PR fixes this by using the from X import Y as Y pattern, which is easier to maintain than __all__.

This required a ruff setting change, which rippled into additional (arguably good) formatting changes.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

To run all checks from main, comment on the PR with @rerun-bot full-check.

@abey79 abey79 added 🐍 Python API Python logging API 🧑‍💻 dev experience developer experience (excluding CI) include in changelog labels May 30, 2024
@abey79 abey79 requested a review from roym899 May 30, 2024 10:21
Copy link

github-actions bot commented May 30, 2024

Deployed docs

Commit Link
0e876e8 https://landing-jpmh8dzts-rerun.vercel.app/docs

Copy link
Collaborator

@roym899 roym899 left a comment

Choose a reason for hiding this comment

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

Looks good to me and works as expected 👍

rerun_py/rerun_sdk/rerun/__init__.py Show resolved Hide resolved
@abey79 abey79 merged commit 1211f6d into main May 31, 2024
40 checks passed
@abey79 abey79 deleted the antoine/fix-public-reexport branch May 31, 2024 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) include in changelog 🐍 Python API Python logging API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python autocomplete worse since 0.16
3 participants