Aturan Python

{3/2.0.20.2. Laporkan masalah Lihat sumber

Aturan

py_binary

Lihat sumber aturan 
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 adalah program Python yang dapat dieksekusi yang terdiri dari kumpulan file sumber .py (mungkin milik aturan py_library lainnya), hierarki direktori *.runfiles yang berisi semua kode dan data yang diperlukan oleh program pada saat runtime, dan skrip stub yang memulai program dengan lingkungan dan data awal yang benar.

Contoh

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

Jika Anda ingin menjalankan py_binary dari dalam biner atau pengujian lain (misalnya, menjalankan biner python untuk menyiapkan beberapa resource tiruan dari dalam java_test), pendekatan yang tepat adalah membuat biner atau pengujian lain bergantung pada py_binary di bagian datanya. Biner lainnya kemudian dapat menemukan py_binary relatif terhadap direktori sumber. 

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

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

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.


Jika main tidak ditentukan, nama ini harus sama dengan nama file sumber yang merupakan titik entri utama aplikasi, tanpa ekstensi. Misalnya, jika titik entri Anda disebut main.py, nama Anda harus main.
deps

Daftar label; defaultnya adalah []

Daftar library lain yang akan ditautkan ke target biner. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build. Ini umumnya adalah aturan py_library.
srcs

Daftar label; wajib diisi

Daftar file sumber (.py) yang diproses untuk membuat target. Ini mencakup semua kode yang Anda check-in dan semua file sumber yang dihasilkan. Target library berada di deps, sedangkan file biner lain yang diperlukan saat runtime termasuk dalam data.
imports

Daftar string; defaultnya adalah []

Daftar direktori impor yang akan ditambahkan ke PYTHONPATH.

Tunduk pada substitusi "Buat variabel". Direktori impor ini akan ditambahkan untuk aturan ini dan semua aturan yang bergantung padanya (catatan: bukan aturan yang menjadi dependensi aturan ini. Setiap direktori akan ditambahkan ke PYTHONPATH oleh aturan py_binary yang bergantung pada aturan ini.

Jalur absolut (jalur yang diawali dengan /) dan jalur yang merujuk ke jalur di atas root eksekusi tidak diizinkan dan akan mengakibatkan error.

legacy_create_init

Bilangan bulat; defaultnya adalah -1

Apakah akan membuat file __init__.py kosong secara implisit di hierarki runfiles. Ini dibuat di setiap direktori yang berisi kode sumber Python atau library bersama, dan setiap direktori induk dari direktori tersebut, kecuali direktori utama repo. Default, otomatis, berarti benar kecuali jika --incompatible_default_to_explicit_init_py digunakan. Jika salah, pengguna bertanggung jawab untuk membuat file __init__.py (mungkin kosong) dan menambahkannya ke srcs target Python sesuai kebutuhan.
main

Label; defaultnya adalah None

Nama file sumber yang merupakan titik entri utama aplikasi. File ini juga harus dicantumkan di srcs. Jika tidak ditentukan, name akan digunakan sebagai gantinya (lihat di atas). Jika name tidak cocok dengan nama file apa pun dalam srcs, main harus ditentukan.
python_version

String; tidak dapat dikonfigurasi; defaultnya adalah "_INTERNAL_SENTINEL"

Menentukan apakah akan membangun target ini (dan deps transitifnya) untuk Python 2 atau Python 3. Nilai yang valid adalah "PY2" dan "PY3" (default).

Versi Python selalu direset (mungkin secara default) ke versi apa pun yang ditentukan oleh atribut ini, terlepas dari versi yang ditentukan pada command line atau oleh target lebih tinggi lainnya yang bergantung pada versi Python.

Jika ingin melakukan select() pada versi Python saat ini, Anda dapat memeriksa nilai @rules_python//python:python_version. Lihat di sini untuk mengetahui informasi selengkapnya.

Peringatan bug: Atribut ini menetapkan versi penafsiran yang ditetapkan oleh Bazel, tetapi karena #4815, skrip stub yang dihasilkan mungkin masih memanggil versi penafsir yang salah pada runtime. Lihat solusi ini, yang melibatkan penentuan target py_runtime yang mengarah ke salah satu versi Python sesuai kebutuhan, dan mengaktifkan py_runtime ini dengan menyetel --python_top.

srcs_version

String; defaultnya adalah "PY2AND3"

Atribut ini mendeklarasikan srcs target agar kompatibel dengan Python 2, Python 3, atau keduanya. Untuk menetapkan versi runtime Python, gunakan atribut python_version dari aturan Python yang dapat dieksekusi (py_binary atau py_test).

Nilai yang diizinkan adalah: "PY2AND3", "PY2", dan "PY3". Nilai "PY2ONLY" dan "PY3ONLY" juga diizinkan karena alasan historis, tetapi pada dasarnya sama dengan "PY2" dan "PY3" dan harus dihindari.

Perlu diperhatikan bahwa hanya aturan yang dapat dieksekusi (py_binary dan py_library ) yang benar-benar memverifikasi versi Python saat ini terhadap nilai atribut ini. (Ini adalah fitur; karena py_library tidak mengubah versi Python saat ini, jika melakukan validasi, maka tidak mungkin mem-build library PY2ONLY dan PY3ONLY dalam pemanggilan yang sama.) Selain itu, jika ada ketidakcocokan versi, error hanya akan dilaporkan pada fase eksekusi. Secara khusus, error tidak akan muncul dalam pemanggilan bazel build --nobuild.)

Untuk mendapatkan informasi diagnostik tentang dependensi yang memperkenalkan persyaratan versi, Anda dapat menjalankan aspek find_requirements pada target: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Tindakan ini akan mem-build file dengan akhiran -pyversioninfo.txt yang memberikan informasi tentang alasan target Anda memerlukan satu versi Python atau yang lainnya. Perhatikan bahwa metode ini tetap berfungsi meskipun target yang ditentukan gagal di-build karena konflik versi.

stamp

Bilangan bulat; defaultnya adalah -1

Apakah ingin mengenkode informasi build ke dalam biner. Nilai yang mungkin:
  • stamp = 1: Selalu tambahkan informasi build ke dalam biner, bahkan dalam build --nostamp. Setelan ini harus dihindari, karena berpotensi menghentikan caching jarak jauh untuk biner dan tindakan downstream apa pun yang bergantung padanya.
  • stamp = 0: Selalu ganti informasi build dengan nilai konstanta. Cara ini memberikan cache hasil build yang baik.
  • stamp = -1: Penyematan informasi build dikontrol oleh tanda --[no]stamp.

Biner yang distempel tidak dibangun ulang kecuali jika dependensinya berubah.

py_library

Lihat sumber aturan 
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)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
deps

