Added script file feature

Author: trvemotion-peterdeme

poetry/core/json/schemas/poetry-schema.json

@@ -163,9 +163,7 @@
         "scripts": {
             "type": "object",
             "description": "A hash of scripts to be installed.",
-            "items": {
-                "type": "string"
-            }
+            "$ref": "#/definitions/scripts"
         },
         "plugins": {
             "type": "object",
@@ -212,13 +210,23 @@
         },
         "package-format": {
             "type": "string",
-            "enum": ["sdist", "wheel"],
+            "enum": [
+                "sdist",
+                "wheel"
+            ],
             "description": "A Python packaging format."
         },
         "package-formats": {
             "oneOf": [
-                {"$ref": "#/definitions/package-format"},
-                {"type": "array", "items": {"$ref": "#/definitions/package-format"}}
+                {
+                    "$ref": "#/definitions/package-format"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/package-format"
+                    }
+                }
             ],
             "description": "The format(s) for which the package must be included."
         },
@@ -513,6 +521,9 @@
                         },
                         {
                             "$ref": "#/definitions/extra-script"
+                        },
+                        {
+                            "$ref": "#/definitions/file-script"
                         }
                     ]
                 }
@@ -522,6 +533,27 @@
             "type": "string",
             "description": "A simple script pointing to a callable object."
         },
+        "file-script": {
+            "type": "object",
+            "description": "A script file that'll be included in the distribution package.",
+            "additionalProperties": false,
+            "properties": {
+                "source": {
+                    "type": "string",
+                    "description": "The relative path of the script file."
+                },
+                "type": {
+                    "description": "This value can only be 'file' currently.",
+                    "type": "string",
+                    "enum": [
+                        "file"
+                    ]
+                }
+            },
+            "required": [
+                "source"
+            ]
+        },
         "extra-script": {
             "type": "object",
             "description": "A script that should be installed only if extras are activated.",
@@ -583,8 +615,12 @@
         },
         "build-section": {
             "oneOf": [
-                {"$ref": "#/definitions/build-script"},
-                {"$ref": "#/definitions/build-config"}
+                {
+                    "$ref": "#/definitions/build-script"
+                },
+                {
+                    "$ref": "#/definitions/build-config"
+                }
             ]
         }
     }

poetry/core/masonry/builders/builder.py

@@ -8,6 +8,7 @@
 from collections import defaultdict
 from contextlib import contextmanager
 from typing import TYPE_CHECKING
+from typing import List
 from typing import Optional
 from typing import Set
 from typing import Union
@@ -271,6 +272,8 @@ def convert_entry_points(self):  # type: () -> dict
         for name, ep in self._poetry.local_config.get("scripts", {}).items():
             extras = ""
             if isinstance(ep, dict):
+                if "source" in ep:
+                    continue
                 extras = "[{}]".format(", ".join(ep["extras"]))
                 ep = ep["callable"]
 
@@ -287,6 +290,22 @@ def convert_entry_points(self):  # type: () -> dict
 
         return dict(result)
 
+    def convert_script_files(self):  # type: () -> List[Path]
+        script_files = []
+
+        for _, ep in self._poetry.local_config.get("scripts", {}).items():
+            if isinstance(ep, dict) and "source" in ep:
+                abs_path = Path.joinpath(self._path, ep["source"])
+
+                if not abs_path.exists():
+                    raise RuntimeError("{} file-script is not found.".format(abs_path))
+                if not abs_path.is_file():
+                    raise RuntimeError("{} file-script is not a file.".format(abs_path))
+
+                script_files.append(abs_path)
+
+        return script_files
+
     @classmethod
     def convert_author(cls, author):  # type: (...) -> dict
         m = AUTHOR_REGEX.match(author)

poetry/core/masonry/builders/sdist.py

@@ -181,6 +181,12 @@ def build_setup(self):  # type: () -> bytes
             before.append("entry_points = \\\n{}\n".format(pformat(entry_points)))
             extra.append("'entry_points': entry_points,")
 
