package builtin

Get desktop application:
View/edit binary Protocol Buffers messages

ApiContext specifies the context(s) in which a symbol is available. For example, a symbol may be available as a builtin only in .bzl files, but not in BUILD files.

Used in: Value

• ALL = 0

• BZL = 1

• BUILD = 2

Top-level object for all BUILD and Starlark builtin modules. Globals contains a list of all builtin variables, functions and packages (e.g. "java_common" and "native" will be included, same as "None" and "dict"). Types contains a list of all builtin packages (e.g. "java_common" and "native"). All types should be uniquely named.

• repeated Type type = 1

• repeated Value global = 2

Used in: Value

• repeated Param param = 1

• string return_type = 2

  Name of the return type.

Used in: Callable

• string name = 1

• string type = 2

  Parameter type represented as a name.

• string doc = 3

  Parameter documentation.

• string default_value = 4

  Default value for the parameter, written as Starlark expression (e.g. "False", "True", "[]", "None")

• bool is_mandatory = 5

  Whether the param is mandatory or optional.

• bool is_star_arg = 6

  Whether the param is a star argument.

• bool is_star_star_arg = 7

  Whether the param is a star-star argument.

Representation for Starlark builtin packages. It contains all the symbols (variables and functions) exposed by the package. E.g. "list" is a Type that exposes a list of fields containing: "insert", "index", "remove" etc.

Used in: Builtins

• string name = 1

• repeated Value field = 2

  List of fields and methods of this type. All such entities are listed as fields, and methods are fields which are callable.

• string doc = 3

  Module documentation.

Generic representation for a Starlark object. If the object is callable (can act as a function), then callable will be set.

Used in: Builtins, Type

• string name = 1

• string type = 2

  Name of the type.

• optional Callable callable = 3

  Set when the object is a function.

• string doc = 4

  Value documentation.

• ApiContext api_context = 5

  The context(s) in which the symbol is recognized.