nmk-python 1.9.1__py3-none-any.whl → 1.10.1__py3-none-any.whl

nmk_python/_buildenv/template.py

@@ -0,0 +1,118 @@
+from pathlib import Path
+
+from buildenv.extension import BuildEnvRenderer
+from jinja2 import Environment, PackageLoader
+from nmk_base._buildenv.template import NmkBaseProjectTemplate, NmkConfigType, NmkReference
+
+_ENV = Environment(loader=PackageLoader("nmk_python"))
+_SRC_PATH = Path("src")
+
+
+class NmkPythonProjectTemplate(NmkBaseProjectTemplate):
+    """
+    Template for **nmk-python** plugin project
+    """
+
+    @property
+    def weight(self) -> int:
+        # Top level plugin weight
+        return 300
+
+    @property
+    def references(self) -> list[NmkReference]:
+        return super().references + [NmkReference("nmk-python!plugin.yml", ["nmk-base!plugin.yml"])]
+
+    @property
+    def description(self) -> str:
+        return "python nmk project"
+
+    @property
+    def preferred_backend(self):
+        return "uv"
+
+    @property
+    def generated_files(self) -> set[Path]:
+        return super().generated_files | set(
+            [
+                Path("pyproject.toml"),
+                _SRC_PATH / self.python_module_name / "__init__.py",
+                _SRC_PATH / self.python_module_name / "sample.py",
+                _SRC_PATH / "tests" / "__init__.py",
+                _SRC_PATH / "tests" / "test_sample.py",
+            ]
+        )
+
+    @property
+    def post_generation_tasks(self) -> list[str]:
+        return super().post_generation_tasks + ["py.project"]
+
+    @property
+    def ignored_tasks(self) -> list[str]:
+        # Only ignore requirements.txt for uv backend
+        return super().ignored_tasks + (["py.req"] if self.info.backend_name == "uv" else [])
+
+    @property
+    def python_module_name(self) -> str:
+        # Deduce the python module name from the project name
+        return self.project_name.replace("-", "_")
+
+    @property
+    def comments(self) -> dict[str, str]:
+        return super().comments | {
+            "config.venvPkgDeps": "\nDevelopment dependencies (tools)",
+            "config.venvArchiveDeps": "\nDevelopment dependencies (tools, from local files)",
+            "config.pythonPackageRequirements": "\nPython package dependencies",
+            "config.pythonProjectFileItems": "\nExtra project settings",
+        }
+
+    def handle_dependencies(self, packages: list[str]) -> dict[str, NmkConfigType]:
+        # Iterate on packages
+        config_items: dict[str, NmkConfigType] = {}
+        simple_refs: list[str] = []
+        file_refs: list[str] = []
+        dep_refs: list[str] = []
+        for package in packages:
+            # Check for dependency groups (no group means it's a regular dependency, otherwise it's a dev dependency)
+            if ":" not in package:
+                dep_refs.append(package)
+            # Dev dependencies
+            else:
+                package = package.split(":")[-1]  # Ignore dependency groups, if any (e.g. `dev:package` -> `package`)
+                if "." in package:
+                    package_path = Path(package)
+                    if package_path.is_absolute() and package_path.is_file():
+                        file_refs.append(package)
+                    elif (Path.cwd() / package).is_file():
+                        file_refs.append(f"${{PROJECTDIR}}/{package}")
+                    else:
+                        simple_refs.append(package)
+                else:
+                    simple_refs.append(package)
+
+        # Build settings
+        if dep_refs:
+            config_items["pythonPackageRequirements"] = dep_refs
+        if simple_refs:
+            config_items["venvPkgDeps"] = simple_refs
+        if file_refs:
+            config_items["venvArchiveDeps"] = file_refs
+
+        return config_items
+
+    def generate_extra_files(self, renderer: BuildEnvRenderer):
+        # Generate source code templates
+        keywords = {"python_module": self.python_module_name}
+        renderer.render(_ENV, "src/__init__.py.jinja", sub_path=_SRC_PATH / self.python_module_name, keywords=keywords)
+        renderer.render(_ENV, "src/__init__.py.jinja", sub_path=_SRC_PATH / "tests", keywords=keywords)
+        renderer.render(_ENV, "src/sample.py.jinja", sub_path=_SRC_PATH / self.python_module_name, keywords=keywords)
+        renderer.render(_ENV, "src/test_sample.py.jinja", sub_path=_SRC_PATH / "tests", keywords=keywords)
+
+    @property
+    def config_items(self) -> dict[str, NmkConfigType]:
+        items = dict(super().config_items)
+        items.update(
+            {
+                "pythonProjectFileItems": {"project": {"description": "Insert here a oneline description of your project"}},
+            }
+        )
+        return items

