walk

os.walk

object walk

Recursively walks the given folder and returns the paths of every file or folder within.

You can pass in a skip callback to skip files or folders you are not interested in. This can avoid walking entire parts of the folder hierarchy, saving time as compared to filtering them after the fact.

By default, the paths are returned as a pre-order traversal: the enclosing folder is occurs first before any of it's contents. You can pass in preOrder = false to turn it into a post-order traversal, such that the enclosing folder occurs last after all it's contents.

os.walk returns but does not follow symlinks; pass in followLinks = true to override that behavior. You can also specify a maximum depth you wish to walk via the maxDepth parameter.

Attributes

Graph
Supertypes: class Object

trait Matchable

class Any
Self type: walk.type

Members list

Type members

Classlikes

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: stream.type

Value members

Concrete methods

Value parameters

followLinks: Whether or not to follow symlinks while walking; defaults to false
includeTarget: Whether or not to include the given path as part of the walk. If true, does not raise an error if the given path is a simple file and not a folder
maxDepth: The max depth of the tree you wish to walk; defaults to unlimited
path: the root path whose contents you wish to walk
preOrder: Whether you want a folder to appear before or after its contents in the final sequence. e.g. if you're deleting them recursively you want it to be false so the folder gets deleted last, but if you're copying them recursively you want preOrder to be true so the folder gets created first.
skip: Skip certain files or folders from appearing in the output. If you skip a folder, its entire subtree is ignored

Attributes

Value parameters

followLinks: Whether or not to follow symlinks while walking; defaults to false
includeTarget: Whether or not to include the given path as part of the walk. If true, does not raise an error if the given path is a simple file and not a folder
maxDepth: The max depth of the tree you wish to walk; defaults to unlimited
path: the root path whose contents you wish to walk
preOrder: Whether you want a folder to appear before or after its contents in the final sequence. e.g. if you're deleting them recursively you want it to be false so the folder gets deleted last, but if you're copying them recursively you want preOrder to be true so the folder gets created first.
skip: Skip certain files or folders from appearing in the output. If you skip a folder, its entire subtree is ignored

Attributes

In this article

Generated with