🐛 fixes schema-json in settings-CLI (ITISFoundation#2825)

* fixes schema-json in settings-CLI
* added exclude-unset option

Author: pcrespov

packages/settings-library/src/settings_library/base.py

@@ -1,5 +1,3 @@
-import warnings
-
 from functools import cached_property
 from typing import Sequence, get_args
 
@@ -89,9 +87,10 @@ def prepare_field(cls, field: ModelField) -> None:
                     assert field.field_info.default is Undefined
                     assert field.field_info.default_factory is None
 
+                    # Transform it into something like `Field(default_factory=create_settings_from_env(field))`
                     field.default_factory = create_settings_from_env(field)
-                    # Having a default value, makes this field automatically optional
-                    field.required = False
+                    field.default = None
+                    field.required = False  # has a default now
 
             elif issubclass(field_type, BaseSettings):
                 raise ValueError(
@@ -106,10 +105,7 @@ def prepare_field(cls, field: ModelField) -> None:
 
     @classmethod
     def create_from_envs(cls, **overrides):
-        # Kept for legacy
+        # Kept for legacy. Identical to the constructor.
         # Optional to use to make the code more readable
         # More explicit and pylance seems to get less confused
-        warnings.warn(
-            "please use constructor instead of `create_from_envs`", DeprecationWarning
-        )
         return cls(**overrides)

packages/settings-library/src/settings_library/utils_cli.py

@@ -11,7 +11,14 @@
 from .base import BaseCustomSettings
 
 
-def print_as_envfile(settings_obj, *, compact: bool, verbose: bool, show_secrets: bool):
+def print_as_envfile(
+    settings_obj,
+    *,
+    compact: bool,
+    verbose: bool,
+    show_secrets: bool,
+    **pydantic_export_options,
+):
     for field in settings_obj.__fields__.values():
 
         value = getattr(settings_obj, field.name)
@@ -20,7 +27,7 @@ def print_as_envfile(settings_obj, *, compact: bool, verbose: bool, show_secrets
 
         if isinstance(value, BaseSettings):
             if compact:
-                value = f"'{value.json()}'"  # flat
+                value = f"'{value.json(**pydantic_export_options)}'"  # flat
             else:
                 if verbose:
                     typer.echo(f"\n# --- {field.name} --- ")
@@ -37,8 +44,10 @@ def print_as_envfile(settings_obj, *, compact: bool, verbose: bool, show_secrets
         typer.echo(f"{field.name}={value}")
 
 
-def print_as_json(settings_obj, *, compact=False):
-    typer.echo(settings_obj.json(indent=None if compact else 2))
+def print_as_json(settings_obj, *, compact=False, **pydantic_export_options):
+    typer.echo(
+        settings_obj.json(indent=None if compact else 2, **pydantic_export_options)
+    )
 
 
 def create_settings_command(
@@ -58,8 +67,14 @@ def settings(
         compact: bool = typer.Option(False, help="Print compact form"),
         verbose: bool = False,
         show_secrets: bool = False,
+        exclude_unset: bool = typer.Option(
+            False,
+            help="displays settings that were explicitly set"
+            "This represents current config (i.e. required+ defaults overriden).",
+        ),
     ):
         """Resolves settings and prints envfile"""
+        pydantic_export_options = {"exclude_unset": exclude_unset}
 
         if as_json_schema:
             typer.echo(settings_cls.schema_json(indent=0 if compact else 2))
@@ -73,7 +88,8 @@ def settings(
 
             assert logger is not None  # nosec
             logger.error(
-                "Invalid application settings. Typically an environment variable is missing or mistyped :\n%s",
+                "Invalid settings. "
+                "Typically this is due to an environment variable missing or misspelled :\n%s",
                 "\n".join(
                     [
                         HEADER_STR.format("detail"),
@@ -95,13 +111,14 @@ def settings(
             raise
 
         if as_json:
-            print_as_json(settings_obj, compact=compact)
+            print_as_json(settings_obj, compact=compact, **pydantic_export_options)
         else:
             print_as_envfile(
                 settings_obj,
                 compact=compact,
                 verbose=verbose,
                 show_secrets=show_secrets,
+                **pydantic_export_options,
             )
 
     return settings

packages/settings-library/tests/test_utils_cli.py

@@ -72,17 +72,20 @@ def fake_granular_env_file_content() -> str:
 
 
 def test_compose_commands(cli: typer.Typer, cli_runner: CliRunner):
-    result = cli_runner.invoke(cli, ["--help"])
+    # NOTE: this tests is mostly here to raise awareness about what options
+    # are exposed in the CLI so we can add tests if there is any update
+    #
+    result = cli_runner.invoke(cli, ["--help"], catch_exceptions=False)
     print(result.stdout)
     assert result.exit_code == 0, result
 
     # first command
-    result = cli_runner.invoke(cli, ["run", "--help"])
+    result = cli_runner.invoke(cli, ["run", "--help"], catch_exceptions=False)
     print(result.stdout)
     assert result.exit_code == 0, result
 
     # settings command
-    result = cli_runner.invoke(cli, ["settings", "--help"])
+    result = cli_runner.invoke(cli, ["settings", "--help"], catch_exceptions=False)
     print(result.stdout)
 
     assert "--compact" in result.stdout
@@ -96,34 +99,58 @@ def extract_lines(text):
 
 
 HELP = """
-    Usage: app settings [OPTIONS]
-
-    Resolves settings and prints envfile
-
-    Options:
-    --as-json / --no-as-json        [default: no-as-json]
-    --as-json-schema / --no-as-json-schema
-                                    [default: no-as-json-schema]
-    --compact / --no-compact        Print compact form  [default: no-compact]
-    --verbose / --no-verbose        [default: no-verbose]
-    --show-secrets / --no-show-secrets
-                                    [default: no-show-secrets]
-    --help                          Show this message and exit.
+Usage: app settings [OPTIONS]
+
+  Resolves settings and prints envfile
+
+Options:
+  --as-json / --no-as-json        [default: no-as-json]
+  --as-json-schema / --no-as-json-schema
+                                  [default: no-as-json-schema]
+  --compact / --no-compact        Print compact form  [default: no-compact]
+  --verbose / --no-verbose        [default: no-verbose]
+  --show-secrets / --no-show-secrets
+                                  [default: no-show-secrets]
+  --exclude-unset / --no-exclude-unset
+                                  displays settings that were explicitly setThis
+                                  represents current config (i.e. required+
+                                  defaults overriden).  [default: no-exclude-
+                                  unset]
+  --help                          Show this message and exit.
 """
 
 
 def test_settings_as_json(
-    cli: typer.Typer, fake_settings_class, mock_environment, cli_runner: CliRunner
+    cli: typer.Typer,
+    fake_settings_class: Type[BaseCustomSettings],
+    mock_environment,
+    cli_runner: CliRunner,
 ):
 
-    result = cli_runner.invoke(cli, ["settings", "--as-json"])
+    result = cli_runner.invoke(cli, ["settings", "--as-json"], catch_exceptions=False)
     print(result.stdout)
 
     # reuse resulting json to build settings
     settings: Dict = json.loads(result.stdout)
     assert fake_settings_class.parse_obj(settings)
 
 
+def test_settings_as_json_schema(
+    cli: typer.Typer,
+    fake_settings_class: Type[BaseCustomSettings],
+    mock_environment,
+    cli_runner: CliRunner,
+):
+
+    result = cli_runner.invoke(
+        cli, ["settings", "--as-json-schema"], catch_exceptions=False
+    )
+    print(result.stdout)
+
+    # reuse resulting json to build settings
+    settings_schema: Dict = json.loads(result.stdout)
+
+
 def test_cli_default_settings_envs(
     cli: typer.Typer,
     fake_settings_class: Type[BaseCustomSettings],
@@ -139,6 +166,7 @@ def test_cli_default_settings_envs(
         cli_settings_output = cli_runner.invoke(
             cli,
             ["settings", "--show-secrets"],
+            catch_exceptions=False,
         ).stdout
 
     # now let's use these as env vars
@@ -207,6 +235,7 @@ def test_cli_compact_settings_envs(
         setting_env_content_compact = cli_runner.invoke(
             cli,
             ["settings", "--compact"],
+            catch_exceptions=False,
         ).stdout
 
     # now we use these as env vars