pum 1.1.3__tar.gz → 1.1.5__tar.gz

{pum-1.1.3/pum.egg-info → pum-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.1.3
+Version: 1.1.5
 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.3 → pum-1.1.5}/docs/docs/index.md

@@ -8,7 +8,7 @@ PUM (PostgreSQL Upgrades Manager) is a robust database migration management tool
 
 # Key Features
 
-- **Command-line and Python Integration**: Use PUM as a standalone [CLI tool](cli.md) or integrate it into your Python project using the [API](api/api.md).
+- **Command-line and Python Integration**: Use PUM as a standalone [CLI tool](cli.md) or integrate it into your Python project using the [API](api/pum_config.md).
 - **Database Versioning**: Automatically manage database versioning with a metadata table.
 - **Changelog Management**: Apply and track SQL delta files for database upgrades.
 - **Migration Hooks**: Define custom hooks to execute additional SQL or Python code before or after migrations. This feature allows you to isolate data (table) code from application code (such as views and triggers), ensuring a clear separation of concerns and more maintainable database structures.

{pum-1.1.3 → pum-1.1.5}/pum/config_model.py

@@ -26,6 +26,12 @@ class ParameterDefinitionModel(PumCustomBaseModel):
     default: Optional[Any] = None
     description: Optional[str] = None
 
+    @model_validator(mode="before")
+    def validate_default(cls, values):
+        if values.get("type") == ParameterType.BOOLEAN:
+            values["default"] = values.get("default", False) in (1, "1", "true", "TRUE", True)
+        return values
+
 
 class HookModel(PumCustomBaseModel):
     """

{pum-1.1.3 → pum-1.1.5}/pum/hook.py

@@ -59,8 +59,9 @@ class HookBase(abc.ABC):
             connection: The database connection.
             sql: The SQL statement to execute or a path to a SQL file..
         """
+        parameters_literals = SqlContent.prepare_parameters(self._parameters)
         SqlContent(sql).execute(
-            connection=self._connection, parameters=self._parameters, commit=False
+            connection=self._connection, parameters=parameters_literals, commit=False
         )
 
     execute.__isfinal__ = True
@@ -191,13 +192,15 @@ class HookHandler:
             f"Executing hook from file: {self.file} or SQL code with parameters: {parameters}",
         )
 
+        parameters_literals = SqlContent.prepare_parameters(parameters)
+
         if self.file is None and self.code is None:
             raise ValueError("No file or SQL code specified for the migration hook.")
 
         if self.file:
             if self.file.suffix == ".sql":
                 SqlContent(self.file).execute(
-                    connection=connection, commit=False, parameters=parameters
+                    connection=connection, commit=False, parameters=parameters_literals
                 )
             elif self.file.suffix == ".py":
                 for parameter_arg in self.parameter_args:
@@ -208,9 +211,10 @@ class HookHandler:
                         )
 
                 _hook_parameters = {}
-                for key, value in parameters.items():
-                    if key in self.parameter_args:
-                        _hook_parameters[key] = value
+                if parameters:
+                    for key, value in parameters.items():
+                        if key in self.parameter_args:
+                            _hook_parameters[key] = value
                 self.hook_instance._prepare(connection=connection, parameters=parameters)
                 try:
                     if _hook_parameters:

{pum-1.1.3 → pum-1.1.5}/pum/parameter.py

@@ -11,6 +11,7 @@ class ParameterType(Enum):
         INTEGER (str): Represents an integer parameter type.
         TEXT (str): Represents a text parameter type.
         DECIMAL (str): Represents a decimal parameter type.
+        PATH (str): Represents a path parameter type.
 
     """
 
@@ -18,6 +19,7 @@ class ParameterType(Enum):
     INTEGER = "integer"
     TEXT = "text"
     DECIMAL = "decimal"
+    PATH = "path"
 
 
 class ParameterDefinition:

{pum-1.1.3 → pum-1.1.5}/pum/pum_config.py

@@ -25,7 +25,7 @@ try:
 except importlib.metadata.PackageNotFoundError:
     # 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
+    versions = []
     for dist_info in dist_info_dirs:
         metadata_path = os.path.join(dist_info, "METADATA")
         if os.path.isfile(metadata_path):
@@ -33,11 +33,11 @@ except importlib.metadata.PackageNotFoundError:
                 for line in f:
                     if line.startswith("Version:"):
                         version = line.split(":", 1)[1].strip()
+                        versions.append(version)
                         break
-        if version:
-            break
-    if version:
-        PUM_VERSION = packaging.version.Version(version)
+    if versions:
+        # Pick the highest version
+        PUM_VERSION = max((packaging.version.Version(v) for v in versions))
     else:
         PUM_VERSION = packaging.version.Version("0.0.0")
 
@@ -137,6 +137,17 @@ class PumConfig:
         """Return the base path used for configuration and changelogs."""
         return self._base_path
 
+    def parameters(self) -> list[ParameterDefinition]:
+        """Return a list of migration parameters.
+
+        Returns:
+            list[ParameterDefinition]: A list of migration parameter definitions.
+
+        """
+        return [
+            ParameterDefinition(**parameter.model_dump()) for parameter in self.config.parameters
+        ]
+
     def parameter(self, name: str) -> ParameterDefinition:
         """Get a specific migration parameter by name.
 

{pum-1.1.3 → pum-1.1.5}/pum/sql_content.py

@@ -263,3 +263,20 @@ class SqlContent:
                 ) from e
 
         return [format_sql(statement, parameters) for statement in sql_code]
