bazel-contrib / bazel-contrib/rules_python

Introduce pytest integration out of the box

Open
#3,594 12 comments 0 reactions 0 assignees View on GitHub
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

Currently users need to know about pytest-bazel or other ways to integrate rules_python with bazel.

Ideally the discovery and onboarding of new users should be as easy as we can make it to be without making rules_python unclude everything and the kitchen sink.

Some ideas how we could do this:
* Implement the default pypi hub idea #2094
* pre-declare the pytest and pytest-bazel dependencies, where we would generate entries in the hub repo with aliases. Maybe we could define a particular default version for everything to work out of the box.
* create a pytest_test rule where we are using the declared deps.
* the users can override the pytest and other included deps.
* use the main_module attribute to launch pytest-bazel. If pytest is not there users would get an error that it could not be imported.

Open questions:
* can we default to pytest-bazel in all py_test invocations if there is no main or main_module defined?
* Is "pypi" a good name to reserve as the default hub repo? How does the predeclaring work? We just accept the same args as whl_library but all optional?
* Who can pre-declare deps and if multiple versions are declared, which one do we chose? We have version marker parsing in rules_python and we can even do resolution based on version ranges, e.g. users declare that they need pytest 7.1 or above and we get the lowest available version that satisfies the conditions. We can also do this by python version since we have marker expression evaluation support.
* How to handle sharding related optional dependencies?
* How to handle other features that may require extra plugins?

Design goals
* no overhead in the number of targets, hence usage of main_module.
* little maintenance in rules_python.
* better out of the box experience. How would the users discover the feature?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the default PyPI hub proposal in #2094 and the existing py_test, main_module, dependency declaration, and version-marker handling mentioned in the issue. Done requires a resolved design for discovery, dependency overrides and versions, optional dependencies, and the out-of-the-box pytest workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.