native

A built-in module to support native rules and other package helper functions. All native rules appear as functions in this module, e.g. native.cc_library. Note that the native module is only available in the loading phase (i.e. for macros, not for rule implementations). Attributes will ignore None values, and treat them as if the attribute was unset.
The following functions are also available:

Members

• existing_rule
• existing_rules
• exports_files
• glob
• module_name
• module_version
• package_group
• package_name
• package_relative_label
• repo_name
• repository_name
• subpackages

existing_rule

unknown native.existing_rule(name)

Here, an immutable dict-like object means a deeply immutable object x supporting dict-like iteration, len(x), name in x, x[name], x.get(name), x.items(), x.keys(), and x.values().

The result contains an entry for each attribute, with the exception of private ones (whose names do not start with a letter) and a few unrepresentable legacy attribute types. In addition, the dict contains entries for the rule instance's name and kind (for example, 'cc_binary').

The values of the result represent attribute values as follows:

• Attributes of type str, int, and bool are represented as is.
• Labels are converted to strings of the form ':foo' for targets in the same package or '//pkg:name' for targets in a different package.
• Lists are represented as tuples, and dicts are converted to new, mutable dicts. Their elements are recursively converted in the same fashion.
• select values are returned with their contents transformed as described above.
• Attributes for which no value was specified during rule instantiation and whose default value is computed are excluded from the result. (Computed defaults cannot be computed until the analysis phase.).

If possible, use this function only in implementation functions of rule finalizer symbolic macros. Use of this function in other contexts is not recommened, and will be disabled in a future Bazel release; it makes BUILD files brittle and order-dependent. Also, beware that it differs subtly from the two other conversions of rule attribute values from internal form to Starlark: one used by computed defaults, the other used by ctx.attr.foo.

Parameters

existing_rules

unknown native.existing_rules()

Here, an immutable dict-like object means a deeply immutable object x supporting dict-like iteration, len(x), name in x, x[name], x.get(name), x.items(), x.keys(), and x.values().

If possible, use this function only in implementation functions of rule finalizer symbolic macros. Use of this function in other contexts is not recommened, and will be disabled in a future Bazel release; it makes BUILD files brittle and order-dependent.

exports_files

None native.exports_files(srcs, visibility=None, licenses=None)

Parameters

glob

sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

• Matches at least one pattern in include.
• Does not match any of the patterns in exclude (default []).

Parameters

module_name

string native.module_name()

module_version

string native.module_version()

package_group

None native.package_group(name, packages=[], includes=[])

Parameters

package_name

string native.package_name()

package_relative_label

Label native.package_relative_label(input)

This function may only be called while evaluating a BUILD file and the macros it directly or indirectly calls; it may not be called in (for instance) a rule implementation function.

The result of this function is the same Label value as would be produced by passing the given string to a label-valued attribute of a target declared in the BUILD file.

Usage note: The difference between this function and Label() is that Label() uses the context of the package of the .bzl file that called it, not the package of the BUILD file. Use Label() when you need to refer to a fixed target that is hardcoded into the macro, such as a compiler. Use package_relative_label() when you need to normalize a label string supplied by the BUILD file to a Label object. (There is no way to convert a string to a Label in the context of a package other than the BUILD file or the calling .bzl file. For that reason, outer macros should always prefer to pass Label objects to inner macros rather than label strings.)

Parameters

repo_name

string native.repo_name()

repository_name

string native.repository_name()

The canonical name of the repository containing the package currently being evaluated, with a single at-sign (@) prefixed. For example, in packages that are called into existence by the WORKSPACE stanza local_repository(name='local', path=...) it will be set to @local. In packages in the main repository, it will be set to @.

subpackages

sequence native.subpackages(include, exclude=[], allow_empty=False)

Parameters