add config option to force --always-copy argument for virtualenv

Author: finswimmer

docs/docs/configuration.md

@@ -35,6 +35,7 @@ cache-dir = "/path/to/cache/directory"
 virtualenvs.create = true
 virtualenvs.in-project = null
 virtualenvs.path = "{cache-dir}/virtualenvs"  # /path/to/cache/directory/virtualenvs
+virtualenvs.always-copy = true
 ```
 
 ## Displaying a single configuration setting
@@ -128,6 +129,12 @@ If not set explicitly (default), `poetry` will use the virtualenv from the `.ven
 Directory where virtual environments will be created.
 Defaults to `{cache-dir}/virtualenvs` (`{cache-dir}\virtualenvs` on Windows).
 
+### `virtualenvs.always-copy`: boolean
+
+If set to `true` the `--always-copy` parameter is passed to `virtualenv` on creation of the venv. Thus all needed files are copied into the venv instead of symlinked.
+Defaults to `false`.
+
+
 ### `repositories.<name>`: string
 
 Set a new alternative repository. See [Repositories](/docs/repositories/) for more information.

poetry/config/config.py

@@ -36,6 +36,7 @@ class Config(object):
             "create": True,
             "in-project": None,
             "path": os.path.join("{cache-dir}", "virtualenvs"),
+            "always-copy": False,
         },
         "experimental": {"new-installer": True},
     }

poetry/console/commands/config.py

@@ -58,6 +58,7 @@ def unique_config_values(self):
                 lambda val: str(Path(val)),
                 str(Path(CACHE_DIR) / "virtualenvs"),
             ),
