Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to include PartialCallableObjectProxy #278

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update documentation to include PartialCallableObjectProxy #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/decorators.rst
View file
Open in desktop
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