Python 규칙

규칙

py_binary
py_library
py_test
py_runtime

py_바이너리

py_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, imports, legacy_create_init, licenses, main, output_licenses, python_version, restricted_to, srcs_version, stamp, tags, target_compatible_with, testonly, toolchains, visibility)

py_binary는 .py 소스 파일 (다른 py_library 규칙에 포함될 수 있음), 컬렉션에서 프로그램에 필요한 모든 코드와 데이터가 포함된 *.runfiles 디렉터리 트리, 올바른 초기 환경 및 데이터로 프로그램을 시작하는 스텁 스크립트로 구성된 실행 가능한 Python 프로그램입니다.

예

py_binary(
    name = "foo",
    srcs = ["foo.py"],
    data = [":transform"],  # a cc_binary which we invoke at run time
    deps = [
        ":foolib",  # a py_library
    ],
)

다른 바이너리 내에서 또는 테스트에서 py_binary를 실행하려는 경우 (예: java_test 내에서 모의 리소스를 설정하기 위해 Python 바이너리를 실행) 올바른 방법을 선택하면 다른 바이너리 또는 테스트가 데이터 섹션의 py_binary에 종속됩니다. 그러면 다른 바이너리는 소스 디렉터리를 기준으로 py_binary를 찾을 수 있습니다.

py_binary(
    name = "test_main",
    srcs = ["test_main.py"],
    deps = [":testing"],
)

java_library(
    name = "testing",
    srcs = glob(["*.java"]),
    data = [":test_main"]
)

인수

