-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate struct and Provider to the skylark build api
RELNOTES: None. PiperOrigin-RevId: 195013604
- Loading branch information
Showing
4 changed files
with
124 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
src/main/java/com/google/devtools/build/lib/skylarkbuildapi/ProviderApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| // Copyright 2017 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| package com.google.devtools.build.lib.skylarkbuildapi; | ||
|
|
||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkValue; | ||
|
|
||
| /** Interface for provider objects (constructors for {@link StructApi} objects). */ | ||
| @SkylarkModule( | ||
| name = "Provider", | ||
| doc = | ||
| "A constructor for simple value objects, known as provider instances." | ||
| + "<br>" | ||
| + "This value has a dual purpose:" | ||
| + " <ul>" | ||
| + " <li>It is a function that can be called to construct 'struct'-like values:" | ||
| + "<pre class=\"language-python\">DataInfo = provider()\n" | ||
| + "d = DataInfo(x = 2, y = 3)\n" | ||
| + "print(d.x + d.y) # prints 5</pre>" | ||
| + " Note: Some providers, defined internally, do not allow instance creation" | ||
| + " </li>" | ||
| + " <li>It is a <i>key</i> to access a provider instance on a" | ||
| + " <a href=\"Target.html\">Target</a>" | ||
| + "<pre class=\"language-python\">DataInfo = provider()\n" | ||
| + "def _rule_impl(ctx)\n" | ||
| + " ... ctx.attr.dep[DataInfo]</pre>" | ||
| + " </li>" | ||
| + " </ul>" | ||
| + "Create a new <code>Provider</code> using the " | ||
| + "<a href=\"globals.html#provider\">provider</a> function." | ||
| ) | ||
| public interface ProviderApi extends SkylarkValue {} |
75 changes: 75 additions & 0 deletions
75
src/main/java/com/google/devtools/build/lib/skylarkbuildapi/StructApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // Copyright 2018 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package com.google.devtools.build.lib.skylarkbuildapi; | ||
|
|
||
| import com.google.devtools.build.lib.events.Location; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; | ||
| import com.google.devtools.build.lib.skylarkinterface.SkylarkValue; | ||
| import com.google.devtools.build.lib.syntax.EvalException; | ||
|
|
||
| /** Interface for the "struct" object in the build API. */ | ||
| @SkylarkModule( | ||
| name = "struct", | ||
| category = SkylarkModuleCategory.BUILTIN, | ||
| doc = | ||
| "A generic object with fields. See the global <a href=\"globals.html#struct\"><code>struct" | ||
| + "</code></a> function for more details." | ||
| + "<p>Structs fields cannot be reassigned once the struct is created. Two structs are " | ||
| + "equal if they have the same fields and if corresponding field values are equal.") | ||
| public interface StructApi extends SkylarkValue { | ||
|
|
||
| @SkylarkCallable( | ||
| name = "to_proto", | ||
| doc = | ||
| "Creates a text message from the struct parameter. This method only works if all " | ||
| + "struct elements (recursively) are strings, ints, booleans, other structs or a " | ||
| + "list of these types. Quotes and new lines in strings are escaped. " | ||
| + "Keys are iterated in the sorted order. " | ||
| + "Examples:<br><pre class=language-python>" | ||
| + "struct(key=123).to_proto()\n# key: 123\n\n" | ||
| + "struct(key=True).to_proto()\n# key: true\n\n" | ||
| + "struct(key=[1, 2, 3]).to_proto()\n# key: 1\n# key: 2\n# key: 3\n\n" | ||
| + "struct(key='text').to_proto()\n# key: \"text\"\n\n" | ||
| + "struct(key=struct(inner_key='text')).to_proto()\n" | ||
| + "# key {\n# inner_key: \"text\"\n# }\n\n" | ||
| + "struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto()\n" | ||
| + "# key {\n# inner_key: 1\n# }\n# key {\n# inner_key: 2\n# }\n\n" | ||
| + "struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto()\n" | ||
| + "# key {\n# inner_key {\n# inner_inner_key: \"text\"\n# }\n# }\n</pre>", | ||
| useLocation = true) | ||
| public String toProto(Location loc) throws EvalException; | ||
|
|
||
| @SkylarkCallable( | ||
| name = "to_json", | ||
| doc = | ||
| "Creates a JSON string from the struct parameter. This method only works if all " | ||
| + "struct elements (recursively) are strings, ints, booleans, other structs or a " | ||
| + "list of these types. Quotes and new lines in strings are escaped. " | ||
| + "Examples:<br><pre class=language-python>" | ||
| + "struct(key=123).to_json()\n# {\"key\":123}\n\n" | ||
| + "struct(key=True).to_json()\n# {\"key\":true}\n\n" | ||
| + "struct(key=[1, 2, 3]).to_json()\n# {\"key\":[1,2,3]}\n\n" | ||
| + "struct(key='text').to_json()\n# {\"key\":\"text\"}\n\n" | ||
| + "struct(key=struct(inner_key='text')).to_json()\n" | ||
| + "# {\"key\":{\"inner_key\":\"text\"}}\n\n" | ||
| + "struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json()\n" | ||
| + "# {\"key\":[{\"inner_key\":1},{\"inner_key\":2}]}\n\n" | ||
| + "struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json()\n" | ||
| + "# {\"key\":{\"inner_key\":{\"inner_inner_key\":\"text\"}}}\n</pre>", | ||
| useLocation = true) | ||
| public String toJson(Location loc) throws EvalException; | ||
| } |