DESCRIPTION.

Retourne le contenu d'un répertoire, d'un dossier.

SYNTAXE.

LST_Variable = os.listdir ( chemin )

LST_Variable = ⇨ variable qui recevra la valeur [ optionnel ]

os.listdir ( ) ⇨ appel de la méthode [ OBLIGATOIRE ]

chemin ⇨ emplacement [ OBLIGATOIRE ]

REMARQUES.

chemin doit être un str ( ), ou un bytes ( ), identifiant le chemin d'un répertoire valide. chemin peut être exprimé en : 

- chemin absolu, par exemple, sous Linux, "/home/origine/Documents" ;

- chemin relatif, par exemple, sous Linux, "./Programmes" pour le dossier Programmes dans le répertoire de travail actuel.

L'appel de la méthode os.listdir ( ) retourne une list ( ), dont les éléments sont : soit des noms fichier ; soit des noms de sous-répertoire, dans un ordre indéterminé, en incluant d'éventuels éléments cachés. Si elles se trouvent dans chemin, les représentations spéciales "." et ".." ne seront inclus dans la list ( ) retournée.

Si chemin est exprimé avec un objet de type bytes ( ), les éléments de chemin seront aussi du type bytes ( ), dans les autres cas, ils seront sous une forme str ( ).

Si la composition de chemin est modifiée, par exemple avec la création ou la suppression d'un élément, durant l'appel de la méthode os.listdir ( ), cette modification ne sera pas prise en compte dans la list ( ) retournée.

Depuis Python 3.3, chemin peut faire référence à un descripteur de fichier, si ce descripteur est associé à un répertoire ouvert et non à un fichier ouvert.

Si chemin est omis, la méthode os.listdir ( ) retournera le contenu du répertoire de travail.

Si chemin n'existe pas, Python lèvera une exception.

Il est fortement coneillé d'utiliser la méthode os.scandir ( ) pour connaitre le contenu d'un emplacement. Celle-ci retournant, en plus des éléments présents, leur attributs, permettant une analyse plus pertinente, dans la plus par des utilisations de ces informations.

EXEMPLE.

import os

for kelement in os.listdir ( os.getcwd ( ) ) : print ( kelement )

for kelement in os.scandir ( os.getcwd ( ) ) : print ( kelement )