pyflyby 1.9.11__tar.gz → 1.9.13__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflyby
-Version: 1.9.11
+Version: 1.9.13
 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.13/bin}/pyflyby/_format.py

@@ -6,7 +6,7 @@
 
 class FormatParams(object):
     max_line_length = None
-    _max_line_lenght_default = 79
+    max_line_length_default = 79
     wrap_paren = True
     indent = 4
     hanging_indent = 'never'
@@ -128,11 +128,15 @@ def pyfill(prefix, tokens, params=FormatParams()):
     :rtype:
       ``str``
     """
-    N = params.max_line_length or params._max_line_lenght_default
+    if params.max_line_length is None:
+        max_line_length = params.max_line_length_default
+    else:
+        max_line_length = params.max_line_length
+
     if params.wrap_paren:
         # Check how we will break up the tokens.
         len_full = sum(len(tok) for tok in tokens) + 2 * (len(tokens)-1)
-        if len(prefix) + len_full <= N:
+        if len(prefix) + len_full <= max_line_length:
             # The entire thing fits on one line; no parens needed.  We check
             # this first because breaking into lines adds paren overhead.
             #
@@ -153,7 +157,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             # longest token since even if the first token fits, we still want
             # to avoid later tokens running over N.
             maxtoklen = max(len(token) for token in tokens)
-            hanging_indent = (len(prefix) + maxtoklen + 2 > N)
+            hanging_indent = (len(prefix) + maxtoklen + 2 > max_line_length)
         else:
             raise ValueError("bad params.hanging_indent=%r"
                              % (params.hanging_indent,))
@@ -166,7 +170,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             #       abc, defgh, ijkl,
             #       mnopq, rst)
             return (prefix + "(\n"
-                    + fill(tokens, max_line_length=N,
+                    + fill(tokens, max_line_length=max_line_length,
                            prefix=(" " * params.indent), suffix=("", ")")))
         else:
             # Non-hanging-indent mode.
@@ -176,7 +180,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             #                    ijkl, mnopq,
             #                    rst)
             pprefix = prefix + "("
-            return fill(tokens, max_line_length=N,
+            return fill(tokens, max_line_length=max_line_length,
                         prefix=(pprefix, " " * len(pprefix)), suffix=("", ")"))
     else:
         raise NotImplementedError

{pyflyby-1.9.11 → pyflyby-1.9.13}/bin/pyflyby/_importstmt.py

@@ -512,7 +512,7 @@ class ImportStatement:
 
         return tuple(self.aliases[0][0].split('.'))
 
-        
+
     def _cmp(self):
         """
         Comparison function for sorting.
@@ -587,12 +587,12 @@ class ImportStatement:
 
         black_config = read_black_config()
         mode = dict()
-        if "line_length" in black_config:
-            mode["line_length"] = (
-                params.max_line_length
-                if params.max_line_length
-                else black_config["line_length"]
-            )
+
+        if params.max_line_length is None:
+            mode["line_length"] = black_config.get("line_length", params.max_line_length_default)
+        else:
+            mode["line_length"] = params.max_line_length
+
         if "target_version" in black_config:
             if isinstance(black_config["target_version"], set):
                 target_versions_in = black_config["target_version"]

{pyflyby-1.9.11/lib/python → pyflyby-1.9.13/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.13/bin}/pyflyby/_version.py

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

{pyflyby-1.9.11/bin → pyflyby-1.9.13/lib/python}/pyflyby/_format.py

@@ -6,7 +6,7 @@
 
 class FormatParams(object):
     max_line_length = None
-    _max_line_lenght_default = 79
+    max_line_length_default = 79
     wrap_paren = True
     indent = 4
     hanging_indent = 'never'
@@ -128,11 +128,15 @@ def pyfill(prefix, tokens, params=FormatParams()):
     :rtype:
       ``str``
     """
-    N = params.max_line_length or params._max_line_lenght_default
+    if params.max_line_length is None:
+        max_line_length = params.max_line_length_default
+    else:
+        max_line_length = params.max_line_length
+
     if params.wrap_paren:
         # Check how we will break up the tokens.
         len_full = sum(len(tok) for tok in tokens) + 2 * (len(tokens)-1)
-        if len(prefix) + len_full <= N:
+        if len(prefix) + len_full <= max_line_length:
             # The entire thing fits on one line; no parens needed.  We check
             # this first because breaking into lines adds paren overhead.
             #
@@ -153,7 +157,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             # longest token since even if the first token fits, we still want
             # to avoid later tokens running over N.
             maxtoklen = max(len(token) for token in tokens)
-            hanging_indent = (len(prefix) + maxtoklen + 2 > N)
+            hanging_indent = (len(prefix) + maxtoklen + 2 > max_line_length)
         else:
             raise ValueError("bad params.hanging_indent=%r"
                              % (params.hanging_indent,))
@@ -166,7 +170,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             #       abc, defgh, ijkl,
             #       mnopq, rst)
             return (prefix + "(\n"
-                    + fill(tokens, max_line_length=N,
+                    + fill(tokens, max_line_length=max_line_length,
                            prefix=(" " * params.indent), suffix=("", ")")))
         else:
             # Non-hanging-indent mode.
@@ -176,7 +180,7 @@ def pyfill(prefix, tokens, params=FormatParams()):
             #                    ijkl, mnopq,
             #                    rst)
             pprefix = prefix + "("
-            return fill(tokens, max_line_length=N,
+            return fill(tokens, max_line_length=max_line_length,
                         prefix=(pprefix, " " * len(pprefix)), suffix=("", ")"))
     else:
         raise NotImplementedError

{pyflyby-1.9.11 → pyflyby-1.9.13}/lib/python/pyflyby/_importstmt.py

@@ -512,7 +512,7 @@ class ImportStatement:
 
         return tuple(self.aliases[0][0].split('.'))
 
-        
+
     def _cmp(self):
         """
         Comparison function for sorting.
