pglift-cli 1.6.0__tar.gz → 1.7.0__tar.gz

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pglift_cli
-Version: 1.6.0
+Version: 1.7.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -31,7 +31,8 @@ Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: rich>=11.0.0
 Provides-Extra: dev
 Requires-Dist: anyio; extra == 'dev'
-Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: mypy!=1.11.*,>=1.10.0; (python_version < '3.10') and extra == 'dev'
+Requires-Dist: mypy>=1.10.0; (python_version >= '3.10') and extra == 'dev'
 Requires-Dist: patroni[etcd]>=2.1.5; extra == 'dev'
 Requires-Dist: port-for; extra == 'dev'
 Requires-Dist: prysk[pytest-plugin]>=0.14.0; extra == 'dev'
@@ -48,7 +49,8 @@ Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: trustme; extra == 'test'
 Provides-Extra: typing
-Requires-Dist: mypy>=1.10.0; extra == 'typing'
+Requires-Dist: mypy!=1.11.*,>=1.10.0; (python_version < '3.10') and extra == 'typing'
+Requires-Dist: mypy>=1.10.0; (python_version >= '3.10') and extra == 'typing'
 Requires-Dist: types-pyyaml>=6.0.12.10; extra == 'typing'
 Description-Content-Type: text/markdown
 

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/pyproject.toml

