Skip to content

Better document env_case test/fixture and cwd #1657

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

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Better document env_case test/fixture and cwd #1657

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74d9c08
Better explain the env_case test
EliahKagan Sep 12, 2023
a59aaea
Condense an overly long comment
EliahKagan Sep 12, 2023
22b8dba
Improve git.util.cwd docstring
EliahKagan Sep 12, 2023
c547555
Clarify test relationship to env_case.py fixture
EliahKagan Sep 12, 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
Prev Previous commit
Next Next commit
Improve git.util.cwd docstring 
This frames the reentrancy claim in terms of what is similar to and
different from contextlib.chdir (which we would just use, but it is
only available on Python 3.11 and later).
  • Loading branch information
@EliahKagan
EliahKagan committed Sep 12, 2023
commit 22b8dba6b4c73d04f3dbfabbb858fb5316fec711
5 changes: 4 additions & 1 deletion git/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,10 @@ def wrapper(self: "Remote", *args: Any, **kwargs: Any) -> T:

@contextlib.contextmanager
def cwd(new_dir: PathLike) -> Generator[PathLike, None, None]:
"""Context manager to temporarily change directory. Not reentrant."""
"""Context manager to temporarily change directory.

This is similar to contextlib.chdir introduced in Python 3.11, but the context
manager object returned by a single call to this function is not reentrant."""
old_dir = os.getcwd()
os.chdir(new_dir)
try:
Expand Down