+        script_files = self.convert_script_files()
+        if script_files:
+            rel_paths = [str(p.relative_to(self._path)) for p in script_files]
+            before.append('scripts = \\\n["{}"]\n'.format('", "'.join(rel_paths)))
+            extra.append("'scripts': scripts,")
+
         if self._package.python_versions != "*":
             python_requires = self._meta.requires_python
 
@@ -311,6 +317,10 @@ def find_files_to_add(
             license_file for license_file in self._path.glob("LICENSE*")
         }
 
+        # add script files
+        for abs_path in self.convert_script_files():
+            additional_files.add(abs_path)
+
         # Include project files
         additional_files.add("pyproject.toml")
 

poetry/core/masonry/builders/wheel.py

@@ -88,6 +88,7 @@ def build(self):
                 self._copy_module(zip_file)
                 self._build(zip_file)
 
+            self._copy_file_scripts(zip_file)
             self._write_metadata(zip_file)
             self._write_record(zip_file)
 
@@ -145,6 +146,16 @@ def _build(self, wheel):
 
                         self._add_file(wheel, pkg, rel_path)
 
+    def _copy_file_scripts(self, wheel):  # type: (zipfile.ZipFile) -> None
+        file_scripts = self.convert_script_files()
+
+        for abs_path in file_scripts:
+            self._add_file(
+                wheel,
+                abs_path,
+                "{}/{}/{}".format(self.wheel_data_folder, "scripts", abs_path.name),
+            )
+
     def _run_build_command(self, setup):
         subprocess.check_call(
             [
@@ -219,6 +230,10 @@ def _write_record(self, wheel):
     def dist_info(self):  # type: () -> str
         return self.dist_info_name(self._package.name, self._meta.version)
 
+    @property
+    def wheel_data_folder(self):  # type: () -> str
+        return "{}-{}.data".format(self._package.name, self._meta.version)
+
     @property
     def wheel_filename(self):  # type: () -> str
         return "{}-{}-{}.whl".format(

tests/fixtures/complete.toml

@@ -38,6 +38,8 @@ pytest-cov = "^2.4"
 
 [tool.poetry.scripts]
 my-script = 'my_package:main'
+sample_pyscript = { source = "script-files/sample_script.py", type= "file" }
+sample_shscript = { source = "script-files/sample_script.sh", type= "file" }
 
 
 [[tool.poetry.source]]

tests/fixtures/script-files/sample_script.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+
+hello = "Hello World!"

tests/fixtures/script-files/sample_script.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello World!"

tests/masonry/builders/fixtures/complete/bin/script1.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello World!"

tests/masonry/builders/fixtures/complete/bin/script2.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello World!"

tests/masonry/builders/fixtures/complete/pyproject.toml

@@ -49,6 +49,9 @@ time = ["pendulum"]
 my-script = "my_package:main"
 my-2nd-script = "my_package:main2"
 extra-script = {callable = "my_package.extra:main", extras = ["time"]}
+sh-script = {source = "bin/script1.sh", type = "file"}
+sh-script2 = {source = "bin/script2.sh" }
+
 
 [tool.poetry.urls]
 "Issue Tracker" = "https://github.com/python-poetry/poetry/issues"

tests/masonry/builders/fixtures/missing_script_files/README.rst

@@ -0,0 +1,2 @@
+Missing Script Files
+========

tests/masonry/builders/fixtures/missing_script_files/missing_script_files/__init__.py

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "missing-script-files"
+version = "0.1"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <[email protected]>"
+]
+readme = "README.rst"
+
+[tool.poetry.scripts]
+missing_file = {source = "not_existing_folder/not_existing_file.sh", type = "file"}
+
+
+[tool.poetry.dependencies]
+python = "3.6"

tests/masonry/builders/fixtures/missing_script_files/pyproject.toml

@@ -0,0 +1,4 @@
+Script File Invalid Definition
+========
+
+This is a use case where the user provides a pyproject.toml where the file script definition is wrong.

tests/masonry/builders/fixtures/script_file_invalid_definition/README.rst

@@ -0,0 +1 @@
+echo "Hello World"

tests/masonry/builders/fixtures/script_file_invalid_definition/bin/script.sh

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "script_file_invalid_definition"
+version = "0.1"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <[email protected]>"
+]
+readme = "README.rst"
+
+[tool.poetry.scripts]
+invalid_definition = {source = "bin/script.sh", type = "ffiillee"}
+
+
+[tool.poetry.dependencies]
+python = "3.6"

tests/masonry/builders/fixtures/script_file_invalid_definition/pyproject.toml

@@ -154,3 +154,29 @@ def test_metadata_with_url_dependencies():
         "demo @ https://python-poetry.org/distributions/demo-0.1.0-py2.py3-none-any.whl"
         == requires_dist
     )
