pum 1.0.0__tar.gz → 1.1.0__tar.gz

{pum-1.0.0 → pum-1.1.0}/.github/workflows/tests.yml

@@ -56,7 +56,6 @@ jobs:
         run: |
           python -m pip install -r requirements/base.txt
           python -m pip install -r requirements/development.txt
-          python -m pip install git+https://github.com/opengisch/pirogue.git@v3#egg=pirogue
 
       - name: Install pum
         run: python -m pip install .

{pum-1.0.0 → pum-1.1.0}/.github/workflows/windows-tests.yml

@@ -49,7 +49,6 @@ jobs:
         run: |
           python -m pip install -r requirements/base.txt
           python -m pip install -r requirements/development.txt
-          python -m pip install git+https://github.com/opengisch/pirogue.git@v3#egg=pirogue
 
       - name: Install pum
         run: python -m pip install .

{pum-1.0.0/pum.egg-info → pum-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.0.0
+Version: 1.1.0
 Summary: Pum stands for "Postgres Upgrades Manager". It is a Database migration management tool very similar to flyway-db or Liquibase, based on metadata tables.
 Author-email: Denis Rouzaud <denis@opengis.ch>
 License-Expression: GPL-2.0-or-later

pum-1.1.0/docs/docs/configuration/dependency_model.md

@@ -0,0 +1,3 @@
+# DependencyModel
+
+::: pum.config_model.DependencyModel

{pum-1.0.0 → pum-1.1.0}/docs/mkdocs.yml

@@ -70,6 +70,7 @@ nav:
   - Configuration:
       - Overview: configuration/configuration.md
       - ConfigModel: configuration/config_model.md
+      - DependencyModel: configuration/dependency_model.md
       - HookModel: configuration/hook_model.md
       - MigrationHooksModel: configuration/migration_hooks_model.md
       - ParameterDefinitionModel: configuration/parameter_definition_model.md

{pum-1.0.0 → pum-1.1.0}/pum/__init__.py

@@ -1,4 +1,5 @@
 from .changelog import Changelog
+from .dependency_handler import DependencyHandler
 from .dumper import Dumper, DumpFormat
 from .pum_config import PumConfig
 from .hook import HookHandler, HookBase
@@ -10,6 +11,7 @@ from .upgrader import Upgrader
 
 __all__ = [
     "Changelog",
+    "DependencyHandler",
     "Dumper",
     "DumpFormat",
     "HookBase",

{pum-1.0.0 → pum-1.1.0}/pum/config_model.py

@@ -132,6 +132,36 @@ class DemoDataModel(PumCustomBaseModel):
     file: str = Field(..., description="Path to the demo data file.")
 
 
+class DependencyModel(PumCustomBaseModel):
+    """
+    DependencyModel represents a Python dependency for PUM.
+
+    Attributes:
+        name: Name of the Python dependency.
+        version: Version of the dependency.
+    """
+
+    model_config = {"arbitrary_types_allowed": True}
+
+    name: str = Field(..., description="Name of the Python dependency.")
+    minimum_version: Optional[packaging.version.Version] = Field(
+        default=None,
+        description="Specific minimum required version of the package.",
+    )
+    maximum_version: Optional[packaging.version.Version] = Field(
+        default=None,
+        description="Specific maximum required version of the package.",
+    )
+
+    @model_validator(mode="before")
+    def parse_version(cls, values):
+        for value in ("minimum_version", "maximum_version"):
+            ver = values.get(value)
+            if isinstance(ver, str):
+                values[value] = packaging.version.Version(ver)
+            return values
+
+
 class ConfigModel(PumCustomBaseModel):
     """
     ConfigModel represents the main configuration schema for the application.
@@ -150,3 +180,4 @@ class ConfigModel(PumCustomBaseModel):
     changelogs_directory: Optional[str] = "changelogs"
     roles: Optional[List[RoleModel]] = []
     demo_data: Optional[List[DemoDataModel]] = []
+    dependencies: Optional[List[DependencyModel]] = []

pum-1.1.0/pum/dependency_handler.py

@@ -0,0 +1,95 @@
+import logging
+import packaging
+import packaging.version
+import os
+import sys
+import importlib.metadata
+import subprocess
+
+from .exceptions import PumDependencyError
+
+logger = logging.getLogger(__name__)
+
+
+class DependencyHandler:
+    def __init__(
+        self,
+        name: str,
+        *,
+        minimum_version: packaging.version.Version | None,
+        maximum_version: packaging.version.Version | None,
+    ):
+        """
+        Initialize the DependencyHandler with a dependency name and version.
+        Args:
+            name (str): The name of the dependency.
+            version (packaging.version.Version | None): The version of the dependency, or None if not specified.
+        """
+        self.name = name
+        self.minimum_version = minimum_version
+        self.maximum_version = maximum_version
+
+    def resolve(self, install_dependencies: bool = False, install_path: str | None = None):
+        """
+        Resolve the dependency by checking if it is installed and compatible with the current PUM version.
+
+        Args:
+            install_dependencies: If True, the dependency will be locally installed.
+        Raises:
+            PumConfigError: If the dependency is not installed or is incompatible.
+        """
+        try:
+            importlib.metadata.version(self.name)
+
+            installed_version = packaging.version.Version(importlib.metadata.version(self.name))
+            if self.minimum_version and installed_version < self.minimum_version:
+                raise PumDependencyError(
+                    f"Installed version of `{self.name}` ({installed_version}) is lower than the minimum required ({self.minimum_version})."
+                )
+            if self.maximum_version and installed_version > self.maximum_version:
+                raise PumDependencyError(
+                    f"Installed version of `{self.name}` ({installed_version}) is higher than the maximum allowed ({self.maximum_version})."
+                )
+
+            logger.info(f"Dependency {self.name} is satisfied.")
+
+        except importlib.metadata.PackageNotFoundError as e:
+            if not install_dependencies:
+                raise PumDependencyError(
+                    f"Dependency `{self.name}` is not installed. You can activate the installation."
+                ) from e
+            else:
+                logger.warning(f"Dependency {self.name} is not installed: {e}")
+                self.pip_install(install_path=install_path)
+
+                logger.info(f"Dependency {self.name} is now installed in {install_path}")
+
+    def pip_install(self, install_path: str):
+        """
+        Installs given reqs with pip
+        Code copied from qpip plugin
+        """
+
+        req = self.name
+        if self.minimum_version and self.maximum_version:
+            req += f">={self.minimum_version},<={self.maximum_version}"
+        elif self.minimum_version:
+            req += f">={self.minimum_version}"
+        elif self.maximum_version:
+            req += f"<={self.maximum_version}"
+
+        command = [self.python_command(), "-m", "pip", "install", req, "--target", install_path]
+
+        try:
+            output = subprocess.run(command, capture_output=True, text=True, check=False)
+            if output.returncode != 0:
+                logger.error("pip installed failed: %s", output.stderr)
+                raise PumDependencyError(output.stderr)
+        except TypeError:
+            logger.error("Invalid command: %s", " ".join(command))
+            raise PumDependencyError("invalid command: {}".format(" ".join(filter(None, command))))
+
+    def python_command(self):
+        # python is normally found at sys.executable, but there is an issue on windows qgis so use 'python' instead
+        # https://github.com/qgis/QGIS/issues/45646
+        return "python" if os.name == "nt" else sys.executable

{pum-1.0.0 → pum-1.1.0}/pum/exceptions.py

@@ -3,6 +3,10 @@ class PumException(Exception):
     """Base class for all exceptions raised by PUM."""
 
 
+class PumDependencyError(PumException):
+    """Exception when dependency are not resolved"""
+
+
 # --- Configuration and Validation Errors ---
 
 

{pum-1.0.0 → pum-1.1.0}/pum/pum_config.py

@@ -5,20 +5,42 @@ import packaging
 from pydantic import ValidationError
 import logging
 import importlib.metadata
+import glob
+import os
 
 
 from .changelog import Changelog
+from .dependency_handler import DependencyHandler
 from .exceptions import PumConfigError, PumException, PumHookError, PumInvalidChangelog, PumSqlError
 from .parameter import ParameterDefinition
 from .role_manager import RoleManager
 from .config_model import ConfigModel
 from .hook import HookHandler
+import tempfile
+import sys
+import atexit
 
 
 try:
     PUM_VERSION = packaging.version.Version(importlib.metadata.version("pum"))
 except importlib.metadata.PackageNotFoundError:
-    PUM_VERSION = packaging.version.Version("0.0.0")
+    # Fallback: try to read from pum-*.dist-info/METADATA
+    dist_info_dirs = glob.glob(os.path.join(os.path.dirname(__file__), "..", "pum-*.dist-info"))
+    version = None
+    for dist_info in dist_info_dirs:
+        metadata_path = os.path.join(dist_info, "METADATA")
+        if os.path.isfile(metadata_path):
+            with open(metadata_path) as f:
+                for line in f:
+                    if line.startswith("Version:"):
+                        version = line.split(":", 1)[1].strip()
+                        break
+        if version:
+            break
+    if version:
+        PUM_VERSION = packaging.version.Version(version)
+    else:
+        PUM_VERSION = packaging.version.Version("0.0.0")
 
 
 logger = logging.getLogger(__name__)
@@ -27,12 +49,20 @@ logger = logging.getLogger(__name__)
 class PumConfig:
     """A class to hold configuration settings."""
 
-    def __init__(self, base_path: str | Path, validate: bool = True, **kwargs: dict) -> None:
+    def __init__(
+        self,
+        base_path: str | Path,
+        *,
+        validate: bool = True,
+        install_dependencies: bool = False,
+        **kwargs: dict,
+    ) -> None:
         """Initialize the configuration with key-value pairs.
 
         Args:
             base_path: The directory where the changelogs are located.
-            validate: Whether to validate the changelogs and hooks.
+            validate: Whether to validate the changelogs and hooks and resolve dependencies. Defaults to True.
+            install_dependencies: Whether to temporarily install dependencies.
             **kwargs: Key-value pairs representing configuration settings.
 
         Raises:
@@ -46,6 +76,8 @@ class PumConfig:
             raise PumConfigError(f"Directory `{base_path}` does not exist.")
         self._base_path = base_path
 
+        self.dependency_path = None
+
         try:
             self.config = ConfigModel(**kwargs)
         except ValidationError as e:
@@ -58,19 +90,26 @@ class PumConfig:
                     f"Minimum required version of pum is {self.config.pum.minimum_version}, but the current version is {PUM_VERSION}. Please upgrade pum."
                 )
             try:
-                self.validate()
+                self.validate(install_dependencies=install_dependencies)
             except (PumInvalidChangelog, PumHookError) as e:
                 raise PumConfigError(
                     f"Configuration is invalid: {e}. You can disable the validation when constructing the config."
                 ) from e
 
     @classmethod
-    def from_yaml(cls, file_path: str | Path, *, validate: bool = True) -> "PumConfig":
+    def from_yaml(
+        cls,
+        file_path: str | Path,
+        *,
+        validate: bool = True,
+        install_dependencies: bool = False,
+    ) -> "PumConfig":
         """Create a PumConfig instance from a YAML file.
 
         Args:
             file_path: The path to the YAML file.
             validate: Whether to validate the changelogs and hooks.
+            install_dependencies: Wheter to temporarily install dependencies.
 
         Returns:
             PumConfig: An instance of the PumConfig class.
@@ -87,7 +126,12 @@ class PumConfig:
             raise PumConfigError("base_path not allowed in configuration instead.")
 
         base_path = Path(file_path).parent
-        return cls(base_path=base_path, validate=validate, **data)
+        return cls(
+            base_path=base_path,
+            validate=validate,
+            install_dependencies=install_dependencies,
+            **data,
+        )
 
     @property
     def base_path(self) -> Path:
@@ -206,13 +250,33 @@ class PumConfig:
         """Return a dictionary of demo data files defined in the configuration."""
         return {dm.name: dm.file for dm in self.config.demo_data}
 
-    def validate(self) -> None:
-        """Validate the chanbgelogs and hooks."""
+    def validate(self, install_dependencies: bool = False) -> None:
+        """Validate the changelogs and hooks.
+
+        Args:
+            install_dependencies (bool): Whether to temporarily install dependencies.
+        """
+
+        if install_dependencies and self.config.dependencies:
+            temp_dir = tempfile.TemporaryDirectory()
+            self.dependency_path = Path(temp_dir.name)
+            sys.path.insert(0, str(self.dependency_path))
+
+            def cleanup():
+                sys.path = [p for p in sys.path if p != str(self.dependency_path)]
+                temp_dir.cleanup()
+
+            atexit.register(cleanup)
 
         parameter_defaults = {}
         for parameter in self.config.parameters:
             parameter_defaults[parameter.name] = psycopg.sql.Literal(parameter.default)
 
+        for dependency in self.config.dependencies:
+            DependencyHandler(**dependency.model_dump()).resolve(
+                install_dependencies=install_dependencies, install_path=self.dependency_path
+            )
+
         for changelog in self.changelogs():
             try:
                 changelog.validate(parameters=parameter_defaults)

{pum-1.0.0 → pum-1.1.0/pum.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.0.0
+Version: 1.1.0
 Summary: Pum stands for "Postgres Upgrades Manager". It is a Database migration management tool very similar to flyway-db or Liquibase, based on metadata tables.
 Author-email: Denis Rouzaud <denis@opengis.ch>
 License-Expression: GPL-2.0-or-later

{pum-1.0.0 → pum-1.1.0}/pum.egg-info/SOURCES.txt

@@ -10,10 +10,10 @@ pyproject.toml
 .github/workflows/tests.yml
 .github/workflows/wheel.yml
 .github/workflows/windows-tests.yml
-docs/create_cli_help.py
 docs/mkdocs.yml
 docs/requirements.txt
 docs/roles.md
+docs/update_cli_docs.py
 docs/docs/cli.md
 docs/docs/getting_started.md
 docs/docs/hooks.md
@@ -50,6 +50,7 @@ docs/docs/cli/upgrade.md
 docs/docs/configuration/config_model.md
 docs/docs/configuration/configuration.md
 docs/docs/configuration/demo_data_model.md
+docs/docs/configuration/dependency_model.md
 docs/docs/configuration/hook_model.md
 docs/docs/configuration/migration_hooks_model.md
 docs/docs/configuration/parameter_definition_model.md
@@ -61,6 +62,7 @@ pum/changelog.py
 pum/checker.py
 pum/cli.py
 pum/config_model.py
+pum/dependency_handler.py
 pum/dumper.py
 pum/exceptions.py
 pum/hook.py
@@ -98,6 +100,12 @@ test/data/custom_migration_schema/changelogs/1.2.3/custom_migration_schema.sql
 test/data/demo_data/.pum.yaml
 test/data/demo_data/changelogs/1.2.3/single_changelog.sql
 test/data/demo_data/demo_data/demo_data.sql
+test/data/dependencies/.pum.yaml
+test/data/dependencies/changelogs/1.2.3/pre_post_python_parameters.sql
+test/data/dependencies/changelogs/1.2.4/rename_created_date.sql
+test/data/dependencies/post/create_schema.sql
+test/data/dependencies/post/create_view.py
+test/data/dependencies/pre/drop_view.sql
 test/data/invalid_changelog_commit/changelogs/1.2.3/invalid_changelog.sql
 test/data/invalid_changelog_search_path/changelogs/1.2.3/invalid_changelog.sql
 test/data/min_version/.pum.yaml

pum-1.1.0/test/data/dependencies/.pum.yaml

@@ -0,0 +1,17 @@
+
+parameters:
+  - name: my_comment
+    type: text
+    default: "This is a comment"
+
+dependencies:
+  - name: pirogue
+    minimum_version: 3.0.0
+
+migration_hooks:
+  pre:
+    - file: pre/drop_view.sql
+
+  post:
+    - file: post/create_schema.sql
+    - file: post/create_view.py

{pum-1.0.0/test/data/pre_post_python_parameters → pum-1.1.0/test/data/dependencies}/post/create_view.py

@@ -17,8 +17,6 @@ class Hook(HookBase):
         SELECT {columns}
         FROM pum_test_data.some_table
         WHERE is_active = TRUE;
-
-        COMMENT ON VIEW pum_test_app.some_view IS {{my_comment}};
         """
 
         self.execute(sql=sql_code)

{pum-1.0.0 → pum-1.1.0}/test/data/pre_post_python/post/create_view.py

@@ -1,4 +1,3 @@
-from pirogue.utils import select_columns
 import psycopg
 
 from pum import HookBase
@@ -7,15 +6,10 @@ from pum import HookBase
 class Hook(HookBase):
     def run_hook(self, connection: psycopg.Connection) -> None:
         """Run the migration hook to create a view."""
-        columns = select_columns(
-            connection=connection,
-            table_schema="pum_test_data",
-            table_name="some_table",
-        )
-        sql_code = f"""
+        sql_code = """
             CREATE OR REPLACE VIEW pum_test_app.some_view AS
-            SELECT {columns}
+            SELECT id, name, created
             FROM pum_test_data.some_table
             WHERE is_active = TRUE;
-            """  # noqa: S608
+            """
         self.execute(sql=sql_code)

{pum-1.0.0 → pum-1.1.0}/test/data/pre_post_python_local_import/post/create_view.py

@@ -1,4 +1,3 @@
-from pirogue.utils import select_columns
 import psycopg
 
 from folder.my_module import produce_sql_code
@@ -9,10 +8,5 @@ from pum import HookBase
 class Hook(HookBase):
     def run_hook(self, connection: psycopg.Connection) -> None:
         """Run the migration hook to create a view."""
-        columns = select_columns(
-            connection=connection,
-            table_schema="pum_test_data",
-            table_name="some_table",
-        )
-        sql_code = produce_sql_code(columns)
+        sql_code = produce_sql_code(["id", "name", "created_date"])
         self.execute(sql=sql_code)

{pum-1.0.0 → pum-1.1.0}/test/data/pre_post_python_local_import/post/folder/my_module.py

@@ -1,8 +1,8 @@
-def produce_sql_code(columns: str) -> str:
+def produce_sql_code(columns: list[str]) -> str:
     """Produce SQL code."""
     return f"""
         CREATE OR REPLACE VIEW pum_test_app.some_view AS
-        SELECT {columns}
+        SELECT {", ".join(columns)}
         FROM pum_test_data.some_table
         WHERE is_active = TRUE;
         """  # noqa: S608

{pum-1.0.0 → pum-1.1.0}/test/data/pre_post_python_parameters/.pum.yaml

@@ -4,7 +4,6 @@ parameters:
     type: text
     default: "This is a comment"
 
-
 migration_hooks:
   pre:
     - file: pre/drop_view.sql

pum-1.1.0/test/data/pre_post_python_parameters/post/create_view.py

@@ -0,0 +1,18 @@
+import psycopg
+
+from pum import HookBase
+
+
+class Hook(HookBase):
+    def run_hook(self, connection: psycopg.Connection) -> None:
+        """Run the migration hook to create a view."""
+        sql_code = """
+        CREATE OR REPLACE VIEW pum_test_app.some_view AS
+        SELECT id, name, created_date -- ! changelog 1.2.4 is not called in test
+        FROM pum_test_data.some_table
+        WHERE is_active = TRUE;
+
+        COMMENT ON VIEW pum_test_app.some_view IS {my_comment};
+        """
+
+        self.execute(sql=sql_code)

pum-1.1.0/test/data/pre_post_python_parameters_broken/post/create_schema.sql

@@ -0,0 +1,2 @@
+
+CREATE SCHEMA IF NOT EXISTS pum_test_app;

{pum-1.0.0 → pum-1.1.0}/test/data/pre_post_python_parameters_broken/post/create_view.py

@@ -1,4 +1,3 @@
-from pirogue.utils import select_columns
 import psycopg
 
 from pum import HookBase
@@ -13,17 +12,13 @@ class Hook(HookBase):
             my_comment (str): The comment to be added to the view.
 
         """
-        columns = select_columns(
-            pg_cur=connection.cursor(),
-            table_schema="pum_test_data",
-            table_name="some_table",
-        )
-        sql_code = psycopg.sql.SQL(f"""
+
+        sql_code = """
         CREATE OR REPLACE VIEW pum_test_app.some_view AS
-        SELECT {columns}
+        SELECT id, name, created
         FROM pum_test_data.some_table
         WHERE is_active = TRUE;
 
-        COMMENT ON VIEW pum_test_app.some_view IS {{my_comment}};
-        """)
-        self.execute(sql_code=sql_code)
+        COMMENT ON VIEW pum_test_app.some_view IS {my_comment};
+        """
+        self.execute(sql=sql_code)

pum-1.1.0/test/data/pre_post_sql_files/changelogs/1.2.4/rename_created_date.sql

@@ -0,0 +1,2 @@
+
+ALTER TABLE pum_test_data.some_table RENAME COLUMN created_date TO created;

pum-1.1.0/test/data/pre_post_sql_files/pre/drop_view.sql

@@ -0,0 +1,3 @@
+
+
+DROP VIEW IF EXISTS pum_test_app.some_view;

pum-1.1.0/test/data/single_changelog/changelogs/1.2.3/single_changelog.sql

@@ -0,0 +1,9 @@
+CREATE SCHEMA IF NOT EXISTS pum_test_data;
+
+CREATE TABLE pum_test_data.some_table (
+    id INT PRIMARY KEY,
+    name VARCHAR(100) NOT NULL,
+    created_date DATE DEFAULT CURRENT_DATE,
+    is_active BOOLEAN DEFAULT TRUE,
+    amount NUMERIC(10,2)
+);

{pum-1.0.0 → pum-1.1.0}/test/test_upgrader.py

@@ -7,7 +7,7 @@ from pathlib import Path
 import psycopg
 
 from pum.pum_config import PumConfig
-from pum.exceptions import PumException, PumHookError
+from pum.exceptions import PumDependencyError, PumException, PumHookError
 from pum.parameter import ParameterDefinition
 from pum.schema_migrations import SchemaMigrations
 from pum.upgrader import Upgrader
@@ -317,7 +317,7 @@ class TestUpgrader(unittest.TestCase):
         with psycopg.connect(f"service={self.pg_service}") as conn:
             self.assertFalse(sm.exists(conn))
             upgrader = Upgrader(config=cfg)
-            upgrader.install(connection=conn, max_version="1.2.3")
+            upgrader.install(connection=conn)
             self.assertTrue(sm.exists(conn))
             cursor = conn.cursor()
             cursor.execute(
@@ -390,6 +390,19 @@ class TestUpgrader(unittest.TestCase):
             count = cursor.fetchone()[0]
             self.assertEqual(count, 4)
 
+    def test_dependencies(self) -> None:
+        """Test the installation of dependencies."""
+        test_dir = Path("test") / "data" / "dependencies"
+        with self.assertRaises(PumDependencyError):
+            PumConfig.from_yaml(test_dir / ".pum.yaml")
+        cfg = PumConfig.from_yaml(test_dir / ".pum.yaml", install_dependencies=True)
+        sm = SchemaMigrations(cfg)
+        with psycopg.connect(f"service={self.pg_service}") as conn:
+            self.assertFalse(sm.exists(conn))
+            upgrader = Upgrader(config=cfg)
+            upgrader.install(connection=conn)
+            self.assertTrue(sm.exists(conn))
+
 
 if __name__ == "__main__":
     unittest.main()