nmk_python/backends/uv_build_backend.py

@@ -52,5 +52,5 @@ class UvBuildBackend(PythonBuildBackend):
         return build_dir / wheel_sub_dir / built_wheel_name
 
     def uninstall_wheels(self, wheel_names: list[str]):
-        # Same as setup
-        self._env_backend.upgrade(full=False, only_deps=True)
+        # Same as setup, just don't print updates (will be done by uninstall builder)
+        self._env_backend.upgrade(full=False, only_deps=True, print_updates=False)

nmk_python/build.py

@@ -141,7 +141,7 @@ class Installer(NmkTaskBuilder):
             eb = cast(EnvBackend, self.model.env_backend)  # type: ignore
             old_packages = eb.installed_packages
             BuildBackendFactory.create(self.model).install_wheel(wheel_path=Path(wheel))
-            eb.print_updates(old_packages)
+            eb.print_updates(old_packages, ignored_packages=set([name]))
 
             # Remove stamp file
             Path(to_remove).unlink(missing_ok=True)
@@ -173,7 +173,7 @@ class Uninstaller(NmkTaskBuilder):
 
         # Delegate to build backend
         BuildBackendFactory.create(self.model).uninstall_wheels(wheel_names=sorted(list(wheel_names)))
-        eb.print_updates(old_packages)
+        eb.print_updates(old_packages, ignored_packages=set([_python_package(self.model)]))
 
 
 class EditableBuilder(NmkTaskBuilder):
