デフォルトの情報

ターゲットの直接ファイルと推移的ファイルに関する一般的な情報を提供するプロバイダ。このプロバイダは、ルールの実装関数で明示的に返されないものも含め、すべてのルールタイプに存在します。各 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。
bazel コマンドラインにこのタゲが指定されたときにビルドされるデフォルトの出力を表す File オブジェクトの depset。デフォルトでは、すべて事前に宣言された出力です。
runfiles runfiles、または None。デフォルトは None です。
このターゲットが実行時に必要とするファイルを記述する runfiles 記述子です（run コマンドを使用するか、ツールの依存関係として）。
data_runfiles runfiles または None。デフォルトは None です。

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

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

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

data 属性以外の属性を介して依存関係である場合に、このターゲットが実行する必要がある runfiles を記述する runfiles 記述子。
executable ファイル、または 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

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

ファイル

depset DefaultInfo.files

bazel コマンドラインでこのターゲットが指定されたときにビルドされるデフォルトの出力を表す File オブジェクトの depset。デフォルトでは、すべて事前に宣言された出力です。 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) を使用してください。