python_bootstrap_binary

A python_bootstrap_binary() rule declares a Python binary intended to be used in scripts that bootstrap other aspects of the Buck2 prelude. Python bootstrap binaries do not use the Python toolchain and, as such, are highly restricted in what they can and can't do. In particular, bootstrap binaries can only depend on python_bootstrap_library() rules and the entry point must consist of a single source file.

Function Signature

def python_bootstrap_binary(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _python_bootstrap_toolchain: str = "gh_facebook_buck2_shims_meta//:python_bootstrap",
    contacts: list[str] = [],
    copy_deps: bool = True,
    deps: list[str] = [],
    has_content_based_path: bool = False,
    labels: list[str] = [],
    main: str,
) -> None

Parameters

name: (required)

name of the target
default_target_platform: (defaults to: None)

specifies the default target platform, used when no platforms are specified on the command line
target_compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with a configuration
compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with a configuration
exec_compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with an execution platform
visibility: (defaults to: [])

a list of visibility patterns restricting what targets can depend on this one
within_view: (defaults to: ["PUBLIC"])

a list of visibility patterns restricting what this target can depend on
metadata: (defaults to: {})

a key-value map of metadata associated with this target
tests: (defaults to: [])

a list of targets that provide tests for this one
modifiers: (defaults to: [])

an array of modifiers associated with this target
contacts: (defaults to: [])

A list of organizational contacts for this rule. These could be individuals who you would contact in the event of a failure or other issue with the rule.
```
contacts = [ 'Joe Sixpack', 'Erika Mustermann' ]
```
labels: (defaults to: [])

Set of arbitrary strings which allow you to annotate a build rule with tags that can be searched for over an entire dependency tree using buck query().

Function Signature​

Parameters​

Function Signature

Parameters