Daftar label; defaultnya adalah []

Daftar library lain yang akan ditautkan ke target biner. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build. Ini umumnya adalah aturan py_library.
srcs

Daftar label; defaultnya adalah []

Daftar file sumber (.py) yang diproses untuk membuat target. Ini mencakup semua kode yang Anda check-in dan semua file sumber yang dihasilkan.
imports

Daftar string; defaultnya adalah []

Daftar direktori impor yang akan ditambahkan ke PYTHONPATH.

Tunduk pada substitusi "Buat variabel". Direktori impor ini akan ditambahkan untuk aturan ini dan semua aturan yang bergantung padanya (catatan: bukan aturan yang menjadi dependensi aturan ini. Setiap direktori akan ditambahkan ke PYTHONPATH oleh aturan py_binary yang bergantung pada aturan ini.

Jalur absolut (jalur yang diawali dengan /) dan jalur yang merujuk ke jalur di atas root eksekusi tidak diizinkan dan akan mengakibatkan error.

srcs_version

String; defaultnya adalah "PY2AND3"

Atribut ini mendeklarasikan srcs target agar kompatibel dengan Python 2, Python 3, atau keduanya. Untuk menetapkan versi runtime Python, gunakan atribut python_version dari aturan Python yang dapat dieksekusi (py_binary atau py_test).

Nilai yang diizinkan adalah: "PY2AND3", "PY2", dan "PY3". Nilai "PY2ONLY" dan "PY3ONLY" juga diizinkan karena alasan historis, tetapi pada dasarnya sama dengan "PY2" dan "PY3" dan harus dihindari.

Perlu diperhatikan bahwa hanya aturan yang dapat dieksekusi (py_binary dan py_library ) yang benar-benar memverifikasi versi Python saat ini terhadap nilai atribut ini. (Ini adalah fitur; karena py_library tidak mengubah versi Python saat ini, jika melakukan validasi, maka tidak mungkin mem-build library PY2ONLY dan PY3ONLY dalam pemanggilan yang sama.) Selain itu, jika ada ketidakcocokan versi, error hanya akan dilaporkan pada fase eksekusi. Secara khusus, error tidak akan muncul dalam pemanggilan bazel build --nobuild.)

