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

Jump to bottom

operator.{itemgetter,attrgetter,methodcaller} don't have signatures #94590

Closed
eriknw opened this issue Jul 6, 2022 · 0 comments · Fixed by #94591
Closed

operator.{itemgetter,attrgetter,methodcaller} don't have signatures #94590

eriknw opened this issue Jul 6, 2022 · 0 comments · Fixed by #94591
Labels
type-feature A feature request or enhancement

Comments

@eriknw
Copy link
Contributor

eriknw commented Jul 6, 2022

Feature or enhancement

Update the docstrings to operator.itemgetter, operator.attrgetter, and operator.methodcaller so that they will automatically be given __text_signature__ strings so inspect.signature will give correct signature.

Pitch

These are the only functions in operator that don't have signatures. operator functions are often used when programming in a functional style, and sometimes signature inspection is useful to e.g. determine whether a call is valid or whether to curry arguments.

Also, as a user, I find it nice to see accurate text signatures in the docstring and when calling help(func).

Previous discussion

These were intentionally skipped when operator functions were updated to use the argument clinic. See:

PR forthcoming.
@eriknw eriknw added the type-feature A feature request or enhancement label Jul 6, 2022
@eriknw eriknw mentioned this issue Jul 6, 2022
Merged
JelleZijlstra pushed a commit that referenced this issue Oct 6, 2022
@eriknw
gh-94590: add signatures to operator itemgetter, attrgetter, methodca…
1c4728c 
…ller (#94591)

These were intentionally skipped when operator was updated to use the argument clinic:
#64385 (comment)

However, by not using the argument clinic, they missed out on getting signatures.
This is a narrow PR to update the docstrings so that `__text_signature__` can be
extracted from them.  Updating to use the argument clinic is beyond scope.

`methodcaller` uses `*args, **kwargs` to match variadic names used elsewhere,
including in `operator.call`.
carljm added a commit to carljm/cpython that referenced this issue Oct 6, 2022
@carljm
Merge branch 'main' into dictwatch
e5d2169 
* main:
  fixes pythongh-96078: os.sched_yield release the GIL while calling sched_yield(2). (pythongh-97965)
  pythongh-65961: Do not rely solely on `__cached__` (pythonGH-97990)
  pythongh-97850: Remove the open issues section from the import reference (python#97935)
  Docs: pin sphinx-lint (pythonGH-97992)
  pythongh-94590: add signatures to operator itemgetter, attrgetter, methodcaller (python#94591)
  Add Pynche's move to the What's new in 3.11 (python#97974)
  pythongh-97781: Apply changes from importlib_metadata 5. (pythonGH-97785)
  pythongh-86482: Document assignment expression need for ()s (python#23291)
  pythongh-97943: PyFunction_GetAnnotations should return a borrowed reference. (python#97949)
  pythongh-94808: Coverage: Test that maximum indentation level is handled (python#95926)
carljm added a commit to carljm/cpython that referenced this issue Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
415ed49 
* main:
  pythonGH-97002: Prevent `_PyInterpreterFrame`s from backing more than one `PyFrameObject` (pythonGH-97996)
  pythongh-97973: Return all necessary information from the tokenizer (pythonGH-97984)
  fixes pythongh-96078: os.sched_yield release the GIL while calling sched_yield(2). (pythongh-97965)
  pythongh-65961: Do not rely solely on `__cached__` (pythonGH-97990)
  pythongh-97850: Remove the open issues section from the import reference (python#97935)
  Docs: pin sphinx-lint (pythonGH-97992)
  pythongh-94590: add signatures to operator itemgetter, attrgetter, methodcaller (python#94591)
  Add Pynche's move to the What's new in 3.11 (python#97974)
  pythongh-97781: Apply changes from importlib_metadata 5. (pythonGH-97785)
  pythongh-86482: Document assignment expression need for ()s (python#23291)
  pythongh-97943: PyFunction_GetAnnotations should return a borrowed reference. (python#97949)
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@eriknw @mpage
pythongh-94590: add signatures to operator itemgetter, attrgetter, me…
a9a8f2e 
…thodcaller (python#94591)

These were intentionally skipped when operator was updated to use the argument clinic:
python#64385 (comment)

However, by not using the argument clinic, they missed out on getting signatures.
This is a narrow PR to update the docstrings so that `__text_signature__` can be
extracted from them.  Updating to use the argument clinic is beyond scope.

`methodcaller` uses `*args, **kwargs` to match variadic names used elsewhere,
including in `operator.call`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-94590: add signatures to operator itemgetter, attrgetter, methodcaller eriknw/cpython
1 participant
@eriknw