bpo-37755: Use configured output in pydoc instead of pager #15105

eht16 · 2019-08-04T12:55:22Z

If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output.
Change the behavior so the output is used if available while keeping the previous behavior if no output was configured.

https://bugs.python.org/issue37755

the-knights-who-say-ni · 2019-08-04T12:55:25Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Our records indicate we have not received your CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

serhiy-storchaka

Please add tests and a NEWS entry.

bedevere-app · 2024-02-29T16:52:54Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

bedevere-app · 2024-06-02T11:29:09Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured.

eht16 · 2024-06-02T12:13:33Z

I have made the requested changes; please review again

Though I'm not sure why the Docs action fail, I don't see how the references are incorrect.

bedevere-app · 2024-06-02T12:13:38Z

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

Misc/NEWS.d/next/Library/2024-06-02-13-35-11.gh-issue-81936.ETeW9x.rst

serhiy-storchaka · 2024-06-02T12:29:41Z

Lib/test/test_pydoc/test_pydoc.py

+        pydoc.getpager = getpager_new
+        try:


You can use test.support.swap_attr() or unittest.mock.patch().

It would be nice to test also that the pager was not called (otherwise why do you need to patch it?).

Good idea, done.

I modified also the existing test test_help_output_redirect from which I borrowed the "getpager" handling code. To me it also seems more reasonable to use mocking here.

…1936.ETeW9x.rst Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

serhiy-storchaka

Very good. But it seems that getpager() is never called in pydoc, so mocking it does not have effect. Should not you mock pager?

eht16 · 2024-06-08T08:50:24Z

Very good. But it seems that getpager() is never called in pydoc, so mocking it does not have effect. Should not you mock pager?

Oops, thanks for noticing. I thought getpager() get called indirectly via pager() but anyway, it is better to mock the pager() function directly.

I'd like to squash the "fixup" commits or do you want to it yourself on merging?

serhiy-storchaka

LGTM.

Usually we only squash on merging.

miss-islington-app · 2024-06-08T09:19:17Z

Thanks @eht16 for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…15105) If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured. (cherry picked from commit 2080425) Co-authored-by: Enrico Tröger <enrico.troeger@uvena.de>

miss-islington-app · 2024-06-08T09:19:25Z

Sorry, @eht16 and @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 2080425154d235b4b7dcc9a8a2f58e71769125ca 3.12

bedevere-app · 2024-06-08T09:19:26Z

GH-120261 is a backport of this pull request to the 3.13 branch.

…thonGH-15105) If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured. (cherry picked from commit 2080425) Co-authored-by: Enrico Tröger <enrico.troeger@uvena.de>

bedevere-app · 2024-06-08T09:24:19Z

GH-120262 is a backport of this pull request to the 3.12 branch.

…-15105) (GH-120262) If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured. (cherry picked from commit 2080425) Co-authored-by: Enrico Tröger <enrico.troeger@uvena.de>

…-15105) (GH-120261) If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured. (cherry picked from commit 2080425) Co-authored-by: Enrico Tröger <enrico.troeger@uvena.de>

…15105) If the Helper() class was initialized with an output, the topics, keywords and symbols help still use the pager instead of the output. Change the behavior so the output is used if available while keeping the previous behavior if no output was configured.

the-knights-who-say-ni added the CLA not signed label Aug 4, 2019

bedevere-bot added the awaiting review label Aug 4, 2019

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Aug 5, 2019

ezio-melotti removed the CLA signed label Jul 13, 2022

serhiy-storchaka requested changes Feb 29, 2024

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting review labels Feb 29, 2024

eht16 force-pushed the issue37755_pydoc_pager branch from 0bb4ee6 to 910baae Compare June 2, 2024 11:29

eht16 force-pushed the issue37755_pydoc_pager branch from 910baae to c1254ea Compare June 2, 2024 11:43

eht16 force-pushed the issue37755_pydoc_pager branch from c1254ea to 207a962 Compare June 2, 2024 11:48

bedevere-app bot added awaiting change review and removed awaiting changes labels Jun 2, 2024

bedevere-app bot requested a review from serhiy-storchaka June 2, 2024 12:13

serhiy-storchaka reviewed Jun 2, 2024

View reviewed changes

Misc/NEWS.d/next/Library/2024-06-02-13-35-11.gh-issue-81936.ETeW9x.rst Outdated Show resolved Hide resolved

serhiy-storchaka reviewed Jun 2, 2024

View reviewed changes

eht16 and others added 2 commits June 2, 2024 18:24

fixup: improve tests

8a92c04

fixup: Update Misc/NEWS.d/next/Library/2024-06-02-13-35-11.gh-issue-8…

3e84bd9

…1936.ETeW9x.rst Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

serhiy-storchaka reviewed Jun 3, 2024

View reviewed changes

fixup: mock pager() instead getpager() in pydoc tests

483d641

serhiy-storchaka approved these changes Jun 8, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting change review labels Jun 8, 2024

eht16 mannequin mentioned this pull request Jun 8, 2024

pydoc topics, keywords and symbols always use pager instead of output #81936

Closed

serhiy-storchaka added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jun 8, 2024

serhiy-storchaka enabled auto-merge (squash) June 8, 2024 09:14

serhiy-storchaka merged commit 2080425 into python:main Jun 8, 2024
36 of 37 checks passed

bedevere-app bot removed the awaiting merge label Jun 8, 2024

miss-islington-app bot assigned serhiy-storchaka Jun 8, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 8, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Jun 8, 2024

eht16 deleted the issue37755_pydoc_pager branch June 8, 2024 09:41

Uh oh!

bpo-37755: Use configured output in pydoc instead of pager #15105

bpo-37755: Use configured output in pydoc instead of pager #15105

Uh oh!

Conversation

eht16 commented Aug 4, 2019 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Aug 4, 2019

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-app bot commented Feb 29, 2024

Uh oh!

bedevere-app bot commented Jun 2, 2024

Uh oh!

eht16 commented Jun 2, 2024

Uh oh!

bedevere-app bot commented Jun 2, 2024

Uh oh!

Uh oh!

serhiy-storchaka Jun 2, 2024

Choose a reason for hiding this comment

Uh oh!

eht16 Jun 2, 2024

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

eht16 commented Jun 8, 2024

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app bot commented Jun 8, 2024

Uh oh!

miss-islington-app bot commented Jun 8, 2024

Uh oh!

bedevere-app bot commented Jun 8, 2024

Uh oh!

bedevere-app bot commented Jun 8, 2024

Uh oh!

Uh oh!

eht16 commented Aug 4, 2019 •

edited by bedevere-bot

Loading