デフォルトの情報

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

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

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

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

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

このターゲットの実行時に必要なファイル（run コマンド経由またはツールの依存関係として）を記述する runfiles 記述子。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) を使用してください。