Skip to content

Allow editable install #155

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

Merged
jarrodmillman merged 10 commits into from
May 1, 2024
Merged

Allow editable install #155

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7e726da
Get path for editable install
stefanv Jan 22, 2024
4b64e52
Detect and work with existing editable installs
stefanv Jan 22, 2024
b97a4e2
Fix Windows
stefanv Jan 23, 2024
9913982
Better find Python executable on Windows
stefanv Jan 23, 2024
cd25bdf
Use distribution name, not package name, to check installed metadata
stefanv Jan 25, 2024
215cee6
Refactor editable tests
stefanv May 1, 2024
844db07
Fix linting
stefanv May 1, 2024
33082e0
Don't try to generate gcov for editable install
stefanv May 1, 2024
91a4c15
Correct working dir for generating gcov
stefanv May 1, 2024
2616c3d
Mention editable install in README
stefanv May 1, 2024
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
Prev Previous commit
Next Next commit
Use distribution name, not package name, to check installed metadata
  • Loading branch information
@stefanv
stefanv committed May 1, 2024
commit cd25bdfd94da4377e95cbf2e432ce7ba35e5a26e
34 changes: 17 additions & 17 deletions spin/cmds/meson.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ def _meson_cli():
return [meson_cli]


def _editable_install_path(package):
def _editable_install_path(distname):
import importlib_metadata

try:
dist = importlib_metadata.Distribution.from_name(package)
dist = importlib_metadata.Distribution.from_name(distname)
except importlib_metadata.PackageNotFoundError:
return None

Expand All @@ -54,13 +54,13 @@ def _editable_install_path(package):
return None


def _is_editable_install(package):
return _editable_install_path(package) is not None
def _is_editable_install(distname):
return _editable_install_path(distname) is not None


def _is_editable_install_of_same_source(package):
editable_path = _editable_install_path(package)
return editable_path and os.path.samefile(_editable_install_path(package), ".")
def _is_editable_install_of_same_source(distname):
editable_path = _editable_install_path(distname)
return editable_path and os.path.samefile(_editable_install_path(distname), ".")


def _set_pythonpath(quiet=False):
Expand All @@ -74,10 +74,10 @@ def _set_pythonpath(quiet=False):
env = os.environ

cfg = get_config()
package = cfg.get("tool.spin.package", None)
if package:
if _is_editable_install(package):
if _is_editable_install_of_same_source(package):
distname = cfg.get("project.name", None)
if distname:
if _is_editable_install(distname):
if _is_editable_install_of_same_source(distname):
if not (quiet):
click.secho(
"Editable install of same source directory detected; not setting PYTHONPATH",
Expand All @@ -87,12 +87,12 @@ def _set_pythonpath(quiet=False):
else:
# Ignoring the quiet flag, because picking up the wrong package is problematic
click.secho(
f"Warning! Editable install of `{package}`, from a different source location, detected.",
f"Warning! Editable install of `{distname}`, from a different source location, detected.",
fg="bright_red",
)
click.secho("Spin commands will pick up that version.", fg="bright_red")
click.secho(
f"Try removing the other installation by switching to its source and running `pip uninstall {package}`.",
f"Try removing the other installation by switching to its source and running `pip uninstall {distname}`.",
fg="bright_red",
)

Expand All @@ -112,8 +112,8 @@ def _set_pythonpath(quiet=False):
def _get_site_packages():
try:
cfg = get_config()
package = cfg.get("tool.spin.package", None)
if _is_editable_install_of_same_source(package):
distname = cfg.get("project.name", None)
if _is_editable_install_of_same_source(distname):
return ""
except RuntimeError:
# Probably not running in click
Expand Down Expand Up @@ -252,8 +252,8 @@ def build(meson_args, jobs=None, clean=False, verbose=False, gcov=False, quiet=F
CFLAGS="-O0 -g" spin build
"""
cfg = get_config()
package = cfg.get("tool.spin.package", None)
if package and _is_editable_install_of_same_source(package):
distname = cfg.get("project.name", None)
if distname and _is_editable_install_of_same_source(distname):
if not quiet:
click.secho(
"Editable install of same source detected; skipping build",
Expand Down