속성
`name`	`Name; required` 이 타겟의 고유한 이름입니다. `main`이 지정되지 않은 경우 애플리케이션의 기본 진입점인 소스 파일의 이름과 확장자를 뺀 값과 같아야 합니다. 예를 들어 진입점의 이름이 `main.py`이면 `main`로 이름을 지정해야 합니다.
`deps`	`List of labels; optional` 바이너리 대상에 연결할 다른 라이브러리 목록입니다. 대부분의 빌드 규칙에서 정의한 일반적인 속성에서 `deps`에 관한 일반적인 주석을 참고하세요. 일반적으로 `py_library` 규칙입니다.
`srcs`	`List of labels; required` 타겟을 만들기 위해 처리되는 소스(`.py`) 파일의 목록입니다. 여기에는 체크인한 모든 코드와 생성된 모든 소스 파일이 포함됩니다. 라이브러리 타겟은 대신 `deps`에 속하지만, 런타임에 필요한 다른 바이너리 파일은 `data`에 속합니다.
`imports`	`List of strings; optional` `PYTHONPATH`에 추가할 가져오기 디렉터리의 목록입니다. '변수 만들기' 대체가 적용됩니다. 이러한 가져오기 디렉터리가 이 규칙과 해당 규칙을 사용하는 모든 규칙에 추가됩니다 (참고: 이 규칙이 의존하는 규칙이 아님). 각 디렉터리에 이 규칙을 사용하는 `py_binary` 규칙이 `PYTHONPATH`에 추가됩니다. 절대 경로 (`/`로 시작하는 경로) 및 실행 루트 위의 경로를 참조하는 경로는 허용되지 않으며 이 경우 오류가 발생합니다.
`legacy_create_init`	`Integer; optional; default is -1` runfiles 트리에서 빈 __init__.py 파일을 암시적으로 만들지 여부입니다. 이러한 저장소는 저장소 루트 디렉터리를 제외하고 Python 소스 코드 또는 공유 라이브러리가 포함된 모든 디렉터리와 이러한 디렉터리의 모든 상위 디렉터리에 생성됩니다. 기본값인 auto는 `--incompatible_default_to_explicit_init_py`가 사용되지 않는 한 true를 의미합니다. false이면 __init__.py 파일을 만들고 필요에 따라 Python 타겟의 `srcs`에 추가할 책임이 있습니다.
`main`	`Label; optional` 애플리케이션의 기본 진입점인 소스 파일의 이름입니다. 이 파일은 `srcs`에도 나열되어야 합니다. 지정하지 않으면 `name`가 대신 사용됩니다 (위 참고). `name`가 `srcs`의 파일 이름과 일치하지 않으면 `main`를 지정해야 합니다.
`python_version`	`String; optional; nonconfigurable; default is "_INTERNAL_SENTINEL"` Python 2 또는 Python 3용 이 타겟 (및 전이적 `deps`)을 빌드할지 여부. 유효한 값은 `"PY2"` 및 `"PY3"` (기본값)입니다. Python 버전은 명령줄 또는 이 버전에 종속된 다른 상위 대상에 지정된 버전과 관계없이 항상 이 속성으로 지정된 모든 버전으로 재설정됩니다. 현재 Python 버전에서 `select()`를 실행하려면 `@rules_python//python:python_version` 값을 검사하면 됩니다. 자세한 내용은 여기를 참고하세요. 버그 경고: 이 속성은 Bazel이 대상을 빌드하는 버전을 설정하지만 #4815로 인해 결과 스텁 스크립트가 여전히 런타임에 잘못된 인터프리터 버전을 호출할 수 있습니다. 이 해결 방법을 참고하세요. 여기에는 필요한 Python 버전을 가리키는 `py_runtime` 대상을 정의하고 `--python_top`을 설정하여 이 `py_runtime`를 활성화하는 작업이 포함됩니다.
`srcs_version`	`String; optional; default is "PY2AND3"` 이 속성은 대상의 `srcs`가 Python 2, Python 3 또는 둘 다와 호환되도록 선언합니다. 실제로 Python 런타임 버전을 설정하려면 실행 가능한 Python 규칙(`py_binary` 또는 `py_test`)의 `python_version` 속성을 사용합니다. 허용되는 값은 `"PY2AND3"`, `"PY2"`, `"PY3"`입니다. `"PY2ONLY"` 및 `"PY3ONLY"` 값은 기록상의 이유로도 허용되지만 기본적으로 `"PY2"` 및 `"PY3"`와 동일하므로 사용하지 않아야 합니다. 실행 가능한 규칙 (`py_binary` 및 `py_library`)만 실제로 이 속성의 값과 비교하여 현재 Python 버전을 확인합니다. (기능입니다. `py_library`가 현재 Python 버전을 변경하지 않으므로 검증을 실행한 경우 동일한 호출에서 `PY2ONLY` 및 `PY3ONLY` 라이브러리를 모두 빌드할 수 없습니다.) 또한 버전 불일치가 있는 경우 오류는 실행 단계에서만 보고됩니다. 특히 `bazel build --nobuild` 호출에 오류가 표시되지 않습니다.) 버전 요구사항을 도입하는 종속 항목에 관한 진단 정보를 얻으려면 대상에서 `find_requirements` 측면을 실행합니다. bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo 이렇게 하면 접미사에 `-pyversioninfo.txt` 버전이 필요한 이유에 대한 정보를 제공하는 접미사가 있는 파일이 빌드됩니다. 대상 충돌은 버전 충돌로 인해 실패하는 경우에도 작동합니다.
`stamp`	`Integer; optional; default is -1` 빌드 정보를 바이너리로 인코딩할지 여부입니다. 가능한 값은 다음과 같습니다. `stamp = 1`: `--nostamp` 빌드에서도 항상 빌드 정보를 바이너리에 스탬프합니다. 이 설정을 사용해서는 안 됩니다. 바이너리 및 바이너리 종속 항목에 종속되는 모든 다운스트림 작업이 종료될 수 있기 때문입니다. `stamp = 0`: 항상 빌드 정보를 상수 값으로 바꿉니다. 이렇게 하면 빌드 결과 캐싱이 개선됩니다. `stamp = -1`: 빌드 정보 삽입은 `--[no]stamp` 플래그로 제어됩니다. 스탬프 처리된 바이너리는 종속 항목이 변경되지 않는 한 다시 빌드되지 않습니다.

py_library

규칙 소스 보기

py_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, imports, licenses, restricted_to, srcs_version, tags, target_compatible_with, testonly, visibility)

인수

