Walk

Synthèse

Renvoie des noms de données dans une structure de répertoire et de base de données en parcourant l’arborescence du haut en bas ou de bas en haut. Chaque répertoire ou espace de travail donne un tuple de trois : chemin de répertoire, noms de répertoire et noms de fichier.

Discussion

Le module os inclut une fonction os.walk qui peut être utilisée pour parcourir une arborescence de répertoires et trouver des données. La fonction os.walk est basée sur des fichiers et ne reconnaît pas le contenu des bases de données comme les classes d’entités, les tables ou les rasters des géodatabases. Pour optimiser les performances, il est recommandé d’utiliser os.walk pour les formats basés sur des fichiers. La fonction arcpy.da.Walk peut être utilisée pour cataloguer des données.

Syntaxe

Walk (top, {topdown}, {onerror}, {followlinks}, {datatype}, {type})
ParamètreExplicationType de données
top

The top-level workspace that will be used.

String
topdown

If topdown is True or not specified, the tuple for a directory is generated before the tuple for any of its workspaces (workspaces are generated trom the top down). If topdown is False, the tuple for a workspace is generated after the tuple for all of its subworkspaces (workspaces are generated from the bottom up).

When topdown is True, the dirnames list can be modified in place, and Walk will only recurse into the subworkspaces whose names remain in dirnames. This can be used to limit the search, impose a specific order of visiting, or inform Walk about directories the caller creates or renames before it resumes Walk again. Modifyingdirnames when topdown is False is ineffective, because in bottom-up mode, the workspaces indirnames are generated before dirpath is generated.

(La valeur par défaut est True)

Boolean
onerror

Errors are ignored by default. The onerror function will be called with an OSError instance.

This function can be used to report the error and continue with Walk or raise an exception to cancel.

Remarque :

The file name is available as the filename attribute of the exception object.

(La valeur par défaut est None)

Function
followlinks

By default, Walk does not visit connection files. Set followlinks to True to visit connection files.

(La valeur par défaut est False)

Boolean
datatype

Specifies the data type that will be used to limit the results.

  • AnyAll data types are returned. This is equivalent to using None or skipping the argument.
  • CadDrawingCAD files (.dwg, .dxf, and .dgn) are returned.
  • FeatureClassFeature classes in a geodatabase and shapefiles (.shp) are returned.
  • FeatureDatasetFeature datasets in a geodatabase are returned.
  • GeometricNetworkGeometric networks in a geodatabase are returned.
  • LasDatasetLAS dataset files (.las and .lasd) are returned.
  • LayerLayer files (.lyrx) are returned.
  • LocatorLocator files (.loc) are returned.
  • Map ArcGIS Pro projects (.aprx files), ArcGIS Pro map documents (.mapx files), and ArcMap documents (.mxd files) are returned.
  • MosaicDatasetMosaic datasets in a geodatabase are returned.
  • NetworkDatasetNetwork datasets in a geodatabase are returned.
  • RasterCatalogRaster catalogs in a geodatabase are returned.
  • RasterDatasetRaster datasets in a geodatabase or in a folder are returned.
  • RelationshipClassRelationship classes in a geodatabase are returned.
  • RepresentationClassRepresentation classes in a geodatabase are returned.
  • TableTables in a geodatabase or folder and sheets in Excel workbooks are returned.
  • TerrainTerrain datasets are returned.
  • TinTIN surfaces in a geodatabase are returned.
  • ToolTools in a toolbox are returned.
  • TopologyTopologies in a geodatabase are returned.

Multiple data types are supported if they're entered as a list or tuple.

for dirpath, dirnames, filenames in arcpy.da.Walk(workspace,
    datatype=['MosaicDataset', 'RasterDataset']):

(La valeur par défaut est None)

String
type

Specifies whether feature and raster data types will be further limited by type.

  • AllAll types are returned. This is equivalent to using None or skipping the argument.
  • AnyAll types are returned. This is equivalent to using None or skipping the argument.

Valid feature types are the following:

  • MultipatchMultipatch feature classes are returned.
  • MultipointMultipoint feature classes are returned.
  • PointPoint feature classes are returned.
  • PolygonPolygon feature classes are returned.
  • PolylinePolyline feature classes are returned.

Valid raster types are the following:

  • BIL Esri Band Interleaved by Line file
  • BIP Esri Band Interleaved by Pixel file
  • BMP Bitmap graphic raster dataset format
  • BSQ Esri Band Sequential file
  • DAT ENVI DAT file
  • GIF Graphic Interchange Format for raster datasets
  • GRID Esri Grid raster dataset format
  • IMG ERDAS IMAGINE raster data format
  • JP2 JPEG 2000 raster dataset format
  • JPG Joint Photographic Experts Group raster dataset format
  • PNG Portable Network Graphic raster dataset format
  • TIF Tag Image File Format for raster datasets

Multiple data types are supported if they're entered as a list or tuple.

for dirpath, dirnames, filenames in arcpy.da.Walk(workspace,
    datatype='FeatureClass', type=['Polygon', 'Polyline']):

(La valeur par défaut est None)

String
Valeur renvoyée
Type de donnéesExplication
Generator

Donne un tuple de trois qui inclut l'espace de travail, les noms de répertoires et les noms de fichiers.

  • dirpath est le chemin d’accès à l’espace de travail en tant que chaîne.
  • dirnames est une liste de noms de sous-répertoires et d’autres espaces de travail dans dirpath.
  • filenames est une liste de noms de contenu sans lien avec l’espace de travail dans dirpath.
Remarque :

Les noms dans les listes ne comprennent que le nom de base ; aucun composant du chemin n'est inclus. Pour obtenir le chemin complet (à partir de la racine) d’un fichier ou d’un répertoire dans dirpath, utilisez os.path.join(dirpath, name).

Exemple de code

Exemple 1 d'utilisation de la fonction Walk

Utilisez la fonction Walk pour cataloguer des classes d’entités surfaciques.

import arcpy
import os

workspace = "c:/data"
feature_classes = []

walk = arcpy.da.Walk(workspace, datatype="FeatureClass", type="Polygon")

for dirpath, dirnames, filenames in walk:
    for filename in filenames:
        feature_classes.append(os.path.join(dirpath, filename))
Exemple 2 d'utilisation de la fonction Walk

Utilisez la fonction Walk pour cataloguer des données raster. Les rasters qui se trouvent dans un dossier nommé back_up sont ignorés.

import arcpy
import os

workspace = "c:/data"
rasters = []

walk = arcpy.da.Walk(workspace, topdown=True, datatype="RasterDataset")

for dirpath, dirnames, filenames in walk:
    # Disregard any folder named 'back_up' in creating list of rasters
    if "back_up" in dirnames:
        dirnames.remove('back_up')
    for filename in filenames:
        rasters.append(os.path.join(dirpath, filename))

Rubriques connexes