デフォルトの情報

7.3 · 7.2 · 7.1 · 7.0 · 6.5

ターゲットの直接ファイルと間接ファイルに関する一般的な情報を提供するプロバイダ。ルールの実装関数によって明示的に返されない場合でも、すべてのルールタイプにこのプロバイダがあります。各 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

data 依存関係属性であるという条件で実行するときに、このターゲットが必要とするファイルを記述する runfiles 記述子。ほとんどの場合、代わりに 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) を使用してください。