Release v1.6.1

Author: pcisar

docs/changelog.txt

@@ -2,6 +2,16 @@
 Changelog
 #########
 
+Version 1.6.1
+=============
+
+* `~firebird.base.config` module:
+
+  - Fixed bug with `.Config.get_config()` and `plain` bool argument.
+  - `.StrOption` now supports preservation of significant leading whitespace for multiline
+    values (like `.PyCodeOption`).
+
+
 Version 1.6.0
 =============
 
@@ -14,6 +24,7 @@ Version 1.6.0
 
   - `.Config.get_config()` and `.Option.get_config()` now provides `plain` bool argument
     to return configuration text without comments. Deafult is False.
+  - `.create_config` is now deprecated, will be removed in version 2.0.
 
 * `~firebird.base.trace` module:
 

docs/conf.py

@@ -23,10 +23,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '1.6.0'
+version = '1.6.1'
 
 # The full version, including alpha/beta/rc tags
-release = '1.6.0'
+release = '1.6.1'
 
 
 # -- General configuration ---------------------------------------------------

docs/config.txt

@@ -359,5 +359,7 @@ Options
 
 Functions
 =========
+.. autofunction:: has_verticals
+.. autofunction:: has_leading_spaces
 .. autofunction:: create_config
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "firebird-base"
-version = "1.6.0"
+version = "1.6.1"
 description = "Firebird base modules for Python"
 readme = "README.rst"
 requires-python = ">=3.8"
@@ -26,7 +26,7 @@ classifiers = [
     "Topic :: Software Development",
     ]
 dependencies = [
-    "protobuf>=4.21.0, <5",
+    "protobuf>=4.21.0, <4.22",
     ]
 
 [project.urls]

src/firebird/base/config.py

@@ -63,8 +63,16 @@
 
 PROTO_CONFIG = 'firebird.base.ConfigProto'
 
+def has_verticals(value: str) -> bool:
+    "Returns True if lines in multiline string contains leading '|' character."
+    return any(1 for line in value.split('\n') if line.startswith('|'))
+
+def has_leading_spaces(value: str) -> bool:
+    "Returns True if any line in multiline string starts with space(s)."
+    return any(1 for line in value.split('\n') if line.startswith(' '))
+
 def unindent_verticals(value: str) -> str:
-    """Removes trailing '|' character from each line in multiline string."""
+    """Removes leading '|' character from each line in multiline string."""
     lines = []
     indent = None
     for line in value.split('\n'):
@@ -81,11 +89,13 @@ def _eq(a: Any, b: Any) -> bool:
 
 def create_config(_cls: Type[Config], name: str) -> Config: # pragma: no cover
     """Return newly created `Config` instance. Intended to be used with `functools.partial`.
+
+    .. deprecated:: 1.6
+       Will be removed in version 2.0
     """
     return _cls(name)
 
 # Next two functions are copied from stdlib enum module, as they were removed in Python 3.11
