Deprecated develop option and rename to editable

0scarB · 0scarB · commit 19a5b69ce0c7 · 2020-10-25T20:06:35.000+01:00
diff --git a/poetry/core/factory.py b/poetry/core/factory.py
@@ -199,6 +199,29 @@ def create_dependency(
                 "allow-prereleases", constraint.get("allows-prereleases", False)
             )
 
+            constraint_has_deprecated_develop = "develop" in constraint
+            if "editable" in constraint:
+                if constraint_has_deprecated_develop:
+                    raise RuntimeError(
+                        'The "{}" dependency specifies '
+                        'both the "editable" property and the deprecated "develop" property. '
+                        'Please remove "develop" and resolve value conflicts!'.format(
+                            name
+                        )
+                    )
+                editable = constraint.get("editable", False)
+            elif constraint_has_deprecated_develop:
+                message = (
+                    'The "{}" dependency specifies '
+                    'the "develop" property, which is deprecated. '
+                    'Use "editable" instead.'.format(name)
+                )
+                warn(message, DeprecationWarning)
+                logger.warning(message)
+                editable = constraint.get("develop", False)
+            else:
+                editable = False
+
             if "git" in constraint:
                 # VCS dependency
                 dependency = VCSDependency(
@@ -210,7 +233,7 @@ def create_dependency(
                     rev=constraint.get("rev", None),
                     category=category,
                     optional=optional,
-                    develop=constraint.get("develop", False),
+                    editable=editable,
                     extras=constraint.get("extras", []),
                 )
             elif "file" in constraint:
@@ -247,7 +270,7 @@ def create_dependency(
                         category=category,
                         optional=optional,
                         base=root_dir,
-                        develop=constraint.get("develop", False),
+                        editable=editable,
                         extras=constraint.get("extras", []),
                     )
             elif "url" in constraint:
diff --git a/poetry/core/json/schemas/poetry-schema.json b/poetry/core/json/schemas/poetry-schema.json
@@ -359,9 +359,14 @@
                         "type": "string"
                     }
                 },
+                "editable": {
+                    "type": "boolean",
+                    "description": "Whether to install the dependency in editable mode."
+                },
                 "develop": {
                     "type": "boolean",
-                    "description": "Whether to install the dependency in development mode."
+                    "description": "Whether to install the dependency in editable mode.",
+                    "deprecated": true
                 }
             }
         },
@@ -435,9 +440,14 @@
                         "type": "string"
                     }
                 },
+                "editable": {
+                    "type": "boolean",
+                    "description": "Whether to install the dependency in editable mode."
+                },
                 "develop": {
                     "type": "boolean",
-                    "description": "Whether to install the dependency in development mode."
+                    "description": "Whether to install the dependency in editable mode.",
+                    "deprecated": true
                 }
             }
         },
diff --git a/poetry/core/packages/directory_dependency.py b/poetry/core/packages/directory_dependency.py
@@ -16,7 +16,7 @@ def __init__(
         category="main",  # type: str
         optional=False,  # type: bool
         base=None,  # type: Path
-        develop=False,  # type: bool
+        editable=False,  # type: bool
         extras=None,  # type: Union[List[str], Set[str]]
     ):
         self._path = path
@@ -29,7 +29,7 @@ def __init__(
             except FileNotFoundError:
                 raise ValueError("Directory {} does not exist".format(self._path))
 
-        self._develop = develop
+        self._editable = editable
         self._supports_poetry = False
 
         if not self._full_path.exists():
@@ -75,8 +75,8 @@ def base(self):
         return self._base
 
     @property
-    def develop(self):
-        return self._develop
+    def editable(self):
+        return self._editable
 
     def supports_poetry(self):
         return self._supports_poetry
@@ -91,7 +91,7 @@ def with_constraint(self, constraint):
             base=self.base,
             optional=self.is_optional(),
             category=self.category,
-            develop=self._develop,
+            editable=self._editable,
             extras=self._extras,
         )
 
diff --git a/poetry/core/packages/package.py b/poetry/core/packages/package.py
@@ -96,7 +96,7 @@ def __init__(
 
         self.root_dir = None
 
-        self.develop = True
+        self.editable = True
 
     @property
     def name(self):
@@ -319,7 +319,7 @@ def to_dependency(self):
                 category=self.category,
                 optional=self.optional,
                 base=self.root_dir,
-                develop=self.develop,
+                editable=self.editable,
                 extras=self.features,
             )
         elif self.source_type == "file":
