2
0
Fork 0
mirror of https://github.com/bazelbuild/bazel-skylib synced 2024-11-30 10:41:18 +00:00
bazel-skylib/docs/dicts_doc.md
nickgooding 31ab4c8bd2
feat: bzlmod setup (#385)
Creates MODULE.bazel and WORKSPACE.bzlmod files to enable bazel-skylib
to work with the `--experimental_enable_bzlmod` flag.

rules_go has been updated as the previously used version is not
available in the BCR.

stardoc has been updated due to a strange issue with Bzlmod enabled that
caused the `diff_test` and `unittest` docs to be generated without any
contents that was magically fixed upon updating.

bazelbuild/bazel-central-registry#124

Co-authored-by: Alexandre Rostovtsev <arostovtsev@google.com>
2022-08-30 14:57:34 -04:00

83 lines
2.3 KiB
Markdown
Executable file

<!-- Generated with Stardoc: http://skydoc.bazel.build -->
Skylib module containing functions that operate on dictionaries.
<a id="dicts.add"></a>
## dicts.add
<pre>
dicts.add(<a href="#dicts.add-dictionaries">dictionaries</a>, <a href="#dicts.add-kwargs">kwargs</a>)
</pre>
Returns a new `dict` that has all the entries of the given dictionaries.
If the same key is present in more than one of the input dictionaries, the
last of them in the argument list overrides any earlier ones.
This function is designed to take zero or one arguments as well as multiple
dictionaries, so that it follows arithmetic identities and callers can avoid
special cases for their inputs: the sum of zero dictionaries is the empty
dictionary, and the sum of a single dictionary is a copy of itself.
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="dicts.add-dictionaries"></a>dictionaries | Zero or more dictionaries to be added. | none |
| <a id="dicts.add-kwargs"></a>kwargs | Additional dictionary passed as keyword args. | none |
**RETURNS**
A new `dict` that has all the entries of the given dictionaries.
<a id="dicts.omit"></a>
## dicts.omit
<pre>
dicts.omit(<a href="#dicts.omit-dictionary">dictionary</a>, <a href="#dicts.omit-keys">keys</a>)
</pre>
Returns a new `dict` that has all the entries of `dictionary` with keys not in `keys`.
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="dicts.omit-dictionary"></a>dictionary | A <code>dict</code>. | none |
| <a id="dicts.omit-keys"></a>keys | A sequence. | none |
**RETURNS**
A new `dict` that has all the entries of `dictionary` with keys not in `keys`.
<a id="dicts.pick"></a>
## dicts.pick
<pre>
dicts.pick(<a href="#dicts.pick-dictionary">dictionary</a>, <a href="#dicts.pick-keys">keys</a>)
</pre>
Returns a new `dict` that has all the entries of `dictionary` with keys in `keys`.
**PARAMETERS**
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
| <a id="dicts.pick-dictionary"></a>dictionary | A <code>dict</code>. | none |
| <a id="dicts.pick-keys"></a>keys | A sequence. | none |
**RETURNS**
A new `dict` that has all the entries of `dictionary` with keys in `keys`.