ae-base 0.3.48__tar.gz → 0.3.49__tar.gz

{ae_base-0.3.48/ae_base.egg-info → ae_base-0.3.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ae_base
-Version: 0.3.48
+Version: 0.3.49
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -68,17 +68,17 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.48
+# base 0.3.49
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.47?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.47)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.48?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.48.
+>ae_base module 0.3.49.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.48 → ae_base-0.3.49}/README.md

@@ -1,16 +1,16 @@
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.48
+# base 0.3.49
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.47?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.47)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.48?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.48.
+>ae_base module 0.3.49.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.48 → ae_base-0.3.49}/ae/base.py

@@ -100,6 +100,9 @@ allowing also ``None`` is an accepted argument value.
 
 to extend any class with an intelligent error message handling, add the mixin :class:`ErrorMsgMixin` to it.
 
+the classes :class:`UnformattedValue` and :class:`GivenFormatter` can be used to format strings with placeholders
+enclosed in curly brackets. the function :func:`format_given` is using them to format templates with placeholders.
+
 
 generic context manager
 -----------------------
@@ -144,6 +147,7 @@ import platform
 import re
 import shutil
 import socket
+import string
 import sys
 import unicodedata
 import warnings
@@ -156,7 +160,7 @@ from types import ModuleType
 from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Tuple, Union, cast
 
 
-__version__ = '0.3.48'
+__version__ = '0.3.49'
 
 
 os_path_abspath = os.path.abspath
@@ -469,6 +473,50 @@ def force_encoding(text: Union[str, bytes], encoding: str = DEF_ENCODING, errors
     return enc_str.decode(encoding=encoding)
 
 
+class UnformattedValue:
+    """ helper class for :func:`~ae.base.format_given` to keep placeholder with format unchanged if not found. """
+    def __init__(self, key: str):
+        self.key = key
+
+    def __format__(self, format_spec: str):
+        """ overriding Python object class method to return placeholder unchanged including the curly brackets. """
+        return "{{{}{}}}".format(self.key, ":" + format_spec if format_spec else "")
+
+
+class GivenFormatter(string.Formatter):
+    """ helper class for :func:`~ae.base.format_given` to keep placeholder with format unchanged if not found. """
+    def get_value(self, key, args, kwargs):
+        """ overriding to keep placeholder unchanged if not found """
+        try:
+            return super().get_value(key, args, kwargs)
+        except KeyError:
+            return UnformattedValue(key)
+
+
+def format_given(text: str, placeholder_map: dict[str, Any], strict: bool = False):
+    """ replacement for Python's str.format_map(), keeping intact placeholders that are not in the specified mapping.
+
+    :param text:                text/template in which the given/specified placeholders will get replaced. in contrary
+                                to str.format_map() no KeyError will be raised for placeholders not specified in
+                                :paramref:`~format_given.placeholder_map`.
+    :param placeholder_map:     dict with placeholder keys to be replaced in :paramref:`~format_given.text` argument.
+    :param strict:              pass True to raise error for text templates containing unpaired curly brackets.
+    :return:                    the specified :paramref:`~format_given.text` with only the placeholders specified in
+                                :paramref:`~format_given.placeholder_map` replaced with their respective map value.
+                                additionally any ValueError that would be thrown by str.format_map(), e.g. if the
+
+
+    inspired by the answer of CodeManX in `https://stackoverflow.com/questions/3536303`__
+    """
+    formatter = GivenFormatter()
+    try:
+        return formatter.vformat(text, (), placeholder_map)
+    except (ValueError, Exception) as ex:
+        if strict:
+            raise ex
+        return text
+
+
 def full_stack_trace(ex: Exception) -> str:
     """ get full stack trace from an exception.
 

{ae_base-0.3.48 → ae_base-0.3.49/ae_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ae_base
-Version: 0.3.48
+Version: 0.3.49
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -68,17 +68,17 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.48
+# base 0.3.49
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.47?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.47)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.48?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.48.
+>ae_base module 0.3.49.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.48 → ae_base-0.3.49}/tests/test_base.py

@@ -21,7 +21,7 @@ from ae.base import (
     UNSET,
     URI_SEP_CHAR, app_name_guess, build_config_variable_values, camel_to_snake, deep_dict_update, dummy_function,
     duplicates, env_str,
-    dedefuse, force_encoding, full_stack_trace, import_module, instantiate_config_parser, in_wd,
+    dedefuse, force_encoding, format_given, full_stack_trace, import_module, instantiate_config_parser, in_wd,
     load_env_var_defaults, load_dotenvs, main_file_paths_parts, module_attr, module_file_path, module_name,
     norm_line_sep, norm_name, norm_path, now_str, os_host_name, os_local_ip, _os_platform, os_user_name,
     parse_dotenv, project_main_file, read_file, round_traditional, snake_to_camel, stack_frames, stack_var, stack_vars,
@@ -326,6 +326,27 @@ class TestBaseHelpers:
         with pytest.raises(TypeError):
             assert force_encoding(s, encoding=cast(str, None)) == '\\xe4\\xf6\\xfc'
 
+    def test_format_given(self):
+        assert format_given("test text with {placeholder}", {}) == "test text with {placeholder}"
+        assert format_given("test text with {placeholder:.2e}", {}) == "test text with {placeholder:.2e}"
+        assert format_given("a {placeholder} {{test}}", {}) == "a {placeholder} {test}"
+
+        assert format_given("test text with {placeholder}", {'placeholder': "replaced"}) == "test text with replaced"
+        assert format_given("test text with {placeholder:.2e}", {'placeholder': 3.14159}) == "test text with 3.14e+00"
+
+        assert format_given("a {ph} {{test}}", {'ph': "rep"}) == "a rep {test}"
+        assert format_given("a {{ph}} {test}", {'ph': "rep"}) == "a {ph} {test}"
+        assert format_given("a {{ph} {test}}", {'ph': "rep"}) == "a {{ph} {test}}"
+
+        assert format_given("a non-ph}", {'ph': "rep"}) == "a non-ph}"
+        assert format_given("a non-{ph", {'ph': "rep"}) == "a non-{ph"
+
+    def test_format_given_err(self):
+        with pytest.raises(ValueError):
+            format_given("test text with {placeholder", {}, strict=True)     # expected '}' before end of string
+        with pytest.raises(ValueError):
+            format_given("test text with placeholder}", {}, strict=True)     # Single '}' encountered in format string
+
     def test_import_module_ae_base(self):
         mod_ref = import_module('ae.base')
         assert isinstance(mod_ref, ModuleType)