pglift-cli 3.1.0__tar.gz → 3.2.0__tar.gz

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 3.1.0
+Version: 3.2.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/src/pglift_cli/main.py

@@ -11,7 +11,7 @@ import warnings
 from functools import partial
 from importlib.metadata import version
 from pathlib import Path
-from typing import Literal
+from typing import Any, Literal
 
 import click
 import click.exceptions
@@ -24,7 +24,6 @@ from rich.highlighter import NullHighlighter
 from rich.syntax import Syntax
 
 from pglift import ui
-from pglift._compat import assert_never
 from pglift.system import install
 from pglift.types import LogLevel
 
@@ -234,35 +233,50 @@ def site_settings(
         console.print(syntax)
 
 
-@cli.command(
-    "site-configure",
-    hidden=True,
-)
-@click.argument(
-    "action",
-    type=click.Choice(["install", "uninstall", "check", "list"]),
-    default="install",
+@cli.group(hidden=True)
+def site_configure(**kwargs: Any) -> None:
+    """Manage installation of extra data files for pglift.
+
+    This is an INTERNAL command.
+    """
+
+
+@site_configure.command("install")
+@click.option(
+    "--force",
+    is_flag=True,
+    default=False,
+    help="Force the overwrite of installed files",
 )
 @click.pass_obj
+@async_command
+async def site_configure_install(obj: Obj, force: bool) -> None:
+    with obj.lock, audit():
+        await install.do(_site.SETTINGS, force=force)
+
+
+@site_configure.command("uninstall")
+@click.pass_obj
+@async_command
+async def site_configure_uninstall(obj: Obj) -> None:
+    with obj.lock, audit():
+        await install.undo(_site.SETTINGS)
+
+
+@site_configure.command("check")
+@click.pass_obj
 @click.pass_context
 @async_command
-async def site_configure(
-    context: click.Context, obj: Obj, action: Literal["install", "uninstall", "check"]
-) -> None:
-    """Manage installation of extra data files for pglift.
+async def site_configure_check(context: click.Context, obj: Obj) -> None:
+    with obj.lock, audit():
+        if not install.check(_site.SETTINGS):
+            context.exit(1)
 
-    This is an INTERNAL command.
-    """
+
+@site_configure.command("list")
+@click.pass_obj
+@async_command
+async def site_configure_list(obj: Obj) -> None:
     with obj.lock, audit():
-        if action == "install":
-            await install.do(_site.SETTINGS)
-        elif action == "uninstall":
-            await install.undo(_site.SETTINGS)
-        elif action == "check":
-            if not install.check(_site.SETTINGS):
-                context.exit(1)
-        elif action == "list":
-            for p in install.ls(_site.SETTINGS):
-                click.echo(p)
-        else:
-            assert_never(action)
+        for p in install.ls(_site.SETTINGS):
+            click.echo(p)

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/src/pglift_cli/model.py

@@ -18,7 +18,7 @@ import pydantic
 from pydantic.fields import FieldInfo
 from pydantic_core import ErrorDetails
 
-from pglift.annotations import cli
+from pglift.annotations import CreateOnly, cli
 from pglift.exceptions import MutuallyExclusiveError
 from pglift.models.helpers import is_optional, optional_type
 from pglift.models.interface import PresenceState
@@ -169,7 +169,7 @@ class ParamSpec(ABC):
     loc: tuple[str, ...]
     description: str | None = None
 
-    objtype: ClassVar[type[click.Parameter]] = click.Parameter
+    objtype: ClassVar[type[click.Parameter]]
 
     @property
     def param(self) -> click.Parameter:
@@ -340,11 +340,7 @@ def _paramspecs_from_model(
     for fname, field in model_type.model_fields.items():
         if field_annotation(field, cli.Hidden):
             continue
-        if (
-            operation == "update"
-            and isinstance(field.json_schema_extra, dict)
-            and field.json_schema_extra.get("readOnly")
-        ):
+        if field_annotation(field, CreateOnly) and operation == "update":
             continue
 
         modelname = argname = field.alias or fname
@@ -372,9 +368,6 @@ def _paramspecs_from_model(
         if not _parents and required:
             if origin_type is typing.Literal:
                 choices = list(typing.get_args(ftype))
-                if config is not None:
-                    assert isinstance(config, cli.Choices)
-                    choices = config.choices
                 attrs["type"] = click.Choice(choices)
             if config is not None and isinstance(config, cli.Option):
                 attrs["required"] = True

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/src/pglift_cli/pgconf.py

@@ -58,7 +58,7 @@ def show_configuration_changes(
 @cli.command("show")
 @click.argument("parameter", nargs=-1)
 @pass_postgresql_instance
-def show(instance: PostgreSQLInstance, parameter: tuple[str]) -> None:
+def show(instance: PostgreSQLInstance, parameter: tuple[str, ...]) -> None:
     """Show configuration (all parameters or specified ones).
 
     Only uncommented parameters are shown when no PARAMETER is specified. When

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/src/pglift_cli/util.py

@@ -273,7 +273,7 @@ def nameversion_from_id(instance_id: str) -> tuple[str, PostgreSQLVersion | None
 
 
 def postgresql_instance_lookup(
-    context: click.Context, param: click.Parameter, value: None | str | tuple[str]
+    context: click.Context, param: click.Parameter, value: None | str | tuple[str, ...]
 ) -> PostgreSQLInstance | tuple[PostgreSQLInstance, ...]:
     """Return one or more PostgreSQLInstance, possibly guessed if there
     is only one on system, depending on 'param' variadic flag (nargs).
@@ -764,7 +764,7 @@ class PluggableCommandGroup(abc.ABC, Group):
         if obj is None:
             obj = context.ensure_object(Obj)
         if obj is None:
-            return
+            return  # type: ignore[unreachable]
         self.register_plugin_commands(obj)
         self._plugin_commands_loaded = True
 

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/tests/expect/test-help.t

@@ -249,13 +249,13 @@ Instance commands
     --locale LOCALE                 Default locale.
     --encoding ENCODING             Character encoding of the PostgreSQL
                                     instance.
-    --auth-local [trust|reject|md5|password|scram-sha-256|sspi|ident|peer|pam|ldap|radius]
+    --auth-local [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer]
                                     Authentication method for local-socket
                                     connections.
-    --auth-host [trust|reject|md5|password|scram-sha-256|gss|sspi|ident|pam|ldap|radius]
+    --auth-host [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|gss]
                                     Authentication method for local TCP/IP
                                     connections.
-    --auth-hostssl [trust|reject|md5|password|scram-sha-256|gss|sspi|ident|pam|ldap|radius|cert]
+    --auth-hostssl [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|gss|cert]
                                     Authentication method for SSL-encrypted
                                     TCP/IP connections.
     --surole-password PASSWORD      Super-user role password.
@@ -947,7 +947,8 @@ HBA configuration management commands
     --database DATABASE             Database name(s). Multiple database names
                                     can be supplied by separating them with
                                     commas.
-    --method TEXT                   Authentication method.  [required]
+    --method [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer|gss|cert]
+                                    Authentication method.  [required]
     --user USER                     User name(s). Multiple user names can be
                                     supplied by separating them with commas.
     --dry-run                       Simulate change operations.
@@ -970,7 +971,8 @@ HBA configuration management commands
     --database DATABASE             Database name(s). Multiple database names
                                     can be supplied by separating them with
                                     commas.
-    --method TEXT                   Authentication method.  [required]
+    --method [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer|gss|cert]
+                                    Authentication method.  [required]
     --user USER                     User name(s). Multiple user names can be
                                     supplied by separating them with commas.
     --dry-run                       Simulate change operations.

{pglift_cli-3.1.0 → pglift_cli-3.2.0}/tests/unit/test_model.py

@@ -76,6 +76,8 @@ def test_as_parameters(runner: CliRunner) -> None:
         "Options:\n"
         "  --exclude-none\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
+        "  --gender [female|male|nonbinary|prefer not to say]\n"
+        "                                  Gender.  [required]\n"
         "  --age AGE                       Age.\n"
         "  --address-street STREET         Street lines. (Can be used multiple times.)\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
@@ -102,6 +104,7 @@ def test_as_parameters(runner: CliRunner) -> None:
             "alice",
             "friend",
             "--exclude-none",
+            "--gender=female",
             "--age=42",
             "--address-street=bd montparnasse",
             "--address-street=far far away",
@@ -126,6 +129,7 @@ def test_as_parameters(runner: CliRunner) -> None:
             "zip_code": 0,
             "primary": True,
         },
+        "gender": "female",
         "age": 42,
         "birth": {"date": "1981-02-18"},
         "is_dead": False,
@@ -157,6 +161,7 @@ def test_as_parameters(runner: CliRunner) -> None:
         [
             "foo",
             "friend",
+            "--gender=female",
             "--age=17",
             "--birth-date=1987-06-05",
             "--nickname=aaa",
@@ -186,6 +191,8 @@ def test_as_parameters_update() -> None:
         "\n"
         "Options:\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
+        "  --gender [female|male|nonbinary|prefer not to say]\n"
+        "                                  Gender.  [required]\n"
         "  --age AGE                       Age.\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
         "  --address-town CITY             City.\n"
@@ -209,16 +216,24 @@ def test_as_parameters_update() -> None:
         ["alice", "--age=5", "--birthdate=2042-02-31"],
     )
     assert result.exit_code == 2, result.output
-    assert "Error: No such option: --birthdate" in result.output
+    assert "Error: No such option '--birthdate'" in result.output
 
     result = runner.invoke(
         update_person,
-        ["alice", "other", "--nickname=a", "--age=5", "--birth-date=1987-06-05"],
+        [
+            "alice",
+            "other",
+            "--nickname=a",
+            "--gender=female",
+            "--age=5",
+            "--birth-date=1987-06-05",
+        ],
     )
     assert result.exit_code == 0, result.output
     assert json.loads(result.output) == {
         "name": "alice",
         "nickname": "**********",
+        "gender": "female",
         "relation": "other",
         "age": 5,
         "birth": {"date": "1987-06-05"},
@@ -228,7 +243,14 @@ def test_as_parameters_update() -> None:
 
     result = runner.invoke(
         update_person,
-        ["alice", "friend", "--nickname=a", "--age=abc", "--birth-date=2010-02-03"],
+        [
+            "alice",
+            "friend",
+            "--nickname=a",
+            "--gender=female",
+            "--age=abc",
+            "--birth-date=2010-02-03",
+        ],
     )
     assert result.exit_code == 2
     assert (
@@ -242,6 +264,7 @@ def test_as_parameters_update() -> None:
             "bob",
             "family",
             "--nickname=b",
+            "--gender=male",
             "--birth-date=1987-06-05",
             "--address-town=laville",
             "--address-country=be",
@@ -262,6 +285,7 @@ def test_as_parameters_update() -> None:
             "marcel",
             "other",
             "--nickname=a",
+            "--gender=male",
             "--age=46",
             "--birth-date=1978-03-09",
             "--add-pet=snoopy",
@@ -275,6 +299,7 @@ def test_as_parameters_update() -> None:
         "name": "marcel",
         "nickname": "**********",
         "relation": "other",
+        "gender": "male",
         "age": 46,
         "birth": {"date": "1978-03-09"},
         "pets": [
@@ -339,6 +364,7 @@ def test_parse_params_as() -> None:
         "name": "alice",
         "relation": "other",
         "nickname": "la malice",
+        "gender": "female",
         "age": 42,
         "address": address_params,
         "birth": {"date": "1976-05-04"},
@@ -347,6 +373,7 @@ def test_parse_params_as() -> None:
         name="alice",
         nickname="la malice",
         relation="other",
+        gender="female",
         age=42,
         address=address,
         birth=models.BirthInformation(date=date(1976, 5, 4)),  # type: ignore[call-arg]
@@ -357,6 +384,7 @@ def test_parse_params_as() -> None:
         "name": "alice",
         "relation": "other",
         "nickname": "la malice",
+        "gender": "female",
         "age": 42,
         "birth_date": "1976-05-04",
     }