デフォルトの情報

問題を報告 ソースを表示 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

ターゲットの直接ファイルと推移的ファイルに関する一般的な情報を提供するプロバイダ。ルールタイプごとにこのプロバイダがあります。ルールの実装関数で明示的に返されない場合でも、このプロバイダは存在します。各 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
です。このターゲットが実行時（run コマンドまたはツール依存関係として）に必要とするファイルを記述する runfiles 記述子。
data_runfiles runfiles。または None。デフォルトは None
です。

このパラメータの使用は避けることをおすすめします（「避けるべき runfiles 機能」を参照）

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

このパラメータの使用は避けることをおすすめします（「避けるべき runfiles 機能」を参照）

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

data_runfiles

runfiles DefaultInfo.data_runfiles

このターゲットが data 依存関係属性であるという条件で実行されるときに必要なファイルを記述する runfiles ディスクリプタ。ほとんどの場合、代わりに default_runfiles パラメータを使用します。詳しくは、「回避すべき runfile の機能」をご覧ください。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 で無効になっています。このフラグを使用して、コードが削除予定の API と互換性があることを確認します。
構造体パラメータから 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 で無効になっています。このフラグを使用して、コードが削除予定の API と互換性があることを確認します。
構造体パラメータからテキスト メッセージを作成します。このメソッドは、すべての構造体要素（再帰的）が文字列、整数、ブール値、他の構造体、辞書、またはこれらの型のリストである場合にのみ機能します。文字列内の引用符と改行はエスケープされます。構造体のキーはソートされた順序で反復処理されます。例:
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) を使用してください。