Walk

サマリー

上から下または下から上にツリーを移動することによって、ディレクトリ構造とデータベース構造内のデータ名を返します。 各ディレクトリまたはワークスペースから、ディレクトリ パス、ディレクトリ名、ファイル名の 3 つの組み合わせが得られます。

説明

os モジュールには os.walk 関数が含まれています。これを使用して、ディレクトリ ツリーを移動し、データを検索することができます。 os.walk 関数はファイルベースで、ジオデータベース フィーチャクラス、テーブル、ラスターなどのデータベース コンテンツは認識しません。 パフォーマンス向上のため、ファイルベース形式には os.walk を使用することをお勧めします。 arcpy.da.Walk 関数を使用して、データをカタログ化できます。

構文

Walk (top, {topdown}, {onerror}, {followlinks}, {datatype}, {type})
パラメーター説明データ タイプ
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.

(デフォルト値は次のとおりです 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.

注意:

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

(デフォルト値は次のとおりです None)

Function
followlinks

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

(デフォルト値は次のとおりです 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']):

(デフォルト値は次のとおりです 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']):

(デフォルト値は次のとおりです None)

String
戻り値
データ タイプ説明
Generator

ワークスペース、ディレクトリ名、ファイル名の 3 つの組み合わせが得られます。

  • dirpath は、ワークスペースのパスを表す文字列です。
  • dirnames は、dirpath のサブディレクトリや他のワークスペースの名前のリストです。
  • filenames は、dirpath のワークスペース以外のコンテンツの名前のリストです。
注意:

リスト内の名前には、ベース名のみが含まれます。パス コンポーネントは含まれません。 dirpath のファイルまたはディレクトリの (先頭から始まる) 絶対パスを取得するには、os.path.join(dirpath, name) を使用します。

コードのサンプル

Walk の例 1

Walk 関数を使用して、ポリゴン フィーチャクラスをカタログ化します。

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))
Walk の例 2

Walk 関数を使用して、ラスター データをカタログ化します。 back_up という名前のフォルダー内のラスターは無視されます。

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))

関連トピック