속성
`name`	`Name; required` 이 타겟의 고유한 이름입니다.
`deps`	`List of labels; optional` 바이너리 대상에 연결할 다른 라이브러리 목록입니다. 대부분의 빌드 규칙에서 정의한 일반적인 속성에서 `deps`에 관한 일반적인 주석을 참고하세요. 일반적으로 `py_library` 규칙입니다.
`srcs`	`List of labels; optional` 타겟을 만들기 위해 처리되는 소스 (`.py`) 파일의 목록입니다. 여기에는 체크인한 모든 코드와 생성된 모든 소스 파일이 포함됩니다.
`imports`	`List of strings; optional` `PYTHONPATH`에 추가할 가져오기 디렉터리의 목록입니다. '변수 만들기' 대체가 적용됩니다. 이러한 가져오기 디렉터리가 이 규칙과 해당 규칙을 사용하는 모든 규칙에 추가됩니다 (참고: 이 규칙이 의존하는 규칙이 아님). 각 디렉터리에 이 규칙을 사용하는 `py_binary` 규칙이 `PYTHONPATH`에 추가됩니다. 절대 경로 (`/`로 시작하는 경로) 및 실행 루트 위의 경로를 참조하는 경로는 허용되지 않으며 이 경우 오류가 발생합니다.
`srcs_version`	`String; optional; default is "PY2AND3"` 이 속성은 대상의 `srcs`가 Python 2, Python 3 또는 둘 다와 호환되도록 선언합니다. 실제로 Python 런타임 버전을 설정하려면 실행 가능한 Python 규칙 (`py_binary` 또는 `py_test`)의 `python_version` 속성을 사용합니다. 허용되는 값은 `"PY2AND3"`, `"PY2"`, `"PY3"`입니다. `"PY2ONLY"` 및 `"PY3ONLY"` 값은 기록상의 이유로도 허용되지만 기본적으로 `"PY2"` 및 `"PY3"`와 동일하므로 사용하지 않아야 합니다. 실행 가능한 규칙 (`py_binary` 및 `py_library`)만 실제로 이 속성의 값과 비교하여 현재 Python 버전을 확인합니다. (기능입니다. `py_library`가 현재 Python 버전을 변경하지 않으므로 검증을 실행한 경우 동일한 호출에서 `PY2ONLY` 및 `PY3ONLY` 라이브러리를 모두 빌드할 수 없습니다.) 또한 버전 불일치가 있는 경우 오류는 실행 단계에서만 보고됩니다. 특히 `bazel build --nobuild` 호출에 오류가 표시되지 않습니다.) 버전 요구사항을 도입하는 종속 항목에 관한 진단 정보를 얻으려면 대상에서 `find_requirements` 측면을 실행합니다. bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo 이렇게 하면 접미사에 `-pyversioninfo.txt` 버전이 필요한 이유에 대한 정보를 제공하는 접미사가 있는 파일이 빌드됩니다. 대상 충돌은 버전 충돌로 인해 실패하는 경우에도 작동합니다.

py_test

규칙 소스 보기

py_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, imports, legacy_create_init, licenses, local, main, python_version, restricted_to, shard_count, size, srcs_version, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

py_test() 규칙은 테스트를 컴파일합니다. 테스트는 일부 테스트 코드를 둘러싼 바이너리 래퍼입니다.

예

py_test(
    name = "runtest_test",
    srcs = ["runtest_test.py"],
    deps = [
        "//path/to/a/py/library",
    ],
)

기본 모듈을 지정할 수도 있습니다.

py_test(
    name = "runtest_test",
    srcs = [
        "runtest_main.py",
        "runtest_lib.py",
    ],
    main = "runtest_main.py",
)

인수

