ae-base 0.3.48__py3-none-any.whl → 0.3.49__py3-none-any.whl

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.dist-info → ae_base-0.3.49.dist-info}/METADATA

@@ -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.49.dist-info/RECORD

@@ -0,0 +1,7 @@
+ae/base.py,sha256=V0wU87UunINFILcnar0HlBvF6gB8nLnj1tfQ-uXoCiY,61257
+ae_base-0.3.49.dist-info/LICENSE.md,sha256=uoIIfORuk4V8ZeNh6SN0EUhiU79RC-indIMFqePKVhY,35002
+ae_base-0.3.49.dist-info/METADATA,sha256=Ezl-iNQcsr9r0ssjPJAVgVTvZcQZDbHIqno7of0zTos,5636
+ae_base-0.3.49.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ae_base-0.3.49.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
+ae_base-0.3.49.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+ae_base-0.3.49.dist-info/RECORD,,

ae_base-0.3.48.dist-info/RECORD

@@ -1,7 +0,0 @@
-ae/base.py,sha256=oZBQxpBifv7BEcygj_JmsEMebDnEBaZiL5v1DCUxPOE,58770
-ae_base-0.3.48.dist-info/LICENSE.md,sha256=uoIIfORuk4V8ZeNh6SN0EUhiU79RC-indIMFqePKVhY,35002
-ae_base-0.3.48.dist-info/METADATA,sha256=HEFW7mCBlpRR8EHFK0B0ZgIEuCD1lXSVA73Bb9kRE_4,5636
-ae_base-0.3.48.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ae_base-0.3.48.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
-ae_base-0.3.48.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-ae_base-0.3.48.dist-info/RECORD,,