@@ -57,7 +57,8 @@ test = [
     "trustme",
 ]
 typing = [
-    "mypy >= 1.10.0",
+    "mypy >= 1.10.0 ; python_version >= '3.10'",
+    "mypy >= 1.10.0, != 1.11.* ; python_version < '3.10'",
     "types-PyYAML >= 6.0.12.10",
 ]
 dev = [

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/src/pglift_cli/base.py

@@ -38,7 +38,10 @@ class CLIGroup(click.Group):
 
     def list_commands(self, context: click.Context) -> list[str]:
         main_commands = super().list_commands(context)
-        plugins_commands: list[str] = sorted(g.name for g in hooks(_site.PLUGIN_MANAGER, h.command))  # type: ignore[misc]
+        plugins_commands: list[str] = sorted(
+            g.name  # type: ignore[misc]
+            for g in hooks(_site.PLUGIN_MANAGER, h.command)
+        )
         return main_commands + self.submodules + plugins_commands
 
     def get_command(self, context: click.Context, name: str) -> click.Command | None:

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/src/pglift_cli/database.py

@@ -30,7 +30,7 @@ from .util import (
     manifest_option,
     model_dump,
     output_format_option,
-    pass_instance,
+    pass_postgresql_instance,
     print_argspec,
     print_json_for,
     print_schema,
@@ -63,11 +63,11 @@ def cli(**kwargs: Any) -> None:
 
 @cli.command("create")
 @model.as_parameters(interface.Database, "create")
-@pass_instance
+@pass_postgresql_instance
 @click.pass_obj
 @async_command
 async def create(
-    obj: Obj, instance: system.Instance, database: interface.Database
+    obj: Obj, instance: system.PostgreSQLInstance, database: interface.Database
 ) -> None:
     """Create a database in a PostgreSQL instance"""
     with obj.lock, audit():
@@ -79,13 +79,13 @@ async def create(
 
 
 @cli.command("alter")  # type: ignore[arg-type]
-@model.as_parameters(interface.Database, "update", parse_model=False)
+@model.as_parameters(interface.Database, "update")
 @click.argument("dbname")
-@pass_instance
+@pass_postgresql_instance
 @click.pass_obj
 @async_command
 async def alter(
-    obj: Obj, instance: system.Instance, dbname: str, **changes: Any
+    obj: Obj, instance: system.PostgreSQLInstance, dbname: str, **changes: Any
 ) -> None:
     """Alter a database in a PostgreSQL instance"""
     with obj.lock, audit():
@@ -100,14 +100,14 @@ async def alter(
 @manifest_option
 @output_format_option
 @dry_run_option
-@pass_instance
+@pass_postgresql_instance
 @click.pass_obj
 @async_command
 async def apply(
     obj: Obj,
-    instance: system.Instance,
+    instance: system.PostgreSQLInstance,
     data: ManifestData,
-    output_format: OutputFormat,
+    output_format: OutputFormat | None,
     dry_run: bool,
 ) -> None:
     """Apply manifest as a database"""
@@ -118,38 +118,44 @@ async def apply(
         with obj.lock, audit():
             async with postgresql.running(instance):
                 ret = await databases.apply(instance, database)
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(ret)
 
 
 @cli.command("get")
 @output_format_option
 @click.argument("name")
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def get(
-    instance: system.Instance, name: str, output_format: OutputFormat
+    instance: system.PostgreSQLInstance, name: str, output_format: OutputFormat | None
 ) -> None:
     """Get the description of a database"""
     async with postgresql.running(instance):
         db = await databases.get(instance, name)
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(model_dump(db))
     else:
-        print_table_for(
-            [db],
-            functools.partial(model_dump, exclude={"extensions", "schemas"}),
-            box=None,
-        )
+        print_table_for([db], functools.partial(model_dump, mode="pretty"), box=None)
 
 
 @cli.command("list")
 @output_format_option
+@click.option(
+    "-x",
+    "--exclude-database",
+    "exclude_dbnames",
+    multiple=True,
+    help="Database to exclude from listing.",
+)
 @click.argument("dbname", nargs=-1)
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def ls(
-    instance: system.Instance, dbname: Sequence[str], output_format: OutputFormat
+    instance: system.PostgreSQLInstance,
+    dbname: Sequence[str],
+    exclude_dbnames: Sequence[str],
+    output_format: OutputFormat | None,
 ) -> None:
     """List databases (all or specified ones)
 
@@ -157,8 +163,10 @@ async def ls(
     """
 
     async with postgresql.running(instance):
-        dbs = await databases.ls(instance, dbnames=dbname)
-    if output_format == OutputFormat.json:
+        dbs = await databases.ls(
+            instance, dbnames=dbname, exclude_dbnames=exclude_dbnames
+        )
+    if output_format == "json":
         print_json_for([model_dump(db) for db in dbs])
     else:
         print_table_for(dbs, model_dump)
@@ -166,11 +174,13 @@ async def ls(
 
 @cli.command("drop")
 @model.as_parameters(interface.DatabaseDropped, "create")
-@pass_instance
+@pass_postgresql_instance
 @click.pass_obj
 @async_command
 async def drop(
-    obj: Obj, instance: system.Instance, databasedropped: interface.DatabaseDropped
+    obj: Obj,
+    instance: system.PostgreSQLInstance,
+    databasedropped: interface.DatabaseDropped,
 ) -> None:
     """Drop a database"""
     with obj.lock, audit():
@@ -183,14 +193,14 @@ async def drop(
 @click.option("-r", "--role", "roles", multiple=True, help="Role to inspect")
 @click.option("--default", "defaults", is_flag=True, help="Display default privileges")
 @output_format_option
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def list_privileges(
-    instance: system.Instance,
+    instance: system.PostgreSQLInstance,
     name: str,
     roles: Sequence[str],
     defaults: bool,
-    output_format: OutputFormat,
+    output_format: OutputFormat | None,
 ) -> None:
     """List privileges on a database."""
     async with postgresql.running(instance):
@@ -201,7 +211,7 @@ async def list_privileges(
             )
         except ValueError as e:
             raise click.ClickException(str(e)) from None
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for([model_dump(p) for p in prvlgs])
     else:
         print_table_for(prvlgs, model_dump)
@@ -220,14 +230,14 @@ async def list_privileges(
     help="Database to not run command on",
 )
 @output_format_option
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def run(
-    instance: system.Instance,
+    instance: system.PostgreSQLInstance,
     sql_command: str,
     dbnames: Sequence[str],
     exclude_dbnames: Sequence[str],
-    output_format: OutputFormat,
+    output_format: OutputFormat | None,
 ) -> None:
     """Run given command on databases of a PostgreSQL instance"""
     async with postgresql.running(instance):
@@ -240,7 +250,7 @@ async def run(
             )
         except psycopg.ProgrammingError as e:
             raise click.ClickException(str(e)) from None
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(result)
     else:
         for dbname, rows in result.items():
@@ -256,9 +266,11 @@ async def run(
     help="Write dump file(s) to DIRECTORY instead of default dumps directory.",
 )
 @click.argument("dbname")
-@pass_instance
+@pass_postgresql_instance
 @async_command
-async def dump(instance: system.Instance, dbname: str, output: Path | None) -> None:
+async def dump(
+    instance: system.PostgreSQLInstance, dbname: str, output: Path | None
+) -> None:
     """Dump a database"""
     async with postgresql.running(instance):
         await databases.dump(instance, dbname, output)
@@ -267,17 +279,19 @@ async def dump(instance: system.Instance, dbname: str, output: Path | None) -> N
 @cli.command("dumps")
 @click.argument("dbname", nargs=-1)
 @output_format_option
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def dumps(
-    instance: system.Instance, dbname: Sequence[str], output_format: OutputFormat
+    instance: system.PostgreSQLInstance,
+    dbname: Sequence[str],
+    output_format: OutputFormat | None,
 ) -> None:
     """List the database dumps
 
     Only dumps created in the default dumps directory are listed.
     """
     values = [asdict(dump) async for dump in databases.dumps(instance, dbnames=dbname)]
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(values)
     else:
         dbnames = ", ".join(dbname) if dbname else "all databases"
@@ -287,10 +301,10 @@ async def dumps(
 @cli.command("restore")
 @click.argument("dump_id")
 @click.argument("targetdbname", required=False)
-@pass_instance
+@pass_postgresql_instance
 @async_command
 async def restore(
-    instance: system.Instance, dump_id: str, targetdbname: str | None
+    instance: system.PostgreSQLInstance, dump_id: str, targetdbname: str | None
 ) -> None:
     """Restore a database dump
 

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/src/pglift_cli/instance.py

@@ -26,9 +26,8 @@ from pglift.settings import default_postgresql_version
 from pglift.settings._postgresql import PostgreSQLVersion
 from pglift.types import Operation, Status, validation_context
 
-from . import _site
+from . import _site, model
 from . import hookspecs as h
-from . import model
 from .util import (
     ManifestData,
     Obj,
@@ -42,6 +41,7 @@ from .util import (
     manifest_option,
     model_dump,
     output_format_option,
+    postgresql_instance_identifier,
     print_argspec,
     print_json_for,
     print_schema,
@@ -115,13 +115,13 @@ async def create(obj: Obj, instance: interface.Instance, drop_on_error: bool) ->
 
 @cli.command("alter")  # type: ignore[arg-type]
 @instance_identifier(nargs=1)
-@model.as_parameters(_site.INSTANCE_MODEL, "update", parse_model=False)
+@model.as_parameters(_site.INSTANCE_MODEL, "update")
 @click.pass_obj
 @async_command
 async def alter(obj: Obj, instance: system.Instance, **changes: Any) -> None:
     """Alter PostgreSQL INSTANCE"""
     with obj.lock, audit():
-        status = await postgresql.status(instance)
+        status = await postgresql.status(instance.postgresql)
         manifest = await instances._get(instance, status)
         values = manifest.model_dump(by_alias=True, exclude={"settings"})
         values = deep_update(values, changes)
@@ -141,7 +141,7 @@ async def alter(obj: Obj, instance: system.Instance, **changes: Any) -> None:
 @click.pass_obj
 @async_command
 async def apply(
-    obj: Obj, data: ManifestData, output_format: OutputFormat, dry_run: bool
+    obj: Obj, data: ManifestData, output_format: OutputFormat | None, dry_run: bool
 ) -> None:
     """Apply manifest as a PostgreSQL instance"""
     name, version = data["name"], data.get("version")
@@ -159,7 +159,7 @@ async def apply(
     else:
         with obj.lock, audit():
             ret = await instances.apply(_site.SETTINGS, instance)
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(ret)
 
 
@@ -177,14 +177,14 @@ async def promote(obj: Obj, instance: system.Instance) -> None:
 @output_format_option
 @instance_identifier(nargs=1)
 @async_command
-async def get(instance: system.Instance, output_format: OutputFormat) -> None:
+async def get(instance: system.Instance, output_format: OutputFormat | None) -> None:
     """Get the description of PostgreSQL INSTANCE.
 
     Unless --output-format is specified, 'settings' and 'state' fields are not
     shown as well as 'standby' information if INSTANCE is not a standby.
     """
     i = await instances.get(instance)
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(model_dump(i))
     else:
         exclude = {
@@ -194,7 +194,7 @@ async def get(instance: system.Instance, output_format: OutputFormat) -> None:
             "wal_directory",
             "powa",
         }
-        if not instance.standby:
+        if not instance.postgresql.standby:
             exclude.add("standby")
         print_table_for([i], partial(model_dump, exclude=exclude), box=None)
 
@@ -207,10 +207,12 @@ async def get(instance: system.Instance, output_format: OutputFormat) -> None:
 )
 @output_format_option
 @async_command
-async def ls(version: PostgreSQLVersion | None, output_format: OutputFormat) -> None:
+async def ls(
+    version: PostgreSQLVersion | None, output_format: OutputFormat | None
+) -> None:
     """List the available instances"""
     items = [i async for i in instances.ls(_site.SETTINGS, version=version)]
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for([model_dump(m) for m in items])
     else:
         print_table_for(items, model_dump)
@@ -290,12 +292,12 @@ async def stop(
 
 
 @cli.command("reload")
-@instance_identifier(nargs=-1)
+@postgresql_instance_identifier(nargs=-1)
 @click.option("--all", "all_instances", is_flag=True, help="Reload all instances.")
 @click.pass_obj
 @async_command
 async def reload(
-    obj: Obj, instance: tuple[system.Instance, ...], all_instances: bool
+    obj: Obj, instance: tuple[system.PostgreSQLInstance, ...], all_instances: bool
 ) -> None:
     """Reload PostgreSQL INSTANCE"""
     with obj.lock, audit():
@@ -362,7 +364,7 @@ def shell(instance: system.Instance, shell: str) -> None:
 @cli.command("env")
 @instance_identifier(nargs=1)
 @output_format_option
-def env(instance: system.Instance, output_format: OutputFormat) -> None:
+def env(instance: system.Instance, output_format: OutputFormat | None) -> None:
     """Output environment variables suitable to handle to PostgreSQL INSTANCE.
 
     This can be injected in shell using:
@@ -370,7 +372,7 @@ def env(instance: system.Instance, output_format: OutputFormat) -> None:
         export $(pglift instance env myinstance)
     """
     instance_env = instances.env_for(instance, path=True)
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for(instance_env)
     else:
         for key, value in sorted(instance_env.items()):
@@ -379,8 +381,8 @@ def env(instance: system.Instance, output_format: OutputFormat) -> None:
 
 @cli.command("logs")
 @click.option("--follow/--no-follow", "-f/", default=False, help="Follow log output.")
-@instance_identifier(nargs=1)
-def logs(instance: system.Instance, follow: bool) -> None:
+@postgresql_instance_identifier(nargs=1)
+def logs(instance: system.PostgreSQLInstance, follow: bool) -> None:
     """Output PostgreSQL logs of INSTANCE.
 
     This assumes that the PostgreSQL instance is configured to use file-based
@@ -400,7 +402,7 @@ def logs(instance: system.Instance, follow: bool) -> None:
 
 
 @cli.command("privileges")
-@instance_identifier(nargs=1)
+@postgresql_instance_identifier(nargs=1)
 @click.option(
     "-d",
     "--database",
@@ -413,11 +415,11 @@ def logs(instance: system.Instance, follow: bool) -> None:
 @output_format_option
 @async_command
 async def list_privileges(
-    instance: system.Instance,
+    instance: system.PostgreSQLInstance,
     databases: Sequence[str],
     roles: Sequence[str],
     defaults: bool,
-    output_format: OutputFormat,
+    output_format: OutputFormat | None,
 ) -> None:
     """List privileges on INSTANCE's databases."""
     async with postgresql.running(instance):
@@ -427,7 +429,7 @@ async def list_privileges(
             )
         except ValueError as e:
             raise click.ClickException(str(e)) from None
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         print_json_for([model_dump(p) for p in prvlgs])
     else:
         if defaults:
@@ -455,8 +457,9 @@ async def list_privileges(
     "--jobs",
     required=False,
     type=click.INT,
-    help="Number of simultaneous processes or threads to use (from pg_upgrade).",
+    help="Number of simultaneous processes or threads to use (from pg_upgrade). Deprecated. Use extra options instead.",
 )
+@click.argument("extra_opts", nargs=-1, type=click.UNPROCESSED)
 @click.pass_obj
 @async_command
 async def upgrade(
@@ -466,12 +469,23 @@ async def upgrade(
     newname: str | None,
     port: int | None,
     jobs: int | None,
+    extra_opts: tuple[str, ...],
 ) -> None:
-    """Upgrade INSTANCE using pg_upgrade"""
+    """Upgrade INSTANCE using pg_upgrade
+
+    Extra options can be passed to the pg_upgrade command. They may need to be prefixed
+    with -- to separate them from the current command options when confusion arises. When using
+    extra options, providing the instance identifier is required.
+    """
     with obj.lock, audit():
-        await postgresql.check_status(instance, Status.not_running)
+        await postgresql.check_status(instance.postgresql, Status.not_running)
         async with task.async_transaction():
             new_instance = await instances.upgrade(
-                instance, version=newversion, name=newname, port=port, jobs=jobs
+                instance,
+                version=newversion,
+                name=newname,
+                port=port,
+                jobs=jobs,
+                extra_opts=extra_opts,
             )
         await instances.start(new_instance)

{pglift_cli-1.6.0 → pglift_cli-1.7.0}/src/pglift_cli/main.py

@@ -207,7 +207,7 @@ def site_settings(
     /,
     defaults: bool | None,
     schema: bool,
-    output_format: OutputFormat,
+    output_format: OutputFormat | None,
 ) -> None:
     """Show site settings.
 
@@ -227,7 +227,7 @@ def site_settings(
             value = _site.SETTINGS.model_dump(
                 mode="json", exclude_defaults=defaults is False
             )
-    if output_format == OutputFormat.json:
+    if output_format == "json":
         console.print_json(data=value)
     else:
         assert output_format is None