속성
`name`	`Name; required` 이 타겟의 고유한 이름입니다.
`deps`	`List of labels; optional` 바이너리 대상에 연결할 다른 라이브러리 목록입니다. 대부분의 빌드 규칙에서 정의한 일반적인 속성에서 `deps`에 관한 일반적인 주석을 참고하세요. 일반적으로 `py_library` 규칙입니다.
`srcs`	`List of labels; required` 타겟을 만들기 위해 처리되는 소스 (`.py`) 파일의 목록입니다. 여기에는 체크인한 모든 코드와 생성된 모든 소스 파일이 포함됩니다. 라이브러리 타겟은 대신 `deps`에 속하지만, 런타임에 필요한 다른 바이너리 파일은 `data`에 속합니다.
`imports`	`List of strings; optional` `PYTHONPATH`에 추가할 가져오기 디렉터리의 목록입니다. '변수 만들기' 대체가 적용됩니다. 이러한 가져오기 디렉터리가 이 규칙과 해당 규칙을 사용하는 모든 규칙에 추가됩니다 (참고: 이 규칙이 의존하는 규칙이 아님). 각 디렉터리에 이 규칙을 사용하는 `py_binary` 규칙이 `PYTHONPATH`에 추가됩니다. 절대 경로 (`/`로 시작하는 경로) 및 실행 루트 위의 경로를 참조하는 경로는 허용되지 않으며 이 경우 오류가 발생합니다.
`legacy_create_init`	`Integer; optional; default is -1` runfiles 트리에서 빈 __init__.py 파일을 암시적으로 만들지 여부입니다. 이러한 저장소는 저장소 루트 디렉터리를 제외하고 Python 소스 코드 또는 공유 라이브러리가 포함된 모든 디렉터리와 이러한 디렉터리의 모든 상위 디렉터리에 생성됩니다. 기본값인 auto는 `--incompatible_default_to_explicit_init_py`가 사용되지 않는 한 true를 의미합니다. false이면 __init__.py 파일을 만들고 필요에 따라 Python 타겟의 `srcs`에 추가할 책임이 있습니다.
`main`	`Label; optional` 애플리케이션의 기본 진입점인 소스 파일의 이름입니다. 이 파일은 `srcs`에도 나열되어야 합니다. 지정하지 않으면 `name`가 대신 사용됩니다 (위 참고). `name`가 `srcs`의 파일 이름과 일치하지 않으면 `main`를 지정해야 합니다.
`python_version`	`String; optional; nonconfigurable; default is "_INTERNAL_SENTINEL"` Python 2 또는 Python 3용 이 타겟 (및 전이적 `deps`)을 빌드할지 여부. 유효한 값은 `"PY2"` 및 `"PY3"` (기본값)입니다. Python 버전은 명령줄 또는 이 버전에 종속된 다른 상위 대상에 지정된 버전과 관계없이 항상 이 속성으로 지정된 모든 버전으로 재설정됩니다. 현재 Python 버전에서 `select()`를 실행하려면 `@rules_python//python:python_version` 값을 검사하면 됩니다. 자세한 내용은 여기를 참고하세요. 버그 경고: 이 속성은 Bazel이 대상을 빌드하는 버전을 설정하지만 #4815로 인해 결과 스텁 스크립트가 여전히 런타임에 잘못된 인터프리터 버전을 호출할 수 있습니다. 이 해결 방법을 참고하세요. 여기에는 필요한 Python 버전을 가리키는 `py_runtime` 대상을 정의하고 `--python_top`을 설정하여 이 `py_runtime`를 활성화하는 작업이 포함됩니다.
`srcs_version`	`String; optional; default is "PY2AND3"` 이 속성은 대상의 `srcs`가 Python 2, Python 3 또는 둘 다와 호환되도록 선언합니다. 실제로 Python 런타임 버전을 설정하려면 실행 가능한 Python 규칙(`py_binary` 또는 `py_test`)의 `python_version` 속성을 사용합니다. 허용되는 값은 `"PY2AND3"`, `"PY2"`, `"PY3"`입니다. `"PY2ONLY"` 및 `"PY3ONLY"` 값은 기록상의 이유로도 허용되지만 기본적으로 `"PY2"` 및 `"PY3"`와 동일하므로 사용하지 않아야 합니다. 실행 가능한 규칙 (`py_binary` 및 `py_library`)만 실제로 이 속성의 값과 비교하여 현재 Python 버전을 확인합니다. (기능입니다. `py_library`가 현재 Python 버전을 변경하지 않으므로 검증을 실행한 경우 동일한 호출에서 `PY2ONLY` 및 `PY3ONLY` 라이브러리를 모두 빌드할 수 없습니다.) 또한 버전 불일치가 있는 경우 오류는 실행 단계에서만 보고됩니다. 특히 `bazel build --nobuild` 호출에 오류가 표시되지 않습니다.) 버전 요구사항을 도입하는 종속 항목에 관한 진단 정보를 얻으려면 대상에서 `find_requirements` 측면을 실행합니다. bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo 이렇게 하면 접미사에 `-pyversioninfo.txt` 버전이 필요한 이유에 대한 정보를 제공하는 접미사가 있는 파일이 빌드됩니다. 대상 충돌은 버전 충돌로 인해 실패하는 경우에도 작동합니다.
`stamp`	`Integer; optional; default is 0` 스탬프 인수가 기본적으로 0으로 설정된다는 점을 제외하고 py_binary() 인수에 관한 섹션을 참고하세요.