+
+    @staticmethod
+    def prepare_parameters(parameters: dict | None):
+        """
+        Prepares a dictionary of parameters for use in SQL queries by converting each value to a psycopg.sql.Literal.
+
+        Args:
+            parameters: A dictionary of parameters to be converted, or None.
+
+        Returns:
+            dict: A new dictionary with the same keys as `parameters`, where each value is wrapped in psycopg.sql.Literal.
+        """
+        parameters_literals = {}
+        if parameters:
+            for key, value in parameters.items():
+                parameters_literals[key] = psycopg.sql.Literal(value)
+        return parameters_literals

{pum-1.1.3 → pum-1.1.5}/pum/upgrader.py

@@ -4,7 +4,6 @@ import logging
 import packaging
 import packaging.version
 import psycopg
-import copy
 
 from .pum_config import PumConfig
 from .exceptions import PumException
@@ -76,8 +75,6 @@ class Upgrader:
             commit:
                 If True, the changes will be committed to the database.
         """
-        parameters_literals = self._prepare_parameters(parameters)
-
         if demo_data and demo_data not in self.config.demo_data():
             raise PumException(
                 f"Demo data '{demo_data}' not found in the configuration. Available demo data: {self.config.demo_data()}"
@@ -98,8 +95,9 @@ class Upgrader:
             )
 
         for pre_hook in self.config.pre_hook_handlers():
-            pre_hook.execute(connection=connection, commit=False, parameters=parameters_literals)
+            pre_hook.execute(connection=connection, commit=False, parameters=parameters)
 
+        parameters_literals = SqlContent.prepare_parameters(parameters)
         last_changelog = None
         for changelog in self.config.changelogs(max_version=max_version):
             last_changelog = changelog
@@ -117,7 +115,7 @@ class Upgrader:
             )
 
         for post_hook in self.config.post_hook_handlers():
-            post_hook.execute(connection=connection, commit=False, parameters=parameters_literals)
+            post_hook.execute(connection=connection, commit=False, parameters=parameters)
 
         logger.info(
             "Installed %s.pum_migrations table and applied changelogs up to version %s",
@@ -148,16 +146,15 @@ class Upgrader:
         if name not in self.config.demo_data():
             raise PumException(f"Demo data '{name}' not found in the configuration.")
 
-        parameters_literals = self._prepare_parameters(parameters)
-
         demo_data_file = self.config.base_path / self.config.demo_data()[name]
         logger.info("Installing demo data from %s", demo_data_file)
 
         for pre_hook in self.config.pre_hook_handlers():
-            pre_hook.execute(connection=connection, commit=False, parameters=parameters_literals)
+            pre_hook.execute(connection=connection, commit=False, parameters=parameters)
 
         connection.commit()
 
+        parameters_literals = SqlContent.prepare_parameters(parameters)
         SqlContent(sql=demo_data_file).execute(
             connection=connection,
             commit=False,
@@ -167,22 +164,6 @@ class Upgrader:
         connection.commit()
 
         for post_hook in self.config.post_hook_handlers():
-            post_hook.execute(connection=connection, commit=False, parameters=parameters_literals)
+            post_hook.execute(connection=connection, commit=False, parameters=parameters)
 
         logger.info("Demo data '%s' installed successfully.", name)
-
-    @staticmethod
-    def _prepare_parameters(parameters: dict | None):
-        """
-        Prepares a dictionary of parameters for use in SQL queries by converting each value to a psycopg.sql.Literal.
-
-        Args:
-            parameters: A dictionary of parameters to be converted, or None.
-
-        Returns:
-            dict: A new dictionary with the same keys as `parameters`, where each value is wrapped in psycopg.sql.Literal.
-        """
-        parameters_literals = copy.deepcopy(parameters) if parameters else {}
-        for key, value in parameters_literals.items():
-            parameters_literals[key] = psycopg.sql.Literal(value)
-        return parameters_literals

{pum-1.1.3 → pum-1.1.5/pum.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.1.3
+Version: 1.1.5
 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.3 → pum-1.1.5}/pum.egg-info/SOURCES.txt

@@ -12,14 +12,12 @@ pyproject.toml
 .github/workflows/windows-tests.yml
 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
 docs/docs/index.md
 docs/docs/roles.md
-docs/docs/api/api.md
 docs/docs/api/changelog.md
 docs/docs/api/dump_format.md
 docs/docs/api/dumper.md

{pum-1.1.3 → pum-1.1.5}/test/test_upgrader.py

@@ -77,7 +77,7 @@ class TestUpgrader(unittest.TestCase):
         test_dir = Path("test") / "data" / "parameters"
         config_path = test_dir / ".pum.yaml"
         cfg = PumConfig.from_yaml(config_path)
-        self.assertEqual(len(cfg.config.parameters), 3)
+        self.assertEqual(len(cfg.parameters()), 3)
         self.assertEqual(
             cfg.parameter("SRID"),
             ParameterDefinition(

pum-1.1.3/docs/docs/api/api.md

@@ -1,11 +0,0 @@
-# PUM API
-
-- [Changelog](api/changelog.md)
-- [Hook](api/hook.md)
-- [Hook](api/hook_handler.md)
-- [ParameterDefinition](api/parameter_definition.md)
-- [ParameterType](api/parameter_type.md)
-- [PumConfig](api/pum_config.md)
-- [SchemaMigrations](api/schema_migrations.md)
-- [Upgrader](api/upgrader.md)
-- [Exceptions](api/exceptions.md)