repository_ctx

ヘルパー関数と属性に関する情報を含むリポジトリ ルールのコンテキスト。リポジトリ ルールを作成するときに、implementation 関数の引数として repo_に 関するオブジェクトを取得します。

メンバー

attr

struct repository_ctx.attr

属性の値にアクセスするための構造体。値はユーザーが指定します（ない場合はデフォルト値が使用されます）。

delete

bool repository_ctx.delete(path)

ファイルまたはディレクトリを削除します。ファイルまたはディレクトリがこの呼び出しによって実際に削除されたかどうかを示すブール値を返します。

パラメータ

パラメータ 説明
path string; or path、 必須
削除するファイルのパス（リポジトリ ディレクトリからの相対パス、または絶対パス）。パスまたは文字列を指定できます。

ダウンロード

struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

指定された URL の出力パスにファイルをダウンロードし、success を含む構造体を返します。ダウンロードが正常に完了した場合はフラグ true、成功した場合は sha256 フィールドと integrity フィールドを含むファイルのハッシュを返します。

パラメータ

パラメータ 説明
url string; or Iterable of strings、 必須
同じファイルを参照するミラー URL のリスト。
output string; or Label; or path、 デフォルト = ''
出力ファイルのパス（リポジトリ ディレクトリを基準とする相対パス）。
sha256 デフォルト = ''
ダウンロードしたファイルの想定される SHA-256 ハッシュダウンロードしたファイルの SHA-256 ハッシュと一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。
executable デフォルト = False
作成されたファイルの実行可能フラグをデフォルトで false に設定します。
allow_fail デフォルト = False
設定すると、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示す
canonical_id デフォルト = ''
設定すると、キャッシュ ヒットは、同じ正規 ID でファイルがキャッシュに追加された場合にのみ制限されます
auth default = {}
一部の URL の認証情報を指定する辞書（省略可）。
integrity デフォルト = ''
ダウンロードされたファイルの想定されるチェックサム（サブリソースの整合性形式）。ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルが変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。

download_and_extract

struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

指定された URL の出力パスにファイルをダウンロードして抽出し、success を含む構造体を返します。ダウンロードが正常に完了した場合はフラグ true、成功した場合は sha256 と integrity のフィールドを含むファイルのハッシュを返します。

パラメータ

パラメータ 説明
url string; or Iterable of strings、 必須
同じファイルを参照するミラー URL のリスト。
output string; or Label; or path、 デフォルト = ''
アーカイブを展開するディレクトリへのパス（リポジトリ ディレクトリを基準とする相対パス）。
sha256 デフォルト = ''
ダウンロードしたファイルの想定される SHA-256 ハッシュダウンロードしたファイルの SHA-256 ハッシュと一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。指定すると、まずリポジトリのキャッシュで、指定されたハッシュを持つファイルがあるかどうかがチェックされます。ダウンロードは、ファイルがキャッシュに見つからなかった場合にのみ試行されます。ダウンロードが正常に完了すると、ファイルがキャッシュに追加されます。
type デフォルト = ''
ダウンロードされたファイルのアーカイブ タイプ。デフォルトでは、アーカイブの種類は URL のファイル拡張子によって決まります。ファイルに拡張子がない場合は、zip、jar、war、aar、tar、tar.gz、tgz、tar.xz、txz、.tar.zst、.tzst、tar.bz2、.ar のいずれかを明示的に指定できます。見てみましょう。
stripPrefix デフォルト = ''
抽出されたファイルから削除するディレクトリ接頭辞。 多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリがあります。このフィールドを使用すると、この接頭辞を build_file で何度も指定しなくても、抽出されたファイルから削除できます。
allow_fail デフォルト = False
設定すると、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示す
canonical_id デフォルト = ''
設定すると、キャッシュ ヒットは、同じ正規 ID でファイルがキャッシュに追加された場合にのみ制限されます
auth default = {}
一部の URL の認証情報を指定する辞書（省略可）。
integrity デフォルト = ''
ダウンロードされたファイルの想定されるチェックサム（サブリソースの整合性形式）。ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルが変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。
rename_files default = {}
抽出時に名前を変更するファイルを指定する辞書（省略可）。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞が調整される前に、その値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイルシステム上の同じパスに抽出されるファイルを含むアーカイブの抽出に使用できます。

execute

exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

引数のリストで指定されたコマンドを実行します。コマンドの実行時間は timeout（秒、デフォルトは 600 秒）によって制限されます。このメソッドは、コマンドの出力を含む exec_result 構造体を返します。environment マップを使用すると、プロセスに渡す一部の環境変数をオーバーライドできます。

パラメータ

パラメータ 説明
arguments 必須
引数のリスト。最初の要素は、実行するプログラムのパスにする必要があります。
timeout デフォルト = 600
コマンドの最大時間（秒）。デフォルトは 600 秒です。
environment default = {}
一部の環境変数がプロセスに渡されるように設定することを強制します。
quiet デフォルト = True
stdout と stderr をターミナルに出力する必要がある場合は、
working_directory デフォルト = ""
コマンド実行用の作業ディレクトリ。 リポジトリのルートからの相対パスまたは絶対パスを指定できます。

