デフォルトの情報

問題を報告する ソースを表示

ターゲットの直接ファイルと推移的ファイルに関する一般的な情報を提供するプロバイダ。このプロバイダは、ルールの実装関数によって明示的に返されない場合でも、すべてのルールタイプに存在します。各 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 の機能」をご覧ください)

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

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

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

files

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) を使用してください。