Untuk mendapatkan informasi diagnostik tentang dependensi yang memperkenalkan persyaratan versi, Anda dapat menjalankan aspek find_requirements pada target: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Tindakan ini akan mem-build file dengan akhiran -pyversioninfo.txt yang memberikan informasi tentang alasan target Anda memerlukan satu versi Python atau yang lainnya. Perhatikan bahwa metode ini tetap berfungsi meskipun target yang ditentukan gagal di-build karena konflik versi.

py_test

Lihat sumber aturan 
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)

Aturan py_test() mengompilasi pengujian. Pengujian adalah wrapper biner untuk beberapa kode pengujian.

Contoh

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

Anda juga dapat menentukan modul utama:

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

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
deps

Daftar label; defaultnya adalah []

Daftar library lain yang akan ditautkan ke target biner. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build. Ini umumnya adalah aturan py_library.
srcs

Daftar label; wajib diisi

Daftar file sumber (.py) yang diproses untuk membuat target. Ini mencakup semua kode yang Anda check-in dan semua file sumber yang dihasilkan. Target library berada di deps, sedangkan file biner lain yang diperlukan saat runtime termasuk dalam data.
imports

Daftar string; defaultnya adalah []

Daftar direktori impor yang akan ditambahkan ke PYTHONPATH.

Tunduk pada substitusi "Buat variabel". Direktori impor ini akan ditambahkan untuk aturan ini dan semua aturan yang bergantung padanya (catatan: bukan aturan yang menjadi dependensi aturan ini. Setiap direktori akan ditambahkan ke PYTHONPATH oleh aturan py_binary yang bergantung pada aturan ini.

Jalur absolut (jalur yang diawali dengan /) dan jalur yang merujuk ke jalur di atas root eksekusi tidak diizinkan dan akan mengakibatkan error.

legacy_create_init

Bilangan bulat; defaultnya adalah -1

Apakah akan membuat file __init__.py kosong secara implisit di hierarki runfiles. Ini dibuat di setiap direktori yang berisi kode sumber Python atau library bersama, dan setiap direktori induk dari direktori tersebut, kecuali direktori utama repo. Default, otomatis, berarti benar kecuali jika --incompatible_default_to_explicit_init_py digunakan. Jika salah, pengguna bertanggung jawab untuk membuat file __init__.py (mungkin kosong) dan menambahkannya ke srcs target Python sesuai kebutuhan.
main

Label; defaultnya adalah None

Nama file sumber yang merupakan titik entri utama aplikasi. File ini juga harus dicantumkan di srcs. Jika tidak ditentukan, name akan digunakan sebagai gantinya (lihat di atas). Jika name tidak cocok dengan nama file apa pun dalam srcs, main harus ditentukan.
python_version

String; tidak dapat dikonfigurasi; defaultnya adalah "_INTERNAL_SENTINEL"

Menentukan apakah akan membangun target ini (dan deps transitifnya) untuk Python 2 atau Python 3. Nilai yang valid adalah "PY2" dan "PY3" (default).

Versi Python selalu direset (mungkin secara default) ke versi apa pun yang ditentukan oleh atribut ini, terlepas dari versi yang ditentukan pada command line atau oleh target lebih tinggi lainnya yang bergantung pada versi Python.

Jika ingin melakukan select() pada versi Python saat ini, Anda dapat memeriksa nilai @rules_python//python:python_version. Lihat di sini untuk mengetahui informasi selengkapnya.

Peringatan bug: Atribut ini menetapkan versi penafsiran yang ditetapkan oleh Bazel, tetapi karena #4815, skrip stub yang dihasilkan mungkin masih memanggil versi penafsir yang salah pada runtime. Lihat solusi ini, yang melibatkan penentuan target py_runtime yang mengarah ke salah satu versi Python sesuai kebutuhan, dan mengaktifkan py_runtime ini dengan menyetel --python_top.

srcs_version

String; defaultnya adalah "PY2AND3"

Atribut ini mendeklarasikan srcs target agar kompatibel dengan Python 2, Python 3, atau keduanya. Untuk menetapkan versi runtime Python, gunakan atribut python_version dari aturan Python yang dapat dieksekusi (py_binary atau py_test).

Nilai yang diizinkan adalah: "PY2AND3", "PY2", dan "PY3". Nilai "PY2ONLY" dan "PY3ONLY" juga diizinkan karena alasan historis, tetapi pada dasarnya sama dengan "PY2" dan "PY3" dan harus dihindari.

Perlu diperhatikan bahwa hanya aturan yang dapat dieksekusi (py_binary dan py_library ) yang benar-benar memverifikasi versi Python saat ini terhadap nilai atribut ini. (Ini adalah fitur; karena py_library tidak mengubah versi Python saat ini, jika melakukan validasi, maka tidak mungkin mem-build library PY2ONLY dan PY3ONLY dalam pemanggilan yang sama.) Selain itu, jika ada ketidakcocokan versi, error hanya akan dilaporkan pada fase eksekusi. Secara khusus, error tidak akan muncul dalam pemanggilan bazel build --nobuild.)

