デフォルトの情報

問題を報告 ソースを表示

ターゲットの直接ファイルと推移的ファイルに関する一般的な情報を提供するプロバイダ。このプロバイダは、ルールの実装関数で明示的に返されないものも含め、すべてのルールタイプに存在します。各 DefaultInfo インスタンスには次のフィールドがあります。
  • files
  • files_to_run
  • data_runfiles
  • default_runfiles
このプロバイダの使用方法の詳細については、ルールページをご覧ください。

メンバー

DefaultInfo

DefaultInfo DefaultInfo(files=None, runfiles=None, data_runfiles=None, default_runfiles=None, executable=None)

DefaultInfo コンストラクタ。

パラメータ

パラメータ 説明
files depset または None。デフォルトは None です。
File オブジェクトの depset。このターゲットが bazel コマンドラインで指定されたときにビルドされるデフォルトの出力を表します。デフォルトでは、すべて事前に宣言された出力です。
runfiles runfiles、または None。デフォルトは None です。
このターゲットが実行時に（run コマンドで、またはツールの依存関係として）必要なファイルを記述する runfiles 記述子です。
data_runfiles runfiles、または None。デフォルトは None

このパラメータは使用しないことをおすすめします（避けるべき runfiles 機能をご覧ください）。

runfiles 記述子。data 属性を介して、このターゲットが依存関係の場合に実行する必要のあるランファイルを記述します。
default_runfiles runfiles、または None。デフォルトは None

このパラメータは使用しないことをおすすめします（避けるべき runfiles 機能をご覧ください）。

runfiles 記述子。data 属性以外の属性を使用して、このターゲットが依存関係である場合に実行する必要のあるランファイルを記述します。
executable File または None。デフォルトは None です。
このルールが executable または test とマークされている場合、これは File オブジェクトで、ターゲットを実行するために実行されるファイルを表します。デフォルトでは、事前に宣言された出力 ctx.outputs.executable です。

data_runfiles

runfiles DefaultInfo.data_runfiles

runfiles 記述子。このターゲットが data 依存関係属性である条件で実行されるときに必要となるファイルを記述します。ほとんどの場合、代わりに default_runfiles パラメータを使用します。詳しくは、避けるべき runfiles 機能をご覧ください。None が返されることがあります。

default_runfiles

runfiles DefaultInfo.default_runfiles

runfiles 記述子: このターゲットが実行時に必要とするファイルを（run コマンドを介して、またはツールの依存関係として）記述します。 None が返されることがあります。

ファイル

depset DefaultInfo.files

File オブジェクトの depset。このターゲットが bazel コマンドラインで指定されたときにビルドされるデフォルトの出力を表します。デフォルトでは、すべて事前に宣言された出力です。 None が返されることがあります。

files_to_run

FilesToRunProvider DefaultInfo.files_to_run

ターゲットの実行可能ファイルとランファイルに関する情報を含む FilesToRunProvider オブジェクト。None が返されることがあります。

to_json

string DefaultInfo.to_json()

非推奨。この API は非推奨となっており、まもなく削除されます。これに依存しないでください。---incompatible_struct_has_no_methods により無効になります。このフラグを使用して、コードが間もなく削除される可能性があることを確認します。
構造体パラメータから JSON 文字列を作成します。このメソッドは、すべての構造体要素が（再帰的に）文字列、整数、ブール値、その他の構造体、これらの型のリスト、または文字列キーとこれらの型の値を持つ辞書である場合にのみ機能します。文字列内の引用符と改行はエスケープされます。例:
struct(key=123).to_json()
# {"key":123}

struct(key=True).to_json()
# {"key":true}

struct(key=[1, 2, 3]).to_json()
# {"key":[1,2,3]}

struct(key='text').to_json()
# {"key":"text"}

struct(key=struct(inner_key='text')).to_json()
# {"key":{"inner_key":"text"}}

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json()
# {"key":[{"inner_key":1},{"inner_key":2}]}

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json()
# {"key":{"inner_key":{"inner_inner_key":"text"}}}
。

非推奨: 代わりに json.encode(x) または json.encode_indent(x) を使用してください。これらは構造体以外の値に対して機能し、構造体フィールドの名前空間を汚染しません。

to_proto

string DefaultInfo.to_proto()

非推奨。この API は非推奨となっており、まもなく削除されます。これに依存しないでください。---incompatible_struct_has_no_methods により無効になります。このフラグを使用して、コードが間もなく削除される可能性があることを確認します。
構造体パラメータからテキスト メッセージを作成します。このメソッドは、すべての構造体要素が（再帰的に）文字列、整数、ブール値、その他の構造体、辞書、またはリストである場合にのみ機能します。文字列内の引用符と改行はエスケープされます。構造体キーは並べ替えた順序で反復されます。例:
struct(key=123).to_proto()
# key: 123

struct(key=True).to_proto()
# key: true

struct(key=[1, 2, 3]).to_proto()
# key: 1
# key: 2
# key: 3

struct(key='text').to_proto()
# key: "text"

struct(key=struct(inner_key='text')).to_proto()
# key {
#   inner_key: "text"
# }

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto()
# key {
#   inner_key: 1
# }
# key {
#   inner_key: 2
# }

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto()
# key {
#    inner_key {
#     inner_inner_key: "text"
#   }
# }

struct(foo={4: 3, 2: 1}).to_proto()
# foo: {
#   key: 4
#   value: 3
# }
# foo: {
#   key: 2
#   value: 1
# }

非推奨: 代わりに proto.encode_text(x) を使用してください。