-
 def _decompose(flag, value):
     """
     Extract all members from the value.
@@ -409,8 +419,8 @@ def get_directory_scheme(app_name: str, version: str=None, *, force_home: bool=F
         app_name: Application name
         version: Application version string
         force_home: When True, the general directies are always set to subdirectories of
-                    `DirectoryScheme.home` directory. When False, these the home is used
-                    ONLY when it's set by "<app_name>_HOME" environment variable.
+                    `DirectoryScheme.home` directory. When False, then home is used ONLY
+                    when it's set by "<app_name>_HOME" environment variable.
     """
     return {'Windows': WindowsDirectoryScheme,
             'Linux':LinuxDirectoryScheme,
@@ -461,7 +471,7 @@ def _get_config_lines(self, plain: bool=False) -> List[str]:
         file processed with `~configparser.ConfigParser`.
 
         Text lines with configuration start with comment marker `;` and end with newline.
-        
+
         Arguments:
           plain: When True, it outputs only the option value. When False, it includes also
                  option description and other helpful information.
@@ -517,7 +527,7 @@ def validate(self) -> None:
     def get_config(self, *, plain: bool=False) -> str:
         """Returns string containing text lines suitable for use in configuration file
         processed with `~configparser.ConfigParser`.
-        
+
         Arguments:
           plain: When True, it outputs only the option value. When False, it includes also
                  option description and other helpful information.
@@ -655,7 +665,7 @@ def get_config(self, *, plain: bool=False) -> str:
         for config in self.configs:
             if not plain:
                 lines.append('\n')
-            lines.append(config.get_config())
+            lines.append(config.get_config(plain=plain))
         return ''.join(lines)
     def load_config(self, config: ConfigParser, section: str=None) -> None:
         """Update configuration.
@@ -738,6 +748,17 @@ def configs(self) -> List[Config]:
 # Options
 class StrOption(Option[str]):
     """Configuration option with string value.
+
+    .. versionadded:: 1.6.1
+       Support for verticals to preserve leading whitespace.
+
+    Important:
+        Multiline string values could contain significant leading whitespace, but
+        ConfigParser multiline string values have leading whitespace removed. To circumvent
+        this, the `StrOption` supports assignment of text values where lines start with `|`
+        character. This character is removed, along with any number of subsequent whitespace
+        characters that are between `|` and first non-whitespace character on first line
+        starting with `|`.
     """
     def __init__(self, name: str, description: str, *, required: bool=False, default: str=None):
         """
@@ -764,9 +785,10 @@ def get_formatted(self) -> str:
         result = self._value
         if '\n' in result:
             lines = []
+            indent = '   | ' if has_leading_spaces(result) else '   '
             for line in result.splitlines(True):
                 if lines:
-                    lines.append('   ' + line)
+                    lines.append(indent + line)
                 else:
                     lines.append(line)
             result = ''.join(lines)
@@ -780,6 +802,7 @@ def set_as_str(self, value: str) -> None:
         Raises:
             ValueError: When the argument is not a valid option value.
         """
+        value = unindent_verticals(value)
         self._value = value
     def get_as_str(self) -> str:
         """Returns value as string.

src/firebird/base/types.py

@@ -374,7 +374,7 @@ def get_callable(self, arguments: str='', namespace: Dict[str, Any]=None) -> Cal
         return ns['expr']
     @property
     def expr(self):
-        "Expression code ready to be appased to `eval`."
+        "Expression code ready to be pased to `eval`."
         return self._expr_
 
 class PyCode(str):
@@ -394,7 +394,7 @@ def __new__(cls, value: str):
         return new
     @property
     def code(self):
-        """Python code ready to be appased to `exec`.
+        """Python code ready to be pased to `exec`.
         """
         return self._code_
 
@@ -436,7 +436,8 @@ def __call__(self, *args, **kwargs):
 # Metaclasses
 def Conjunctive(name, bases, attrs):
     """Returns a metaclass that is conjunctive descendant of all metaclasses used by parent
-    classes.
+    classes. It's necessary to create a class with multiple inheritance, where multiple
+    parent classes use different metaclasses.
 
     Example:
 

test/test_config.py

@@ -129,6 +129,13 @@ def setUp(self):
 [%(ABSENT)s]
 [%(BAD)s]
 option_name =
+[VERTICALS]
+option_name =
+    | def pp(value):
+    |     print("Value:",value,file=output)
+    |
+    | for i in [1,2,3]:
+    |     pp(i)
 """)
     def test_simple(self):
         opt = config.StrOption('option_name', 'description')
@@ -156,6 +163,9 @@ def test_simple(self):
         opt.set_value(self.NEW_VAL)
         self.assertEqual(opt.value, self.NEW_VAL)
         self.assertIsInstance(opt.value, opt.datatype)
+        # Verticals
+        opt.load_config(self.conf, 'VERTICALS')
+        self.assertEqual(opt.get_as_str(), '\ndef pp(value):\n    print("Value:",value,file=output)\n\nfor i in [1,2,3]:\n    pp(i)')
     def test_required(self):
         opt = config.StrOption('option_name', 'description', required=True)
         self.assertEqual(opt.name, 'option_name')
@@ -259,6 +269,16 @@ def test_get_config(self):
 """
         opt.set_value(None)
         self.assertEqual(opt.get_config(), lines)
+        lines = """; description
+; Type: str
+option_name =
+   | def pp(value):
+   |     print("Value:",value,file=output)
+   |
+   | for i in [1,2,3]:
+   |     pp(i)"""
+        opt.set_value('\ndef pp(value):\n    print("Value:",value,file=output)\n\nfor i in [1,2,3]:\n    pp(i)')
+        self.assertEqual('\n'.join(x.rstrip() for x in opt.get_config().splitlines()), lines)
 
 class TestIntOption(BaseConfigTest):
     "Unit tests for firebird.base.config.IntOption"