| commit | 9ff6ab7905f79079766c69ff8735542ebf9894bb | [log] [tgz] |
|---|---|---|
| author | Bruno Beltran <129457302+bruno-digitbio@users.noreply.github.com> | Fri Jul 19 03:30:46 2024 -0400 |
| committer | GitHub <noreply@github.com> | Fri Jul 19 07:30:46 2024 +0000 |
| tree | c4f895612e297933a21c69cd6228207aa2d6f534 | |
| parent | bd0ca99d7a03c0319ad17785c02561e7d5fccaae [diff] |
docs: describe `annotations` attr of `pip_parse` (#1667) My default expectation would be that the keys to the `annotations` dictionary passed to `pip_parse` would use the `normalize_name(...)` convention, as is used elsewhere in the API. However, this does not appear to be the case. I originally was going to file a bug, but maybe just documenting the current behavior is enough? For a minimal repro showing that this capitalization is indeed required, see https://github.com/bruno-digitbio/bug-rules-python-annotation-pyqt In that repo, ```bash $ bazel run //:test_has_comment $ tail $(bazel info output_base)/external/pip_pyqt6/BUILD.bazel $ tail $(bazel info output_base)/external/pip_wheel/BUILD.bazel ``` will both show `# A comment` at the bottom, as requested in the `WORKSPACE` file. However, if you first run ```bash $ bazel run //:requirements.update ``` then the auto-generated requirements file will use lowercase for the requirement specification, breaking the desired behavior. Please let me know if it makes more sense to just check in the docs, include this example (or something similar) as a small test, or something else. Apologies if I missed anything in the contribution guidelines!
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.