Skip to content

Commit

Permalink
Update documentation to include PartialCallableObjectProxy
Browse files Browse the repository at this point in the history
  • Loading branch information
Neil Wadhvana committed Dec 5, 2024
1 parent 0da4ba5 commit 4ca0dbe
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/decorators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ being able to be dropped in the latter.

def with_optional_arguments(wrapped=None, myarg1=1, myarg2=2):
if wrapped is None:
return functools.partial(with_optional_arguments,
return wrapt.PartialCallableObjectProxy(with_optional_arguments,
myarg1=myarg1, myarg2=myarg2)

@wrapt.decorator
Expand Down Expand Up @@ -155,7 +155,7 @@ be enforced using the keyword only argument syntax.

def with_optional_arguments(wrapped=None, *, myarg1=1, myarg2=2):
if wrapped is None:
return functools.partial(with_optional_arguments,
return wrapt.PartialCallableObjectProxy(with_optional_arguments,
myarg1=myarg1, myarg2=myarg2)

@wrapt.decorator
Expand All @@ -164,6 +164,10 @@ be enforced using the keyword only argument syntax.

return wrapper(wrapped)

The ``wrapt.PartialCallableObjectProxy()`` object is an implementation of
``functools.partial()`` which uses wrapt and preserves introspection for the
wrapped callable object.

Processing Function Arguments
-----------------------------

Expand Down

0 comments on commit 4ca0dbe

Please sign in to comment.