mirror of
https://github.com/bazelbuild/bazel-skylib
synced 2024-11-28 08:43:51 +00:00
Update partial_doc.md (#308)
Clean up the docs to make them look significantly better. No semantics changes, just styling.
This commit is contained in:
parent
fd75066f15
commit
775f66fb28
|
@ -12,16 +12,22 @@ passed to it at the call sites.
|
||||||
A partial 'function' can be defined with positional args and kwargs:
|
A partial 'function' can be defined with positional args and kwargs:
|
||||||
|
|
||||||
# function with no args
|
# function with no args
|
||||||
|
```
|
||||||
def function1():
|
def function1():
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
# function with 2 args
|
# function with 2 args
|
||||||
|
```
|
||||||
def function2(arg1, arg2):
|
def function2(arg1, arg2):
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
# function with 2 args and keyword args
|
# function with 2 args and keyword args
|
||||||
|
```
|
||||||
def function3(arg1, arg2, x, y):
|
def function3(arg1, arg2, x, y):
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
The positional args passed to the function are the args passed into make
|
The positional args passed to the function are the args passed into make
|
||||||
followed by any additional positional args given to call. The below example
|
followed by any additional positional args given to call. The below example
|
||||||
|
@ -29,24 +35,30 @@ illustrates a function with two positional arguments where one is supplied by
|
||||||
make and the other by call:
|
make and the other by call:
|
||||||
|
|
||||||
# function demonstrating 1 arg at make site, and 1 arg at call site
|
# function demonstrating 1 arg at make site, and 1 arg at call site
|
||||||
|
```
|
||||||
def _foo(make_arg1, func_arg1):
|
def _foo(make_arg1, func_arg1):
|
||||||
print(make_arg1 + " " + func_arg1 + "!")
|
print(make_arg1 + " " + func_arg1 + "!")
|
||||||
|
```
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
```
|
||||||
hi_func = partial.make(_foo, "Hello")
|
hi_func = partial.make(_foo, "Hello")
|
||||||
bye_func = partial.make(_foo, "Goodbye")
|
bye_func = partial.make(_foo, "Goodbye")
|
||||||
partial.call(hi_func, "Jennifer")
|
partial.call(hi_func, "Jennifer")
|
||||||
partial.call(hi_func, "Dave")
|
partial.call(hi_func, "Dave")
|
||||||
partial.call(bye_func, "Jennifer")
|
partial.call(bye_func, "Jennifer")
|
||||||
partial.call(bye_func, "Dave")
|
partial.call(bye_func, "Dave")
|
||||||
|
```
|
||||||
|
|
||||||
prints:
|
prints:
|
||||||
|
|
||||||
|
```
|
||||||
"Hello, Jennifer!"
|
"Hello, Jennifer!"
|
||||||
"Hello, Dave!"
|
"Hello, Dave!"
|
||||||
"Goodbye, Jennifer!"
|
"Goodbye, Jennifer!"
|
||||||
"Goodbye, Dave!"
|
"Goodbye, Dave!"
|
||||||
|
```
|
||||||
|
|
||||||
The keyword args given to the function are the kwargs passed into make
|
The keyword args given to the function are the kwargs passed into make
|
||||||
unioned with the keyword args given to call. In case of a conflict, the
|
unioned with the keyword args given to call. In case of a conflict, the
|
||||||
|
@ -56,16 +68,20 @@ value for keyword arguments and override it at the call site.
|
||||||
Example with a make site arg, a call site arg, a make site kwarg and a
|
Example with a make site arg, a call site arg, a make site kwarg and a
|
||||||
call site kwarg:
|
call site kwarg:
|
||||||
|
|
||||||
|
```
|
||||||
def _foo(make_arg1, call_arg1, make_location, call_location):
|
def _foo(make_arg1, call_arg1, make_location, call_location):
|
||||||
print(make_arg1 + " is from " + make_location + " and " +
|
print(make_arg1 + " is from " + make_location + " and " +
|
||||||
call_arg1 + " is from " + call_location + "!")
|
call_arg1 + " is from " + call_location + "!")
|
||||||
|
|
||||||
func = partial.make(_foo, "Ben", make_location="Hollywood")
|
func = partial.make(_foo, "Ben", make_location="Hollywood")
|
||||||
partial.call(func, "Jennifer", call_location="Denver")
|
partial.call(func, "Jennifer", call_location="Denver")
|
||||||
|
```
|
||||||
|
|
||||||
Prints "Ben is from Hollywood and Jennifer is from Denver!".
|
Prints "Ben is from Hollywood and Jennifer is from Denver!".
|
||||||
|
|
||||||
|
```
|
||||||
partial.call(func, "Jennifer", make_location="LA", call_location="Denver")
|
partial.call(func, "Jennifer", make_location="LA", call_location="Denver")
|
||||||
|
```
|
||||||
|
|
||||||
Prints "Ben is from LA and Jennifer is from Denver!".
|
Prints "Ben is from LA and Jennifer is from Denver!".
|
||||||
|
|
||||||
|
@ -73,12 +89,13 @@ Note that keyword args may not overlap with positional args, regardless of
|
||||||
whether they are given during the make or call step. For instance, you can't
|
whether they are given during the make or call step. For instance, you can't
|
||||||
do:
|
do:
|
||||||
|
|
||||||
|
```
|
||||||
def foo(x):
|
def foo(x):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
func = partial.make(foo, 1)
|
func = partial.make(foo, 1)
|
||||||
partial.call(func, x=2)
|
partial.call(func, x=2)
|
||||||
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue