Publicly expose `shutil.ReadError` and `shutil.RegistryError`
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Bug report
Bug description
shutil.ReadError and shutil.RegistryError are not included in shutil.__all__, making them inaccessible via wildcard import. Both exceptions are actively raised by public API functions:
ReadErroris raised byunpack_archive()RegistryErroris raised byregister_unpack_format()
The other shutil exceptions (Error, SameFileError, SpecialFileError) are all in __all__.
>>> from shutil import *
>>> try:
... unpack_archive("nonexistent.zip")
... except ReadError:
... pass
...
NameError: name 'ReadError' is not defined. Did you mean: 'KeyError'?
Impact
from shutil import *does not exportReadErrororRegistryError, so users cannot catch exceptions raised byunpack_archive()orregister_unpack_format()without explicitly importing them by name.- Neither exception is documented in
Doc/library/shutil.rst, while the other three shutil exceptions (Error,SameFileError,SpecialFileError) all have dedicated.. exception::entries. - Tools that rely on
__all__for API discovery (linters, IDE autocompletion, documentation generators) will not surface these exceptions.
This was introduced in commit 6ac91723bd7 (bpo-8295, 2010) which added the archive functions and exceptions but did not add ReadError or RegistryError to __all__. A later fix for incomplete __all__ (#66855, 2014) added SameFileError but missed these two.
Verified on Python 3.14.3 in a clean venv.
Proposed fix
Add "ReadError" and "RegistryError" to __all__ in Lib/shutil.py, and add .. exception:: entries in Doc/library/shutil.rst to document them alongside the other exceptions.
CPython versions tested on:
3.14
Operating system:
All
Linked PRs
- gh-148004
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez all dans Lib/shutil.py et les entrées d’exception dans Doc/library/shutil.rst, puis consultez la PR liée gh-148004 avant de commencer. Vérifiez que les deux exceptions sont exposées par une importation avec joker et documentées avec les autres exceptions de shutil.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api, documentation
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 30/100