Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve handling of prepend_sys_path, fixes #1330 #1331

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve handling of prepend_sys_path, fixes #1330 #1331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4b3782
Improve handling of prepend_sys_path
mwerezak Oct 19, 2023
50cad3d
Implement prepend_sys_path_separator
mwerezak Nov 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions alembic/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,25 @@ def messaging_opts(self) -> MessagingOptions:
),
)

def get_separator_char(self, name: str) -> Optional[str]:
separator = self.get_main_option(name)

split_on_path = {
None: None,
"space": " ",
"os": os.pathsep,
":": ":",
";": ";",
}

try:
return split_on_path[separator]
except KeyError as ke:
raise ValueError(
"'%s' is not a valid value for %s; "
"expected 'space', 'os', ':', ';'" % (separator, name)
) from ke


class MessagingOptions(TypedDict, total=False):
quiet: bool
Expand Down
52 changes: 22 additions & 30 deletions alembic/script/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,47 +175,39 @@ def from_config(cls, config: Config) -> ScriptDirectory:
version_locations_str = config.get_main_option("version_locations")
version_locations: Optional[List[str]]
if version_locations_str:
version_path_separator = config.get_main_option(
split_char = config.get_separator_char(
"version_path_separator"
)

split_on_path = {
None: None,
"space": " ",
"os": os.pathsep,
":": ":",
";": ";",
}

try:
split_char: Optional[str] = split_on_path[
version_path_separator
]
except KeyError as ke:
raise ValueError(
"'%s' is not a valid value for "
"version_path_separator; "
"expected 'space', 'os', ':', ';'" % version_path_separator
) from ke
if split_char is None:
# legacy behaviour for backwards compatibility
version_locations = _split_on_space_comma.split(
version_locations_str
)
else:
if split_char is None:
# legacy behaviour for backwards compatibility
version_locations = _split_on_space_comma.split(
version_locations_str
)
else:
version_locations = [
x for x in version_locations_str.split(split_char) if x
]
version_locations = [
x for x in version_locations_str.split(split_char) if x
]
else:
version_locations = None

prepend_sys_path = config.get_main_option("prepend_sys_path")
if prepend_sys_path:
sys.path[:0] = list(
_split_on_space_comma_colon.split(prepend_sys_path)
split_char = config.get_separator_char(
"prepend_sys_path_separator"
)

if split_char is None:
# legacy behaviour for backwards compatibility
sys.path[:0] = list(
_split_on_space_comma_colon.split(prepend_sys_path)
)
else:
sys.path[:0] = (
os.path.normpath(path.strip())
for path in prepend_sys_path.split(split_char)
)

rvl = config.get_main_option("recursive_version_locations") == "true"
return ScriptDirectory(
util.coerce_resource_to_filename(script_location),
Expand Down
Loading