pyflyby 1.9.11__tar.gz → 1.9.12__tar.gz

{pyflyby-1.9.11/lib/python/pyflyby.egg-info → pyflyby-1.9.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflyby
-Version: 1.9.11
+Version: 1.9.12
 Summary: pyflyby - Python development productivity tools, in particular automatic import management
 Home-page: https://pypi.org/project/pyflyby/
 Author: Karl Chen

{pyflyby-1.9.11/lib/python → pyflyby-1.9.12/bin}/pyflyby/_py.py

@@ -281,7 +281,9 @@ Examples
 
 
 from   functools                import total_ordering
+from   pathlib                  import Path
 from   typing                   import Any
+import warnings
 
 from   pyflyby._util            import cmp
 from   shlex                    import quote as shquote
@@ -1410,9 +1412,84 @@ def print_result(result, output_mode):
         raise AssertionError("unexpected output_mode=%r" % (output_mode,))
 
 
+def _get_path_links(p: Path):
+    """Gets path links including all symlinks.
+
+    Adapted from `IPython.core.interactiveshell.InteractiveShell.get_path_links`.
+    """
+    paths = [p]
+    while p.is_symlink():
+        new_path = Path(os.readlink(p))
+        if not new_path.is_absolute():
+            new_path = p.parent / new_path
+        p = new_path
+        paths.append(p)
+    return paths
+
+
+def _init_virtualenv():
+    """Add the current virtualenv to sys.path so the user can import modules from it.
+
+    A warning will appear suggesting the user installs IPython in the
+    virtualenv, but for many cases, it probably works well enough.
+
+    Adapted `IPython.core.interactiveshell.InteractiveShell.init_virtualenv`.
+    """
+    if 'VIRTUAL_ENV' not in os.environ:
+        # Not in a virtualenv
+        return
+    elif os.environ["VIRTUAL_ENV"] == "":
+        warnings.warn("Virtual env path set to '', please check if this is intended.")
+        return
+
+    p = Path(sys.executable)
+    p_venv = Path(os.environ["VIRTUAL_ENV"]).resolve()
+
+    # fallback venv detection:
+    # stdlib venv may symlink sys.executable, so we can't use realpath.
+    # but others can symlink *to* the venv Python, so we can't just use sys.executable.
+    # So we just check every item in the symlink tree (generally <= 3)
+    paths = _get_path_links(p)
+
+    # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible
+    if len(p_venv.parts) > 2 and p_venv.parts[1] == "cygdrive":
+        drive_name = p_venv.parts[2]
+        p_venv = (drive_name + ":/") / Path(*p_venv.parts[3:])
+
+    if any(p_venv == p.parents[1].resolve() for p in paths):
+        # Our exe is inside or has access to the virtualenv, don't need to do anything.
+        return
+
+    if sys.platform == "win32":
+        virtual_env = str(Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages"))
+    else:
+        virtual_env_path = Path(
+            os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages"
+        )
+        p_ver = sys.version_info[:2]
+
+        # Predict version from py[thon]-x.x in the $VIRTUAL_ENV
+        re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"])
+        if re_m:
+            predicted_path = Path(str(virtual_env_path).format(*re_m.groups()))
+            if predicted_path.exists():
+                p_ver = re_m.groups()
+
+        virtual_env = str(virtual_env_path).format(*p_ver)
+
+    warnings.warn(
+        "Attempting to work in a virtualenv. If you encounter problems, "
+        "please install pyflyby inside the virtualenv."
+    )
+    import site
+    sys.path.insert(0, virtual_env)
+    site.addsitedir(virtual_env)
+
+
 class _Namespace(object):
 
     def __init__(self):
+        _init_virtualenv()
         self.globals      = {"__name__": "__main__",
                              "__builtin__": builtins,
                              "__builtins__": builtins}

{pyflyby-1.9.11/lib/python → pyflyby-1.9.12/bin}/pyflyby/_version.py

@@ -4,4 +4,4 @@
 # http://creativecommons.org/publicdomain/zero/1.0/
 
 
-__version__ = "1.9.11"
+__version__ = "1.9.12"

{pyflyby-1.9.11/bin → pyflyby-1.9.12/lib/python}/pyflyby/_py.py

@@ -281,7 +281,9 @@ Examples
 
 
 from   functools                import total_ordering
+from   pathlib                  import Path
 from   typing                   import Any
+import warnings
 
 from   pyflyby._util            import cmp
 from   shlex                    import quote as shquote
@@ -1410,9 +1412,84 @@ def print_result(result, output_mode):
         raise AssertionError("unexpected output_mode=%r" % (output_mode,))
 
 
+def _get_path_links(p: Path):
+    """Gets path links including all symlinks.
+
+    Adapted from `IPython.core.interactiveshell.InteractiveShell.get_path_links`.
+    """
+    paths = [p]
+    while p.is_symlink():
+        new_path = Path(os.readlink(p))
+        if not new_path.is_absolute():
+            new_path = p.parent / new_path
+        p = new_path
+        paths.append(p)
+    return paths
+
+
+def _init_virtualenv():
+    """Add the current virtualenv to sys.path so the user can import modules from it.
+
+    A warning will appear suggesting the user installs IPython in the
+    virtualenv, but for many cases, it probably works well enough.
+
+    Adapted `IPython.core.interactiveshell.InteractiveShell.init_virtualenv`.
+    """
+    if 'VIRTUAL_ENV' not in os.environ:
+        # Not in a virtualenv
+        return
+    elif os.environ["VIRTUAL_ENV"] == "":
+        warnings.warn("Virtual env path set to '', please check if this is intended.")
+        return
+
+    p = Path(sys.executable)
+    p_venv = Path(os.environ["VIRTUAL_ENV"]).resolve()
+
+    # fallback venv detection:
+    # stdlib venv may symlink sys.executable, so we can't use realpath.
+    # but others can symlink *to* the venv Python, so we can't just use sys.executable.
+    # So we just check every item in the symlink tree (generally <= 3)
+    paths = _get_path_links(p)
+
+    # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible
+    if len(p_venv.parts) > 2 and p_venv.parts[1] == "cygdrive":
+        drive_name = p_venv.parts[2]
+        p_venv = (drive_name + ":/") / Path(*p_venv.parts[3:])
+
+    if any(p_venv == p.parents[1].resolve() for p in paths):
+        # Our exe is inside or has access to the virtualenv, don't need to do anything.
+        return
+
+    if sys.platform == "win32":
+        virtual_env = str(Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages"))
+    else:
+        virtual_env_path = Path(
+            os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages"
+        )
+        p_ver = sys.version_info[:2]
+
+        # Predict version from py[thon]-x.x in the $VIRTUAL_ENV
+        re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"])
+        if re_m:
+            predicted_path = Path(str(virtual_env_path).format(*re_m.groups()))
+            if predicted_path.exists():
+                p_ver = re_m.groups()
+
+        virtual_env = str(virtual_env_path).format(*p_ver)
+
+    warnings.warn(
+        "Attempting to work in a virtualenv. If you encounter problems, "
+        "please install pyflyby inside the virtualenv."
+    )
+    import site
+    sys.path.insert(0, virtual_env)
+    site.addsitedir(virtual_env)
+
+
 class _Namespace(object):
 
     def __init__(self):
+        _init_virtualenv()
         self.globals      = {"__name__": "__main__",
                              "__builtin__": builtins,
                              "__builtins__": builtins}

{pyflyby-1.9.11/bin → pyflyby-1.9.12/lib/python}/pyflyby/_version.py

@@ -4,4 +4,4 @@
 # http://creativecommons.org/publicdomain/zero/1.0/
 
 
-__version__ = "1.9.11"
+__version__ = "1.9.12"

{pyflyby-1.9.11 → pyflyby-1.9.12/lib/python/pyflyby.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflyby
-Version: 1.9.11
+Version: 1.9.12
 Summary: pyflyby - Python development productivity tools, in particular automatic import management
 Home-page: https://pypi.org/project/pyflyby/
 Author: Karl Chen

{pyflyby-1.9.11 → pyflyby-1.9.12}/tests/test_py.py

@@ -5,6 +5,7 @@
 
 
 
+import ast
 import os
 import pytest
 from   shutil                   import rmtree
@@ -13,6 +14,7 @@ import sys
 import tempfile
 from   tempfile                 import NamedTemporaryFile, mkdtemp
 from   textwrap                 import dedent
+import venv
 
 from   pyflyby._file            import Filename
 from   pyflyby._util            import cached_attribute
@@ -2734,6 +2736,65 @@ def test_apply_not_a_function():
     assert "NotAFunctionError: ('Not a function', 75650517)" in result
 
 
+def test_virtualenv_recognized(tmpdir, monkeypatch):
+    """Verify that virtualenv sys.path is set correctly, and that warnings are emitted."""
+    if os.environ.get("VIRTUAL_ENV") is not None:
+        old_path = os.environ["PATH"].split(os.pathsep)
+        new_path = os.pathsep.join(old_path[1:])
+
+        monkeypatch.delenv("VIRTUAL_ENV")
+        monkeypatch.setenv("PATH", new_path)
+
+    no_venv_stdout = py('print(sys.path)')
+    no_venv_sys_path = ast.literal_eval(no_venv_stdout.split('\n')[-1])
+
+    env_dir = os.path.join(tmpdir, "venv")
+    env_bin = os.path.join(env_dir, "Scripts" if os.name == "nt" else "bin")
+    venv.create(env_dir)
+
+    # Simulate activation
+    monkeypatch.setenv("VIRTUAL_ENV", env_dir)
+    monkeypatch.setenv("PATH", env_bin + os.pathsep + os.environ["PATH"])
+
+    venv_stdout = py('print(sys.path)')
+    venv_sys_path = ast.literal_eval(venv_stdout.split('\n')[-1])
+
+    # Check that the appropriate warning is in place when using the venv,
+    # and missing if not.
+    warning =  (
+        "UserWarning: Attempting to work in a virtualenv. "
+        "If you encounter problems, please install pyflyby inside the virtualenv."
+    )
+    assert warning not in no_venv_stdout
+    assert warning in venv_stdout
+
+    # Check that sys.path printed from the subprocess contains the same
+    # paths as what we have in the test process
+    for path in sys.path:
+
+        # If a path is missing from one, it must be missing from the other
+        # (because both are called in subprocesses, which means that e.g.
+        # the pyenv bin path won't be included in the subprocess call but
+        # will be in the pytest call that runs this test)
+        if path not in no_venv_stdout:
+            assert path not in venv_stdout
+        else:
+            assert path in venv_stdout
+            assert path in no_venv_stdout
+
+    # Check that sys.path of the non-virtualenv appears
+    # in the sys.path of the virtualenv
+    #
+    # Get the last line (which contains the printed sys.path); convert
+    # back into a list
+    assert all(path in venv_sys_path for path in no_venv_sys_path)
+
+    # Check that the virtualenv directory appears in the sys.path of
+    # the virtualenv, but not in the sys.path of the non-virtualenv
+    assert not any(env_dir in path for path in no_venv_sys_path)
+    assert any(env_dir in path for path in venv_sys_path)
+
+
 # TODO: test timeit, time
 # TODO: test --attach
 # TODO: test postmortem debugging