Bonne façon de nettoyer un dossier temporaire en Python classe

Je suis la création d'une classe dans laquelle je veux générer un espace de travail temporaire de dossiers qui seront conservés pour la durée de vie de l'objet et ensuite être retiré. Je suis à l'aide de fichier temporaire.mkdtemp() dans la def init pour créer de l'espace, mais j'ai lu que je ne peux pas compter sur del appelé.

Je suis désireux quelque chose comme ceci:

class MyClass:
  def __init__(self):
    self.tempfolder = tempfile.mkdtemp()

  def ... #other stuff

  def __del__(self):
    if os.path.exists(self.tempfolder): shutil.rmtree(self.tempfolder)

Est-il une autre/meilleure façon de gérer cela nettoyer? Je lisais à propos de "avec", mais il semble seulement être utile au sein d'une fonction.

Je pense que les seules solutions fiables impliquera toujours faire le nettoyage de manière explicite. Je ne pense pas que l'automatique fiable de nettoyage solution à envisager dans votre question, c'est possible.
faux: Python contexte, les gestionnaires sont exactement à cette fin.
même contexte, les gestionnaires doivent être explicitement entrée.
oui, mais vous avez toujours besoin pour ouvrir un fichier. Le point d'un gestionnaire de contexte est qu'il ne gère nettoyage.

InformationsquelleAutor Rob Hunter | 2012-11-14

40

Mise en garde: vous ne pouvez jamais garantie que le dossier temp sera supprimé, car l'utilisateur peut toujours dur de tuer vos processus et il ne peut pas exécuter quoi que ce soit d'autre.

