Public API

file_exists

Check whether a file exists.

Useful in macros to set defaults for a configuration file if it is present. This can only be called during the loading phase, not from a rule implementation.

PARAMETERS

Name	Description	Default Value
path	a label, or a string which is a path relative to this package	none

glob_directories

PARAMETERS

Name	Description	Default Value
include	-	none
kwargs	-	none

is_external_label

Returns True if the given Label (or stringy version of a label) represents a target outside of the workspace

PARAMETERS

Name	Description	Default Value
param	a string or label	none

RETURNS

a bool

path_to_workspace_root

Returns the path to the workspace root under bazel

RETURNS

Path to the workspace root

propagate_well_known_tags

Returns a list of tags filtered from the input set that only contains the ones that are considered “well known”

These are listed in Bazel's documentation: https://docs.bazel.build/versions/main/test-encyclopedia.html#tag-conventions https://docs.bazel.build/versions/main/be/common-definitions.html#common-attributes

PARAMETERS

Name	Description	Default Value
tags	List of tags to filter	[]

RETURNS

List of tags that only contains the well known set

to_label

Converts a string to a Label. If Label is supplied, the same label is returned.

PARAMETERS

Name	Description	Default Value
param	a string representing a label or a Label	none

RETURNS

a Label