From 4497a82c504818d61ab18c5251ae2bc42bae279e Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 23 Nov 2024 18:47:50 +0000 Subject: Deploying to docs from @ python-discord/bot-core@bdaaa2e76d4cb32843754757532ef8d73ac97761 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v11.3.0/output/pydis_core.utils.function.html | 60 +++++++++++++++------------ 1 file changed, 34 insertions(+), 26 deletions(-) (limited to 'v11.3.0/output/pydis_core.utils.function.html') diff --git a/v11.3.0/output/pydis_core.utils.function.html b/v11.3.0/output/pydis_core.utils.function.html index b93e07a8..73dd206b 100644 --- a/v11.3.0/output/pydis_core.utils.function.html +++ b/v11.3.0/output/pydis_core.utils.function.html @@ -5,13 +5,13 @@ - + function - Pydis Core v11.3.0 - + @@ -330,6 +330,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -457,7 +465,7 @@
    exception GlobalNameConflictError[source]¶
    -

    Bases: Exception

    +

    Bases: Exception

    Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.

    @@ -469,17 +477,17 @@
    Parameters:
      -

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • -

    • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

      • -

    • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

      • -

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

      • +

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • +

    • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

      • +

    • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

      • +

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

    Return type:
    -

    Callable[[Callable[[ParamSpec(_P)], TypeVar(_R)]], Callable[[ParamSpec(_P)], TypeVar(_R)]]

    +

    Callable[[Callable[[ParamSpec(_P)], TypeVar(_R)]], Callable[[ParamSpec(_P)], TypeVar(_R)]]

    Returns:
    -

    A decorator that behaves like functools.wraps(), +

    A decorator that behaves like functools.wraps(), with the wrapper replaced with the function update_wrapper_globals() returned.

    @@ -491,18 +499,18 @@ with the wrapper replaced with the function
    Parameters:
    -

    arguments (OrderedDict[str, Any]) – An ordered mapping of parameter names to argument values.

    +

    arguments (OrderedDict[str, Any]) – An ordered mapping of parameter names to argument values.

    Return type:
    -

    Any

    +

    Any

    Returns:

    Value from arguments based on a name or position.

    Raises:
    @@ -515,14 +523,14 @@ with the wrapper replaced with the function
    Parameters:
    Return type:
    -

    Callable[[Callable], Callable]

    +

    Callable[[Callable], Callable]

    Returns:

    The decorator returned by decorator_func.

    @@ -538,13 +546,13 @@ parameter names to argument values of the function it’s decorating.

    Parameters:
      -

    • args (tuple) – The arguments to bind to func

      • -

    • kwargs (dict[str, Any]) – The keyword arguments to bind to func

      • -

    • func (Callable) – The function to bind args and kwargs to

      • +

    • args (tuple) – The arguments to bind to func

      • +

    • kwargs (dict[str, Any]) – The keyword arguments to bind to func

      • +

    • func (Callable) – The function to bind args and kwargs to

    Return type:
    -

    OrderedDict[str, Any]

    +

    OrderedDict[str, Any]

    Returns:

    A mapping of parameter names to argument values.

    @@ -567,9 +575,9 @@ changes won’t be reflected in the new function’s globals.

    Parameters:
      -

    • wrapper (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap.

      • -

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • -

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

      • +

    • wrapper (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap.

      • +

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • +

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

    Raises:
    @@ -577,7 +585,7 @@ changes won’t be reflected in the new function’s globals.

    and is not in ignored_conflict_names.

    Return type:
    -

    Callable[[ParamSpec(_P)], TypeVar(_R)]

    +

    Callable[[ParamSpec(_P)], TypeVar(_R)]

    @@ -658,7 +666,7 @@ changes won’t be reflected in the new function’s globals.

    - + -- cgit v1.2.3