Cela dit, ne
```
temp_dir = tempfile.mkdtemp()
try:
    <some code>
finally:
    shutil.rmtree(temp_dir)
```
Puisque c'est une opération très courante, Python a une façon particulière pour encapsuler "faire quelque chose, d'exécuter du code, clean up": un gestionnaire de contexte. Vous pouvez écrire votre propre comme suit:
```
@contextlib.contextmanager
def make_temp_directory():
    temp_dir = tempfile.mkdtemp()
    try:
        yield temp_dir
    finally:
        shutil.rmtree(temp_dir)
```
et l'utiliser comme
```
with make_temp_directory() as temp_dir:
    <some code>
```
(Notez que cette fonction utilise la @contextlib.contextmanager de raccourci pour créer un gestionnaire de contexte. Si vous souhaitez mettre en place une façon originale, vous avez besoin de faire une classe personnalisée avec __enter__ et __exit__ méthodes; l' __enter__ serait de créer et retourner le répertoire temp et le __exit__ le supprimer.
- Peut le gestionnaire de contexte persistent mon dossier temporaire pour la durée de vie de l'objet? Il semble qu'il serait de supprimer le dossier une fois que je quitte la "avec la" déclaration. Je suppose que je pourrais passer le dossier dans mon objet en tant que paramètre, mais je m'attendais à encapsuler le dossier temporaire au sein de la classe.
- Le définition de la with déclaration est qu'elle ferme l'objet lorsque vous le quittez. Si vous voulez que votre répertoire temp de fermer quelque part d'autre, vous devez fermer explicitement il y et de gérer les exceptions de vous-même.
- J'aime la façon dont cela fonctionne, maintenant que j'ai refait mon code pour utiliser le contextmanager.
- Heureux de l'apprendre =)
- Le gestionnaire de contexte fonctionne très bien pour moi, mais j'ai dû ajouter un essai: enfin: autour du rendement ou sinon il ne serait pas nettoyer si le code à l'aide de la temp dir soulève une exception. Peut-être documenté quelque part ou peut-être différents entre les versions de python, mais j'ai pensé que je le mentionne.
- Ce comportement est documentée: "Si une exception non gérée se produit dans le bloc, il est surrelance à l'intérieur du générateur au point où le rendement est produite. Ainsi, vous pouvez utiliser un try...except...finally déclaration pour intercepter l'erreur (le cas échéant), ou à faire en sorte que le nettoyage a lieu."
- Notez que Python 3.2 ajouté tempfile.TemporaryDirectory() qui fait la même chose que cette réponse montre. Pour 3.2 et versions plus récentes je voudrais utiliser le module de bibliothèque de code; pour les anciennes versions de Python je voudrais utiliser ce code, mais je voudrais renommer la fonction de TemporaryDirectory() et le document qu'il est similaire à la 3.2 code. docs.python.org/3/library/tempfile.html
InformationsquelleAutor Katriel
11

Une belle façon de traiter avec des fichiers temporaires et des répertoires est par l'intermédiaire d'un gestionnaire de contexte. C'est de cette façon que vous pouvez utiliser tempfile.TemporaryFile ou tempfile.NamedTemporaryFile -- une fois que vous avez quitté le with déclaration (via la sortie normale, de retour, d'exception, ou quoi que ce soit d'autre) le fichier/répertoire et son contenu seront supprimés à partir du système de fichiers.

Pour Python 3.2+, c'est construit comme tempfile.TemporaryDirectory:
```
import tempfile

with tempfile.TemporaryDirectory() as temp_dir:
    ... do stuff ...
```
Pour les précédentes versions de Python, vous pouvez facilement créer votre propre gestionnaire de contexte pour faire exactement la même chose. Les différences de @katrielalex réponse sont le passage d'arguments pour mkdtemp() et le try/finally bloc assurez-vous que le répertoire obtient nettoyé si une exception est levée.
```
import contextlib
import shutil

@contextlib.contextmanager
def temporary_directory(*args, **kwargs):
    d = tempfile.mkdtemp(*args, **kwargs)
    try:
        yield d
    finally:
        shutil.rmtree(d)


# use it
with temporary_directory() as temp_dir:
    ... do stuff ...
```
Notez que si votre processus est dur tué (par exemple. kill -9) puis les répertoires ne le seront pas nettoyés.

InformationsquelleAutor rcoup
2

Comme l'a déclaré Bluewind vous avez à faire assurez-vous d'envelopper le rendement de la part du gestionnaire de contexte à l'intérieur d'un essai: instruction enfin sinon aucune exception ne sera pas manipulé correctement à l'intérieur du gestionnaire de contexte.

De Python 2.7 docs

Au point où le générateur génère, le bloc imbriqué dans l'instruction est exécutée. Le générateur est ensuite repris après le bloc est fermé. Si une exception non gérée se produit dans le bloc, il est surrelance à l'intérieur du générateur au point où le rendement est produite. Ainsi, vous pouvez utiliser un try...except...enfin relevé pour intercepter l'erreur (le cas échéant), ou à faire en sorte que le nettoyage a lieu. Si une exception est pris au piège dans le seul but de les enregistrer dans un fichier ou d'effectuer une action (plutôt que de la supprimer entièrement), le générateur doit relancer cette exception. Sinon, le générateur gestionnaire de contexte indique à l'instruction que l'exception n'a été manipulée, et l'exécution reprend à l'instruction qui suit immédiatement l'instruction.

Aussi, si vous êtes à l'aide de Python 3.2+ vous devriez vérifier ce petit bijou qui dispose de tous les ci-dessus enveloppé bien pour vous

tempfile.TemporaryDirectory(suffixe=", prefix='tmp', dir=None)

Cette fonction crée un répertoire temporaire à l'aide de mkdtemp() (les arguments fournis sont directement transmises à la fonction sous-jacente). L'objet résultant peut être utilisé comme un gestionnaire de contexte (voir Avec l'Énoncé de Contexte Gestionnaires). À l'achèvement du cadre (ou de la destruction du répertoire temporaire de l'objet), viennent de créer le répertoire temporaire et l'ensemble de son contenu sont supprimés à partir du système de fichiers.

Le nom du répertoire peut être récupéré à partir de l'attribut name de l'objet retourné.

Le répertoire peut être explicitement nettoyé par l'appel de la méthode cleanup ().

Nouveau dans la version 3.2.

InformationsquelleAutor Necrolyte2

Une autre alternative à l'aide contextlib est de faire de votre objet refermable, et l'utilisation de la fermeture gestionnaire de contexte.

class MyClass:
    def __init__(self):
        self.tempfolder = tempfile.mkdtemp()

    def do_stuff():
        pass

    def close(self):
        if os.path.exists(self.tempfolder):
            shutil.rmtree(self.tempfolder)

Puis avec le gestionnaire de contexte:

from contextlib import closing

with closing(MyClass()) as my_object:
    my_object.do_stuff()

InformationsquelleAutor Peter Wood

1

D'autres réponses ont noté que vous pouvez utiliser un contextmanager ou besoin de vos utilisateurs à appeler explicitement un certain type de fonction nettoyage. Ce sont de grand à faire si vous le pouvez. Cependant, parfois, il n'y a pas à s'accrocher cette de nettoyage parce que vous êtes à l'intérieur d'une grande application et vous sont imbriqués plusieurs couches vers le bas, et personne au dessus de vous a des méthodes de nettoyage ou de contexte, les gestionnaires.

Dans ce cas, vous pouvez utiliser atexit: https://docs.python.org/2/library/atexit.html
```
import atexit

class MyClass:
  def __init__(self):
    self.tempfolder = tempfile.mkdtemp()
    atexit.register(shutil.rmtree, self.tempfolder)

  def ... #other stuff
```
InformationsquelleAutor crouleau

Vous devez vous connecter pour publier un commentaire.