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.

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

bpo-39400: Do not pass MANPAGER value to shell in pydoc #18123

Open
wants to merge 2 commits into
base: master
from

Conversation

@RPigott
Copy link

RPigott commented Jan 22, 2020

pipepager in pydoc passes documentation content to a pager using Popen with shell=True.

Shell parsing is incompatible with the interpretation of MANPAGER by the ubiquitous man program from man-db.

man man:

The [$MANPAGER] value may be a simple command name or a command with arguments, and may use shell quoting (backslashes, single quotes, or double quotes). It may not use pipes to connect multiple commands; if you need that, use a wrapper script [...]

The difference in interpretation can make some valid values of MANPAGER cause pydoc to fail, but not man. For example,

$ printf "%s\n" $MANPAGER | cat -v -
env
LESS_TERMCAP_mb=^[[01;31m
LESS_TERMCAP_me=^[[00m
LESS_TERMCAP_md=^[[01;31m
LESS_TERMCAP_so=^[[44m^[[01;30m
LESS_TERMCAP_se=^[[00m
LESS_TERMCAP_us=^[[01;32m
LESS_TERMCAP_ue=^[[00m
less
$ man man # works as intended
$ pydoc pydoc # fails
/bin/sh: 31m: command not found
/bin/sh: 31m: command not found
/bin/sh: 30m: command not found
/bin/sh: 32m: command not found

In pydoc, the shell has split the unquoted terminal control sequences at the ;.

If we really want to borrow the MANPAGER variable from man, Python should match man's interpretation of the value. Python already has a built in parser that closely matches man's use of MANPAGER in shlex.split, so for compatibility we can use that instead.

If Python is not wiling to match man's interpretation of MANPAGER, it think should reference only the PAGER value instead, as is already described in the documentation (no mention of MANPAGER):

When printing output to the console, pydoc attempts to paginate the output for easier reading. If the PAGER environment variable is set, pydoc will use its value as a pagination program.

https://bugs.python.org/issue39400

@the-knights-who-say-ni

This comment has been minimized.

Copy link

the-knights-who-say-ni commented Jan 22, 2020

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@RPigott

For legal reasons we need all the people listed to sign the CLA 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 the contribution, we look forward to reviewing it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.