extract

None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})

アーカイブをリポジトリ ディレクトリに展開します。

パラメータ

パラメータ 説明
archive string; or Label; or path、 必須
展開するアーカイブへのパス（リポジトリ ディレクトリからの相対パス）。
output string; or Label; or path、 デフォルト = ''
アーカイブを展開するディレクトリへのパス（リポジトリ ディレクトリを基準とする相対パス）。
stripPrefix デフォルト = ''
抽出されたファイルから削除するディレクトリ接頭辞。 多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリがあります。このフィールドを使用すると、この接頭辞を build_file で何度も指定しなくても、抽出されたファイルから削除できます。
rename_files default = {}
抽出時に名前を変更するファイルを指定する辞書（省略可）。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞が調整される前に、その値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイルシステム上の同じパスに抽出されるファイルを含むアーカイブの抽出に使用できます。

あなた宛てに表示されます。

None repository_ctx.file(path, content='', executable=True, legacy_utf8=True)

リポジトリ ディレクトリに、提供されたコンテンツを含むファイルを生成します。

パラメータ

パラメータ 説明
path string; or Label; or path、 必須
作成するファイルのパス（リポジトリ ディレクトリを基準とする相対パス）。
content デフォルト = ''
作成するファイルの内容。デフォルトでは空です。
executable デフォルト = True
作成されたファイルの実行可能フラグをデフォルトで true に設定します。
legacy_utf8 デフォルト = True
ファイルのコンテンツを UTF-8 にエンコードします（デフォルトは true）。今後のバージョンでデフォルトが変更され、このパラメータは削除されます。

name

string repository_ctx.name

このルールによって作成された外部リポジトリの名前。

os

repository_os repository_ctx.os

システムからの情報にアクセスするための構造体。

patch

None repository_ctx.patch(patch_file, strip=0)

外部リポジトリのルート ディレクトリにパッチファイルを適用します。パッチファイルは、標準の統合差分形式ファイルである必要があります。Bazel ネイティブのパッチ実装は、パッチ コマンドライン ツールのようなファズマッチとバイナリパッチをサポートしていません。

パラメータ

パラメータ 説明
patch_file string; or Label; or path、 必須
適用するパッチファイル。ラベル、相対パス、絶対パスのいずれかです。相対パスの場合は、リポジトリのディレクトリに解決されます。
strip デフォルト = 0
指定した数の先頭コンポーネントをファイル名から削除します。

パス

path repository_ctx.path(path)

文字列、ラベル、またはパスからパスを返します。パスが相対パスの場合は、リポジトリ ディレクトリを基準として解決されます。パスがラベルの場合は、対応するファイルのパスに解決されます。リモート・リポジトリは分析フェーズで実行されるため、ターゲットの結果に依存できません（ラベルは、生成されていないファイルを指している必要があります）。path がパスの場合は、そのパスをそのまま返します。

パラメータ

パラメータ 説明
path string; or Label; or path、 必須
パスの作成元となる文字列、ラベル、またはパス

read

string repository_ctx.read(path)

ファイル システム上のファイルの内容を読み取ります。

パラメータ

パラメータ 説明
path string; or Label; or path、 必須
読み取り元のファイルのパスです。

report_progress

None repository_ctx.report_progress(status='')

このリポジトリまたはモジュール拡張機能の取得の進行状況ステータスを更新します。

パラメータ

パラメータ 説明
status string、 デフォルト = ''
取得の進行状況の現在のステータスを説明する文字列 

None repository_ctx.symlink(target, link_name)

ファイル システムにシンボリック リンクを作成します。

パラメータ

パラメータ 説明
target string; or Label; or path、 必須
シンボリック リンクが指すパス。
string; or Label; or path、 必須
作成するシンボリック リンクのパス（リポジトリ ディレクトリを基準とする相対パス）。

テンプレート

None repository_ctx.template(path, template, substitutions={}, executable=True)

template を使用して新しいファイルを生成します。substitutions のキーが template で出現するたびに、対応する値に置き換えられます。結果は path に書き込まれます。オプションの executable 引数（デフォルトは true）を設定して、実行可能ビットをオンまたはオフにすることができます。

パラメータ

パラメータ 説明
path string; or Label; or path、 必須
作成するファイルのパス（リポジトリ ディレクトリを基準とする相対パス）。
template string; or Label; or path、 必須
テンプレート ファイルへのパスを指定します。
substitutions default = {}
テンプレートを展開すると、置換の候補が表示されます。
executable デフォルト = True
作成されたファイルの実行可能フラグをデフォルトで true に設定します。

これは

path repository_ctx.which(program)

対応するプログラムのパスを返します。パス内にそのようなプログラムが存在しない場合は None を返します。

パラメータ

パラメータ 説明
program 必須
パスで見つけるプログラム。
None を返すことができます。

workspace_root

path repository_ctx.workspace_root

bazel 呼び出しのルート ワークスペースへのパス。