package stardoc_output

Get desktop application:
View/edit binary Protocol Buffers messages

Representation of a Starlark aspect definition.

Used in: ModuleInfo

• string aspect_name = 1

  The name under which the aspect is made accessible to a user of this module, including any structs it is nested in, for example "foo.foo_aspect".

• string doc_string = 2

  The documentation string of the aspect.

• repeated string aspect_attribute = 3

  The rule attributes along which the aspect propagates.

• repeated AttributeInfo attribute = 4

  The attributes of the aspect.

• optional OriginKey origin_key = 5

  The module where and the name under which the aspect was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.

Representation of a Starlark rule, repository rule, or module extension tag attribute definition, comprised of an attribute name, and a schema defined by a call to one of the 'attr' module methods enumerated at https://bazel.build/rules/lib/toplevel/attr.

Used in: AspectInfo, MacroInfo, ModuleExtensionTagClassInfo, RepositoryRuleInfo, RuleInfo

• string name = 1

  The name of the attribute.

• string doc_string = 2

  The documentation string of the attribute, supplied via the 'doc' parameter to the schema-creation call.

• AttributeType type = 3

  The type of the attribute, defined generally by which function is invoked in the attr module.

• bool mandatory = 4

  If true, all targets of the rule must specify a value for this attribute.

• repeated ProviderNameGroup provider_name_group = 5

  The target(s) in this attribute must define all the providers of at least one of the ProviderNameGroups in this list. If the Attribute Type is not a label, a label list, or a label-keyed string dictionary, the field will be left empty. For attributes of a repository rule or a module extension tag, this attribute is meaningless and may be ignored. TODO(b/290788853): ensure this field is always empty for attributes of a repository rule or a module extension tag.

• string default_value = 6

  The string representation of the default value of this attribute.

• bool nonconfigurable = 7

  If true, the attribute is non-configurable.

• bool natively_defined = 8

  If true, the attribute is defined in Bazel's native code, not in Starlark.

Representation of a Starlark rule attribute type. These generally have a one-to-one correspondence with functions defined at https://bazel.build/rules/lib/toplevel/attr.

Used in: AttributeInfo

• UNKNOWN = 0

• NAME = 1

  A special case of STRING; all rules have exactly one implicit attribute "name" of type NAME.

• INT = 2

• LABEL = 3

• STRING = 4

• STRING_LIST = 5

• INT_LIST = 6

• LABEL_LIST = 7

• BOOLEAN = 8

• LABEL_STRING_DICT = 9

• STRING_DICT = 10

• STRING_LIST_DICT = 11

• OUTPUT = 12

• OUTPUT_LIST = 13

• LABEL_DICT_UNARY = 14

• LABEL_LIST_DICT = 15

Used in: StarlarkFunctionInfo

