remove jinja, list parameters

Author: 3nids

pum/cli.py

@@ -5,6 +5,7 @@
 import sys
 from typing import Any
 import importlib.metadata
+from pathlib import Path
 
 import psycopg
 
@@ -316,6 +317,13 @@ def create_parser() -> argparse.ArgumentParser:
 
     # Parser for the "install" command
     parser_install = subparsers.add_parser("install", help="Installs the module.")
+    parser_install.add_argument(
+        "-p",
+        "--parameter",
+        nargs=2,
+        help="Assign variable for running SQL deltas. Format is name value.",
+        action="append",
+    )
 
     # Parser for the "check" command
     parser_check = subparsers.add_parser(
@@ -386,20 +394,13 @@ def create_parser() -> argparse.ArgumentParser:
 
     # Parser for the "upgrade" command
     parser_upgrade = subparsers.add_parser("upgrade", help="upgrade db")
-    parser_upgrade.add_argument("-t", "--table", help="Upgrades information table", required=True)
-    parser_upgrade.add_argument(
-        "-d",
-        "--dir",
-        nargs="+",
-        help="Delta directories (space-separated)",
-        required=True,
-    )
+
     parser_upgrade.add_argument("-u", "--max-version", help="upper bound limit version")
     parser_upgrade.add_argument(
         "-p",
         "--parameter",
-        nargs=3,
-        help="Assign variable for running SQL deltas. Format is: (string|float|int) name value.",
+        nargs=2,
+        help="Assign variable for running SQL deltas. Format is: name value.",
         action="append",
     )
 
@@ -414,32 +415,37 @@ def cli() -> int:
     if args.config_file:
         config = PumConfig.from_yaml(args.config_file)
     else:
-        args_dict = vars(args)
-        config = PumConfig(**args_dict)
+        config = PumConfig.from_yaml(Path(args.dir) / ".pum-config.yaml")
 
     # if no command is passed, print the help and exit
     if not args.command:
         parser.print_help()
         parser.exit()
 
-    # Build variables dict for upgrade/test-and-upgrade commands
-    variables: dict[str, Any] = {}
-    if args.command in ("upgrade", "test-and-upgrade"):
-        for v in args.var or ():
-            if v[0] == "float":
-                variables[v[1]] = float(v[2])
-            elif v[0] == "int":
-                variables[v[1]] = int(v[2])
+    # Build parameters dict for install and upgrade commands
+    parameters: dict[str, Any] = {}
+    parameters_definition = {p["name"]: {k: v for k, v in p.items() if k != "name"} for p in config.parameters()}
+    if args.command in ("install", "upgrade"):
+        for p in args.parameter or ():
+            if p[0] not in parameters_definition:
+                print(f"Unknown parameter: {p[0]}")
+                sys.exit(1)
+            if parameters_definition[p[0]].get("type") == "float":
+                parameters[p[0]] = float(p[1])
+            elif parameters_definition[p[0]].get("type") == "int":
+                parameters[p[0]] = int(p[1])
             else:
-                variables[v[1]] = v[2]
+                parameters[p[0]] = p[1]
+
+    logging.debug(f"Parameters: {parameters}")
 
     pum = Pum(args.pg_service, config)
     exit_code = 0
 
     if args.command == "info":
         run_info(args.pg_service, config)
     elif args.command == "install":
-        Upgrader(args.pg_service, config=config, dir=args.dir).install()
+        Upgrader(args.pg_service, config=config, dir=args.dir, parameters=parameters).install()
     elif args.command == "check":
         success = pum.run_check(
             args.pg_service1,
@@ -463,7 +469,7 @@ def cli() -> int:
             args.pg_service,
             args.table,
             args.dir,
-            variables,
+            parameters,
             args.max_version,
             args.verbose,
         )

pum/config.py

@@ -21,6 +21,7 @@ def __init__(self, **kwargs):
             kwargs.get("schema_migrations_table") or "public.pum_migrations"
         )
         self.changelogs_directory: str = kwargs.get("changelogs_directory") or "changelogs"
+        self.parameters_definition: dict = kwargs.get("parameters") or {}
 
     def get(self, key, default=None):
         """
@@ -34,6 +35,12 @@ def set(self, key, value):
         """
         setattr(self, key, value)
 
