Python - Wie schreibe ich einen Dekorateur, der die cwd wiederherstellt?

Question

Wie schreibe ich einen Dekorator, der das aktuelle Arbeitsverzeichnis auf das wiederherstellt, was es war, bevor die dekorierte Funktion aufgerufen wurde? Mit anderen Worten, wenn ich den Decorator für eine Funktion verwende, die ein os.chdir() ausführt, wird das cwd nicht geändert, nachdem die Funktion aufgerufen wurde.

Answer 1

Das path.py Modul verfügt über einen Kontext-Manager (die Sie wirklich mit Pfaden in Python-Skripte, wenn Umgang verwenden sollten):

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

#not anymore 

(Dank geht an this blog post von Rob erto Alsina)

Answer 2

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

Hier ist, wie es verwendet wird:

@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 

Answer 3

Die Antwort für einen Dekorateur gegeben wurde; Es funktioniert bei der Definition der Funktion wie gewünscht.

Mit Python 2.5+, Sie haben auch eine Option, dass Anruf Bühne an der Funktion zu tun, um einen Kontext-Manager:

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) 

, die verwendet werden können, wenn bei der Funktionsaufruf Zeit benötigt wie:

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

Es ist eine schöne Option zu haben.

EDIT: Ich fügte Fehlerbehandlung wie von Codeape vorgeschlagen hinzu. Da meine Antwort gewählt wurde, ist es fair, eine vollständige Antwort anzubieten, alle anderen Fragen beiseite.

Answer 4

Die angegebenen Antworten berücksichtigen nicht, dass die umbrochene Funktion eine Ausnahme auslösen kann. In diesem Fall wird das Verzeichnis niemals wiederhergestellt. Der folgende Code fügt die Ausnahmenbehandlung zu den vorherigen Antworten hinzu.

als Dekorateur:

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 

und als Kontext-Manager:

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