snakemake-interface-software-deployment-plugins 0.16.5__tar.gz → 0.18.0__tar.gz

{snakemake_interface_software_deployment_plugins-0.16.5 → snakemake_interface_software_deployment_plugins-0.18.0}/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.18.0](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/compare/v0.17.0...v0.18.0) (2026-06-02)
+
+
+### Features
+
+* suffix replacement ([#54](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/issues/54)) ([6282e25](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/commit/6282e25b76e389b35921971447b9fdc6af4abcd6))
+
+
+### Bug Fixes
+
+* remove debug code ([ffa0804](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/commit/ffa08047257ee3e3e90cde1fe53a5e202c18b02a))
+
+## [0.17.0](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/compare/v0.16.5...v0.17.0) (2026-03-10)
+
+
+### Features
+
+* allow to select whether within env shall be included in hash ([8b9291d](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/commit/8b9291daddf7a70ddba080ae9ac268a35c8417e1))
+
 ## [0.16.5](https://github.com/snakemake/snakemake-interface-software-deployment-plugins/compare/v0.16.4...v0.16.5) (2026-03-10)
 
 

{snakemake_interface_software_deployment_plugins-0.16.5 → snakemake_interface_software_deployment_plugins-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snakemake-interface-software-deployment-plugins
-Version: 0.16.5
+Version: 0.18.0
 Summary: This package provides a stable interface for interactions between Snakemake and its software deployment plugins.
 Project-URL: repository, https://github.com/snakemake/snakemake-interface-software-deployment-plugins
 Project-URL: homepage, https://snakemake.github.io

{snakemake_interface_software_deployment_plugins-0.16.5 → snakemake_interface_software_deployment_plugins-0.18.0}/pyproject.toml

@@ -6,7 +6,7 @@ description = "This package provides a stable interface for interactions between
 license = "MIT"
 name = "snakemake-interface-software-deployment-plugins"
 readme = "README.md"
-version = "0.16.5"
+version = "0.18.0"
 requires-python = ">=3.11,<4.0"
 dependencies = [
     "argparse-dataclass >=2.0.0,<3.0",

{snakemake_interface_software_deployment_plugins-0.16.5 → snakemake_interface_software_deployment_plugins-0.18.0}/snakemake_interface_software_deployment_plugins/__init__.py

@@ -33,9 +33,16 @@ from snakemake_interface_common.exceptions import WorkflowError
 from snakemake_interface_common.software import SoftwareReport
 
 
+@dataclass
+class SuffixReplacement:
+    old_suffixes: List[str]
+    new_suffix: str
+
+
 @dataclass
 class EnvSpecSourceFile:
     path_or_uri: Union[str, Path]
+    suffix_replacement: Optional[SuffixReplacement] = None
     cached: Optional[Path] = field(repr=False, default=None)
 
     def __eq__(self, other) -> bool:
@@ -46,6 +53,18 @@ class EnvSpecSourceFile:
     def __hash__(self) -> int:
         return hash(self.path_or_uri)
 
+    def replace_suffix(
+        self, suffixes: List[str], new_suffix: str
+    ) -> "EnvSpecSourceFile":
+        if self.suffix_replacement is not None:
+            raise ValueError("Suffix replacement already defined for this source file.")
+        return EnvSpecSourceFile(
+            path_or_uri=self.path_or_uri,
+            suffix_replacement=SuffixReplacement(
+                old_suffixes=suffixes, new_suffix=new_suffix
+            ),
+        )
+
 
 class EnvSpecBase(ABC):
     @classmethod
@@ -193,7 +212,7 @@ class EnvBase(ABC):
         self.within = within
         self.settings = settings
         self.shell_executable = shell_executable
-        self.mountpoints = mountpoints
+        self.mountpoints = [mountpoint.absolute() for mountpoint in mountpoints]
         self.tempdir = tempdir
         self._deployment_prefix: Path = deployment_prefix
         self._cache_prefix: Path = cache_prefix
@@ -285,16 +304,28 @@ class EnvBase(ABC):
             cmd = self.within.managed_decorate_shellcmd(cmd)
         return cmd
 
+    def hash_include_within(self) -> bool:
+        """Return whether the hash of the environment should also reflect the "within"
+        environment. Usually, this should be the case, unless you have a particular
+        reason. For the conda plugin, we overwrite this in case of containerized
+        environments.
+        """
+        return True
+
     def hash(self) -> str:
         return self._managed_generic_hash("hash")
 
+    def clear_hashes(self) -> None:
+        self._managed_hash_store = None
+        self._managed_deployment_hash_store = None
+
     def _managed_generic_hash(self, kind: str) -> str:
         store_attr = f"_managed_{kind}_store"
         store = getattr(self, store_attr)
         if store is None:
             record_hash = f"record_{kind}"
-            hash_object = hashlib.md5()
-            if self.within is not None:
+            hash_object = hashlib.md5(usedforsecurity=False)
+            if self.within is not None and self.hash_include_within():
                 # For within, we always take the normal hash,
                 # since the deployment just runs within that.
                 self.within.record_hash(hash_object)

{snakemake_interface_software_deployment_plugins-0.16.5 → snakemake_interface_software_deployment_plugins-0.18.0}/snakemake_interface_software_deployment_plugins/registry/__init__.py

@@ -36,9 +36,7 @@ class SoftwareDeploymentPluginRegistry(PluginRegistryBase):
         return Plugin(
             _name=name,
             common_settings=module.common_settings,
-            _software_deployment_settings_cls=getattr(
-                module, "SoftwareDeploymentSettings", None
-            ),
+            _software_deployment_settings_cls=getattr(module, "Settings", None),
             _env_cls=module.EnvBase,
             _env_spec_cls=module.EnvSpecBase,
         )
@@ -50,7 +48,7 @@ class SoftwareDeploymentPluginRegistry(PluginRegistryBase):
                 mode=AttributeMode.REQUIRED,
                 kind=AttributeKind.OBJECT,
             ),
-            "SoftwareDeploymentSettings": AttributeType(
+            "Settings": AttributeType(
                 cls=SoftwareDeploymentSettingsBase,
                 mode=AttributeMode.OPTIONAL,
                 kind=AttributeKind.CLASS,