+
+
+def test_missing_script_files_throws_error():
+    builder = Builder(
+        Factory().create_poetry(
+            Path(__file__).parent / "fixtures" / "missing_script_files"
+        )
+    )
+
+    with pytest.raises(RuntimeError) as err:
+        builder.convert_script_files()
+
+    assert "file-script is not found." in err.value.args[0]
+
+
+def test_invalid_script_files_definition():
+    with pytest.raises(RuntimeError) as err:
+        Builder(
+            Factory().create_poetry(
+                Path(__file__).parent / "fixtures" / "script_file_invalid_definition"
+            )
+        )
+
+    assert "configuration is invalid" in err.value.args[0]
+    assert "[scripts.invalid_definition]" in err.value.args[0]
+

tests/masonry/builders/fixtures/script_file_invalid_definition/script_file_invalid_definition/__init__.py

@@ -224,6 +224,16 @@ def test_complete():
 
     try:
         assert "my_package/sub_pgk1/extra_file.xml" not in zip.namelist()
+        assert "my-package-1.2.3.data/scripts/script1.sh" in zip.namelist()
+        assert "my-package-1.2.3.data/scripts/script2.sh" in zip.namelist()
+        assert (
+            "Hello World"
+            in zip.read("my-package-1.2.3.data/scripts/script1.sh").decode()
+        )
+        assert (
+            "Hello World"
+            in zip.read("my-package-1.2.3.data/scripts/script2.sh").decode()
+        )
 
         entry_points = zip.read("my_package-1.2.3.dist-info/entry_points.txt")
 
@@ -289,6 +299,29 @@ def test_complete():
 
 """
         )
+        actual_records = decode(zip.read("my_package-1.2.3.dist-info/RECORD"))
+
+        # For some reason, the ordering of the files and the SHA hashes
+        # vary per operating systems and Python versions.
+        # So instead of 1:1 assertion, let's do a bit clunkier one:
+
+        expected_records = [
+            "my_package/__init__.py",
+            "my_package/data1/test.json",
+            "my_package/sub_pkg1/__init__.py",
+            "my_package/sub_pkg2/__init__.py",
+            "my_package/sub_pkg2/data2/data.json",
+            "my-package-1.2.3.data/scripts/script1.sh",
+            "my-package-1.2.3.data/scripts/script2.sh",
+            "my_package-1.2.3.dist-info/entry_points.txt",
+            "my_package-1.2.3.dist-info/LICENSE",
+            "my_package-1.2.3.dist-info/WHEEL",
+            "my_package-1.2.3.dist-info/METADATA",
+        ]
+
+        for expected_record in expected_records:
+            assert expected_record in actual_records
+
     finally:
         zip.close()
 
@@ -317,6 +350,8 @@ def test_complete_no_vcs():
         "my_package/sub_pkg1/__init__.py",
         "my_package/sub_pkg2/__init__.py",
         "my_package/sub_pkg2/data2/data.json",
+        "my-package-1.2.3.data/scripts/script1.sh",
+        "my-package-1.2.3.data/scripts/script2.sh",
         "my_package/sub_pkg3/foo.py",
         "my_package-1.2.3.dist-info/entry_points.txt",
         "my_package-1.2.3.dist-info/LICENSE",

tests/masonry/builders/test_builder.py

@@ -171,6 +171,8 @@ def test_find_files_to_add():
         [
             Path("LICENSE"),
             Path("README.rst"),
+            Path("bin/script1.sh"),
+            Path("bin/script2.sh"),
             Path("my_package/__init__.py"),
             Path("my_package/data1/test.json"),
             Path("my_package/sub_pkg1/__init__.py"),