pypeline-runner 1.22.0__py3-none-any.whl → 1.23.0__py3-none-any.whl

pypeline/__init__.py

@@ -1 +1 @@
-__version__ = "1.22.0"
+__version__ = "1.23.0"

pypeline/steps/create_venv.py

@@ -2,6 +2,7 @@ import io
 import json
 import re
 import shutil
+import subprocess
 import sys
 import traceback
 from dataclasses import dataclass
@@ -85,17 +86,73 @@ class CreateVEnv(PipelineStep[ExecutionContext]):
             ]
         )
 
+    def _verify_python_version(self, executable: str, expected_version: str) -> bool:
+        """
+        Verify that a Python executable matches the expected version.
+
+        Args:
+        ----
+            executable: Name or path of Python executable to check
+            expected_version: Expected version string (e.g., "3.11" or "3.11.5")
+
+        Returns:
+        -------
+            True if the executable's version matches expected_version (ignoring patch),
+            False otherwise or if the executable cannot be queried.
+
+        """
+        try:
+            # Run python --version to get the version string
+            result = subprocess.run(
+                [executable, "--version"],  # noqa: S603
+                capture_output=True,
+                text=True,
+                check=False,
+            )
+
+            if result.returncode != 0:
+                return False
+
+            # Parse version from output (e.g., "Python 3.11.5")
+            version_output = result.stdout.strip()
+            match = re.match(r"Python\s+(\d+)\.(\d+)(?:\.\d+)?", version_output)
+            if not match:
+                self.logger.warning(f"Could not parse version from: {version_output}")
+                return False
+
+            actual_major = match.group(1)
+            actual_minor = match.group(2)
+
+            # Parse expected version
+            expected_parts = expected_version.split(".")
+            if len(expected_parts) == 0:
+                return False
+
+            expected_major = expected_parts[0]
+            # If only major version specified, only compare major
+            if len(expected_parts) == 1:
+                return actual_major == expected_major
+
+            # Compare major.minor
+            expected_minor = expected_parts[1]
+            return actual_major == expected_major and actual_minor == expected_minor
+
+        except (FileNotFoundError, OSError) as e:
+            self.logger.debug(f"Failed to verify Python version for {executable}: {e}")
+            return False
+
     def _find_python_executable(self, python_version: str) -> Optional[str]:
         """
         Find Python executable based on version string.
 
         Supports version formats:
-        - "3.11.5" or "3.11" -> tries python3.11, python311
-        - "3" -> tries python3
+        - "3.11.5" or "3.11" -> tries python3.11, python311, then falls back to python
+        - "3" -> tries python3, then falls back to python
 
-        Always ignores patch version. No fallbacks to generic python.
+        Always ignores patch version. Falls back to generic 'python' if version-specific
+        executables are not found, but verifies the version matches.
 
-        Returns the first executable found in PATH, or None if not found.
+        Returns the first executable found in PATH, or None if not found or version mismatch.
         """
         # Handle empty string
         if not python_version:
@@ -133,7 +190,16 @@ class CreateVEnv(PipelineStep[ExecutionContext]):
                 self.logger.debug(f"Found Python executable: {executable_path} (candidate: {candidate})")
                 return candidate
 
-        # No fallback - return None if specific version not found
+        # Fallback to generic 'python' executable with version verification
+        self.logger.debug(f"No version-specific Python executable found for {python_version}, trying generic 'python'")
+        if shutil.which("python"):
+            if self._verify_python_version("python", python_version):
+                self.logger.info(f"Using generic 'python' executable (verified as Python {python_version})")
+                return "python"
+            else:
+                self.logger.warning(f"Generic 'python' executable found but version does not match {python_version}")
+
+        # No suitable executable found
         return None
 
     @property

pypeline/steps/env_setup_script.py

@@ -1,7 +1,8 @@
+import platform
 from pathlib import Path
-from typing import Dict, List
+from typing import Any, Dict, List, Optional
 
-from py_app_dev.core.env_setup_scripts import BatEnvSetupScriptGenerator, Ps1EnvSetupScriptGenerator
+from py_app_dev.core.env_setup_scripts import BatEnvSetupScriptGenerator, EnvSetupScriptGenerator, Ps1EnvSetupScriptGenerator
 from py_app_dev.core.logging import logger
 
 from pypeline.domain.execution_context import ExecutionContext