+            "virtualenvs.always-copy": (boolean_validator, boolean_normalizer, False),
             "experimental.new-installer": (
                 boolean_validator,
                 boolean_normalizer,

poetry/utils/env.py

@@ -642,7 +642,11 @@ def create_venv(
                 "Creating virtualenv <c1>{}</> in {}".format(name, str(venv_path))
             )
 
-            self.build_venv(venv, executable=executable)
+            self.build_venv(
+                venv,
+                executable=executable,
+                always_copy=self._poetry.config.get("virtualenvs.always-copy"),
+            )
         else:
             if force:
                 if not env.is_sane():
@@ -655,7 +659,11 @@ def create_venv(
                     "Recreating virtualenv <c1>{}</> in {}".format(name, str(venv))
                 )
                 self.remove_venv(venv)
-                self.build_venv(venv, executable=executable)
+                self.build_venv(
+                    venv,
+                    executable=executable,
+                    always_copy=self._poetry.config.get("virtualenvs.always-copy"),
+                )
             elif io.is_very_verbose():
                 io.write_line("Virtualenv <c1>{}</> already exists.".format(name))
 
@@ -679,19 +687,23 @@ def create_venv(
 
     @classmethod
     def build_venv(
-        cls, path, executable=None
-    ):  # type: (Union[Path,str], Optional[Union[str, Path]]) -> virtualenv.run.session.Session
+        cls, path, executable=None, always_copy=False
+    ):  # type: (Union[Path,str], Optional[Union[str, Path]], bool) -> virtualenv.run.session.Session
         if isinstance(executable, Path):
             executable = executable.resolve().as_posix()
-        return virtualenv.cli_run(
-            [
-                "--no-download",
-                "--no-periodic-update",
-                "--python",
-                executable or sys.executable,
-                str(path),
-            ]
-        )
+
+        args = [
+            "--no-download",
+            "--no-periodic-update",
+            "--python",
+            executable or sys.executable,
+            str(path),
+        ]
+
+        if always_copy:
+            args.insert(0, "--always-copy")
+
+        return virtualenv.cli_run(args)
 
     @classmethod
     def remove_venv(cls, path):  # type: (Union[Path,str]) -> None

tests/console/commands/env/helpers.py

@@ -5,7 +5,9 @@
 from poetry.utils._compat import Path
 
 
-def build_venv(path, executable=None):  # type: (Union[Path,str], Optional[str]) -> ()
+def build_venv(
+    path, executable=None, always_copy=False
+):  # type: (Union[Path,str], Optional[str], bool) -> ()
     Path(path).mkdir(parents=True, exist_ok=True)
 
 

tests/console/commands/env/test_use.py

@@ -50,7 +50,9 @@ def test_activate_activates_non_existing_virtualenv_no_envs_file(
     tester.execute("3.7")
 
     venv_py37 = venv_cache / "{}-py3.7".format(venv_name)
-    mock_build_env.assert_called_with(venv_py37, executable="python3.7")
+    mock_build_env.assert_called_with(
+        venv_py37, executable="python3.7", always_copy=False
+    )
 
     envs_file = TOMLFile(venv_cache / "envs.toml")
     assert envs_file.exists()

tests/console/commands/test_config.py

@@ -17,6 +17,7 @@ def test_list_displays_default_value_if_not_set(tester, config):
 
     expected = """cache-dir = "/foo"
 experimental.new-installer = true
+virtualenvs.always-copy = false
 virtualenvs.create = true
 virtualenvs.in-project = null
 virtualenvs.path = {path}  # /foo{sep}virtualenvs
@@ -34,6 +35,7 @@ def test_list_displays_set_get_setting(tester, config):
 
     expected = """cache-dir = "/foo"
 experimental.new-installer = true
+virtualenvs.always-copy = false
 virtualenvs.create = false
 virtualenvs.in-project = null
 virtualenvs.path = {path}  # /foo{sep}virtualenvs
@@ -73,6 +75,7 @@ def test_list_displays_set_get_local_setting(tester, config):
 
     expected = """cache-dir = "/foo"
 experimental.new-installer = true
+virtualenvs.always-copy = false
 virtualenvs.create = false
 virtualenvs.in-project = null
 virtualenvs.path = {path}  # /foo{sep}virtualenvs

tests/utils/test_env.py

@@ -118,7 +118,9 @@ def test_env_get_venv_with_venv_folder_present(
         assert venv.path == in_project_venv_dir
 
 
-def build_venv(path, executable=None):  # type: (Union[Path,str], Optional[str]) -> ()
+def build_venv(
+    path, executable=None, always_copy=False
+):  # type: (Union[Path,str], Optional[str], bool) -> ()
     os.mkdir(str(path))
 
 
@@ -156,7 +158,9 @@ def test_activate_activates_non_existing_virtualenv_no_envs_file(
     venv_name = EnvManager.generate_env_name("simple-project", str(poetry.file.parent))
 
     m.assert_called_with(
-        Path(tmp_dir) / "{}-py3.7".format(venv_name), executable="python3.7"
+        Path(tmp_dir) / "{}-py3.7".format(venv_name),
+        executable="python3.7",
+        always_copy=False,
     )
 
     envs_file = TOMLFile(Path(tmp_dir) / "envs.toml")
@@ -274,7 +278,9 @@ def test_activate_activates_different_virtualenv_with_envs_file(
     env = manager.activate("python3.6", NullIO())
 
     m.assert_called_with(
-        Path(tmp_dir) / "{}-py3.6".format(venv_name), executable="python3.6"
+        Path(tmp_dir) / "{}-py3.6".format(venv_name),
+        executable="python3.6",
+        always_copy=False,
     )
 
     assert envs_file.exists()
@@ -326,7 +332,9 @@ def test_activate_activates_recreates_for_different_patch(
     env = manager.activate("python3.7", NullIO())
 
     build_venv_m.assert_called_with(
-        Path(tmp_dir) / "{}-py3.7".format(venv_name), executable="python3.7"
+        Path(tmp_dir) / "{}-py3.7".format(venv_name),
+        executable="python3.7",
+        always_copy=False,
     )
     remove_venv_m.assert_called_with(Path(tmp_dir) / "{}-py3.7".format(venv_name))
 
@@ -654,7 +662,9 @@ def test_create_venv_tries_to_find_a_compatible_python_executable_using_generic_
     manager.create_venv(NullIO())
 
     m.assert_called_with(
-        Path("/foo/virtualenvs/{}-py3.7".format(venv_name)), executable="python3"
+        Path("/foo/virtualenvs/{}-py3.7".format(venv_name)),
+        executable="python3",
+        always_copy=False,
     )
 
 
@@ -678,7 +688,9 @@ def test_create_venv_tries_to_find_a_compatible_python_executable_using_specific
     manager.create_venv(NullIO())
 
     m.assert_called_with(
-        Path("/foo/virtualenvs/{}-py3.9".format(venv_name)), executable="python3.9"
+        Path("/foo/virtualenvs/{}-py3.9".format(venv_name)),
+        executable="python3.9",
+        always_copy=False,
     )
 
 
@@ -767,6 +779,7 @@ def test_create_venv_uses_patch_version_to_detect_compatibility(
             )
         ),
         executable=None,
+        always_copy=False,
     )
 
 
@@ -804,6 +817,7 @@ def test_create_venv_uses_patch_version_to_detect_compatibility_with_executable(
             )
         ),
         executable="python{}.{}".format(version.major, version.minor - 1),
+        always_copy=False,
     )
 
 
@@ -834,7 +848,9 @@ def test_activate_with_in_project_setting_does_not_fail_if_no_venvs_dir(
 
     manager.activate("python3.7", NullIO())
 
-    m.assert_called_with(poetry.file.parent / ".venv", executable="python3.7")
+    m.assert_called_with(
+        poetry.file.parent / ".venv", executable="python3.7", always_copy=False
+    )
 
     envs_file = TOMLFile(Path(tmp_dir) / "virtualenvs" / "envs.toml")
     assert not envs_file.exists()