| # rules_python Changelog |
| |
| This is a human-friendly changelog in a keepachangelog.com style format. |
| Because this changelog is for end-user consumption of meaningful changes,only |
| a summary of a release's changes is described. This means every commit is not |
| necessarily mentioned, and internal refactors or code cleanups are omitted |
| unless they're particularly notable. |
| |
| A brief description of the categories of changes: |
| |
| * `Changed`: Some behavior changed. If the change is expected to break a |
| public API or supported behavior, it will be marked as **BREAKING**. Note that |
| beta APIs will not have breaking API changes called out. |
| * `Fixed`: A bug, or otherwise incorrect behavior, was fixed. |
| * `Added`: A new feature, API, or behavior was added in a backwards compatible |
| manner. |
| * Particular sub-systems are identified using parentheses, e.g. `(bzlmod)` or |
| `(docs)`. |
| |
| ## Unreleased |
| |
| [x.x.x]: https://github.com/bazelbuild/rules_python/releases/tag/x.x.x |
| |
| ### Changed |
| * (toolchains) Optional toolchain dependency: `py_binary`, `py_test`, and |
| `py_library` now depend on the `//python:exec_tools_toolchain_type` for build |
| tools. |
| * (deps): Bumped `bazel_skylib` to 1.6.1. |
| * (bzlmod): The `python` and internal `rules_python` extensions have been |
| marked as `reproducible` and will not include any lock file entries from now |
| on. |
| |
| * (gazelle): Remove gazelle plugin's python deps and make it hermetic. |
| Introduced a new Go-based helper leveraging tree-sitter for syntax analysis. |
| Implemented the use of `pypi/stdlib-list` for standard library module verification. |
| |
| ### Fixed |
| * (gazelle) Remove `visibility` from `NonEmptyAttr`. |
| Now empty(have no `deps/main/srcs/imports` attr) `py_library/test/binary` rules will |
| be automatically deleted correctly. For example, if `python_generation_mode` |
| is set to package, when `__init__.py` is deleted, the `py_library` generated |
| for this package before will be deleted automatically. |
| * (whl_library): Use `is_python_config_setting` to correctly handle multi-python |
| version dependency select statements when the `experimental_target_platforms` |
| includes the Python ABI. The default python version case within the select is |
| also now handled correctly, stabilizing the implementation. |
| * (gazelle) Fix Gazelle failing on Windows with |
| "panic: runtime error: invalid memory address or nil pointer dereference" |
| * (bzlmod) remove `pip.parse(annotations)` attribute as it is unused and has been |
| replaced by whl_modifications. |
| |
| ### Added |
| * (rules) Precompiling Python source at build time is available. but is |
| disabled by default, for now. Set |
| `@rules_python//python/config_settings:precompile=enabled` to enable it |
| by default. A subsequent release will enable it by default. See the |
| [Precompiling docs][precompile-docs] and API reference docs for more |
| information on precompiling. Note this requires Bazel 7+ and the Pystar rule |
| implementation enabled. |
| ([#1761](https://github.com/bazelbuild/rules_python/issues/1761)) |
| * (rules) Attributes and flags to control precompile behavior: `precompile`, |
| `precompile_optimize_level`, `precompile_source_retention`, |
| `precompile_invalidation_mode`, and `pyc_collection` |
| * (toolchains) The target runtime toolchain (`//python:toolchain_type`) has |
| two new optional attributes: `pyc_tag` (tells the pyc filename infix to use) and |
| `implementation_name` (tells the Python implementation name). |
| * (toolchains) A toolchain type for build tools has been added: |
| `//python:exec_tools_toolchain_type`. |
| * (providers) `PyInfo` has two new attributes: `direct_pyc_files` and |
| `transitive_pyc_files`, which tell the pyc files a target makes available |
| directly and transitively, respectively. |
| * `//python:features.bzl` added to allow easy feature-detection in the future. |
| * (pip) Allow specifying the requirements by (os, arch) and add extra |
| validations when parsing the inputs. This is a non-breaking change for most |
| users unless they have been passing multiple `requirements_*` files together |
| with `extra_pip_args = ["--platform=manylinux_2_4_x86_64"]`, that was an |
| invalid usage previously but we were not failing the build. From now on this |
| is explicitly disallowed. |
| * (toolchains) Added riscv64 platform definition for python toolchains. |
| |
| [precompile-docs]: /precompiling |
| |
| ## [0.32.2] - 2024-05-14 |
| |
| [0.32.2]: https://github.com/bazelbuild/rules_python/releases/tag/0.32.2 |
| |
| ### Fixed |
| |
| * Workaround existence of infinite symlink loops on case insensitive filesystems when targeting linux platforms with recent Python toolchains. Works around an upstream [issue][indygreg-231]. Fixes [#1800][rules_python_1800]. |
| |
| [indygreg-231]: https://github.com/indygreg/python-build-standalone/issues/231 |
| [rules_python_1800]: https://github.com/bazelbuild/rules_python/issues/1800 |
| |
| ## [0.32.0] - 2024-05-12 |
| |
| [0.32.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.32.0 |
| |
| ### Changed |
| |
| * (bzlmod): The `MODULE.bazel.lock` `whl_library` rule attributes are now |
| sorted in the attributes section. We are also removing values that are not |
| default in order to reduce the size of the lock file. |
| * (coverage) Bump `coverage.py` to [7.4.3](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst#version-743--2024-02-23). |
| * (deps): Bumped `bazel_features` to 1.9.1 to detect optional support |
| non-blocking downloads. |
| * (deps): Updated `pip_tools` to >= 7.4.0 |
| * (toolchains): Change some old toolchain versions to use [20240224] release to |
| include security fixes `3.8.18`, `3.9.18` and `3.10.13` |
| * (toolchains): Bump default toolchain versions to: |
| * `3.8 -> 3.8.19` |
| * `3.9 -> 3.9.19` |
| * `3.10 -> 3.10.14` |
| * `3.11 -> 3.11.9` |
| * `3.12 -> 3.12.3` |
| |
| ### Fixed |
| |
| * (whl_library): Fix the experimental_target_platforms overriding for platform |
| specific wheels when the wheels are for any python interpreter version. Fixes |
| [#1810](https://github.com/bazelbuild/rules_python/issues/1810). |
| * (whl_library): Stop generating duplicate dependencies when encountering |
| duplicates in the METADATA. Fixes |
| [#1873](https://github.com/bazelbuild/rules_python/issues/1873). |
| * (gazelle) In `project` or `package` generation modes, do not generate `py_test` |
| rules when there are no test files and do not set `main = "__test__.py"` when |
| that file doesn't exist. |
| * (whl_library) The group redirection is only added when the package is part of |
| the group potentially fixing aspects that want to traverse a `py_library` graph. |
| Fixes [#1760](https://github.com/bazelbuild/rules_python/issues/1760). |
| * (bzlmod) Setting a particular micro version for the interpreter and the |
| `pip.parse` extension is now possible, see the |
| `examples/pip_parse/MODULE.bazel` for how to do it. |
| See [#1371](https://github.com/bazelbuild/rules_python/issues/1371). |
| * (refactor) The pre-commit developer workflow should now pass `isort` and `black` |
| checks (see [#1674](https://github.com/bazelbuild/rules_python/issues/1674)). |
| |
| ### Added |
| |
| * (toolchains) Added armv7 platform definition for python toolchains. |
| * (toolchains) New Python versions available: `3.11.8`, `3.12.2` using the [20240224] release. |
| * (toolchains) New Python versions available: `3.8.19`, `3.9.19`, `3.10.14`, `3.11.9`, `3.12.3` using |
| the [20240415] release. |
| * (gazelle) Added a new `python_visibility` directive to control visibility |
| of generated targets by appending additional visibility labels. |
| * (gazelle) Added a new `python_default_visibility` directive to control the |
| _default_ visibility of generated targets. See the [docs][python_default_visibility] |
| for details. |
| * (gazelle) Added a new `python_test_file_pattern` directive. This directive tells |
| gazelle which python files should be mapped to the `py_test` rule. See the |
| [original issue][test_file_pattern_issue] and the [docs][test_file_pattern_docs] |
| for details. |
| * (wheel) Add support for `data_files` attributes in py_wheel rule |
| ([#1777](https://github.com/bazelbuild/rules_python/issues/1777)) |
| * (py_wheel) `bzlmod` installations now provide a `twine` setup for the default |
| Python toolchain in `rules_python` for version 3.11. |
| * (bzlmod) New `experimental_index_url`, `experimental_extra_index_urls` and |
| `experimental_index_url_overrides` to `pip.parse` for using the bazel |
| downloader. If you see any issues, report in |
| [#1357](https://github.com/bazelbuild/rules_python/issues/1357). The URLs for |
| the whl and sdist files will be written to the lock file. Controlling whether |
| the downloading of metadata is done in parallel can be done using |
| `parallel_download` attribute. |
| * (gazelle) Add a new annotation `include_dep`. Also add documentation for |
| annotations to `gazelle/README.md`. |
| * (deps): `rules_python` depends now on `rules_cc` 0.0.9 |
| * (pip_parse): A new flag `use_hub_alias_dependencies` has been added that is going |
| to become default in the next release. This makes use of `dep_template` flag |
| in the `whl_library` rule. This also affects the |
| `experimental_requirement_cycles` feature where the dependencies that are in |
| a group would be only accessible via the hub repo aliases. If you still |
| depend on legacy labels instead of the hub repo aliases and you use the |
| `experimental_requirement_cycles`, now is a good time to migrate. |
| |
| [python_default_visibility]: gazelle/README.md#directive-python_default_visibility |
| [test_file_pattern_issue]: https://github.com/bazelbuild/rules_python/issues/1816 |
| [test_file_pattern_docs]: gazelle/README.md#directive-python_test_file_pattern |
| [20240224]: https://github.com/indygreg/python-build-standalone/releases/tag/20240224. |
| [20240415]: https://github.com/indygreg/python-build-standalone/releases/tag/20240415. |
| |
| |
| ## [0.31.0] - 2024-02-12 |
| |
| [0.31.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.31.0 |
| |
| ### Changed |
| |
| * For Bazel 7, the core rules and providers are now implemented in rules_python |
| directly and the rules bundled with Bazel are not used. Bazel 6 and earlier |
| continue to use the Bazel builtin symbols. Of particular note, this means, |
| under Bazel 7, the builtin global symbol `PyInfo` is **not** the same as what |
| is loaded from rules_python. The same is true of `PyRuntimeInfo`. |
| |
| ## [0.30.0] - 2024-02-12 |
| |
| [0.30.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.30.0 |
| |
| ### Changed |
| |
| * (toolchains) Windows hosts always ignore pyc files in the downloaded runtimes. |
| This fixes issues due to pyc files being created at runtime and affecting the |
| definition of what files were considered part of the runtime. |
| |
| * (pip_parse) Added the `envsubst` parameter, which enables environment variable |
| substitutions in the `extra_pip_args` attribute. |
| |
| * (pip_repository) Added the `envsubst` parameter, which enables environment |
| variable substitutions in the `extra_pip_args` attribute. |
| |
| ### Fixed |
| |
| * (bzlmod) pip.parse now does not fail with an empty `requirements.txt`. |
| |
| * (py_wheel) Wheels generated by `py_wheel` now preserve executable bits when |
| being extracted by `installer` and/or `pip`. |
| |
| * (coverage) During the running of lcov, the stdout/stderr was causing test |
| failures. By default, suppress output when generating lcov. This can be |
| overridden by setting 'VERBOSE_COVERAGE'. This change only affect bazel |
| 7.x.x and above. |
| |
| * (toolchain) Changed the `host_toolchain` to symlink all files to support |
| Windows host environments without symlink support. |
| |
| * (PyRuntimeInfo) Switch back to builtin PyRuntimeInfo for Bazel 6.4 and when |
| pystar is disabled. This fixes an error about `target ... does not have ... |
| PyRuntimeInfo`. |
| ([#1732](https://github.com/bazelbuild/rules_python/issues/1732)) |
| |
| ### Added |
| |
| * (py_wheel) Added `requires_file` and `extra_requires_files` attributes. |
| |
| * (whl_library) *experimental_target_platforms* now supports specifying the |
| Python version explicitly and the output `BUILD.bazel` file will be correct |
| irrespective of the python interpreter that is generating the file and |
| extracting the `whl` distribution. Multiple python target version can be |
| specified and the code generation will generate version specific dependency |
| closures but that is not yet ready to be used and may break the build if |
| the default python version is not selected using |
| `common --@rules_python//python/config_settings:python_version=X.Y.Z`. |
| |
| * New Python versions available: `3.11.7`, `3.12.1` using |
| https://github.com/indygreg/python-build-standalone/releases/tag/20240107. |
| |
| * (toolchain) Allow setting `x.y` as the `python_version` parameter in |
| the version-aware `py_binary` and `py_test` rules. This allows users to |
| use the same rule import for testing with specific Python versions and |
| rely on toolchain configuration and how the latest version takes precedence |
| if e.g. `3.8` is selected. That also simplifies `.bazelrc` for any users |
| that set the default `python_version` string flag in that way. |
| |
| * (toolchain) The runtime's shared libraries (libpython.so et al) can be |
| accessed using `@rules_python//python/cc:current_py_cc_libs`. This uses |
| toolchain resolution, so the files are from the same runtime used to run a |
| target. If you were previously using e.g. `@python_3_11//:libpython`, then |
| switch to `:current_py_cc_libs` for looser coupling to the underlying runtime |
| repo implementation. |
| |
| * (repo rules) The environment variable `RULES_PYTHON_REPO_DEBUG=1` can be |
| set to make repository rules log detailed information about what they're |
| up to. |
| |
| * (coverage) Add support for python 3.12 and bump `coverage.py` to |
| 7.4.1. |
| |
| |
| ## [0.29.0] - 2024-01-22 |
| |
| [0.29.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.29.0 |
| |
| ### Changed |
| |
| * **BREAKING** The deprecated `incompatible_generate_aliases` feature flags |
| from `pip_parse` and `gazelle` got removed. They had been flipped to `True` |
| in 0.27.0 release. |
| * **BREAKING** (wheel) The `incompatible_normalize_name` and |
| `incompatible_normalize_version` flags have been removed. They had been |
| flipped to `True` in 0.27.0 release. |
| * (bzlmod) The pip hub repository now uses the newly introduced config settings |
| using the `X.Y` python version notation. This improves cross module |
| interoperability and allows to share wheels built by interpreters using |
| different patch versions. |
| |
| ### Fixed |
| |
| * (bzlmod pip.parse) Use a platform-independent reference to the interpreter |
| pip uses. This reduces (but doesn't eliminate) the amount of |
| platform-specific content in `MODULE.bazel.lock` files; Follow |
| [#1643](https://github.com/bazelbuild/rules_python/issues/1643) for removing |
| platform-specific content in `MODULE.bazel.lock` files. |
| |
| * (wheel) The stamp variables inside the distribution name are no longer |
| lower-cased when normalizing under PEP440 conventions. |
| |
| ### Added |
| |
| * (toolchains) `python_register_toolchains` now also generates a repository |
| that is suffixed with `_host`, that has a single label `:python` that is a |
| symlink to the python interpreter for the host platform. The intended use is |
| mainly in `repository_rule`, which are always run using `host` platform |
| Python. This means that `WORKSPACE` users can now copy the `requirements.bzl` |
| file for vendoring as seen in the updated `pip_parse_vendored` example. |
| |
| * (runfiles) `rules_python.python.runfiles.Runfiles` now has a static `Create` |
| method to make imports more ergonomic. Users should only need to import the |
| `Runfiles` object to locate runfiles. |
| |
| * (toolchains) `PyRuntimeInfo` now includes a `interpreter_version_info` field |
| that contains the static version information for the given interpreter. |
| This can be set via `py_runtime` when registering an interpreter toolchain, |
| and will done automatically for the builtin interpreter versions registered via |
| `python_register_toolchains`. |
| Note that this only available on the Starlark implementation of the provider. |
| |
| * (config_settings) Added `//python/config_settings:is_python_X.Y` config |
| settings to match on minor Python version. These settings match any `X.Y` |
| version instead of just an exact `X.Y.Z` version. |
| |
| ## [0.28.0] - 2024-01-07 |
| |
| [0.28.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.28.0 |
| |
| ### Changed |
| |
| * **BREAKING** (pip_install) the deprecated `pip_install` macro and related |
| items have been removed. |
| |
| * **BREAKING** Support for Bazel 5 has been officially dropped. This release |
| was only partially tested with Bazel 5 and may or may not work with Bazel 5. |
| Subequent versions will no longer be tested under Bazel 5. |
| |
| * (runfiles) `rules_python.python.runfiles` now directly implements type hints |
| and drops support for python2 as a result. |
| |
| * (toolchains) `py_runtime`, `py_runtime_pair`, and `PyRuntimeInfo` now use the |
| rules_python Starlark implementation, not the one built into Bazel. NOTE: This |
| only applies to Bazel 6+; Bazel 5 still uses the builtin implementation. |
| |
| * (pip_parse) The parameter `experimental_requirement_cycles` may be provided a |
| map of names to lists of requirements which form a dependency |
| cycle. `pip_parse` will break the cycle for you transparently. This behavior |
| is also available under bzlmod as |
| `pip.parse(experimental_requirement_cycles={})`. |
| |
| * (toolchains) `py_runtime` can now take an executable target. Note: runfiles |
| from the target are not supported yet. |
| ([#1612](https://github.com/bazelbuild/rules_python/issues/1612)) |
| |
| * (gazelle) When `python_generation_mode` is set to `file`, create one `py_binary` |
| target for each file with `if __name__ == "__main__"` instead of just one |
| `py_binary` for the whole module. |
| |
| * (gazelle) the Gazelle manifest integrity field is now optional. If the |
| `requirements` argument to `gazelle_python_manifest` is unset, no integrity |
| field will be generated. |
| |
| ### Fixed |
| |
| * (gazelle) The gazelle plugin helper was not working with Python toolchains 3.11 |
| and above due to a bug in the helper components not being on PYTHONPATH. |
| |
| * (pip_parse) The repositories created by `whl_library` can now parse the `whl` |
| METADATA and generate dependency closures irrespective of the host platform |
| the generation is executed on. This can be turned on by supplying |
| `experimental_target_platforms = ["all"]` to the `pip_parse` or the `bzlmod` |
| equivalent. This may help in cases where fetching wheels for a different |
| platform using `download_only = True` feature. |
| * (bzlmod pip.parse) The `pip.parse(python_interpreter)` arg now works for |
| specifying a local system interpreter. |
| * (bzlmod pip.parse) Requirements files with duplicate entries for the same |
| package (e.g. one for the package, one for an extra) now work. |
| * (bzlmod python.toolchain) Submodules can now (re)register the Python version |
| that rules_python has set as the default. |
| ([#1638](https://github.com/bazelbuild/rules_python/issues/1638)) |
| * (whl_library) Actually use the provided patches to patch the whl_library. |
| On Windows the patching may result in files with CRLF line endings, as a result |
| the RECORD file consistency requirement is lifted and now a warning is emitted |
| instead with a location to the patch that could be used to silence the warning. |
| Copy the patch to your workspace and add it to the list if patches for the wheel |
| file if you decide to do so. |
| * (coverage): coverage reports are now created when the version-aware |
| rules are used. |
| ([#1600](https://github.com/bazelbuild/rules_python/issues/1600)) |
| * (toolchains) Workspace builds register the py cc toolchain (bzlmod already |
| was). This makes e.g. `//python/cc:current_py_cc_headers` Just Work. |
| ([#1669](https://github.com/bazelbuild/rules_python/issues/1669)) |
| * (bzlmod python.toolchain) The value of `ignore_root_user_error` is now decided |
| by the root module only. |
| ([#1658](https://github.com/bazelbuild/rules_python/issues/1658)) |
| |
| ### Added |
| |
| * (docs) bzlmod extensions are now documented on rules-python.readthedocs.io |
| * (docs) Support and backwards compatibility policies have been documented. |
| See https://rules-python.readthedocs.io/en/latest/support.html |
| * (gazelle) `file` generation mode can now also add `__init__.py` to the srcs |
| attribute for every target in the package. This is enabled through a separate |
| directive `python_generation_mode_per_file_include_init`. |
| |
| ## [0.27.0] - 2023-11-16 |
| |
| [0.27.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.27.0 |
| |
| ### Changed |
| |
| * Make `//python/pip_install:pip_repository_bzl` `bzl_library` target internal |
| as all of the publicly available symbols (etc. `package_annotation`) are |
| re-exported via `//python:pip_bzl` `bzl_library`. |
| |
| * (gazelle) Gazelle Python extension no longer has runtime dependencies. Using |
| `GAZELLE_PYTHON_RUNTIME_DEPS` from `@rules_python_gazelle_plugin//:def.bzl` is |
| no longer necessary. |
| |
| * (pip_parse) The installation of `pip_parse` repository rule toolchain |
| dependencies is now done as part of `py_repositories` call. |
| |
| * (pip_parse) The generated `requirements.bzl` file now has an additional symbol |
| `all_whl_requirements_by_package` which provides a map from the normalized |
| PyPI package name to the target that provides the built wheel file. Use |
| `pip_utils.normalize_name` function from `@rules_python//python:pip.bzl` to |
| convert a PyPI package name to a key in the `all_whl_requirements_by_package` |
| map. |
| |
| * (pip_parse) The flag `incompatible_generate_aliases` has been flipped to |
| `True` by default on `non-bzlmod` setups allowing users to use the same label |
| strings during the transition period. For example, instead of |
| `@pypi_foo//:pkg`, you can now use `@pypi//foo` or `@pypi//foo:pkg`. Other |
| labels that are present in the `foo` package are `dist_info`, `whl` and |
| `data`. Note, that the `@pypi_foo//:pkg` labels are still present for |
| backwards compatibility. |
| |
| * (gazelle) The flag `use_pip_repository_aliases` is now set to `True` by |
| default, which will cause `gazelle` to change third-party dependency labels |
| from `@pip_foo//:pkg` to `@pip//foo` by default. |
| |
| * The `compile_pip_requirements` now defaults to `pyproject.toml` if the `src` |
| or `requirements_in` attributes are unspecified, matching the upstream |
| `pip-compile` behaviour more closely. |
| |
| * (gazelle) Use relative paths if possible for dependencies added through |
| the use of the `resolve` directive. |
| |
| * (gazelle) When using `python_generation_mode file`, one `py_test` target is |
| made per test file even if a target named `__test__` or a file named |
| `__test__.py` exists in the same package. Previously in these cases there |
| would only be one test target made. |
| |
| Breaking changes: |
| |
| * (pip) `pip_install` repository rule in this release has been disabled and |
| will fail by default. The API symbol is going to be removed in the next |
| version, please migrate to `pip_parse` as a replacement. The `pip_parse` |
| rule no longer supports `requirements` attribute, please use |
| `requirements_lock` instead. |
| |
| * (py_wheel) switch `incompatible_normalize_name` and |
| `incompatible_normalize_version` to `True` by default to enforce `PEP440` |
| for wheel names built by `rules_python`. |
| |
| * (tools/wheelmaker.py) drop support for Python 2 as only Python 3 is tested. |
| |
| ### Fixed |
| |
| * Skip aliases for unloaded toolchains. Some Python versions that don't have full |
| platform support, and referencing their undefined repositories can break operations |
| like `bazel query rdeps(...)`. |
| |
| * Python code generated from `proto_library` with `strip_import_prefix` can be imported now. |
| |
| * (py_wheel) Produce deterministic wheel files and make `RECORD` file entries |
| follow the order of files written to the `.whl` archive. |
| |
| * (gazelle) Generate a single `py_test` target when `gazelle:python_generation_mode project` |
| is used. |
| |
| * (gazelle) Move waiting for the Python interpreter process to exit to the shutdown hook |
| to make the usage of the `exec.Command` more idiomatic. |
| |
| * (toolchains) Keep tcl subdirectory in Windows build of hermetic interpreter. |
| |
| * (bzlmod) sub-modules now don't have the `//conditions:default` clause in the |
| hub repos created by `pip.parse`. This should fix confusing error messages |
| in case there is a misconfiguration of toolchains or a bug in `rules_python`. |
| |
| ### Added |
| |
| * (bzlmod) Added `.whl` patching support via `patches` and `patch_strip` |
| arguments to the new `pip.override` tag class. |
| |
| * (pip) Support for using [PEP621](https://peps.python.org/pep-0621/) compliant |
| `pyproject.toml` for creating a resolved `requirements.txt` file. |
| |
| * (utils) Added a `pip_utils` struct with a `normalize_name` function to allow users |
| to find out how `rules_python` would normalize a PyPI distribution name. |
| |
| ## [0.26.0] - 2023-10-06 |
| |
| ### Changed |
| |
| * Python version patch level bumps: |
| * 3.8.15 -> 3.8.18 |
| * 3.9.17 -> 3.9.18 |
| * 3.10.12 -> 3.10.13 |
| * 3.11.4 -> 3.11.6 |
| |
| * (deps) Upgrade rules_go 0.39.1 -> 0.41.0; this is so gazelle integration works with upcoming Bazel versions |
| |
| * (multi-version) The `distribs` attribute is no longer propagated. This |
| attribute has been long deprecated by Bazel and shouldn't be used. |
| |
| * Calling `//python:repositories.bzl#py_repositories()` is required. It has |
| always been documented as necessary, but it was possible to omit it in certain |
| cases. An error about `@rules_python_internal` means the `py_repositories()` |
| call is missing in `WORKSPACE`. |
| |
| * (bzlmod) The `pip.parse` extension will generate os/arch specific lock |
| file entries on `bazel>=6.4`. |
| |
| |
| ### Added |
| |
| * (bzlmod, entry_point) Added |
| [`py_console_script_binary`](./docs/py_console_script_binary.md), which |
| allows adding custom dependencies to a package's entry points and customizing |
| the `py_binary` rule used to build it. |
| |
| * New Python versions available: `3.8.17`, `3.11.5` using |
| https://github.com/indygreg/python-build-standalone/releases/tag/20230826. |
| |
| * (gazelle) New `# gazelle:python_generation_mode file` directive to support |
| generating one `py_library` per file. |
| |
| * (python_repository) Support `netrc` and `auth_patterns` attributes to enable |
| authentication against private HTTP hosts serving Python toolchain binaries. |
| |
| * `//python:packaging_bzl` added, a `bzl_library` for the Starlark |
| files `//python:packaging.bzl` requires. |
| * (py_wheel) Added the `incompatible_normalize_name` feature flag to |
| normalize the package distribution name according to latest Python |
| packaging standards. Defaults to `False` for the time being. |
| * (py_wheel) Added the `incompatible_normalize_version` feature flag |
| to normalize the package version according to PEP440 standard. This |
| also adds support for local version specifiers (versions with a `+` |
| in them), in accordance with PEP440. Defaults to `False` for the |
| time being. |
| |
| * New Python versions available: `3.8.18`, `3.9.18`, `3.10.13`, `3.11.6`, `3.12.0` using |
| https://github.com/indygreg/python-build-standalone/releases/tag/20231002. |
| `3.12.0` support is considered beta and may have issues. |
| |
| ### Removed |
| |
| * (bzlmod) The `entry_point` macro is no longer supported and has been removed |
| in favour of the `py_console_script_binary` macro for `bzlmod` users. |
| |
| * (bzlmod) The `pip.parse` no longer generates `{hub_name}_{py_version}` hub repos |
| as the `entry_point` macro has been superseded by `py_console_script_binary`. |
| |
| * (bzlmod) The `pip.parse` no longer generates `{hub_name}_{distribution}` hub repos. |
| |
| ### Fixed |
| |
| * (whl_library) No longer restarts repository rule when fetching external |
| dependencies improving initial build times involving external dependency |
| fetching. |
| |
| * (gazelle) Improve runfiles lookup hermeticity. |
| |
| [0.26.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.26.0 |
| |
| ## [0.25.0] - 2023-08-22 |
| |
| ### Changed |
| |
| * Python version patch level bumps: |
| * 3.9.16 -> 3.9.17 |
| * 3.10.9 -> 3.10.12 |
| * 3.11.1 -> 3.11.4 |
| * (bzlmod) `pip.parse` can no longer automatically use the default |
| Python version; this was an unreliable and unsafe behavior. The |
| `python_version` arg must always be explicitly specified. |
| |
| ### Fixed |
| |
| * (docs) Update docs to use correct bzlmod APIs and clarify how and when to use |
| various APIs. |
| * (multi-version) The `main` arg is now correctly computed and usually optional. |
| * (bzlmod) `pip.parse` no longer requires a call for whatever the configured |
| default Python version is. |
| |
| ### Added |
| |
| * Created a changelog. |
| * (gazelle) Stop generating unnecessary imports. |
| * (toolchains) s390x supported for Python 3.9.17, 3.10.12, and 3.11.4. |
| |
| [0.25.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.25.0 |
| |
| ## [0.24.0] - 2023-07-11 |
| |
| ### Changed |
| |
| * **BREAKING** (gazelle) Gazelle 0.30.0 or higher is required |
| * (bzlmod) `@python_aliases` renamed to `@python_versions |
| * (bzlmod) `pip.parse` arg `name` renamed to `hub_name` |
| * (bzlmod) `pip.parse` arg `incompatible_generate_aliases` removed and always |
| true. |
| |
| ### Fixed |
| |
| * (bzlmod) Fixing Windows Python Interpreter symlink issues |
| * (py_wheel) Allow twine tags and args |
| * (toolchain, bzlmod) Restrict coverage tool visibility under bzlmod |
| * (pip) Ignore temporary pyc.NNN files in wheels |
| * (pip) Add format() calls to glob_exclude templates |
| * plugin_output in py_proto_library rule |
| |
| ### Added |
| |
| * Using Gazelle's lifecycle manager to manage external processes |
| * (bzlmod) `pip.parse` can be called multiple times with different Python |
| versions |
| * (bzlmod) Allow bzlmod `pip.parse` to reference the default python toolchain and interpreter |
| * (bzlmod) Implementing wheel annotations via `whl_mods` |
| * (gazelle) support multiple requirements files in manifest generation |
| * (py_wheel) Support for specifying `Description-Content-Type` and `Summary` in METADATA |
| * (py_wheel) Support for specifying `Project-URL` |
| * (compile_pip_requirements) Added `generate_hashes` arg (default True) to |
| control generating hashes |
| * (pip) Create all_data_requirements alias |
| * Expose Python C headers through the toolchain. |
| |
| [0.24.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.24.0 |