@@ -20,16 +21,47 @@ def read_dot_env_file(dot_env_file: Path) -> Dict[str, str]:
     return env_vars
 
 
+class ShEnvSetupScriptGenerator(EnvSetupScriptGenerator):
+    """Generates a bash/sh script to set environment variables and update PATH."""
+
+    def generate_content(self) -> str:
+        lines = ["#!/bin/bash"]
+
+        for key, value in self.environment.items():
+            # Escape single quotes by replacing ' with '\''
+            # This closes the string, adds an escaped quote, then reopens the string
+            escaped_value = value.replace("'", "'\\''")
+            # Use single quotes for the value to prevent variable expansion
+            lines.append(f"export {key}='{escaped_value}'")
+
+        if self.install_dirs:
+            # Convert to POSIX paths to ensure forward slashes on all platforms
+            path_string = ":".join([path.as_posix() for path in self.install_dirs])
+            # Escape single quotes in paths
+            escaped_path_string = path_string.replace("'", "'\\''")
+            lines.append(f"export PATH='{escaped_path_string}':\"$PATH\"")
+        else:
+            self.logger.debug("No install directories provided for PATH update.")
+        lines.append("")
+
+        return "\n".join(lines)
+
+
 class GenerateEnvSetupScript(PipelineStep[ExecutionContext]):
+    def __init__(self, execution_context: ExecutionContext, group_name: Optional[str], config: Optional[Dict[str, Any]] = None) -> None:
+        super().__init__(execution_context, group_name, config)
+        self._generated_scripts: List[Path] = []
+
     def run(self) -> None:
         logger.info(f"Generating environment setup scripts under {self.output_dir} ...")
+
         # Read the .env file and set up the environment variables
         dot_env_file = self.execution_context.project_root_dir.joinpath(".env")
         if dot_env_file.exists():
             logger.debug(f"Reading .env file: {dot_env_file}")
             env_vars = read_dot_env_file(dot_env_file)
         else:
-            logger.warning(f".env file not found: {dot_env_file}")
+            logger.info(f".env file not found: {dot_env_file}.")
             env_vars = {}
 
         # Merge execution context environment variables
@@ -37,23 +69,43 @@ class GenerateEnvSetupScript(PipelineStep[ExecutionContext]):
         # Update the execution context with the merged environment variables to ensure they are available for subsequent steps
         self.execution_context.env_vars.update(env_vars)
 
-        # Generate the environment setup scripts
-        BatEnvSetupScriptGenerator(
-            install_dirs=self.execution_context.install_dirs,
-            environment=env_vars,
-            output_file=self.output_dir.joinpath("env_setup.bat"),
-        ).to_file()
-        Ps1EnvSetupScriptGenerator(
-            install_dirs=self.execution_context.install_dirs,
-            environment=env_vars,
-            output_file=self.output_dir.joinpath("env_setup.ps1"),
-        ).to_file()
+        # Get generate-all option and detect OS
+        generate_all = self.execution_context.get_input("generate-all") or False
+        is_windows = platform.system() == "Windows"
+
+        # Generate Windows scripts if on Windows OR generate-all is True
+        if is_windows or generate_all:
+            bat_script = self.output_dir.joinpath("env_setup.bat")
+            BatEnvSetupScriptGenerator(
+                install_dirs=self.execution_context.install_dirs,
+                environment=env_vars,
+                output_file=bat_script,
+            ).to_file()
+            self._generated_scripts.append(bat_script)
+
+            ps1_script = self.output_dir.joinpath("env_setup.ps1")
+            Ps1EnvSetupScriptGenerator(
+                install_dirs=self.execution_context.install_dirs,
+                environment=env_vars,
+                output_file=ps1_script,
+            ).to_file()
+            self._generated_scripts.append(ps1_script)
+
+        # Generate Unix/Linux/macOS script if NOT on Windows OR generate-all is True
+        if not is_windows or generate_all:
+            sh_script = self.output_dir.joinpath("env_setup.sh")
+            ShEnvSetupScriptGenerator(
+                install_dirs=self.execution_context.install_dirs,
+                environment=env_vars,
+                output_file=sh_script,
+            ).to_file()
+            self._generated_scripts.append(sh_script)
 
     def get_inputs(self) -> List[Path]:
         return []
 
     def get_outputs(self) -> List[Path]:
-        return []
+        return self._generated_scripts
 
     def get_name(self) -> str:
         return self.__class__.__name__

{pypeline_runner-1.22.0.dist-info → pypeline_runner-1.23.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypeline-runner
-Version: 1.22.0
+Version: 1.23.0
 Summary: Configure and execute pipelines with Python (similar to GitHub workflows or Jenkins pipelines).
 License: MIT
 License-File: LICENSE

{pypeline_runner-1.22.0.dist-info → pypeline_runner-1.23.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pypeline/__init__.py,sha256=Szrc0NsRYdxS5fUcYkEqrRJ7XLunDfkSaKDKZIhbemc,23
+pypeline/__init__.py,sha256=ytSrJKh9KOuUfqP3DPPNXc0__n_XE-EgHA5DOGwts50,23
 pypeline/__run.py,sha256=TCdaX05Qm3g8T4QYryKB25Xxf0L5Km7hFOHe1mK9vI0,350
 pypeline/bootstrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pypeline/bootstrap/run.py,sha256=tFyi5LeH8OY9EjqvJww2Ruq6XVv0t3dDpmG5sU-VfyY,32167
@@ -21,12 +21,12 @@ pypeline/main.py,sha256=k1CkeFGRvQ-zLv6C-AMLC2ed1iyFzDUdvEam3HLHy2E,4210
 pypeline/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pypeline/pypeline.py,sha256=mDKUnTuMDw8l-kSDJCHRNbn6zrxAfXhAIAqc5HyHd5M,8758
 pypeline/steps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pypeline/steps/create_venv.py,sha256=O34M7GmsMnJTIw5aee4EwPAuwJD_gH3TI7EG6rkl-MY,13932
-pypeline/steps/env_setup_script.py,sha256=DRDCNMUDiW2rzkgEs0FhQfA_-WjPzPLb_e9dGc-mjLg,2526
+pypeline/steps/create_venv.py,sha256=MrA1zfwabVIjFLP47wagyR2JVUP3SSrLTQNqQdtWi-Y,16751
+pypeline/steps/env_setup_script.py,sha256=L8TwGo_Ugo2r4Z10MxtE0P8w0ApAxMKCHMnW-NkyG3w,4968
 pypeline/steps/scoop_install.py,sha256=2MhsJ0iPmL8ueQhI52sKjVY9fqzj5xOQweQ65C0onfE,4117
 pypeline/steps/west_install.py,sha256=hPyr28ksdKsQ0tv0gMNytzupgk1IgjN9CpmaBdX5zps,1947
-pypeline_runner-1.22.0.dist-info/METADATA,sha256=q55q_iUj9db0iwELEZ2rJFd7iBIWPwuWO-dRZkJZdJ4,7659
-pypeline_runner-1.22.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-pypeline_runner-1.22.0.dist-info/entry_points.txt,sha256=pe1u0uuhPI_yeQ0KjEw6jK-EvQfPcZwBSajgbAdKz1o,47
-pypeline_runner-1.22.0.dist-info/licenses/LICENSE,sha256=sKxdoqSmW9ezvPvt0ZGJbneyA0SBcm0GiqzTv2jN230,1066
-pypeline_runner-1.22.0.dist-info/RECORD,,
+pypeline_runner-1.23.0.dist-info/METADATA,sha256=i8_6yzoi_RG4t7Hznpu5x12Rqk5-_qkmqL6wiE49xho,7659
+pypeline_runner-1.23.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+pypeline_runner-1.23.0.dist-info/entry_points.txt,sha256=pe1u0uuhPI_yeQ0KjEw6jK-EvQfPcZwBSajgbAdKz1o,47
+pypeline_runner-1.23.0.dist-info/licenses/LICENSE,sha256=sKxdoqSmW9ezvPvt0ZGJbneyA0SBcm0GiqzTv2jN230,1066
+pypeline_runner-1.23.0.dist-info/RECORD,,