python / python/cpython

Promote _delete member of TemporaryDirectory to delete

Ouverte
#128,397 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

stdlib type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Feature or enhancement

Proposal:

TemporaryDirectory.__delete__ gained a delete parameter to support retaining temporary files for diagnostic purposes.

In a running system, you may wish gather diagnostic files on failure, or when a specific signal is received. Supporting this fully requires allowing the decision of whether to delete files to be made after the TemporaryDirectory has been __enter__ed.

Assigning to _delete can achieve this effect, but _delete is not part of the public interface.

Therefore, I propose changing TemporaryDirectory._delete to TemporaryDirectory.delete.

Example use to retain temporary files on error:

with TemporaryDirectory() as temp_dir:
    try:
        thing_that_may_raise()
    except Exception:
        temp_dir.delete = False
        raise

Alternatives considered:

  • Provide a function to control this behaviour
    • We can always turn delete into a property if necessary
  • Users can provide subclasses of TemporaryDirectory to achieve this
    • Temporary Directory doesn't have enough of a public API for this to be viable. Using the private API would be morally equivalent to modifying _delete, and modifying _delete would be easier.
  • Users can provide a wrapper to prevent __exit__ from being called
    • __del__ might be implemented in the future, as it is for TemporaryFile.
Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Linked PRs
  • gh-128643

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par TemporaryDirectory et son cycle de vie enter/exit, en vous concentrant sur la manière dont la décision de suppression est stockée et utilisée après l’entrée dans le contexte. Consultez la PR liée gh-128643 pour examiner le travail déjà en cours ; le travail est terminé lorsque l’attribut public delete permet de modifier le comportement de nettoyage après enter.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
operating-systems
Type d'issue
Fonctionnalité
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.