如何编写一个恢复 cwd 的装饰器？

Question

如何编写一个装饰器，将当前工作目录恢复到调用装饰函数之前的状态？ 换句话说，如果我在执行 os.chdir() 的函数上使用装饰器，则调用函数后 cwd 将不会更改。

Answer 1

装饰器的答案已经给出了； 它按照要求在函数定义阶段工作。

使用 Python 2.5+，您还可以选择使用上下文管理器在函数调用阶段执行此操作：

from __future__ import with_statement # needed for 2.5 ≤ Python < 2.6
import contextlib, os

@contextlib.contextmanager
def remember_cwd():
    curdir= os.getcwd()
    try: yield
    finally: os.chdir(curdir)

如果需要，可以在函数调用时使用它，因为：

print "getcwd before:", os.getcwd()
with remember_cwd():
    walk_around_the_filesystem()
print "getcwd after:", os.getcwd()

这是一个不错的选择。

编辑：我按照 codeape 的建议添加了错误处理。 由于我的答案已被投票通过，因此可以公平地提供完整的答案，抛开所有其他问题。

Answer 2

path.py 模块（如果处理 python 脚本中的路径，你确实应该使用它）有一个上下文管理器：（

subdir = d / 'subdir' #subdir is a path object, in the path.py module
with subdir:
  # here current dir is subdir

#not anymore

感谢 Roberto Alsina 的这篇博文）

Answer 3

给出的答案没有考虑到包装函数可能会引发异常。 在这种情况下，该目录将永远不会被恢复。 下面的代码在前面的答案中添加了异常处理。

作为装饰器：

def preserve_cwd(function):
    @functools.wraps(function)
    def decorator(*args, **kwargs):
        cwd = os.getcwd()
        try:
            return function(*args, **kwargs)
        finally:
            os.chdir(cwd)
    return decorator

以及作为上下文管理器：

@contextlib.contextmanager
def remember_cwd():
    curdir = os.getcwd()
    try:
        yield
    finally:
        os.chdir(curdir)

Answer 4

你不需要为你写它。 在 python 3.11 中，开发人员已经为您编写了它。 在 github.com 上查看代码。

import contextlib
with contextlib.chdir('/path/to/cwd/to'):
    pass

Answer 5

def preserve_cwd(function):
   def decorator(*args, **kwargs):
      cwd = os.getcwd()
      result = function(*args, **kwargs)
      os.chdir(cwd)
      return result
   return decorator

它的使用方法如下：

@preserve_cwd
def test():
  print 'was:',os.getcwd()
  os.chdir('/')
  print 'now:',os.getcwd()

>>> print os.getcwd()
/Users/dspitzer
>>> test()
was: /Users/dspitzer
now: /
>>> print os.getcwd()
/Users/dspitzer