@@ -587,12 +587,12 @@ class ImportStatement:
 
         black_config = read_black_config()
         mode = dict()
-        if "line_length" in black_config:
-            mode["line_length"] = (
-                params.max_line_length
-                if params.max_line_length
-                else black_config["line_length"]
-            )
+
+        if params.max_line_length is None:
+            mode["line_length"] = black_config.get("line_length", params.max_line_length_default)
+        else:
+            mode["line_length"] = params.max_line_length
+
         if "target_version" in black_config:
             if isinstance(black_config["target_version"], set):
                 target_versions_in = black_config["target_version"]

{pyflyby-1.9.11/bin → pyflyby-1.9.13/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.13/lib/python}/pyflyby/_version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflyby
-Version: 1.9.11
+Version: 1.9.13
 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.13}/tests/test_imports2s.py

@@ -11,6 +11,7 @@ import sys
 from   textwrap                 import dedent
 import types
 
+from   pyflyby._format          import FormatParams
 from   pyflyby._importdb        import ImportDB
 from   pyflyby._imports2s       import (canonicalize_imports,
                                         fix_unused_and_missing_imports,
@@ -1111,3 +1112,50 @@ def test_fix_unused_imports_submodule_importas_1():
         m2.x + m2y + m3.x
     '''))
     assert expected == output
+
+
+def test_reformat_import_statements_respect_width_1(tmp_path):
+    """Test that tidy-imports with a max line length correctly wraps imports."""
+    filename = str(tmp_path / "test_reformat_import_statements_respect_width_1")
+    input = PythonBlock(dedent('''
+        from math import sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians
+        assert [sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians]
+    ''').lstrip(), filename=filename)
+    output = reformat_import_statements(input, FormatParams(max_line_length=100))
+    expected = PythonBlock(dedent('''
+        from math import (cos, cosh, factorial, floor, log, log10, nextafter, radians, remainder, sin, sinh,
+                          tan, tanh)
+        assert [sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians]
+    ''').lstrip(), filename=filename)
+    assert output == expected
+
+
+def test_reformat_import_statements_respect_width_2(tmp_path):
+    """Test that tidy-imports with a max line length correctly wraps imports."""
+    filename = str(tmp_path / "test_reformat_import_statements_respect_width_2")
+    input = PythonBlock(dedent('''
+        from math import sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians
+        assert [sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians]
+    ''').lstrip(), filename=filename)
+    output = reformat_import_statements(input, FormatParams(max_line_length=200))
+    expected = PythonBlock(dedent('''
+        from math import cos, cosh, factorial, floor, log, log10, nextafter, radians, remainder, sin, sinh, tan, tanh
+        assert [sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians]
+    ''').lstrip(), filename=filename)
+    assert output == expected
+
+
+def test_reformat_import_statements_respect_width_3(tmp_path):
+    """Test that tidy-imports with no specified width matches the default width."""
+    filename = str(tmp_path / "test_reformat_import_statements_respect_width_3")
+    input = PythonBlock(dedent('''
+        from math import sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians
+        assert [sin,cos,tan,sinh,cosh,tanh,log,floor,log10,remainder,factorial,nextafter,radians]
+    ''').lstrip(), filename=filename)
+    assert reformat_import_statements(
+        input,
+        FormatParams(max_line_length=None),
+    ) == reformat_import_statements(
+        input,
+        FormatParams(max_line_length=FormatParams.max_line_length_default),
+    )

{pyflyby-1.9.11 → pyflyby-1.9.13}/tests/test_importstmt.py

@@ -123,11 +123,34 @@ def test_Import_replace_2():
 
 @patch("pyflyby._importstmt.read_black_config", lambda: {"line_length": 20})
 def test_Import_black_line_length():
+    """Test that a black config takes precedence over the default line length."""
     stmt = Import("from a123456789 import b123456789")
     result = stmt.pretty_print(params=FormatParams(use_black=True))
     assert result == "from a123456789 import (\n    b123456789,\n)\n"
 
 
+@patch("pyflyby._importstmt.read_black_config", lambda: {})
+def test_Import_black_line_length2():
+    """Test that the default line length is used if no black config is present."""
+    stmt = Import("from math import sincostansinhcoshtanhlogfloorlog10remainderfactorialnextafter")
+    result = stmt.pretty_print(params=FormatParams(use_black=True))
+    assert result == "from math import sincostansinhcoshtanhlogfloorlog10remainderfactorialnextafter\n"
+
+@patch("pyflyby._importstmt.read_black_config", lambda: {})
+def test_Import_black_line_length3():
+    """Test that the default line length is used if no black config is present."""
+    stmt = Import("from math import sincostansinhcoshtanhlogfloorlog10remainderfactorialnextafterradians")
+    result = stmt.pretty_print(params=FormatParams(use_black=True))
+    assert result == "from math import (\n    sincostansinhcoshtanhlogfloorlog10remainderfactorialnextafterradians,\n)\n"
+
+@patch("pyflyby._importstmt.read_black_config", lambda: {"line_length": 200})
+def test_Import_black_line_length4():
+    """Test that a command line --width takes precedence over a black config."""
+    stmt = Import("from a123456789 import b123456789")
+    result = stmt.pretty_print(params=FormatParams(use_black=True, max_line_length=20))
+    assert result == "from a123456789 import (\n    b123456789,\n)\n"
+
+
 def test_ImportStatement_1():
     stmt = ImportStatement("import  foo . bar")
     assert stmt.fromname == None

{pyflyby-1.9.11 → pyflyby-1.9.13}/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