| commit | 49772214d4f2c87e3b0968a373d4a694a147c1e7 | [log] [tgz] |
|---|---|---|
| author | Joshua Bronson <joshua.bronson@chicagotrading.com> | Thu Sep 04 16:40:15 2025 -0400 |
| committer | GitHub <noreply@github.com> | Thu Sep 04 20:40:15 2025 +0000 |
| tree | e2542b0412e88c3c5a5a143a59e49f151bff7f48 | |
| parent | 1169eec93cae138a1c514bf7a8b6f537367b46ad [diff] |
refactor(gazelle): report missing BUILD_WORKSPACE_DIRECTORY key more directly (#3240)
Replace `os.environ.get("BUILD_WORKSPACE_DIRECTORY")` with
`os.environ["BUILD_WORKSPACE_DIRECTORY"]`.
The former may return None if the environment variable is not set, in
which case the code will crash with a TypeError when the line is run
since the result is concatenated with a `pathlib.Path` object, and is
therefore making it impossible to use rules_python_gazelle_plugin along
with rules_mypy:
These changes allow rules_mypy users to also use
rules_python_gazelle_plugin without having to work around the type
error.
Now if the environment variable is not set, the code will still crash,
but now with an error that better indicates the failed precondition,
namely `KeyError("BUILD_WORKSPACE_DIRECTORY")` rather than
`TypeError("unsupported operand type(s) for /: 'PosixPath' and
'NoneType')`.
This repository is the home of the core Python rules -- py_library, py_binary, py_test, py_proto_library, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.
Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.
Examples live in the examples directory.
The core rules are stable. Their implementation is subject to Bazel's backward compatibility policy. This repository aims to follow semantic versioning.
The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.
For detailed documentation, see https://rules-python.readthedocs.io
See Bzlmod support for more details.