Skip to content

DOC: editable: clarify file guarantees with non-Python files #786

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: editable: clarify file guarantees with non-Python files #786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/how-to-guides/editable-installs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,11 @@ installation step to become effective.

__ https://packaging.python.org/en/latest/specifications/entry-points/

An editable install exposes at least all the files that would be
An editable install exposes at least all of the Python files that would be
available in a regular installation. However, depending on the file
and directory organization in your project, it might also expose files
that would not be normally available.
that would not be normally available. Furthermore, some files written in
other languages to Python may not be available.
Copy link
Member

Choose a reason for hiding this comment

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

Uh? This is actually false. Where did you get the impression that only Python files are exposed?

Copy link
Author

Choose a reason for hiding this comment

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

Where did you get the impression that only Python files are exposed?

I didn't get the impression that only Python files are exposed — that isn't what this says!

I did get the impression that some files in other languages may not be available: see numpy/numpy#29490.

Copy link
Member

Choose a reason for hiding this comment

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

All installed files are available, if you look them up with the proper Python API.

I really don't understand what you are trying to communicate with these edits. Most likely I don't understand what you mean with "Python file". After all, meson-python is mostly used to build packages that contain Python modules written in other languages that Python, therefore, if these sometimes were to go missing, it would be a major issue.

I guess that you are trying to access installed files by their (expected) filesystem location rather than through the Python API. A few lines above the text you are amending we have this sentence:

This will install a stub in the Python site packages directory that loads the package content from the sources and build directory.

I thought that this should be indication enough that the installed files do not exist in the filesystem at the location where they would be in an normal isntallation. But I have the impression that this is not picked up by most readers. What we really need is a "Accessing data files" in the editable install documentation that spells this out.



Build dependencies
Expand Down