bpo-25625: add contextlib.chdir by FFY00 · Pull Request #28271 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions Doc/library/contextlib.rst
19 changes: 18 additions & 1 deletion Lib/contextlib.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"""Utilities for with-statement contexts. See PEP 343."""
import abc
import os
import sys
import _collections_abc
from collections import deque
Expand All @@ -9,7 +10,8 @@
__all__ = ["asynccontextmanager", "contextmanager", "closing", "nullcontext",
"AbstractContextManager", "AbstractAsyncContextManager",
"AsyncExitStack", "ContextDecorator", "ExitStack",
"redirect_stdout", "redirect_stderr", "suppress", "aclosing"]
"redirect_stdout", "redirect_stderr", "suppress", "aclosing",
"chdir"]


class AbstractContextManager(abc.ABC):
Expand Down Expand Up @@ -754,3 +756,18 @@ async def __aenter__(self):

async def __aexit__(self, *excinfo):
pass


class chdir(AbstractContextManager):
"""Non thread-safe context manager to change the current working directory."""

def __init__(self, path):
self.path = path
self._old_cwd = []
Comment thread
warsaw marked this conversation as resolved.

def __enter__(self):
self._old_cwd.append(os.getcwd())
os.chdir(self.path)

def __exit__(self, *excinfo):
os.chdir(self._old_cwd.pop())
43 changes: 43 additions & 0 deletions Lib/test/test_contextlib.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""Unit tests for contextlib.py, and other context managers."""

import io
import os
import sys
import tempfile
import threading
Expand Down Expand Up @@ -1080,5 +1081,47 @@ def test_cm_is_reentrant(self):
1/0
self.assertTrue(outer_continued)


class TestChdir(unittest.TestCase):
def test_simple(self):
old_cwd = os.getcwd()
target = os.path.join(os.path.dirname(__file__), 'data')
self.assertNotEqual(old_cwd, target)

with chdir(target):
self.assertEqual(os.getcwd(), target)
self.assertEqual(os.getcwd(), old_cwd)

def test_reentrant(self):
old_cwd = os.getcwd()
target1 = os.path.join(os.path.dirname(__file__), 'data')
target2 = os.path.join(os.path.dirname(__file__), 'ziptestdata')
self.assertNotIn(old_cwd, (target1, target2))
chdir1, chdir2 = chdir(target1), chdir(target2)

with chdir1:
self.assertEqual(os.getcwd(), target1)
with chdir2:
self.assertEqual(os.getcwd(), target2)
with chdir1:
self.assertEqual(os.getcwd(), target1)
self.assertEqual(os.getcwd(), target2)
self.assertEqual(os.getcwd(), target1)
self.assertEqual(os.getcwd(), old_cwd)

def test_exception(self):
old_cwd = os.getcwd()
target = os.path.join(os.path.dirname(__file__), 'data')
self.assertNotEqual(old_cwd, target)

try:
with chdir(target):
self.assertEqual(os.getcwd(), target)
raise RuntimeError("boom")
except RuntimeError as re:
self.assertEqual(str(re), "boom")
self.assertEqual(os.getcwd(), old_cwd)


if __name__ == "__main__":
unittest.main()