+    def parameters(self):
+        """
+        Get all changelogs parameters as a dictionary.
+        """
+        return self.get("parameters_definition", {})
+
     @classmethod
     def from_yaml(cls, file_path):
         """

pum/upgrader.py

@@ -39,7 +39,7 @@ def __init__(
         self,
         pg_service: str,
         config: PumConfig,
-        variables=None,
+        parameters=None,
         dir: str | Path = ".",
         max_version=None,
     ):
@@ -55,8 +55,8 @@ def __init__(
             related to the db
         config: PumConfig
             The configuration object
-        variables: dict
-            dictionary for variables to be used in SQL deltas ( name => value )
+        parameters: dict
+            The parameters to pass to the SQL files.
         dir: str | Path
             The directory where the module is located.
         max_version: str
@@ -65,22 +65,18 @@ def __init__(
 
         self.pg_service = pg_service
         self.config = config
-        self.variables = variables
         self.max_version = parse_version(max_version) if max_version else None
         self.schema_migrations = SchemaMigrations(self.config)
         self.dir = dir
+        self.parameters = parameters
 
-    def install(self, parameters: dict | None = None):
+    def install(self):
         """
         Installs the given module
         This will create the schema_migrations table if it does not exist.
         This will also apply all the changelogs that are after the current version.
         The changelogs are applied in the order they are found in the directory.
         It will also set the baseline version to the current version of the module.
-
-        args:
-            parameters: dict
-                The parameters to pass to the SQL files
         """
 
         with psycopg.connect(f"service={self.pg_service}") as conn:
@@ -91,7 +87,7 @@ def install(self, parameters: dict | None = None):
             self.schema_migrations.create(conn, commit=False)
             for changelog in self.changelogs(after_current_version=False):
                 changelog_files = self.__apply_changelog(
-                    conn, changelog, commit=False, parameters=parameters
+                    conn, changelog, commit=False, parameters=self.parameters
                 )
                 changelog_files = [str(f) for f in changelog_files]
                 self.schema_migrations.set_baseline(
@@ -100,7 +96,7 @@ def install(self, parameters: dict | None = None):
                     beta_testing=False,
                     commit=False,
                     changelog_files=changelog_files,
-                    parameters=parameters,
+                    parameters=self.parameters,
                 )
             logger
 
@@ -272,8 +268,8 @@ def __run_sql_file(self, filepath):
 
         with open(filepath) as delta_file:
             sql = delta_file.read()
-            if self.variables:
-                self.cursor.execute(sql, self.variables)
+            if self.parameters:
+                self.cursor.execute(sql, self.parameters)
             else:
                 self.cursor.execute(sql)
             self.connection.commit()

pum/utils/execute_sql.py

@@ -1,8 +1,6 @@
 import logging
 from pathlib import Path
 
-from jinja2 import Template
-
 from psycopg import Connection, Cursor
 from psycopg.errors import SyntaxError
 
@@ -32,13 +30,16 @@ def execute_sql(
     try:
         if isinstance(sql, Path):
             logger.debug(
-                f"Executing SQL from file: {sql}",
+                f"Executing SQL from file: {sql} with parameters: {parameters}",
             )
             with open(sql) as file:
+                sql_content = file.read()
                 if parameters:
-                    sql_code = Template(file.read()).render(**parameters)
+                    for key, value in parameters.items():
+                        sql_content = sql_content.replace(f'{{{{ {key} }}}}', str(value))
+                    sql_code = sql_content
                 else:
-                    sql_code = file.read()
+                    sql_code = sql_content
                 sql_code = sql_code.split(";")
         else:
             sql_code = [sql]

requirements/base.txt

@@ -1,4 +1,3 @@
-jinja2
 packaging
 PyYAML
 psycopg[binary]

test/data/parameters/.pum-config.yaml

@@ -0,0 +1,6 @@
+
+parameters:
+  - name: SRID
+    type: int
+    default: 2056
+    description: SRID for the geometry column

test/test_upgrader.py

@@ -58,7 +58,13 @@ def test_install_single_changelog(self):
         )
 
     def test_parameters(self):
-        cfg = PumConfig()
+        cfg = PumConfig.from_yaml(str(Path("test") / "data" / "parameters" / ".pum-config.yaml"))
+        self.assertEqual(cfg.parameters(), [{
+            "name": "SRID",
+            "type": "int",
+            "default": 2056,
+            "description": "SRID for the geometry column",
+        }])
         sm = SchemaMigrations(cfg)
         self.assertFalse(sm.exists(self.conn))
         upgrader = Upgrader(