gh-64373: Convert _functools to Argument Clinic
#96640
Open
+582
−83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Now, let's compare cmp_to_keyBefore: >>> help(_functools.cmp_to_key)
Help on built-in function cmp_to_key in module _functools:
cmp_to_key(...)
Convert a cmp= function into a key= function.After: >>> help(_functools.cmp_to_key)
Help on built-in function cmp_to_key in module _functools:
cmp_to_key(mycmp)
Convert a cmp= function into a key= function.
mycmp
Function that compares two objects._lru_cache_wrapperBefore: >>> help(_functools._lru_cache_wrapper)
Help on class _lru_cache_wrapper in module functools:
class _lru_cache_wrapper(builtins.object)
| Create a cached callable that wraps another function.
|
| user_function: the function being cached
|
| maxsize: 0 for no caching
| None for unlimited cache size
| n for a bounded cache
|
| typed: False cache f(3) and f(3.0) as identical calls
| True cache f(3) and f(3.0) as distinct calls
|
| cache_info_type: namedtuple class with the fields:
| hits misses currsize maxsize
|
| Methods defined here:After: >>> help(_functools._lru_cache_wrapper)
Help on class _lru_cache_wrapper in module functools:
class _lru_cache_wrapper(builtins.object)
| _lru_cache_wrapper(user_function, maxsize, typed, cache_info_type)
|
| Create a cached callable that wraps another function.
|
| user_function
| the function being cached
| maxsize
| 0 for no caching
| None for unlimited cache size
| n for a bounded cache
| typed
| False cache f(3) and f(3.0) as identical calls
| True cache f(3) and f(3.0) as distinct calls
| cache_info_type
| namedtuple class with the fields:
| hits misses currsize maxsize
|
| Methods defined here:
|
This was referenced Sep 7, 2022
|
We generally only apply argclinic to functions directly visible to the user. Otherwise, it is mostly pointless since no one sees the signature. So, I would leave the lru cache internals alone -- iirc, we had an issue for this previously. It was would be a lot of code churn for no benefit. The |
|
Thank you for the insight! This is my first clinic-related PR. I will remove things like
I think that |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
A couple of extra notes:
functools.reduceis not converted, because itsargsparsing / in-place mutation is optimizedpartial_newandpartial_callrequire*args, **kwargs, as far as I know AC does not support that at the moment, they are not converted_lru_cache_wrapper.__call__