BREAK: rename enforce_multiline to multiline in to_toml_array() (…

…#372)
ComPWA · Aug 12, 2024 · b0d1b22 · b0d1b22
1 parent 70db258
commit b0d1b22
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/src/compwa_policy/check_dev_files/ruff.py b/src/compwa_policy/check_dev_files/ruff.py
@@ -308,7 +308,7 @@ def __update_ruff_lint_settings(pyproject: ModifiablePyproject) -> None:
     ignored_rules = ___merge_rules(settings.get("ignore", []), ignored_rules)
     minimal_settings = {
         "select": to_toml_array(["ALL"]),
-        "ignore": to_toml_array(sorted(ignored_rules), enforce_multiline=True),
+        "ignore": to_toml_array(sorted(ignored_rules), multiline=True),
         "task-tags": ___get_task_tags(settings),
     }
     if not complies_with_subset(settings, minimal_settings):

diff --git a/src/compwa_policy/check_dev_files/toml.py b/src/compwa_policy/check_dev_files/toml.py
@@ -107,7 +107,7 @@ def _update_taplo_config() -> None:
     excludes = filter_patterns(expected["exclude"])  # type:ignore[arg-type]
     if excludes:
         sorted_excludes = sorted(excludes, key=str.lower)
-        expected["exclude"] = to_toml_array(sorted_excludes, enforce_multiline=True)
+        expected["exclude"] = to_toml_array(sorted_excludes, multiline=True)
     else:
         del expected["exclude"]
     with open(CONFIG_PATH.taplo) as f:

diff --git a/src/compwa_policy/utilities/toml.py b/src/compwa_policy/utilities/toml.py
@@ -10,10 +10,10 @@
     from tomlkit.items import Array
 
 
-def to_toml_array(items: Iterable[Any], enforce_multiline: bool = False) -> Array:
+def to_toml_array(items: Iterable[Any], multiline: bool = False) -> Array:
     array = tomlkit.array()
     array.extend(items)
-    if enforce_multiline or len(array) > 1:
+    if multiline or len(array) > 1:
         array.multiline(True)
     else:
         array.multiline(False)

diff --git a/tests/utilities/test_pyproject.py b/tests/utilities/test_pyproject.py
@@ -68,7 +68,7 @@ def test_edit_and_dump():
         work = pyproject.get_table("owner.work", create=True)
         work["type"] = "scientist"
         tools = pyproject.get_table("tool", create=True)
-        tools["black"] = to_toml_array(["--line-length=79"], enforce_multiline=True)
+        tools["black"] = to_toml_array(["--line-length=79"], multiline=True)
 
     new_content = pyproject.dumps()
     expected = dedent("""

diff --git a/tests/utilities/test_toml.py b/tests/utilities/test_toml.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from textwrap import dedent
 
 import pytest
@@ -16,7 +18,7 @@ def test_to_toml_array_single_item():
     array = to_toml_array(lst)
     assert _dump(array) == "a = [1]"
 
-    array = to_toml_array(lst, enforce_multiline=True)
+    array = to_toml_array(lst, multiline=True)
     expected = dedent("""
         a = [
             1,
@@ -25,10 +27,10 @@ def test_to_toml_array_single_item():
     assert _dump(array) == expected.strip()
 
 
-@pytest.mark.parametrize("enforce_multiline", [False, True])
-def test_to_toml_array_multiple_items(enforce_multiline: bool):
+@pytest.mark.parametrize("multiline", [False, True])
+def test_to_toml_array_multiple_items(multiline: bool):
     lst = [1, 2, 3]
-    array = to_toml_array(lst, enforce_multiline)
+    array = to_toml_array(lst, multiline)
     expected = dedent("""
         a = [
             1,