pum 1.1.4__tar.gz → 1.1.6__tar.gz

{pum-1.1.4/pum.egg-info → pum-1.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pum
-Version: 1.1.4
+Version: 1.1.6
 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.4 → pum-1.1.6}/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:
@@ -225,7 +229,7 @@ class HookHandler:
                     f"Unsupported file type for migration hook: {self.file.suffix}. Only .sql and .py files are supported."
                 )
         elif self.code:
-            SqlContent(self.code).execute(connection, parameters=parameters, commit=False)
+            SqlContent(self.code).execute(connection, parameters=parameters_literals, commit=False)
 
         if commit:
             connection.commit()

{pum-1.1.4 → pum-1.1.6}/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.4 → pum-1.1.6}/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.4 → pum-1.1.6}/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.4 → pum-1.1.6/pum.egg-info}/PKG-INFO

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

@@ -12,7 +12,6 @@ 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

{pum-1.1.4 → pum-1.1.6}/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(