Untuk mendapatkan informasi diagnostik tentang dependensi yang memperkenalkan persyaratan versi, Anda dapat menjalankan aspek find_requirements pada target: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Tindakan ini akan mem-build file dengan akhiran -pyversioninfo.txt yang memberikan informasi tentang alasan target Anda memerlukan satu versi Python atau yang lainnya. Perhatikan bahwa metode ini tetap berfungsi meskipun target yang ditentukan gagal di-build karena konflik versi.

stamp

Bilangan bulat; defaultnya adalah 0

Lihat bagian argumen py_binary(), kecuali bahwa argumen stamp ditetapkan ke 0 secara default untuk pengujian.

py_runtime

Lihat sumber aturan 
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)

Mewakili runtime Python yang digunakan untuk mengeksekusi kode Python.

Target py_runtime dapat mewakili runtime platform atau runtime dalam build. Runtime platform mengakses penafsir yang diinstal sistem pada jalur yang diketahui, sedangkan runtime dalam build menunjuk ke target yang dapat dieksekusi yang bertindak sebagai penafsir. Dalam kedua kasus, "penafsir" berarti skrip biner atau wrapper yang dapat dieksekusi yang mampu menjalankan skrip Python yang diteruskan pada command line, mengikuti konvensi yang sama dengan penafsir CPython standar.

Runtime platform pada dasarnya bersifat non-hermetik. Hal ini memberlakukan persyaratan pada platform target untuk memiliki penafsir yang terletak di jalur tertentu. Runtime dalam build mungkin bersifat hermetik atau tidak, bergantung pada apakah runtime tersebut mengarah ke penafsir yang check-in atau skrip wrapper yang mengakses penafsir sistem.

Contoh:

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",
)

Argumen

Atribut
name

Nama; wajib diisi

Nama unik untuk target ini.
bootstrap_template

Label; defaultnya adalah "@bazel_tools//tools/python:python_bootstrap_template.txt"

Sebelumnya disebut sebagai "skrip stub Python", ini adalah titik masuk ke setiap target yang dapat dieksekusi Python.
coverage_tool

Label; defaultnya adalah None

Target ini adalah target yang akan digunakan untuk mengumpulkan informasi cakupan kode dari target py_binary dan py_test.

Jika ditetapkan, target harus menghasilkan satu file atau menjadi target yang dapat dieksekusi. Jalur ke file tunggal, atau file yang dapat dieksekusi jika target dapat dieksekusi, menentukan titik entri untuk alat cakupan python. Target dan runfile-nya akan ditambahkan ke runfile saat cakupan diaktifkan.

Titik entri untuk alat harus dapat dimuat oleh penafsir python (misalnya file .py atau .pyc). API tersebut harus menerima argumen command line coverage.py, setidaknya termasuk subperintah run dan lcov.

files

Daftar label; defaultnya adalah []

Untuk runtime dalam build, ini adalah kumpulan file yang terdiri dari runtime ini. File ini akan ditambahkan ke runfile biner Python yang menggunakan runtime ini. Untuk runtime platform, atribut ini tidak boleh ditetapkan.
interpreter

Label; defaultnya adalah None

Untuk runtime dalam build, ini adalah target yang akan dipanggil sebagai penafsir. Untuk runtime platform, atribut ini tidak boleh ditetapkan.
interpreter_path

String; defaultnya adalah ""

Untuk runtime platform, ini adalah jalur absolut penafsir Python pada platform target. Untuk runtime dalam build, atribut ini tidak boleh ditetapkan.
python_version

String; defaultnya adalah "_INTERNAL_SENTINEL"

Apakah runtime ini ditujukan untuk Python versi utama 2 atau 3. Nilai yang valid adalah "PY2" dan "PY3".

Nilai default dikontrol oleh tanda --incompatible_py3_is_default. Namun, di masa mendatang, atribut ini akan bersifat wajib dan tidak memiliki nilai default.

stub_shebang

String; defaultnya adalah "#!/usr/bin/env python3"

Ekspresi "Shebang" ditambahkan ke skrip Python bootstrap yang digunakan saat mengeksekusi target py_binary.

Lihat masalah 8685 untuk motivasi.

Tidak berlaku untuk Windows.