• string doc_string = 1

  The documented deprecation of the function (if specified in the function's docstring).

Representation of a Starlark function parameter definition.

Used in: StarlarkFunctionInfo

• string name = 1

  The name of the parameter. This does *not* include the `*` or `**` prefix for varargs or residual keyword argument parameters.

• string doc_string = 2

  The documented description of the parameter (if specified in the function's docstring).

• string default_value = 3

  If not an empty string, the default value of the parameter displayed as a string.

• bool mandatory = 4

  If true, the default value is unset and a value is needed for this parameter. This might be false even if defaultValue is empty in the case of special parameter such as *args and **kwargs"

• FunctionParamRole role = 5

  The parameter's syntactic role.

Representation of the syntactic role of a given function parameter.

Used in: FunctionParamInfo

• PARAM_ROLE_UNSPECIFIED = 0

• PARAM_ROLE_ORDINARY = 1

  An ordinary parameter which may be used as a positional or by keyword.

• PARAM_ROLE_POSITIONAL_ONLY = 2

  A positional-only parameter; such parameters cannot be defined in pure Starlark code, but exist in some natively-defined functions.

• PARAM_ROLE_KEYWORD_ONLY = 3

  A keyword-only parameter, i.e. a non-vararg/kwarg parameter that follows `*` or `*args` in the function's declaration.

• PARAM_ROLE_VARARGS = 4

  Residual varargs, typically `*args` in the function's declaration.

• PARAM_ROLE_KWARGS = 5

  Residual keyword arguments, typically `**kwargs` in the function's declaration.

Used in: StarlarkFunctionInfo

• string doc_string = 1

  The documented return value of the function (if specified in the function's docstring).

Representation of a Starlark symbolic macro definition. Note: symbolic macros (and thus, their documentation format) are an experimental feature gated by the --experimental_enable_first_class_macros flag.

Used in: ModuleInfo

• string macro_name = 1

  The name under which the macro is made accessible to a user of this module, including any structs it is nested in, for example "foo.foo_library".

• string doc_string = 2

  The documentation string of the macro.

• repeated AttributeInfo attribute = 3

  The attributes of the macro.

• optional OriginKey origin_key = 4

  The module where and the name under which the macro was originally declared.

• bool finalizer = 5

  True if this macro is a rule finalizer.

Representation of a Bazel module extension, i.e. the object returned by calling `module_extension(...)`. Note: legacy Stardoc (0.5.x and earlier) does not emit this message.

Used in: ModuleInfo

• string extension_name = 1

  The name under which the extension is made accessible to a user of this Starlark module.

• string doc_string = 2

  The documentation string of the extension.

• repeated ModuleExtensionTagClassInfo tag_class = 3

  The tag classes of the extension.

• optional OriginKey origin_key = 4

  The Starlark module where the Bazel module extension was originally declared; origin_key.name is currently never set. TODO(arostovtsev): attempt to retrieve the name under which the module extension was originally declared if it was declared as a global.

Representation of a Bazel module extension tag class.

Used in: ModuleExtensionInfo

• string tag_name = 1

  The name of the tag for this tag class.

• string doc_string = 2

  The documentation string of the tag class.

• repeated AttributeInfo attribute = 3

  The tag class's attributes.

The root output proto of Stardoc. An invocation of Stardoc on a single file will output exactly one instance of this proto, representing all documentation for the input Starlark file.

• repeated RuleInfo rule_info = 1

• repeated ProviderInfo provider_info = 2

• repeated StarlarkFunctionInfo func_info = 3

• repeated AspectInfo aspect_info = 4

• string module_docstring = 5

  The docstring present at the top of the input Starlark file.

• string file = 6

  The display form of the label of the module file (as seen from the starlark_doc_extract or Stardoc target's repo). Unset when there is no module file (e.g. when the module is a REPL, or in Bazel's internal tests).

• repeated ModuleExtensionInfo module_extension_info = 7

• repeated RepositoryRuleInfo repository_rule_info = 8

• repeated MacroInfo macro_info = 9

Representation of the origin of a rule, provider, aspect, or function. Intended to be used for building unambiguous cross-references: for example, between an element of a ProviderNameGroup required by a rule attribute and its corresponding ProviderInfo.

Used in: AspectInfo, MacroInfo, ModuleExtensionInfo, ProviderInfo, ProviderNameGroup, RepositoryRuleInfo, RuleInfo, StarlarkFunctionInfo

• string name = 1

  The name under which the entity was originally exported. Unset when the entity was not exported in its module.

• string file = 2

  The display form of the label of the module file in which the entity was originally declared (as seen from the starlark_doc_extract or Stardoc target's repo), or "<native>" for Bazel's built-in entities implemented in Java. Unset when there is no module file (such as for legacy struct providers, when the module is a REPL, or in Bazel's internal tests).

Representation of a Starlark provider field definition, comprised of the field name and provider description.

Used in: ProviderInfo

• string name = 1

  The name of the field.

• string doc_string = 2

  The description of the provider.

Representation of a Starlark provider definition.

Used in: ModuleInfo

• string provider_name = 1

  The name under which the provider is made accessible to a user of this module, including any structs it is nested in, for example "foo.FooInfo".

• string doc_string = 2

  The description of the provider.

• repeated ProviderFieldInfo field_info = 3

  The fields of the provider.

• optional OriginKey origin_key = 4

  The module where and the name under which the provider was originally declared.

• optional StarlarkFunctionInfo init = 5

  The provider's init callback.

Representation of a set of providers.

Used in: AttributeInfo, RuleInfo

• repeated string provider_name = 1

  The names of the providers. This field is only intended for rendering human-readable output. Please use origin_key (a list of the same length and in the same order as this field) for cross-references and tooling. Note: legacy Stardoc (0.5.x and earlier) is unable to extract the name in some circumstances (for example, if the provider is nested in a struct), and in that case, the provider name will be "Unknown Provider".

• repeated OriginKey origin_key = 2

  A list of unambiguous references to providers, of the same length and in the same order as the provider_name list. For provider symbols, this means modules where and the names under which the providers were originally declared. For legacy struct providers, origin_key.file is unset. Note: legacy Stardoc (0.5.x and earlier) does not set this field.

Representation of a Bazel repository rule, i.e. the object returned by calling `repository_rule(...)`. Note: legacy Stardoc (0.5.x and earlier) does not emit this message, instead using RuleInfo.

Used in: ModuleInfo

• string rule_name = 1

  The name under which the repository rule is made accessible to a user of this Starlark module.

• string doc_string = 2

  The documentation string of the repository rule.

• repeated AttributeInfo attribute = 3

  The attributes of the repository rule.

• repeated string environ = 4

  Environment variables that this repository rule depends on.

• optional OriginKey origin_key = 5

  The Starlark module where and the name under which the repository rule was originally declared.

Representation of a Starlark rule definition.

Used in: ModuleInfo

• string rule_name = 1

  In Stardoc and starlark_doc_extract output, this is the name under which the rule is made accessible to a user of this module, including any structs it is nested in, for example "foo.foo_library". In query output, this is the name under which the rule was defined (which might be a private symbol prefixed with "_").

• string doc_string = 2

  The documentation string of the rule.

• repeated AttributeInfo attribute = 3

  The attributes of the rule.

• optional OriginKey origin_key = 4

  The module where and the name under which the rule was originally declared.

• optional ProviderNameGroup advertised_providers = 5

  The list of providers that the rule's implementation must return. Unset if the rule lists no advertised providers.

• bool test = 6

  True if this is a test rule.

• bool executable = 7

  True if this is an executable rule. Note: if test is true, executable is also true (test rules are implicitly executable).

Representation of Starlark function definition.

Used in: ModuleInfo, ProviderInfo

• string function_name = 1

  The name under which the function is made accessible to a user of this module, including any structs it is nested in, for example "foo.frobnicate".

• repeated FunctionParamInfo parameter = 2

  The parameters for the function, in the following order: - positional parameters - keyword-only parameters - residual varargs parameter (`*args`) - residual keyword arguments parameter (`**kwargs`) This order differs from the order in which parameters are listed in the function's declaration (where positional parameters and keyword-only parameters are separated either by `*` or `*args`). The declaration order can be recovered by looking for the transition from ordinary/positional to keyword-only.

• string doc_string = 3

  The documented description of the function (if specified in the function's docstring).

• optional FunctionReturnInfo return = 4

  The return value for the function.

• optional FunctionDeprecationInfo deprecated = 5

  The deprecation for the function.

• optional OriginKey origin_key = 6

  The module where and the name under which the function was originally declared. Note: legacy Stardoc (0.5.x and earlier) does not set this field.