Support `python -m` invocation style

[rickeylev]

Python supports two ways to start programs: by file, or by module name.

Today, only file is supported. This is a FR for -m to also be supported. There's two main use cases for this style:

1. Using a file not in the same Bazel package as main.
2. Specifying a main that comes from dependencies, and referencing the actual main file directly is problematic.

Some example use cases:

• When using a macro to generate a test/binary.
• pytest: a common main is used and the tests to execute are passed as arguments or discovered at runtime. This basically a special case of the above.

This should be fairly easy to implement using bootstrap script. It just requires passing the name of the main module to the stage2 bootstrap instead of the path to the main module.

Docs for -m: https://docs.python.org/3.10/using/cmdline.html#cmdoption-m

See also: runpy.run_module: https://docs.python.org/3.10/library/runpy.html#runpy.run_module

[aignas]

A note for a possible cleanup - the py_console_script_binary could diructly leverage this feature. It could be also harvested for the initial implementation to support this.

[aignas]

This has made it possible to integrate pytest-bazel so much easier:

"""A small wrapper for pytest-bazel.

Taken from: https://pytest-bazel.readthedocs.io/latest/usage.html
"""

load("@rules_python//python:py_test.bzl", "py_test")

def py_pytest_test(*, deps = [], data = [], **kwargs):
    """Use pytest-bazel for running pytest tests

    Args:
        deps: Deps to pass to the test.
        data: The data to pass to the test rule.
        **kwargs: Extra args passed to the py_test.
    """

    py_test(
        deps = deps + [
            "@pypi//pytest_bazel",  # assuming your hub repo name is `pypi`.
        ],
        main_module = "pytest_bazel",
        data = data + [
            "//:pyproject.toml",
        ],
        **kwargs,
    )

See aignas/pytest-bazel#14

Thank you.