@@ -189,12 +189,13 @@ class EditableBuilder(NmkTaskBuilder):
         """
 
         # Check if project can be installed in editable mode
-        if _can_install(_python_package(self.model), self.logger):
+        package_name = _python_package(self.model)
+        if _can_install(package_name, self.logger):
             # Delegate to build backend
             eb = cast(EnvBackend, self.model.env_backend)  # type: ignore
             old_packages = eb.installed_packages
             BuildBackendFactory.create(self.model).install_editable()
-            eb.print_updates(old_packages)
+            eb.print_updates(old_packages, ignored_packages=set([package_name]))
 
             # Touch stamp file
             self.main_output.touch()
@@ -311,3 +312,19 @@ class DepsMetadataBuilder(NmkTaskBuilder):
                 indent=4,
             )
         )
+
+
+class PythonIgnoredLockfileResolver(NmkListConfigResolver):
+    """
+    Python ignored lockfile resolver
+    """
+
+    def get_value(self, name: str) -> list[str]:  # pyright: ignore[reportIncompatibleMethodOverride]
+        """
+        Return the list of lockfiles to be ignored, depending on the env backend and if the project is locked or not
+        """
+
+        # Ignore uv.lock file if using uv env backend and project is not locked
+        if not self.model.env_backend.is_locked and self.model.env_backend.name == "uv":
+            return ["uv.lock"]  # pragma: no cover
+        return []

nmk_python/build.yml

@@ -59,12 +59,17 @@ config:
   # Python editable install stamp
   pythonEditableStamp: ${outputDir}/.pyeditable
 
+  # Python ignored lockfile, depending on the env backend and if the project is locked or not
+  pythonIgnoredLockfile:
+    __resolver__: nmk_python.build.PythonIgnoredLockfileResolver
+
   # Python files to be ignored
   gitIgnoredFiles:
     - .eggs/
     - "*.egg-info/"
     - "*.pyc"
     - __pycache__
+    - ${pythonIgnoredLockfile}
 
   # Additional github publish step: publish on pypi.org
   githubPublishSteps:

nmk_python/templates/python-settings.json.jinja

@@ -6,12 +6,10 @@
         "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnSave": true
     },
-    "python.defaultInterpreterPath": "{{ venvName }}/bin/python",
     "python.autoComplete.extraPaths": [{% for folder in pythonSrcFolders %}{% if loop.index > 1 %},{% endif %}
         "{{folder}}"{% endfor %}
     ],
     "cSpell.words": [
-        "isort",
         "noqa",
         "pycache",
         "pylint",

nmk_python/templates/src/sample.py.jinja

@@ -0,0 +1,9 @@
+def some_sample_function(a: int, b: int) -> int:
+    """
+    Sample function that adds two integers.
+
+    :param a: The first integer.
+    :param b: The second integer.
+    :return: The sum of a and b.
+    """
+    return a + b

nmk_python/templates/src/test_sample.py.jinja

@@ -0,0 +1,8 @@
+from pytest_multilog import TestHelper
+
+from {{python_module}}.sample import some_sample_function
+
+
+class TestSample(TestHelper):
+    def test_sample_function(self):
+        assert some_sample_function(45, 56) == 45 + 56

{nmk_python-1.9.1.dist-info → nmk_python-1.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nmk-python
-Version: 1.9.1
+Version: 1.10.1
 Summary: Python plugin for nmk build system
 Author: The dynod project
 Maintainer: The dynod project

{nmk_python-1.9.1.dist-info → nmk_python-1.10.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
 nmk_python/__init__.py,sha256=EouCWXbAeObby1vOCx0Vx_WaGC2fEEFDMCen3JZt4TU,446
 nmk_python/badges.yml,sha256=LzElZecCXKxdF-oPkvIwfnbQlOcAM_zUj6MelClmAug,749
-nmk_python/build.py,sha256=nBqyMcZXhOjnMBocUooL1rM9BJyPX42A6nGbwlB5dRg,12224
-nmk_python/build.yml,sha256=8CWVacVv3r3pbvuRkaLQbH1aTO-oK4U0hAO9SgDTfFA,5726
+nmk_python/build.py,sha256=K-ZPBSN0YgWQqS4Nz2tRg-y2zTFvcutDiNR7Ii1NrMY,12979
+nmk_python/build.yml,sha256=bl1ttXjW7av5JfI8daBLF0jfUHbA4S1cy4Ym90BQ2T8,5942
 nmk_python/doc.yml,sha256=12amAlYylH7JAHaqBIOoEZ_LrXY_bPNKuHrrwUkIj8w,932
 nmk_python/files.py,sha256=K6Y-XKXuf8jh4x333Qgj6G1MyB-BgZ5Kd2-XCZhsfR4,2000
 nmk_python/files.yml,sha256=jlp87gW9rTASUnsy7id7VWanaMUMN_py82bMa2adniM,813
@@ -13,19 +13,26 @@ nmk_python/tests.py,sha256=DLUqTYhMbRupD5iK-nMnEM0GbfPPYgOp1wKHa_OCL7I,1391
 nmk_python/tests.yml,sha256=by_Ml1JXjgt1-J96AMp-6gwhISVFVylRZowUvaMkfpk,1636
 nmk_python/version.py,sha256=fLpOWdujYwlJB7XhWaOGCTeg3gQaClk2YHoRkkW64dE,3109
 nmk_python/version.yml,sha256=WpZyQ2mChmvA_6eVb_Yp6ZaFIkX6oINxWBhKgb8h4GE,833
+nmk_python/_buildenv/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nmk_python/_buildenv/template.py,sha256=avDeQuMSYHTiTwAgLbrpTPZ6bSaEqjCZDkcpzFxNt88,4568
 nmk_python/backends/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nmk_python/backends/build_backend.py,sha256=WO0wZaxGdPna4K2yK7pNLtZX3cKf6atLLa00931N43Y,1400
 nmk_python/backends/factory.py,sha256=NMYByORffwSSIjeNMLkOnwh6x1xhJQVhoV-0rSooq6Q,953
 nmk_python/backends/pip_build_backend.py,sha256=4MGYghBeMjZhUlKTwE0svSHArYwOAaK1I6_gmeNnwaI,1698
-nmk_python/backends/uv_build_backend.py,sha256=QpN5nMm_QhnKzoHQcX4769OOQG6NqOD2ctYXyH2MI7A,1880
+nmk_python/backends/uv_build_backend.py,sha256=cIQwKVsYWHlVQCmHWjjoC-3aRmWiHK55VSGexQbn_vw,1963
 nmk_python/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nmk_python/templates/build.toml.jinja,sha256=6F1Kdb32JVBWEitxLC7AsUdhx2VTyQEyWhhSb7n3oBs,1770
 nmk_python/templates/pytest.toml.jinja,sha256=zQ3SRWnF23Omxm7zInE54j0l3OyjXSOn5pQ5Pak8Boo,641
-nmk_python/templates/python-settings.json.jinja,sha256=jYXSy96cX9X9GIHoF7XiZDzd4P2GOlMisAVWW626WF4,749
+nmk_python/templates/python-settings.json.jinja,sha256=v-GlXJSGdtfaEZIinSC_aT54rlKArFe1RZ-BgPdbANM,666
 nmk_python/templates/python-test-debug-launch.json.jinja,sha256=J_xju2EpHNXvgvqBxlf99p7g-ZMh3xE-_2r7o_57gpU,364
 nmk_python/templates/ruff.toml.jinja,sha256=DTHe1ixK1SBY8d2xBCfkGz89HzjAoMO7Ogs12AY1i4Y,346
-nmk_python-1.9.1.dist-info/licenses/LICENSE,sha256=PROo9EW7wP6jmSr_90OluItAsIB411b_CAqEBioMKpI,1074
-nmk_python-1.9.1.dist-info/METADATA,sha256=FN-Sm5fDeJ-fKF_Zt5-EbN65960FG_EVnm-EwISt3B4,3148
-nmk_python-1.9.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-nmk_python-1.9.1.dist-info/top_level.txt,sha256=MCb5w_hoOZ0kk3Dajxrd9Pz6lZ3pyuS6TQCRA3vddTo,11
-nmk_python-1.9.1.dist-info/RECORD,,
+nmk_python/templates/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nmk_python/templates/src/__init__.py.jinja,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nmk_python/templates/src/sample.py.jinja,sha256=OOTps7EjviwYFCIb5GpMHcidxhBY5NLQVlcFLqxuxNU,227
+nmk_python/templates/src/test_sample.py.jinja,sha256=u-ShBoKDF3se9KvgQ1SzO4NwymjqNowwURF4Q1oR3wo,221
+nmk_python-1.10.1.dist-info/licenses/LICENSE,sha256=PROo9EW7wP6jmSr_90OluItAsIB411b_CAqEBioMKpI,1074
+nmk_python-1.10.1.dist-info/METADATA,sha256=7_h01aDokzIuXy7tl3SN5Z0APbtsAroZVR_FNNcPAVk,3149
+nmk_python-1.10.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+nmk_python-1.10.1.dist-info/entry_points.txt,sha256=QLXIIXl6wODHDnVkh7KuiLv_XzfFtNfdWwpxyB675ak,88
+nmk_python-1.10.1.dist-info/top_level.txt,sha256=MCb5w_hoOZ0kk3Dajxrd9Pz6lZ3pyuS6TQCRA3vddTo,11
+nmk_python-1.10.1.dist-info/RECORD,,

nmk_python-1.10.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[buildenv_template]
+nmk.python = nmk_python._buildenv.template:NmkPythonProjectTemplate