ヘルパー関数と属性に関する情報を含むリポジトリ ルールのコンテキスト。リポジトリ ルールを作成するときに、implementation
関数の引数として repository_ctx オブジェクトを取得します。
メンバー
- attr
- delete
- ダウンロード
- download_and_extract
- 実行
- 抽出
- ファイル
- getenv
- name
- os
- patch
- path
- read
- 名前変更
- report_progress
- symlink
- テンプレート
- watch
- watch_tree
- workspace_root
attr
struct repository_ctx.attr
delete
bool repository_ctx.delete(path)
パラメータ
パラメータ | 説明 |
---|---|
path
|
string: path: 必須 削除するファイルのパス(リポジトリ ディレクトリからの相対パス、または絶対パス)。パスまたは文字列にできます。 |
ダウンロード
unknown repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
success
を含む構造体、ダウンロードが正常に完了した場合は true
のフラグ、正常に完了した場合は sha256
フィールドと integrity
フィールドを含むファイルのハッシュを返します。sha256
または integrity
をユーザーが指定する場合は、明示的な canonical_id
を設定することを強くおすすめします(例: get_default_canonical_id
)。
パラメータ
パラメータ | 説明 |
---|---|
url
|
文字列、または文字列の iterable。必須 同じファイルを参照するミラー URL のリスト。 |
output
|
文字列、ラベル、パス。デフォルトは '' 。リポジトリ ディレクトリを基準とする出力ファイルのパス。 |
sha256
|
文字列。デフォルトは '' 。ダウンロードしたファイルの想定される SHA-256 ハッシュ。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたハッシュのファイルがチェックされます。キャッシュにファイルが見つからない場合のみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
executable
|
bool;
デフォルトは False 作成されたファイルに実行可能フラグを設定します。デフォルトは false です。 |
allow_fail
|
bool。デフォルトは False 。設定すると、ダウンロードに失敗した場合にエラーをスローするのではなく、戻り値でエラーを示します。 |
canonical_id
|
文字列。デフォルトは '' 。設定すると、キャッシュ ヒットを、ファイルが同じ正規 ID でキャッシュに追加されたケースに限定します。デフォルトでは、キャッシュにチェックサム( sha256 または integrity )が使用されます。 |
auth
|
dict(デフォルトは {} ): 一部の URL の認証情報を指定するオプションの辞書。 |
headers
|
dict。デフォルトは {} 。すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
文字列。デフォルトは '' 。ダウンロードされたファイルの想定されるチェックサム(Subresource Integrity 形式)。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルが変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたチェックサムを持つファイルが検索されます。キャッシュにファイルが見つからない場合にのみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
block
|
bool: デフォルトは True false に設定すると、この呼び出しはすぐに返され、通常の戻り値の代わりに、単一のメソッド wait() を含むトークンを返します。このメソッドはダウンロードが完了するまでブロックし、通常の戻り値を返すか、通常どおりスローします。 |
download_and_extract
struct repository_ctx.download_and_extract(url, output='', sha256='', type='', strip_prefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success
を含む構造体を返します。ダウンロードが正常に完了した場合はフラグ true
、成功した場合は sha256
と integrity
のフィールドを含むファイルのハッシュを返します。sha256
または integrity
がユーザー指定の場合は、明示的な canonical_id
を設定することを強くおすすめします。例: get_default_canonical_id
パラメータ
パラメータ | 説明 |
---|---|
url
|
文字列、または文字列の iterable。必須 同じファイルを参照するミラー URL のリスト。 |
output
|
文字列、ラベル、パス。デフォルトは '' 。アーカイブを展開するディレクトリのパス(リポジトリ ディレクトリからの相対パス)。 |
sha256
|
文字列。デフォルトは '' 。ダウンロードしたファイルの想定される SHA-256 ハッシュ。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドは非密封になります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたハッシュのファイルがチェックされます。キャッシュにファイルが見つからない場合のみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
type
|
string;
デフォルトは '' ですダウンロードされたファイルのアーカイブ タイプ。デフォルトでは、アーカイブ タイプは URL のファイル拡張子から判断されます。ファイルに拡張子がない場合は、ここで「zip」、「jar」、「war」、「aar」、「nupkg」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tzst」、「tar.bz2」、「.tbz」、「.ar」、「.deb」のいずれかを明示的に指定できます。 |
strip_prefix
|
文字列。デフォルトは '' 。抽出されたファイルから削除するディレクトリ接頭辞。多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリが含まれています。この接頭辞を build_file で何度も指定する代わりに、このフィールドを使用して、抽出されたファイルから削除できます。互換性のため、このパラメータは非推奨の名前 |
allow_fail
|
bool: デフォルトは False 設定されている場合は、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示します。 |
canonical_id
|
文字列。デフォルトは '' 。設定すると、キャッシュ ヒットを、ファイルが同じ正規 ID でキャッシュに追加されたケースに限定します。デフォルトでは、キャッシュにチェックサムを使用します」( sha256 または integrity )。 |
auth
|
dict: デフォルトは {} です一部の URL の認証情報を指定するオプションの辞書。 |
headers
|
dict。デフォルトは {} 。すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
string:
デフォルトは '' です。ダウンロードされるファイルの想定されるチェックサム(サブリソースの整合性形式)。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたチェックサムを持つファイルが検索されます。キャッシュにファイルが見つからない場合にのみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
rename_files
|
dict(デフォルトは {} ): 抽出時に名前を変更するファイルを指定するオプションの辞書。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞の調整の前に、値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイル システムで同じパスに抽出されるファイルを抽出する場合に使用できます。 |
execute
exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout
によって制限されます(秒単位、デフォルトは 600 秒)。このメソッドは、コマンドの出力を含む exec_result
構造体を返します。environment
マップを使用すると、プロセスに渡す一部の環境変数をオーバーライドできます。
パラメータ
パラメータ | 説明 |
---|---|
arguments
|
順序: 必須 引数のリスト。最初の要素は、実行するプログラムのパスにする必要があります。 |
timeout
|
int;
デフォルトは 600 コマンドの最大時間(秒単位)(デフォルトは 600 秒)。 |
environment
|
dict: デフォルトは {} です。プロセスに渡されるように一部の環境変数を強制的に設定します。値を None にすると、環境変数を削除できます。
|
quiet
|
bool。デフォルトは True 。stdout と stderr をターミナルに出力するかどうか。 |
working_directory
|
string;
デフォルトは "" コマンド実行の作業ディレクトリ。 リポジトリ ルートからの相対パスまたは絶対パスを指定できます。デフォルトはリポジトリのルートです。 |
extract
None
repository_ctx.extract(archive, output='', strip_prefix='', *, rename_files={}, watch_archive='auto')
パラメータ
パラメータ | 説明 |
---|---|
archive
|
文字列、ラベル、パス。必須 展開するアーカイブのパス(リポジトリ ディレクトリからの相対パス)。 |
output
|
文字列、ラベル、パス。デフォルトは '' 。アーカイブを展開するディレクトリのパス(リポジトリ ディレクトリからの相対パス)。 |
strip_prefix
|
文字列。デフォルトは '' 。抽出されたファイルから削除するディレクトリ接頭辞。多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリがあります。この接頭辞を build_file で何度も指定する代わりに、このフィールドを使用して、抽出されたファイルから削除できます。互換性のため、このパラメータは非推奨の名前 |
rename_files
|
dict(デフォルトは {} ): 抽出時に名前を変更するファイルを指定するオプションの辞書。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞が調整される前に、その値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイル システムで同じパスに抽出されるファイルを抽出する場合に使用できます。 |
watch_archive
|
string:
デフォルトは 'auto' アーカイブ ファイルを監視するかどうか。文字列「yes」、「no」、「auto」のいずれか。「yes」を渡すと、 watch() メソッドを直ちに呼び出すのと同じ結果になります。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、許可されている場合にのみ、ファイルの監視が試行されます(詳しくは、watch() のドキュメントをご覧ください)。 |
ファイル
None
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 リポジトリ ディレクトリを基準とする、作成するファイルのパス。 |
content
|
文字列。デフォルトは '' 。作成するファイルの内容。デフォルトは空です。 |
executable
|
bool;
デフォルトは True 作成されたファイルに実行可能フラグを設定します。デフォルトは true です。 |
legacy_utf8
|
bool;
デフォルトは True ファイルの内容を UTF-8 にエンコードします。デフォルトは true です。今後のバージョンではデフォルトが変更され、このパラメータは削除されます。 |
getenv
string repository_ctx.getenv(name, default=None)
name
の値を文字列として返します(存在する場合)。存在しない場合は default
を返します。増分ビルドでは、name
という名前の変数の値が変更されると、このリポジトリが再取得されます。
パラメータ
パラメータ | 説明 |
---|---|
name
|
文字列。必須 目的の環境変数の名前。 |
default
|
string: None :
デフォルトは None name が見つからない場合に返されるデフォルト値。
|
None
を返す場合があります。name
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')
パラメータ
パラメータ | 説明 |
---|---|
patch_file
|
文字列、ラベル、パス。必須 適用するパッチファイル。ラベル、相対パス、絶対パスのいずれかです。相対パスの場合は、リポジトリ ディレクトリに解決されます。 |
strip
|
int;
デフォルトは 0 ファイル名の先頭から指定した数のコンポーネントを削除します。 |
watch_patch
|
文字列。デフォルトは 'auto' 。パッチファイルを監視するかどうか。文字列「yes」、「no」、「auto」のいずれかです。「yes」を渡すと、 watch() メソッドがすぐに呼び出されます。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、ファイルの監視は、監視が許可されている場合にのみ試行されます(詳しくは、watch() のドキュメントをご覧ください)。
|
パス
path repository_ctx.path(path)
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須string 、Label 、path のいずれか。パスの作成元。 |
read
string repository_ctx.read(path, *, watch='auto')
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 読み取り元のファイルのパス。 |
watch
|
string:
デフォルトは 'auto' ファイルを監視するかどうか。文字列「yes」、「no」、「auto」のいずれか。「yes」を渡すと、 watch() メソッドがすぐに呼び出されます。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、ファイルの監視は、監視が許可されている場合にのみ試行されます(詳しくは、watch() のドキュメントをご覧ください)。
|
名前を変更
None
repository_ctx.rename(src, dst)
src
から dst
に変更します。必要に応じて、親ディレクトリが作成されます。宛先パスがすでに存在する場合は失敗します。両方のパスはリポジトリ内に存在する必要があります。
パラメータ
パラメータ | 説明 |
---|---|
src
|
文字列、ラベル、パス。必須 リポジトリ ディレクトリを基準とする、名前を変更する既存のファイルまたはディレクトリのパス。 |
dst
|
文字列、ラベル、パス。必須 ファイルまたはディレクトリの名前を変更する新しい名前(リポジトリ ディレクトリを基準とする相対パス)。 |
report_progress
None
repository_ctx.report_progress(status='')
パラメータ
パラメータ | 説明 |
---|---|
status
|
文字列。デフォルトは '' 。 string は、取得の進行状況の現在のステータスを表します。 |
symlink
None
repository_ctx.symlink(target, link_name)
パラメータ
パラメータ | 説明 |
---|---|
target
|
string、Label、path。必須 シンボリック リンクが参照するパス。 |
link_name
|
文字列、ラベル、パス。必須 作成するシンボリック リンクのパス。 |
テンプレート
None
repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')
template
を使用して新しいファイルを生成します。template
内の substitutions
のキーはすべて、対応する値に置き換えられます。結果は path
に書き込まれます。オプションの executable
引数(デフォルトは true)を設定すると、実行可能ビットをオンまたはオフにできます。
パラメータ
パラメータ | 説明 |
---|---|
path
|
string、Label、または path。必須 作成するファイルのパス(リポジトリ ディレクトリからの相対パス)。 |
template
|
文字列、ラベル、パス。必須 テンプレート ファイルのパス。 |
substitutions
|
dict: デフォルトは {} 。テンプレートを展開するときに行う置換。 |
executable
|
bool;
デフォルトは True 作成されたファイルに実行可能フラグを設定します。デフォルトは true です。 |
watch_template
|
文字列。デフォルトは 'auto' 。テンプレート ファイルを監視するかどうか。文字列「yes」、「no」、「auto」のいずれかです。「yes」を渡すと、 watch() メソッドを直ちに呼び出すのと同じ結果になります。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、許可されている場合にのみ、ファイルの監視が試行されます(詳しくは、watch() のドキュメントをご覧ください)。
|
再起動する
None
repository_ctx.watch(path)
「変更」には、ファイルの内容の変更(パスがファイルの場合)、パスがファイルからディレクトリに変更された場合やその逆の場合、パスが存在しなくなった場合などが含まれます。なお、パスがディレクトリの場合、ディレクトリ内のファイルの変更は含まれません。その場合は、代わりに path.readdir()
を使用します。
ただし、現在フェッチ中のリポジトリ内または現在のモジュール拡張機能の作業ディレクトリ内のパスを監視しようとすると、エラーが発生します。モジュール拡張機能が現在の Bazel ワークスペース外のパスを監視しようとした場合も、エラーが発生します。
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 監視するファイルのパス。 |
watch_tree
None
repository_ctx.watch_tree(path)
現在フェッチ中のリポジトリ内のパスを監視しようとすると、エラーが発生します。
パラメータ
パラメータ | 説明 |
---|---|
path
|
string、Label、path。必須 監視するディレクトリ ツリーのパス。 |
これは
path repository_ctx.which(program)
path
を返します。パスにそのようなプログラムがない場合、None
を返します。
パラメータ
パラメータ | 説明 |
---|---|
program
|
文字列。必須 パス内で検索するプログラム。 |
None
を返す場合があります。workspace_root
path repository_ctx.workspace_root