@@ -348,7 +348,7 @@ def to_dependency(self):
                 resolved_rev=self.source_resolved_reference,
                 category=self.category,
                 optional=self.optional,
-                develop=self.develop,
+                editable=self.editable,
                 extras=self.features,
             )
         else:
@@ -405,7 +405,7 @@ def clone(self):  # type: () -> "Package"
         clone.marker = self.marker
         clone.extras = self.extras
         clone.root_dir = self.root_dir
-        clone.develop = self.develop
+        clone.editable = self.editable
 
         for dep in self.requires:
             clone.requires.append(dep)
diff --git a/poetry/core/packages/vcs_dependency.py b/poetry/core/packages/vcs_dependency.py
@@ -23,7 +23,7 @@ def __init__(
         resolved_rev=None,
         category="main",
         optional=False,
-        develop=False,
+        editable=False,
         extras=None,  # type: Union[List[str], Set[str]]
     ):
         self._vcs = vcs
@@ -36,7 +36,7 @@ def __init__(
         self._branch = branch
         self._tag = tag
         self._rev = rev
-        self._develop = develop
+        self._editable = editable
 
         super(VCSDependency, self).__init__(
             name,
@@ -71,9 +71,16 @@ def tag(self):
     def rev(self):
         return self._rev
 
+    @property
+    def editable(self):  # type: () -> bool
+        return self._editable
+
     @property
     def develop(self):  # type: () -> bool
-        return self._develop
+        raise DeprecationWarning(
+            "The `develop` key is deprecated, please use `editable` instead!"
+        )
+        return self.editable
 
     @property
     def reference(self):  # type: () -> str
@@ -127,7 +134,7 @@ def with_constraint(self, constraint):
             resolved_rev=self._source_resolved_reference,
             optional=self.is_optional(),
             category=self.category,
-            develop=self._develop,
+            editable=self._editable,
             extras=self._extras,
         )
 
diff --git a/tests/fixtures/project_with_deprecated_develop_dependency/pyproject.toml b/tests/fixtures/project_with_deprecated_develop_dependency/pyproject.toml
@@ -0,0 +1,8 @@
+[tool.poetry]
+name = "my-package"
+version = "1.2.3"
+description = ""
+authors = ["Awesome Hacker <awesome@hacker.io>"]
+
+[tool.poetry.dependencies]
+pendulum = { git = "https://github.com/sdispater/pendulum.git", develop = false }
diff --git a/tests/fixtures/project_with_editable_and_deprecated_develop_dependency/pyproject.toml b/tests/fixtures/project_with_editable_and_deprecated_develop_dependency/pyproject.toml
@@ -0,0 +1,8 @@
+[tool.poetry]
+name = "my-package"
+version = "1.2.3"
+description = ""
+authors = ["Awesome Hacker <awesome@hacker.io>"]
+
+[tool.poetry.dependencies]
+pendulum = { git = "https://github.com/sdispater/pendulum.git", editable = false, develop = false }
diff --git a/tests/fixtures/project_with_invalid_dev_deps/pyproject.toml b/tests/fixtures/project_with_invalid_dev_deps/pyproject.toml
@@ -10,4 +10,4 @@ license = "MIT"
 [tool.poetry.extras]
 
 [tool.poetry.dev-dependencies]
-mylib = { path = "../mylib", develop = true}
+mylib = { path = "../mylib", editable = false }
diff --git a/tests/fixtures/sample_project/pyproject.toml b/tests/fixtures/sample_project/pyproject.toml
@@ -25,7 +25,7 @@ classifiers = [
 python = "~2.7 || ^3.6"
 cleo = "^0.6"
 pendulum = { git = "https://github.com/sdispater/pendulum.git", branch = "2.0" }
-tomlkit = { git = "https://github.com/sdispater/tomlkit.git", rev = "3bff550", develop = false }
+tomlkit = { git = "https://github.com/sdispater/tomlkit.git", rev = "3bff550", editable = false }
 requests = { version = "^2.18", optional = true, extras=[ "security" ] }
 pathlib2 = { version = "^2.2", python = "~2.7" }
 
diff --git a/tests/masonry/builders/fixtures/with_bad_path_dep/pyproject.toml b/tests/masonry/builders/fixtures/with_bad_path_dep/pyproject.toml
@@ -6,4 +6,4 @@ authors = ["Awesome Hacker <awesome@hacker.io>"]
 
 [tool.poetry.dependencies]
 python = "^3.6"
-bogus = { path = "../only/in/dev", develop = true }
+bogus = { path = "../only/in/dev", editable = true }
diff --git a/tests/masonry/builders/fixtures/with_bad_path_dev_dep/pyproject.toml b/tests/masonry/builders/fixtures/with_bad_path_dev_dep/pyproject.toml
@@ -8,4 +8,4 @@ authors = ["Awesome Hacker <awesome@hacker.io>"]
 python = "^3.6"
 
 [tool.poetry.dev-dependencies]
-bogus = { path = "../only/in/dev", develop = true }
+bogus = { path = "../only/in/dev", editable = true }
diff --git a/tests/test_factory.py b/tests/test_factory.py
@@ -2,6 +2,8 @@
 from __future__ import absolute_import
 from __future__ import unicode_literals
 
+import warnings
+
 import pytest
 
 from poetry.core.factory import Factory
@@ -49,7 +51,7 @@ def test_create_poetry():
     assert pendulum.branch == "2.0"
     assert pendulum.source == "https://github.com/sdispater/pendulum.git"
     assert pendulum.allows_prereleases()
-    assert not pendulum.develop
+    assert not pendulum.editable
 
     tomlkit = dependencies["tomlkit"]
     assert tomlkit.pretty_constraint == "rev 3bff550"
@@ -58,7 +60,7 @@ def test_create_poetry():
     assert tomlkit.rev == "3bff550"
     assert tomlkit.source == "https://github.com/sdispater/tomlkit.git"
     assert tomlkit.allows_prereleases()
-    assert not tomlkit.develop
+    assert not tomlkit.editable
 
     requests = dependencies["requests"]
     assert requests.pretty_constraint == "^2.18"
@@ -217,3 +219,35 @@ def test_create_poetry_fails_with_invalid_dev_dependencies_iff_with_dev_is_true(
     Factory().create_poetry(
         fixtures_dir / "project_with_invalid_dev_deps", with_dev=False
     )
+
+
+def test_create_poetry_fails_when_dependency_contains_editable_and_deprecated_develop_key():
+    with pytest.raises(RuntimeError) as e:
+        Factory().create_poetry(
+            fixtures_dir / "project_with_editable_and_deprecated_develop_dependency"
+        )
+    assert (
+        'The "pendulum" dependency specifies '
+        'both the "editable" property and the deprecated "develop" property. '
+        'Please remove "develop" and resolve value conflicts!'
+    ) == str(e.value)
+
+
+def test_create_poetry_warns_when_dependency_contains_deprecated_develop_key(caplog):
+    # All warnings are triggered inside this context manager.
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        expected = (
+            'The "pendulum" dependency specifies '
+            'the "develop" property, which is deprecated. '
+            'Use "editable" instead.'
+        )
+        Factory().create_poetry(
+            fixtures_dir / "project_with_deprecated_develop_dependency"
+        )
+        assert len(w) == 1
+        assert issubclass(w[-1].category, DeprecationWarning)
+        assert expected == str(w[-1].message)
+        for record in caplog.records:
+            assert record.levelname == "WARNING"
+        assert expected in caplog.text

Original file line number	Diff line number	Diff line change
`@@ -359,9 +359,14 @@`
`359`	`359`	`"type": "string"`
`360`	`360`	`}`
`361`	`361`	`},`
	`362`	`+ "editable": {`
	`363`	`+ "type": "boolean",`
	`364`	`+ "description": "Whether to install the dependency in editable mode."`
	`365`	`+ },`
`362`	`366`	`"develop": {`
`363`	`367`	`"type": "boolean",`
`364`		`- "description": "Whether to install the dependency in development mode."`
	`368`	`+ "description": "Whether to install the dependency in editable mode.",`
	`369`	`+ "deprecated": true`
`365`	`370`	`}`
`366`	`371`	`}`
`367`	`372`	`},`
`@@ -435,9 +440,14 @@`
`435`	`440`	`"type": "string"`
`436`	`441`	`}`
`437`	`442`	`},`
	`443`	`+ "editable": {`
	`444`	`+ "type": "boolean",`
	`445`	`+ "description": "Whether to install the dependency in editable mode."`
	`446`	`+ },`
`438`	`447`	`"develop": {`
`439`	`448`	`"type": "boolean",`
`440`		`- "description": "Whether to install the dependency in development mode."`
	`449`	`+ "description": "Whether to install the dependency in editable mode.",`
	`450`	`+ "deprecated": true`
`441`	`451`	`}`
`442`	`452`	`}`
`443`	`453`	`},`