the1conf 1.3.0__tar.gz → 1.3.1__tar.gz

{the1conf-1.3.0 → the1conf-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: the1conf
-Version: 1.3.0
+Version: 1.3.1
 Summary: All in one configuration management tool for your python applications.
 License-Expression: MIT
 License-File: LICENSE

{the1conf-1.3.0 → the1conf-1.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "the1conf"
-version = "1.3.0"
+version = "1.3.1"
 description = "All in one configuration management tool for your python applications."
 readme = "README.md"
 requires-python = ">=3.12"

{the1conf-1.3.0 → the1conf-1.3.1}/python/main/the1conf/app_config.py

@@ -389,19 +389,31 @@ class AppConfig(AttrDict, AutoProlog, metaclass=AppConfigMeta):
         self, vardef_to_serialize: Iterable[ConfigVarDef], for_file: bool = False
     ) -> dict[str, Any]:
         """
-        Serialize the given variable definitions to a dictionary.
-        We know that values came from strings and that they are either alone or in a list.
-        Thus we can just use str() to serialize them.
+        Serialize the given variable definitions to a dictionary **that have a value**.
+
+        for_file is used to specify if we serialize for storing in a file or for display
+
+        if for file is True  we serialize only variables that have no_conffile_search set to False and used
+        the first key in file_key as the key in the dict, otherwise the key is the variable name. In this case we don't
+        serialize variables whose type_info is None and their real type is not string because we would not be able to
+        read them back from the file and get the same value.
+
+        We use str() to serialize configuration variables .
         To detect list we need to look at the split_to_list attribute of the ConfigVarDef and call str() on
         each element of the list, then join them with the separator used to create the list.
-        If for_file is True we serialize only variables that have no_conffile_search set to False and
-        used file_key as the key in the dict, otherwise the key is the variable name.
         """
         # we are going to take advantage of the AttrDict to accept dotted keys in order to create nested dicts.
         dumper = AttrDict()
         for var in vardef_to_serialize:
-            if for_file and not var.flags.no_conffile_search:
-                key = var.file_key
+            if not self.has_value(var.name):
+                # we skip variables that don't have a value, surely their scope hasn't been resolved yet.
+                continue
+            stringifiable = True
+            if var._type_info is None and not isinstance(self[var.name], str):
+                # we don't know how to put this varialbe in a file so that we can read it afterward and get back the same value.
+                stringifiable = False
+            if for_file and var.file_key is not None and stringifiable:
+                key = var.file_key[0]
             elif not for_file:
                 key = var.name
             else:

{the1conf-1.3.0 → the1conf-1.3.1}/python/main/the1conf/click_option.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from typing import Any, Callable
 
 import click
+from click.types import BoolParamType
 
 from .app_config import ConfigVarDef
 from .utils import Undefined, _undef
@@ -17,6 +18,15 @@ class StringOrUndefined(click.ParamType):
         return click.STRING.convert(value, param, ctx)
 
 
+class BoolOrUndefined(BoolParamType):
+    name = "boolean"
+
+    def convert(self, value: Any, param: Any, ctx: Any) -> Any:
+        if value is _undef:
+            return value
+        return super().convert(value, param, ctx)
+
+
 def click_option(config_var: Any, **kwargs: Any) -> Callable[[Any], Any]:
     """Wrapper for click.option with the metadata from ConfigVarDef."""
     if not isinstance(config_var, ConfigVarDef):
@@ -33,15 +43,24 @@ def click_option(config_var: Any, **kwargs: Any) -> Callable[[Any], Any]:
     else:
         keys = config_var.value_key
 
+    is_bool = config_var._type_info is bool
+
     for key in keys:
         if len(key) == 1:
             param_decls.append(f"-{key}")
         else:
-            param_decls.append(f"--{key.replace('_', '-').lower()}")
+            param_name_str = key.replace("_", "-").lower()
+            if is_bool:
+                param_decls.append(f"--{param_name_str}/--no-{param_name_str}")
+            else:
+                param_decls.append(f"--{param_name_str}")
 
     # Used as destination in the dict returned by click
     param_name = keys[0]
 
+    if is_bool:
+        kwargs["is_flag"] = True
+
     # 2. Documentation
     if "help" not in kwargs and config_var.help:
         kwargs["help"] = config_var.help
@@ -49,7 +68,10 @@ def click_option(config_var: Any, **kwargs: Any) -> Callable[[Any], Any]:
     # 3. Strict constraint: Always strings
     # We overwrite any passed type to ensure that resolve_vars receives a string.
     # We use a custom type to handle the `_undef` default value without converting it to string.
-    kwargs["type"] = StringOrUndefined()
+    if not is_bool:
+        kwargs["type"] = StringOrUndefined()
+    else:
+        kwargs["type"] = BoolOrUndefined()
 
     # We set default to `_undef` to distinguish between "option not provided" (_undef)
     # and "option provided with no value" (which shouldn't happen with string) or None.
@@ -69,4 +91,4 @@ def click_option(config_var: Any, **kwargs: Any) -> Callable[[Any], Any]:
     # Note: We do NOT pass 'envvar' nor 'default'
 
     # We force the destination name to match the key expected by the1conf
-    return click.option(*param_decls, param_name, **kwargs)
+    return click.option(*param_decls, **kwargs)

{the1conf-1.3.0 → the1conf-1.3.1}/python/main/the1conf/config_var.py

@@ -209,7 +209,7 @@ class ConfigVarDef(Generic[_T]):
     _name: Optional[str] = None
     _split_to_list: Optional[bool | str] = None
     _transform: Optional[Union[Callable[[str, Any, Any], Any], str]] = None
-    _type_info: Any = None
+    _type_info: Any = _undef
     _value_key: Optional[Sequence[str]] = None
 
     def __init__(
@@ -233,7 +233,7 @@ class ConfigVarDef(Generic[_T]):
         no_value_search: Optional[bool] = None,
         split_to_list: Optional[bool | str] = None,
         transform: Optional[Union[Callable[[str, Any, Any], Any], str]] = None,
-        type_info: Any = None,
+        type_info: Any = _undef,
         value_key: Optional[str | Sequence[str]] = None,
     ) -> None:
         """Initialize the configuration variable definition.
@@ -289,6 +289,7 @@ class ConfigVarDef(Generic[_T]):
             no_conffile_search=no_conffile_search,
             click_key_conversion=click_key_conversion,
             allow_override=allow_override,
+            no_search=no_search,
         )
 
     def __set_name__(self, owner: type, name: str) -> None:
@@ -347,17 +348,15 @@ class ConfigVarDef(Generic[_T]):
                         "Please check that the type is imported and available."
                     )
 
-        type_info_directive: type | None = None
-        if self._type_info is not None:
-            type_info_directive = self._type_info
+        type_info_directive = self._type_info
 
-        if annotated_type is not None and type_info_directive is not None:
+        if annotated_type is not None and type_info_directive != _undef:
             # both type hint and type_info directive are defined, use type_info directive
             self._type_info = type_info_directive
         elif annotated_type is not None:
             # only type hint is defined, use it
             self._type_info = annotated_type
-        elif type_info_directive is not None:
+        elif type_info_directive != _undef:
             # only type_info directive is defined, use it
             self._type_info = type_info_directive
         else:
@@ -428,14 +427,14 @@ class ConfigVarDef(Generic[_T]):
         if self.flags.no_search or self.flags.no_env_search:
             return None
         else:
-            return self._env_name or self.name
+            return self._env_name or [self.name]
 
     @property
-    def file_key(self) -> Optional[str | Sequence[str]]:
+    def file_key(self) -> Optional[Sequence[str]]:
         if self.flags.no_search or self.flags.no_conffile_search:
             return None
         else:
-            return self._file_key or self.name
+            return self._file_key or [self.name]
 
     @property
     def help(self) -> str:
@@ -470,13 +469,13 @@ class ConfigVarDef(Generic[_T]):
         return self._transform
 
     @property
-    def value_key(self) -> Optional[str | Sequence[str]]:
+    def value_key(self) -> Optional[Sequence[str]]:
         """Note: we can't compute the final value here because it depends on the click_key_conversion
         flag that can be set globally or in resolve_vars."""
         if self.flags.no_search or self.flags.no_value_search:
             return None
         else:
-            return self._value_key or self.name
+            return self._value_key or [self.name]
 
 
 def configvar(
@@ -499,7 +498,7 @@ def configvar(
     no_value_search: Optional[bool] = None,
     split_to_list: Optional[bool | str] = None,
     transform: Optional[Union[Callable[[str, Any, Any], Any], str]] = None,
-    type_info: Any = None,
+    type_info: Any = _undef,
     value_key: Optional[str | Sequence[str]] = None,
 ) -> Any:
     """Create a declarative configuration variable definition.