Move selfish imports off package __init__.py #14190
Merged
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
|
Note this can't pass static analysis because our imports are order sensitive and ruff format wants to put them in pep ordering. 🫠 |
|
@chrisguidry I changed the integrations test to use subprocess instead of runpy.run_file. The way that runpy resolves imports I was actually getting an error from this implementation (spooky). I want to make sure I'm not cheating though so your 👀 here are much appreciated. |
chrisguidry
approved these changes
Jun 21, 2024
There was a problem hiding this comment.
Looks like a major improvement! We can quibble over the exact public_api but at least now we can make those decisions freely without the whole house of cards collapsing :D
As for the static analysis, I think ruff respects # isort: split, give that a shot. If not we can just ignore this one file.
| "__ui_static_path__": __ui_static_path__, | ||
| } | ||
|
|
||
| _public_api: dict[str, tuple[str, str]] = { |
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.
Prefect directly / indirectly imports almost every module into it's init.py, which is an obstacle to progress on untangling circular imports or overall import speed.
This PR cheats a little, but in a net-positive way. This moves the contents of the init.py file to a sibling main.py file, and sets up a dynamic importing scheme from to read from it. Here's why this matters:
from prefect.client.orchestration import get_clientI would traverse Prefect's init.py which would in turn import every module (by simply visiting it!).from prefect.client.orchestration import get_clientsafely traverses down toprefect.client.orchestrationand accesses the attributeget_client.This is no free lunch from the perspective of our users.
import prefectis now instant, at the expense thatfrom prefect import flownow incurs the import time instead (importantly though: subsequentfrom prefect import Xdo not continue to pay import tax since everything is loaded).So this PR is purely a path to a path to sanity.