Add handling of pydist resource paths (#306)

Author: blink1073

.github/workflows/test.yml

@@ -130,3 +130,17 @@ jobs:
           pushd docs
           make html
           popd
+
+  check: # This job does nothing and is only used for the branch protection
+    if: always()
+    needs:
+      - check-links
+      - test
+      - docs
+      - pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

docs/source/how_to_guides/write_config.md

@@ -84,3 +84,14 @@ post-version-spec = "dev"
 ```
 
 This will bump it to the next minor release with a `.dev0` suffix.
+
+## Ensuring Python Resource Files
+
+If you want to ensure that resource files are included in your installed Python
+package
+(from an sdist or a wheel), include configuration like the following:
+
+```toml
+[tool.jupyter-releaser.options]
+pydist_resource_paths = ["my-package/img1.png", "my-package/foo.json"]
+```

jupyter_releaser/cli.py

@@ -248,7 +248,13 @@ def main(force):
         envvar="RH_PYDIST_CHECK_CMD",
         default="twine check --strict",
         help="The command to use to check a python distribution file",
-    )
+    ),
+    click.option(
+        "--pydist-resource-paths",
+        envvar="RH_PYDIST_RESOURCE_PATHS",
+        multiple=True,
+        help="Resource paths that should be available when installed",
+    ),
 ]
 
 
@@ -410,14 +416,19 @@ def build_python(dist_dir, python_packages):
 @add_options(check_imports_options)
 @add_options(pydist_check_options)
 @use_checkout_dir()
-def check_python(dist_dir, check_imports, pydist_check_cmd):
+def check_python(dist_dir, check_imports, pydist_check_cmd, pydist_resource_paths):
     """Check Python dist files"""
     for dist_file in glob(f"{dist_dir}/*"):
         if Path(dist_file).suffix not in [".gz", ".whl"]:
             util.log(f"Skipping non-python dist file {dist_file}")
             continue
 
-        python.check_dist(dist_file, python_imports=check_imports, check_cmd=pydist_check_cmd)
+        python.check_dist(
+            dist_file,
+            python_imports=check_imports,
+            check_cmd=pydist_check_cmd,
+            resource_paths=pydist_resource_paths,
+        )
 
 
 @main.command()
@@ -589,6 +600,7 @@ def extract_release(
     release_url,
     npm_install_options,
     pydist_check_cmd,
+    pydist_resource_paths,
     check_imports,
 ):
     """Download and verify assets from a draft GitHub release"""
@@ -599,6 +611,7 @@ def extract_release(
         release_url,
         npm_install_options,
         pydist_check_cmd,
+        pydist_resource_paths,
         check_imports,
     )
 

jupyter_releaser/lib.py

@@ -313,6 +313,7 @@ def extract_release(
     release_url,
     npm_install_options,
     pydist_check_cmd,
+    pydist_resource_paths,
     python_imports,
 ):
     """Download and verify assets from a draft GitHub release"""
@@ -363,6 +364,7 @@ def extract_release(
                 dist / asset.name,
                 check_cmd=pydist_check_cmd,
                 python_imports=python_imports,
+                resource_paths=pydist_resource_paths,
             )
         elif suffix == ".tgz":
             pass  # already handled

jupyter_releaser/python.py

@@ -32,8 +32,15 @@ def build_dist(dist_dir, clean=True):
         util.run(f"python setup.py bdist_wheel --dist-dir {dest}", quiet=True)
 
 
-def check_dist(dist_file, test_cmd="", python_imports=None, check_cmd="twine check --strict"):
+def check_dist(
+    dist_file,
+    test_cmd="",
+    python_imports=None,
+    check_cmd="twine check --strict",
+    resource_paths=None,
+):
     """Check a Python package locally (not as a cli)"""
+    resource_paths = resource_paths or []
     dist_file = util.normalize_path(dist_file)
     util.run(f"{check_cmd} {dist_file}")
 
@@ -74,6 +81,18 @@ def check_dist(dist_file, test_cmd="", python_imports=None, check_cmd="twine che
                     'You may need to set "check_imports" to appropriate Python package names in the config file.'
                 )
             raise e
+        for resource_path in resource_paths:
+            name, _, rest = resource_path.partition("/")
+            test_file = Path(td) / "test_path.py"
+            test_text = f"""
+import importlib.resources
+with importlib.resources.path('{name}','{rest}') as resource_path:
+    assert resource_path.exists()
+"""
+            test_file.write_text(test_text, encoding="utf-8")
+            test_file = util.normalize_path(test_file)
+            cmd = f"{bin_path}/python {test_file}"
+            util.run(cmd)
 
 
 def get_pypi_token(release_url, python_package):

jupyter_releaser/tests/test_cli.py

@@ -161,6 +161,7 @@ def test_list_envvars(runner):
 post-version-message: RH_POST_VERSION_MESSAGE
 post-version-spec: RH_POST_VERSION_SPEC
 pydist-check-cmd: RH_PYDIST_CHECK_CMD
+pydist-resource-paths: RH_PYDIST_RESOURCE_PATHS
 python-packages: RH_PYTHON_PACKAGES
 ref: RH_REF
 release-message: RH_RELEASE_MESSAGE
@@ -437,6 +438,30 @@ def test_check_python_different_names(
     monkeypatch, py_package_different_names, runner, build_mock, git_prep
 ):
     monkeypatch.setenv("RH_CHECK_IMPORTS", "foobar")
+
+
+def test_check_python_resource_path(monkeypatch, py_package, runner, build_mock, git_prep):
+    monkeypatch.setenv("RH_PYDIST_RESOURCE_PATHS", "foo/baz.txt")
+
+    # Convert the package to use a package dir.
+    foo_dir = Path(util.CHECKOUT_NAME) / "foo"
+    foo_dir.mkdir()
+    shutil.move(Path(util.CHECKOUT_NAME) / "foo.py", foo_dir / "__init__.py")
+
+    path = foo_dir / "baz.txt"
+    path.write_text("hello", encoding="utf-8")
+
+    manifest = Path(util.CHECKOUT_NAME) / "MANIFEST.in"
+    manifest_text = manifest.read_text(encoding="utf-8")
+    manifest_text += "\ninclude foo/baz.txt\n"
+    manifest.write_text(manifest_text, encoding="utf-8")
+
+    setup_cfg_path = Path(util.CHECKOUT_NAME) / "setup.cfg"
+    setup_cfg_text = setup_cfg_path.read_text(encoding="utf-8")
+    setup_cfg_text = setup_cfg_text.replace("foo.__version__", "foo.__init__.__version__")
+    setup_cfg_text = setup_cfg_text.replace("py_modules = foo", "")
+    setup_cfg_path.write_text(setup_cfg_text, encoding="utf-8")
+
     runner(["build-python"])
     runner(["check-python"])