Enhance version_path_separator behaviour by adding a multiline option

References: sqlalchemy#1509

Fix changelog ticket number

References: sqlalchemy#1509

alembic/script/base.py

@@ -187,6 +187,7 @@ def from_config(cls, config: Config) -> ScriptDirectory:
             split_on_path = {
                 None: None,
                 "space": " ",
+                "newline": "\n",
                 "os": os.pathsep,
                 ":": ":",
                 ";": ";",
@@ -200,7 +201,7 @@ def from_config(cls, config: Config) -> ScriptDirectory:
                 raise ValueError(
                     "'%s' is not a valid value for "
                     "version_path_separator; "
-                    "expected 'space', 'os', ':', ';'" % version_path_separator
+                    "expected 'space', 'newline', 'os', ':', ';'" % version_path_separator
                 ) from ke
             else:
                 if split_char is None:

alembic/templates/async/alembic.ini.mako

@@ -47,6 +47,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

alembic/templates/generic/alembic.ini.mako

@@ -49,6 +49,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

alembic/templates/multidb/alembic.ini.mako

@@ -49,6 +49,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

alembic/testing/assertions.py

@@ -74,7 +74,7 @@ class _ErrorContainer:
 
 
 @contextlib.contextmanager
-def _expect_raises(except_cls, msg=None, check_context=False):
+def _expect_raises(except_cls, msg=None, check_context=False, text_exact=False):
     ec = _ErrorContainer()
     if check_context:
         are_we_already_in_a_traceback = sys.exc_info()[0]
@@ -85,7 +85,10 @@ def _expect_raises(except_cls, msg=None, check_context=False):
         ec.error = err
         success = True
         if msg is not None:
-            assert re.search(msg, str(err), re.UNICODE), f"{msg} !~ {err}"
+            if text_exact:
+                assert str(err) == msg, f"{msg} != {err}"
+            else:
+                assert re.search(msg, str(err), re.UNICODE), f"{msg} !~ {err}"
         if check_context and not are_we_already_in_a_traceback:
             _assert_proper_exception_context(err)
         print(str(err).encode("utf-8"))
@@ -98,8 +101,8 @@ def expect_raises(except_cls, check_context=True):
     return _expect_raises(except_cls, check_context=check_context)
 
 
-def expect_raises_message(except_cls, msg, check_context=True):
-    return _expect_raises(except_cls, msg=msg, check_context=check_context)
+def expect_raises_message(except_cls, msg, check_context=True, text_exact=False):
+    return _expect_raises(except_cls, msg=msg, check_context=check_context, text_exact=text_exact)
 
 
 def eq_ignore_whitespace(a, b, msg=None):

docs/build/changelog.rst

@@ -7,6 +7,12 @@ Changelog
     :version: 1.13.3
     :include_notes_from: unreleased
 
+    .. change::
+        :tags: feature, environment
+        :tickets: 1509
+
+        Enhance ``version_locations`` parsing to handle paths containing newlines.
+
 .. changelog::
     :version: 1.13.2
     :released: June 26, 2024

docs/build/tutorial.rst

@@ -174,6 +174,7 @@ The file generated with the "generic" configuration looks like::
     # version_path_separator = :
     # version_path_separator = ;
     # version_path_separator = space
+    # version_path_separator = newline
     version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
     # set to 'true' to search source files recursively

tests/test_config.py

@@ -134,6 +134,12 @@ def test_attributes_constructor(self):
             "/foo /bar",
             ["/foo", "/bar"],
         ),
+        (
+            "multiline string 1",
+            "newline",
+            "/foo\n/bar",
+            ["/foo", "/bar"],
+        ),
         (
             "Linux pathsep 1",
             ":",
@@ -171,7 +177,7 @@ def test_attributes_constructor(self):
             "/foo|/bar",
             ValueError(
                 "'|' is not a valid value for version_path_separator; "
-                "expected 'space', 'os', ':', ';'"
+                "expected 'space', 'newline', 'os', ':', ';'"
             ),
         ),
         id_="iaaa",
@@ -188,7 +194,7 @@ def test_version_locations(self, separator, string_value, expected_result):
         cfg.set_main_option("version_locations", string_value)
 
         if isinstance(expected_result, ValueError):
-            with expect_raises_message(ValueError, expected_result.args[0]):
+            with expect_raises_message(ValueError, str(expected_result), text_exact=True):
                 ScriptDirectory.from_config(cfg)
         else:
             s = ScriptDirectory.from_config(cfg)