ExpandedDirectory

Report an issue View source Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Represents an expanded directory that makes the files within the it directly accessible.

Members

basename

string ExpandedDirectory.basename

The base name of this file. This is the name of the file inside the directory.

children

list ExpandedDirectory.children

Contains the files within the directory.

directory

File ExpandedDirectory.directory

The input directory that was expanded.

dirname

string ExpandedDirectory.dirname

The name of the directory containing this file. It's taken from path and is always relative to the execution directory.

extension

string ExpandedDirectory.extension

The file extension of this file, following (not including) the rightmost period. Empty string if the file's basename includes no periods.

is_directory

bool ExpandedDirectory.is_directory

Returns true if this is a directory. This reflects the type the file was declared as (i.e. ctx.actions.declare_directory), not its type on the filesystem, which might differ.

is_source

bool ExpandedDirectory.is_source

Returns true if this is a source file, i.e. it is not generated. 

bool ExpandedDirectory.is_symlink

Returns true if this was declared as a symlink. This reflects the type the file was declared as (i.e. ctx.actions.declare_symlink), not its type on the filesystem, which might differ.

owner

Label ExpandedDirectory.owner

A label of a target that produces this File. May return None.

path

string ExpandedDirectory.path

The execution path of this file, relative to the workspace's execution directory. It consists of two parts, an optional first part called the root (see also the root module), and the second part which is the short_path. The root may be empty, which it usually is for non-generated files. For generated files it usually contains a configuration-specific path fragment that encodes things like the target CPU architecture that was used while building said file. Use the short_path for the path under which the file is mapped if it's in the runfiles of a binary.

root

root ExpandedDirectory.root

The root beneath which this file resides.

short_path

string ExpandedDirectory.short_path

The path of this file relative to its root. This excludes the aforementioned root, i.e. configuration-specific fragments of the path. This is also the path under which the file is mapped if it's in the runfiles of a binary.

tree_relative_path

string ExpandedDirectory.tree_relative_path

The path of this file relative to the root of the ancestor's tree, if the ancestor's is_directory field is true. tree_relative_path is only available for expanded files of a directory in an action command, i.e. Args.add_all(). For other types of files, it is an error to access this field.