Py.typed #1685
Closed
Py.typed #1685
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
- Explicit `check=False` - Sort functions in their call order - Use Pathlib for paths
zanieb
reviewed
Feb 19, 2024
| return sys.prefix | ||
|
|
||
| return "" | ||
| from pathlib import Path |
There was a problem hiding this comment.
We are explicitly not using pathlib because it's slower to import
zanieb
reviewed
Feb 19, 2024
| strongly discouraged to import from our `uv` Python module, but you can do so at your | ||
| own risk. | ||
| """ | ||
| from uv.__main__ import detect_virtualenv, find_uv_bin |
There was a problem hiding this comment.
Let's not import then from __main__, let's do it the other way around (define them here and import them there).
I think detect_virtualenv should remain private as well.
zanieb
reviewed
Feb 19, 2024
Comment on lines
+2
to
+4
| The Python API of `uv` is not guaranteed to be stable and may chance at any time. It is | ||
| strongly discouraged to import from our `uv` Python module, but you can do so at your | ||
| own risk. |
There was a problem hiding this comment.
Suggested change
| The Python API of `uv` is not guaranteed to be stable and may chance at any time. It is | |
| strongly discouraged to import from our `uv` Python module, but you can do so at your | |
| own risk. | |
| The Python API of `uv` is not guaranteed to be stable and may change at any time. |
Fixed a typo and this seems sufficient. I was only strongly discouraging people from importing from __main__.
zanieb
added
the
enhancement
|
Superseded by #1728 |
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.
Suggested implementation for #1677
Summary
Add
py.typed+ cautionary docstring.Importing these functions is discouraged, but not prohibited: users can do so at their own risk.
Included some best practices in the Python part, we should set the right example !
Atomic commits, see commit message for details.
Test Plan