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

User documentation on import hook-based editable installs (PEP 660) #3407

Closed
debonte opened this issue Sep 29, 2022 · 2 comments · Fixed by #3440
Closed

User documentation on import hook-based editable installs (PEP 660) #3407

debonte opened this issue Sep 29, 2022 · 2 comments · Fixed by #3440
Assignees
Labels
needs documentation Improvements or additions to documentation pep 660 Issues related to PEP 660 import hooks

Comments

@debonte
Copy link
Contributor

debonte commented Sep 29, 2022

Add user documentation somewhere explaining:

  • Why import hooks are a problem for static analysis tools
  • The downside of opting out of import hooks -- your editable install may not match your real install as closely as it could.
  • How to out-out of import hooks in common build backends. Graham started that here. We might need to move it for discoverability.

For https://github.com/microsoft/pyrx/issues/2715

@ofek
Copy link

ofek commented Oct 2, 2022

Hatchling does the .pth file way by default

@debonte debonte self-assigned this Oct 3, 2022
@debonte
Copy link
Contributor Author

debonte commented Oct 3, 2022

Hatchling does the .pth file way by default

Thanks @ofek. For hatchling I think we would just explain that dev-mode-exact = true enables import hooks and could cause issues with Pylance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs documentation Improvements or additions to documentation pep 660 Issues related to PEP 660 import hooks
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants