ヘルパー関数と属性に関する情報を含むリポジトリ ルールのコンテキスト。リポジトリ ルールを作成するときに、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
フィールドを含むファイルのハッシュを返します。
パラメータ
パラメータ | 説明 |
---|---|
url
|
文字列、または文字列のイテラブル。
必須 同じファイルを参照するミラー URL のリスト。 |
output
|
文字列、ラベル、パス。デフォルトは '' 。リポジトリ ディレクトリを基準とする出力ファイルのパス。 |
sha256
|
デフォルトは '' で、ダウンロードされたファイルの想定される SHA-256 ハッシュです。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが生じます。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。指定すると、まず、指定したハッシュを持つファイルがないかリポジトリのキャッシュがチェックされます。ダウンロードは、そのファイルがキャッシュに見つからなかった場合にのみ試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
executable
|
デフォルトは False 作成されたファイルに実行可能フラグを設定します。デフォルトは false です。 |
allow_fail
|
デフォルトは False です設定されている場合は、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示します。 |
canonical_id
|
デフォルトは '' この値を設定すると、キャッシュ ヒットは、ファイルが同じ正規 ID でキャッシュに追加された場合にのみ発生します。デフォルトでは、キャッシュにチェックサム( sha256 または integrity )が使用されます。 |
auth
|
デフォルトは {} URL の認証情報を指定するオプションの辞書。 |
headers
|
デフォルトは {} すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
デフォルトは '' ダウンロードされたファイルの想定チェックサム(Subresource Integrity 形式)。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたチェックサムを持つファイルが検索されます。キャッシュにファイルが見つからない場合にのみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルがキャッシュに追加されます。 |
block
|
デフォルトは True です。false に設定すると、呼び出しはすぐに戻り、通常の戻り値ではなく、1 つのメソッド wait() でトークンを返します。このメソッドは、ダウンロードが完了するまでブロックし、通常の戻り値を返すか、通常どおりスローします。 |
download_and_extract
struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success
を含む構造体、ダウンロードが正常に完了した場合は true
のフラグ、正常に完了した場合は sha256
フィールドと integrity
フィールドを含むファイルのハッシュを返します。
パラメータ
パラメータ | 説明 |
---|---|
url
|
文字列、または文字列のイテラブル。
必須 同じファイルを参照するミラー URL のリスト。 |
output
|
string、Label、または 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」、「.tbz」、「.ar」、「.deb」のいずれかを明示的に指定できます。 |
stripPrefix
|
デフォルトは '' です。抽出されたファイルから削除するディレクトリ接頭辞です。多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリがあります。このフィールドを使用すると、この接頭辞を build_file で何度も指定しなくても、抽出されたファイルから削除できます。 |
allow_fail
|
デフォルトは False です。設定すると、ダウンロードに失敗したときにエラーをスローするのではなく、戻り値でエラーを示します。 |
canonical_id
|
デフォルトは '' この値を設定すると、キャッシュ ヒットは、ファイルが同じ正規 ID でキャッシュに追加された場合にのみ発生します。デフォルトでは、キャッシュにチェックサム( sha256 または integrity )が使用されます。 |
auth
|
デフォルトは {} URL の認証情報を指定するオプションの辞書。 |
headers
|
デフォルトは {} すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
デフォルトは '' ダウンロードされたファイルの想定チェックサム(Subresource Integrity 形式)。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルが変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたチェックサムを持つファイルが検索されます。キャッシュにファイルが見つからない場合にのみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルがキャッシュに追加されます。 |
rename_files
|
デフォルトは {} 抽出時に名前を変更するファイルを指定するオプションの辞書。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞の調整の前に、値に名前が変更されます。これは、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
|
デフォルトは {} です。一部の環境変数を強制的に設定してプロセスに渡します。 |
quiet
|
デフォルトは True です。stdout と stderr をターミナルに出力するかどうか。 |
working_directory
|
デフォルトは "" コマンド実行の作業ディレクトリ。リポジトリのルート相対または絶対にできます。 |
extract
None
repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')
パラメータ
パラメータ | 説明 |
---|---|
archive
|
文字列、ラベル、パス。必須 展開するアーカイブのパス(リポジトリ ディレクトリからの相対パス)。 |
output
|
文字列、ラベル、パス。デフォルトは '' 。アーカイブを展開するディレクトリのパス(リポジトリ ディレクトリからの相対パス)。 |
stripPrefix
|
デフォルトは '' です。抽出されたファイルから削除するディレクトリ接頭辞です。多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリが含まれています。この接頭辞を build_file で何度も指定する代わりに、このフィールドを使用して、抽出されたファイルから削除できます。 |
rename_files
|
デフォルトは {} 抽出時に名前を変更するファイルを指定するオプションの辞書。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞の調整の前に、値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイルシステム上の同じパスに抽出されるファイルを含むアーカイブの抽出に使用できます。 |
watch_archive
|
デフォルトは 'auto' です。アーカイブ ファイルを監視するかどうか。文字列「yes」、「no」、「auto」のいずれかです。「yes」を渡すと、 watch() メソッドがすぐに呼び出されます。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、ファイルの監視は、監視が許可されている場合にのみ試行されます(詳細については、watch() のドキュメントをご覧ください)。
|
ファイル
None
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
パラメータ
パラメータ | 説明 |
---|---|
path
|
string、Label、または path。リポジトリ ディレクトリを基準とする、作成するファイルの パス(必須)。 |
content
|
デフォルトは '' です。作成するファイルの内容。デフォルトでは空です。 |
executable
|
デフォルトは True 作成されたファイルに実行可能フラグを設定します。デフォルトは true です。 |
legacy_utf8
|
デフォルトは True ファイル コンテンツを UTF-8 にエンコードします。デフォルトは true です。今後のバージョンではデフォルトが変更され、このパラメータは削除されます。 |
getenv
string repository_ctx.getenv(name, default=None)
name
の値を文字列として返します(存在する場合)。存在しない場合は default
を返します。段階的にビルドする場合、name
で指定された変数の値が変更されると、このリポジトリが再取得されます。
パラメータ
パラメータ | 説明 |
---|---|
name
|
文字列。必須 目的の環境変数の名前 |
default
|
文字列、または 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
|
デフォルトは 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
|
string、Label、path。読み取り元のファイルの パス(必須)。 |
watch
|
デフォルトは 'auto' ファイルの監視を行うかどうか。文字列「yes」、「no」、「auto」のいずれかです。「yes」を渡すと、 watch() メソッドがすぐに呼び出されます。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、ファイルの監視は、監視が許可されている場合にのみ試行されます(詳しくは、watch() のドキュメントをご覧ください)。
|
report_progress
None
repository_ctx.report_progress(status='')
パラメータ
パラメータ | 説明 |
---|---|
status
|
文字列。デフォルトは '' 。取得の進行状況の現在のステータスを示す文字列。 |
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
|
文字列、ラベル、パス。必須 リポジトリ ディレクトリを基準とする、作成するファイルのパス。 |
template
|
文字列、ラベル、パス。必須 テンプレート ファイルのパス。 |
substitutions
|
デフォルトは {} です。テンプレートの拡張時に行われる置換があります。 |
executable
|
デフォルトは True です。作成されたファイルの実行可能フラグをデフォルトで true に設定します。 |
watch_template
|
デフォルトは 'auto' です。テンプレート ファイルを watch するかどうかを設定します。文字列「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
|
文字列、ラベル、パス。必須 監視するディレクトリ ツリーのパス。 |
これは
path repository_ctx.which(program)
パラメータ
パラメータ | 説明 |
---|---|
program
|
必須 パス内で検索するプログラム。 |
None
が返されることがあります。
workspace_root
path repository_ctx.workspace_root