mirror of
https://github.com/httpie/cli.git
synced 2024-11-22 15:53:13 +01:00
f9b5c2f696
- Highlighting for options (-x, --x) now doesn't strip the prefix (may be whitespace). - Escape sequences are now cross-platform compatible (directly taken by groff/troff [man's renderer]) - Now we check for the section before displaying the man pages. - On MacOS, there is HTTP(n) which is different from our HTTP(1). This used to conflict with it, and we showed the wrong page. Now we specifically ask foir HTTP(1). - Errors that might happen (e.g non executable man command) is now suppressed. So in the worst case (if anything regarding man execution goes wrong), we'll always display the manual. - Docs for man pages. - HTTPie man pages. - Epilog for the man pages (see also) - Auto-generated comments.
48 lines
1.2 KiB
Python
48 lines
1.2 KiB
Python
"""Logic for checking and displaying man pages."""
|
|
|
|
import subprocess
|
|
import os
|
|
from httpie.context import Environment
|
|
|
|
MAN_COMMAND = 'man'
|
|
NO_MAN_PAGES = os.getenv('HTTPIE_NO_MAN_PAGES', False)
|
|
|
|
# On some systems, HTTP(n) might exist but we are only
|
|
# interested in HTTP(1).
|
|
#
|
|
# For more information on man page sections: https://unix.stackexchange.com/a/138643
|
|
|
|
MAN_PAGE_SECTION = '1'
|
|
|
|
|
|
def is_available(program: str) -> bool:
|
|
"""Check whether HTTPie's man pages are available in this system."""
|
|
|
|
if NO_MAN_PAGES or os.system == 'nt':
|
|
return False
|
|
|
|
try:
|
|
process = subprocess.run(
|
|
[MAN_COMMAND, MAN_PAGE_SECTION, program],
|
|
shell=False,
|
|
stdout=subprocess.DEVNULL,
|
|
stderr=subprocess.DEVNULL
|
|
)
|
|
except Exception:
|
|
# There might be some errors outside of the process, e.g
|
|
# a permission error to execute something that is not an
|
|
# executable.
|
|
return False
|
|
else:
|
|
return process.returncode == 0
|
|
|
|
|
|
def display_for(env: Environment, program: str) -> None:
|
|
"""Display the man page for the given command (http/https)."""
|
|
|
|
subprocess.run(
|
|
[MAN_COMMAND, MAN_PAGE_SECTION, program],
|
|
stdout=env.stdout,
|
|
stderr=env.stderr
|
|
)
|