os.stat()’s follow_symlinks is a bit ambigously described
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 36k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
There are numerous functions which take a pathname and and argument like follow_symlinks.
For most of these, the argument follow_symlinks is not further explained in the function itself, but people will rather have to resort to https://docs.python.org/3/library/os.html#files-and-directories where things are rather exactly described.
However, the description of os.stat() has:
This function normally follows symlinks; to stat a symlink add the argument follow_symlinks=False, or use lstat().
Which is however only half correct, because what it actually means is:
When the last component of the path is a symbolic link, the function normally follows it. Symbolic links in the path that are not the last component, are always followed.
Similar, the paragraph below for windows, also uses wording that implies any name-surrogate reparse points, i.e. not only if the last pathname component is one.
No idea what Windows does, but if that's also wrong, it should be corrected accordingly. Also in the "Changed in" entry for that.
AFAICS, the other functions of os have it correctly described (by simply not describing it).
Thanks,
Chris.
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
Commencez par la documentation de os.stat() et la section liée Files and Directories. Précisez que follow_symlinks s’applique au dernier composant du chemin, puis vérifiez et corrigez si nécessaire la formulation correspondante pour Windows et l’entrée Changed in ; la documentation doit décrire correctement les deux comportements.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100