py_runtime

규칙 소스 보기

py_runtime(name, bootstrap_template, compatible_with, coverage_tool, deprecation, distribs, features, files, interpreter, interpreter_path, licenses, python_version, restricted_to, stub_shebang, tags, target_compatible_with, testonly, visibility)

Python 코드를 실행하는 데 사용되는 Python 런타임을 나타냅니다.

py_runtime 대상은 플랫폼 런타임 또는 빌드 내 런타임을 나타낼 수 있습니다. 플랫폼 런타임은 알려진 경로에서 시스템에 설치된 인터프리터에 액세스하는 반면, 빌드 런타임은 인터프리터 역할을 하는 실행 가능 대상을 가리킵니다. 두 경우 모두 '인터프리터'는 표준 CPython 인터프리터와 동일한 규칙에 따라 명령줄에서 전달된 Python 스크립트를 실행할 수 있는 모든 실행 가능한 바이너리 또는 래퍼 스크립트를 의미합니다.

플랫폼 런타임은 본질적으로 밀폐되지 않습니다. 타겟 플랫폼에 인터프리터가 특정 경로에 있어야 한다는 요구사항을 적용합니다. 빌드 런타임은 시스템 인터프리터에 액세스하는 래퍼 스크립트나 체크인 인터프리터를 가리키는지 여부에 따라 밀폐될 수도 있습니다.

예:

py_runtime(
    name = "python-2.7.12",
    files = glob(["python-2.7.12/**"]),
    interpreter = "python-2.7.12/bin/python",
)

py_runtime(
    name = "python-3.6.0",
    interpreter_path = "/opt/pyenv/versions/3.6.0/bin/python",
)

인수

속성
`name`	`Name; required` 이 타겟의 고유한 이름입니다.
`bootstrap_template`	`Label; optional; default is @bazel_tools//tools/python:python_bootstrap_template.txt` 이전에 'Python 스텁 스크립트'라고 불렸던 모든 Python 실행 대상의 진입점입니다.
`coverage_tool`	`Label; optional` `py_binary` 및 `py_test` 타겟에서 코드 적용 범위 정보를 수집하는 데 사용할 타겟입니다. 설정된 경우 대상은 단일 파일을 생성하거나 실행 가능한 타겟이어야 합니다. 단일 파일 경로 또는 타겟 실행 파일인 경우 실행 가능 경로에 따라 Python 적용 범위 도구의 진입점이 결정됩니다. 적용 범위가 사용 설정되면 타겟 및 실행 파일이 실행 파일에 추가됩니다. 도구의 진입점은 Python 인터프리터가 로드할 수 있어야 합니다 (예: `.py` 또는 `.pyc` 파일). 적어도 `run` 및 `lcov` 하위 명령어를 포함하여 coverage.py의 명령줄 인수를 허용해야 합니다.
`files`	`List of labels; optional` 빌드 런타임의 경우 이 런타임을 구성하는 파일 집합입니다. 이러한 파일은 이 런타임을 사용하는 Python 바이너리의 실행 파일에 추가됩니다. 플랫폼 런타임의 경우 이 속성을 설정하면 안 됩니다.
`interpreter`	`Label; optional` 빌드 시 런타임의 경우 인터프리터로 호출할 대상입니다. 플랫폼 런타임의 경우 이 속성을 설정하면 안 됩니다.
`interpreter_path`	`String; optional` 플랫폼 런타임의 경우 대상 플랫폼에 있는 Python 인터프리터의 절대 경로입니다. 빌드 시 런타임의 경우 이 속성을 설정하면 안 됩니다.
`python_version`	`String; optional; default is "_INTERNAL_SENTINEL"` 이 런타임이 Python 메이저 버전 2용인지 3용인지 나타냅니다. 유효한 값은 `"PY2"` 및 `"PY3"`입니다. 기본값은 `--incompatible_py3_is_default` 플래그로 제어됩니다. 하지만 앞으로 이 속성은 필수이며 기본값이 없습니다.
`stub_shebang`	`String; optional; default is "#!/usr/bin/env python3"` `py_binary` 타겟을 실행할 때 사용되는 부트스트랩 Python 스크립트 앞에 'Shebang' 표현식이 추가됩니다. 문제 8685에서 동기를 확인하세요. Windows에는 적용되지 않습니다.