2022-03-07 23:34:04 +01:00
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
import os
|
2022-03-07 23:34:04 +01:00
|
|
|
|
import textwrap
|
|
|
|
|
from argparse import FileType
|
|
|
|
|
|
|
|
|
|
from httpie import __doc__, __version__
|
2025-03-06 16:22:23 +01:00
|
|
|
|
from httpie.cli.argtypes import (
|
|
|
|
|
KeyValueArgType,
|
|
|
|
|
SessionNameValidator,
|
|
|
|
|
SSLCredentials,
|
|
|
|
|
readable_file_arg,
|
|
|
|
|
response_charset_type,
|
|
|
|
|
response_mime_type,
|
|
|
|
|
)
|
|
|
|
|
from httpie.cli.constants import (
|
|
|
|
|
BASE_OUTPUT_OPTIONS,
|
|
|
|
|
DEFAULT_FORMAT_OPTIONS,
|
|
|
|
|
OUT_REQ_BODY,
|
|
|
|
|
OUT_REQ_HEAD,
|
|
|
|
|
OUT_RESP_BODY,
|
|
|
|
|
OUT_RESP_HEAD,
|
|
|
|
|
OUT_RESP_META,
|
|
|
|
|
OUTPUT_OPTIONS,
|
|
|
|
|
OUTPUT_OPTIONS_DEFAULT,
|
|
|
|
|
PRETTY_MAP,
|
|
|
|
|
PRETTY_STDOUT_TTY_ONLY,
|
|
|
|
|
SEPARATOR_GROUP_ALL_ITEMS,
|
|
|
|
|
SEPARATOR_PROXY,
|
|
|
|
|
SORTED_FORMAT_OPTIONS_STRING,
|
|
|
|
|
UNSORTED_FORMAT_OPTIONS_STRING,
|
|
|
|
|
RequestType,
|
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
from httpie.cli.options import ParserSpec, Qualifiers, to_argparse
|
2025-03-06 16:22:23 +01:00
|
|
|
|
from httpie.output.formatters.colors import (
|
|
|
|
|
AUTO_STYLE,
|
|
|
|
|
DEFAULT_STYLE,
|
|
|
|
|
BUNDLED_STYLES,
|
|
|
|
|
get_available_styles,
|
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
from httpie.plugins.builtin import BuiltinAuthPlugin
|
|
|
|
|
from httpie.plugins.registry import plugin_manager
|
2023-05-19 22:26:33 +02:00
|
|
|
|
from httpie.ssl_ import AVAILABLE_SSL_VERSION_ARG_MAPPING, DEFAULT_SSL_CIPHERS_STRING
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
|
|
|
|
|
# Man pages are static (built when making a release).
|
|
|
|
|
# We use this check to not include generated, system-specific information there (e.g., default --ciphers).
|
2025-03-06 16:22:23 +01:00
|
|
|
|
IS_MAN_PAGE = bool(os.environ.get("HTTPIE_BUILDING_MAN_PAGES"))
|
2023-05-22 20:56:30 +02:00
|
|
|
|
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
options = ParserSpec(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"http",
|
|
|
|
|
description=f"{__doc__.strip()} <https://httpie.io>",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
epilog="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
For every --OPTION there is also a --no-OPTION that reverts OPTION
|
|
|
|
|
to its default value.
|
2022-04-14 16:43:10 +02:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Suggestions and bug reports are greatly appreciated:
|
2023-08-06 14:04:32 +02:00
|
|
|
|
https://github.com/httpie/cli/issues
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2025-03-06 16:22:23 +01:00
|
|
|
|
source_file=__file__,
|
2012-08-18 05:59:20 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Positional arguments.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
positional_arguments = options.add_group(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"Positional arguments",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
description="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
These arguments come after any flags and in the order they are listed here.
|
|
|
|
|
Only URL is required.
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-08-18 05:59:20 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
|
|
|
|
positional_arguments.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="method",
|
|
|
|
|
metavar="METHOD",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
nargs=Qualifiers.OPTIONAL,
|
2012-08-18 05:59:20 +02:00
|
|
|
|
default=None,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).
|
|
|
|
|
|
|
|
|
|
This argument can be omitted in which case HTTPie will use POST if there
|
|
|
|
|
is some data to be sent, otherwise GET:
|
|
|
|
|
|
|
|
|
|
$ http example.org # => GET
|
|
|
|
|
$ http example.org hello=world # => POST
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-08-18 05:59:20 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
positional_arguments.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="url",
|
|
|
|
|
metavar="URL",
|
|
|
|
|
short_help="The request URL.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2022-04-14 16:43:10 +02:00
|
|
|
|
The request URL. Scheme defaults to 'http://' if the URL
|
|
|
|
|
does not include one. (You can override this with: --default-scheme=http/https)
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2013-10-09 22:21:14 +02:00
|
|
|
|
You can also use a shorthand for localhost
|
|
|
|
|
|
|
|
|
|
$ http :3000 # => http://localhost:3000
|
|
|
|
|
$ http :/foo # => http://localhost/foo
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-08-18 05:59:20 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
positional_arguments.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="request_items",
|
|
|
|
|
metavar="REQUEST_ITEM",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
nargs=Qualifiers.ZERO_OR_MORE,
|
2016-09-01 11:14:23 +02:00
|
|
|
|
default=None,
|
2019-08-31 15:17:10 +02:00
|
|
|
|
type=KeyValueArgType(*SEPARATOR_GROUP_ALL_ITEMS),
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"HTTPie’s request items syntax for specifying HTTP headers, JSON/Form"
|
|
|
|
|
"data, files, and URL parameters."
|
2022-04-14 16:43:10 +02:00
|
|
|
|
),
|
|
|
|
|
nested_options=[
|
2025-03-06 16:22:23 +01:00
|
|
|
|
("HTTP Headers", "Name:Value", "Arbitrary HTTP header, e.g X-API-Token:123"),
|
|
|
|
|
(
|
|
|
|
|
"URL Parameters",
|
|
|
|
|
"name==value",
|
|
|
|
|
"Querystring parameter to the URL, e.g limit==50",
|
|
|
|
|
),
|
|
|
|
|
(
|
|
|
|
|
"Data Fields",
|
|
|
|
|
"field=value",
|
|
|
|
|
"Data fields to be serialized as JSON (default) or Form Data (with --form)",
|
|
|
|
|
),
|
|
|
|
|
("Raw JSON Fields", "field:=json", "Data field for real JSON types."),
|
|
|
|
|
("File upload Fields", "field@/dir/file", "Path field for uploading a file."),
|
2022-04-14 16:43:10 +02:00
|
|
|
|
],
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=r"""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Optional key-value pairs to be included in the request. The separator used
|
|
|
|
|
determines the type:
|
|
|
|
|
|
|
|
|
|
':' HTTP headers:
|
|
|
|
|
|
2021-09-28 12:53:53 +02:00
|
|
|
|
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
|
|
|
|
'==' URL parameters to be appended to the request URI:
|
|
|
|
|
|
|
|
|
|
search==httpie
|
|
|
|
|
|
|
|
|
|
'=' Data fields to be serialized into a JSON object (with --json, -j)
|
|
|
|
|
or form data (with --form, -f):
|
|
|
|
|
|
|
|
|
|
name=HTTPie language=Python description='CLI HTTP client'
|
|
|
|
|
|
2013-09-24 23:41:18 +02:00
|
|
|
|
':=' Non-string JSON data fields (only with --json, -j):
|
|
|
|
|
|
|
|
|
|
awesome:=true amount:=42 colors:='["red", "green", "blue"]'
|
|
|
|
|
|
2020-09-28 12:16:57 +02:00
|
|
|
|
'@' Form file fields (only with --form or --multipart):
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2020-06-08 18:02:04 +02:00
|
|
|
|
cv@~/Documents/CV.pdf
|
2020-06-08 17:59:41 +02:00
|
|
|
|
cv@'~/Documents/CV.pdf;type=application/pdf'
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2013-09-24 23:41:18 +02:00
|
|
|
|
'=@' A data field like '=', but takes a file path and embeds its content:
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2021-12-03 11:17:45 +01:00
|
|
|
|
essay=@Documents/essay.txt
|
2013-09-24 23:41:18 +02:00
|
|
|
|
|
|
|
|
|
':=@' A raw JSON field like ':=', but takes a file path and embeds its content:
|
|
|
|
|
|
|
|
|
|
package:=@./package.json
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
|
|
|
|
You can use a backslash to escape a colliding separator in the field name:
|
|
|
|
|
|
|
|
|
|
field-name-with\:colon=value
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-08-18 05:59:20 +02:00
|
|
|
|
)
|
2012-03-04 10:48:30 +01:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-03-04 10:48:30 +01:00
|
|
|
|
# Content type.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-03-04 10:48:30 +01:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
content_types = options.add_group("Predefined content types")
|
2012-09-07 11:58:39 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
content_types.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--json",
|
|
|
|
|
"-j",
|
|
|
|
|
action="store_const",
|
2020-09-28 12:16:57 +02:00
|
|
|
|
const=RequestType.JSON,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="request_type",
|
|
|
|
|
short_help="(default) Serialize data items from the command line as a JSON object.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
(default) Data items from the command line are serialized as a JSON object.
|
|
|
|
|
The Content-Type and Accept headers are set to application/json
|
|
|
|
|
(if not specified).
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
content_types.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--form",
|
|
|
|
|
"-f",
|
|
|
|
|
action="store_const",
|
2020-09-28 12:16:57 +02:00
|
|
|
|
const=RequestType.FORM,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="request_type",
|
|
|
|
|
short_help="Serialize data items from the command line as form field data.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Data items from the command line are serialized as form fields.
|
|
|
|
|
|
|
|
|
|
The Content-Type is set to application/x-www-form-urlencoded (if not
|
|
|
|
|
specified). The presence of any file fields results in a
|
|
|
|
|
multipart/form-data request.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
content_types.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--multipart",
|
|
|
|
|
action="store_const",
|
2020-09-28 12:16:57 +02:00
|
|
|
|
const=RequestType.MULTIPART,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
dest="request_type",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"Similar to --form, but always sends a multipart/form-data "
|
|
|
|
|
"request (i.e., even without files)."
|
|
|
|
|
),
|
2020-08-19 10:22:42 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
content_types.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--boundary",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"Specify a custom boundary string for multipart/form-data requests. "
|
|
|
|
|
"Only has effect only together with --form."
|
|
|
|
|
),
|
2020-08-19 10:22:42 +02:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
content_types.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--raw",
|
|
|
|
|
short_help="Pass raw request data without extra processing.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2021-05-24 14:29:54 +02:00
|
|
|
|
This option allows you to pass raw request data without extra processing
|
|
|
|
|
(as opposed to the structured request items syntax):
|
|
|
|
|
|
|
|
|
|
$ http --raw='data' pie.dev/post
|
|
|
|
|
|
|
|
|
|
You can achieve the same by piping the data via stdin:
|
|
|
|
|
|
|
|
|
|
$ echo data | http pie.dev/post
|
|
|
|
|
|
|
|
|
|
Or have HTTPie load the raw data from a file:
|
|
|
|
|
|
|
|
|
|
$ http pie.dev/post @data.txt
|
|
|
|
|
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2021-05-24 14:29:54 +02:00
|
|
|
|
)
|
2020-08-19 10:22:42 +02:00
|
|
|
|
|
2025-02-25 18:53:23 +01:00
|
|
|
|
content_types.add_argument(
|
|
|
|
|
"--http-file",
|
|
|
|
|
action="store_true",
|
|
|
|
|
default=False,
|
|
|
|
|
short_help="Parse and send an HTTP request from a .http file",
|
|
|
|
|
help="""
|
|
|
|
|
Parse and send an HTTP request from a file in .http format.
|
|
|
|
|
The file should contain a valid HTTP request with headers and body.
|
|
|
|
|
If this is specified, URL will be treated as a file path.
|
|
|
|
|
""",
|
|
|
|
|
)
|
|
|
|
|
|
2019-08-29 10:44:59 +02:00
|
|
|
|
#######################################################################
|
|
|
|
|
# Content processing.
|
|
|
|
|
#######################################################################
|
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
processing_options = options.add_group("Content processing options")
|
2019-08-29 10:44:59 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
processing_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--compress",
|
|
|
|
|
"-x",
|
|
|
|
|
action="count",
|
2019-09-01 11:38:14 +02:00
|
|
|
|
default=0,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Compress the content with Deflate algorithm.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2019-08-29 10:44:59 +02:00
|
|
|
|
Content compressed (encoded) with Deflate algorithm.
|
|
|
|
|
The Content-Encoding header is set to deflate.
|
|
|
|
|
|
|
|
|
|
Compression is skipped if it appears that compression ratio is
|
|
|
|
|
negative. Compression can be forced by repeating the argument.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2019-08-29 10:44:59 +02:00
|
|
|
|
)
|
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Output processing
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2021-12-01 19:15:59 +01:00
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
def format_style_help(available_styles, *, isolation_mode: bool = False):
|
|
|
|
|
text = """
|
2021-12-01 19:15:59 +01:00
|
|
|
|
Output coloring style (default is "{default}"). It can be one of:
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2021-05-28 12:45:40 +02:00
|
|
|
|
{available_styles}
|
2022-04-14 16:43:10 +02:00
|
|
|
|
"""
|
|
|
|
|
if isolation_mode:
|
2025-03-06 16:22:23 +01:00
|
|
|
|
text += "\n\n"
|
|
|
|
|
text += "For finding out all available styles in your system, try:\n\n"
|
|
|
|
|
text += " $ http --style\n"
|
2022-04-14 16:43:10 +02:00
|
|
|
|
text += textwrap.dedent("""
|
|
|
|
|
The "{auto_style}" style follows your terminal's ANSI color styles.
|
|
|
|
|
For non-{auto_style} styles to work properly, please make sure that the
|
|
|
|
|
$TERM environment variable is set to "xterm-256color" or similar
|
|
|
|
|
(e.g., via `export TERM=xterm-256color' in your ~/.bashrc).
|
|
|
|
|
""")
|
|
|
|
|
|
|
|
|
|
if isolation_mode:
|
|
|
|
|
available_styles = sorted(BUNDLED_STYLES)
|
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
available_styles_text = "\n".join(
|
|
|
|
|
f" {line.strip()}" for line in textwrap.wrap(", ".join(available_styles), 60)
|
2022-04-14 16:43:10 +02:00
|
|
|
|
).strip()
|
|
|
|
|
return text.format(
|
2013-08-10 11:56:19 +02:00
|
|
|
|
default=DEFAULT_STYLE,
|
2022-04-14 16:43:10 +02:00
|
|
|
|
available_styles=available_styles_text,
|
2018-11-02 14:53:05 +01:00
|
|
|
|
auto_style=AUTO_STYLE,
|
2013-08-10 11:56:19 +02:00
|
|
|
|
)
|
2021-12-01 19:15:59 +01:00
|
|
|
|
|
|
|
|
|
|
2020-06-16 12:54:50 +02:00
|
|
|
|
_sorted_kwargs = {
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"action": "append_const",
|
|
|
|
|
"const": SORTED_FORMAT_OPTIONS_STRING,
|
|
|
|
|
"dest": "format_options",
|
2020-06-16 12:54:50 +02:00
|
|
|
|
}
|
|
|
|
|
_unsorted_kwargs = {
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"action": "append_const",
|
|
|
|
|
"const": UNSORTED_FORMAT_OPTIONS_STRING,
|
|
|
|
|
"dest": "format_options",
|
2020-06-16 12:54:50 +02:00
|
|
|
|
}
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
output_processing = options.add_group("Output processing")
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--pretty",
|
|
|
|
|
dest="prettify",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
default=PRETTY_STDOUT_TTY_ONLY,
|
|
|
|
|
choices=sorted(PRETTY_MAP.keys()),
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Control the processing of console outputs.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
|
|
|
|
Controls output processing. The value can be "none" to not prettify
|
|
|
|
|
the output (default for redirected output), "all" to apply both colors
|
|
|
|
|
and formatting (default for terminal output), "colors", or "format".
|
|
|
|
|
|
|
|
|
|
""",
|
|
|
|
|
)
|
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--style",
|
|
|
|
|
"-s",
|
|
|
|
|
dest="style",
|
|
|
|
|
metavar="STYLE",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
default=DEFAULT_STYLE,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="lazy_choices",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
getter=get_available_styles,
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=f'Output coloring style (default is "{DEFAULT_STYLE}").',
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help_formatter=format_style_help,
|
|
|
|
|
)
|
|
|
|
|
|
2020-06-16 12:54:50 +02:00
|
|
|
|
# The closest approx. of the documented resetting to default via --no-<option>.
|
|
|
|
|
# We hide them from the doc because they act only as low-level aliases here.
|
2022-03-07 23:34:04 +01:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--no-unsorted", **_sorted_kwargs, help=Qualifiers.SUPPRESS
|
2022-03-07 23:34:04 +01:00
|
|
|
|
)
|
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--no-sorted", **_unsorted_kwargs, help=Qualifiers.SUPPRESS
|
2022-03-07 23:34:04 +01:00
|
|
|
|
)
|
2020-06-16 12:54:50 +02:00
|
|
|
|
|
2020-06-16 12:20:13 +02:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--unsorted",
|
2020-06-16 12:54:50 +02:00
|
|
|
|
**_unsorted_kwargs,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Disables all sorting while formatting output.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2020-06-16 12:20:13 +02:00
|
|
|
|
Disables all sorting while formatting output. It is a shortcut for:
|
|
|
|
|
|
2020-06-16 12:54:50 +02:00
|
|
|
|
--format-options={UNSORTED_FORMAT_OPTIONS_STRING}
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2020-06-16 12:20:13 +02:00
|
|
|
|
)
|
2020-06-16 12:54:50 +02:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--sorted",
|
2020-06-16 12:54:50 +02:00
|
|
|
|
**_sorted_kwargs,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Re-enables all sorting options while formatting output.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2020-06-16 12:54:50 +02:00
|
|
|
|
Re-enables all sorting options while formatting output. It is a shortcut for:
|
|
|
|
|
|
|
|
|
|
--format-options={SORTED_FORMAT_OPTIONS_STRING}
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2020-06-16 12:54:50 +02:00
|
|
|
|
)
|
2021-09-27 13:58:19 +02:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--response-charset",
|
|
|
|
|
metavar="ENCODING",
|
2021-10-06 17:27:07 +02:00
|
|
|
|
type=response_charset_type,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Override the response encoding for terminal display purposes.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2021-10-06 17:27:07 +02:00
|
|
|
|
Override the response encoding for terminal display purposes, e.g.:
|
2021-09-27 13:58:19 +02:00
|
|
|
|
|
2021-10-06 17:27:07 +02:00
|
|
|
|
--response-charset=utf8
|
|
|
|
|
--response-charset=big5
|
2021-09-27 13:58:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2021-09-27 13:58:19 +02:00
|
|
|
|
)
|
2021-10-06 17:27:07 +02:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--response-mime",
|
|
|
|
|
metavar="MIME_TYPE",
|
2021-10-06 17:27:07 +02:00
|
|
|
|
type=response_mime_type,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Override the response mime type for coloring and formatting for the terminal.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2021-10-06 17:27:07 +02:00
|
|
|
|
Override the response mime type for coloring and formatting for the terminal, e.g.:
|
|
|
|
|
|
|
|
|
|
--response-mime=application/json
|
|
|
|
|
--response-mime=text/xml
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2021-10-06 17:27:07 +02:00
|
|
|
|
)
|
2020-05-27 15:58:15 +02:00
|
|
|
|
output_processing.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--format-options",
|
|
|
|
|
action="append",
|
|
|
|
|
short_help="Controls output formatting.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2020-05-27 15:58:15 +02:00
|
|
|
|
Controls output formatting. Only relevant when formatting is enabled
|
|
|
|
|
through (explicit or implied) --pretty=all or --pretty=format.
|
|
|
|
|
The following are the default options:
|
|
|
|
|
|
|
|
|
|
{option_list}
|
|
|
|
|
|
2020-06-16 12:20:13 +02:00
|
|
|
|
You may use this option multiple times, as well as specify multiple
|
|
|
|
|
comma-separated options at the same time. For example, this modifies the
|
|
|
|
|
settings to disable the sorting of JSON keys, and sets the indent size to 2:
|
2020-05-27 15:58:15 +02:00
|
|
|
|
|
2020-06-16 12:20:13 +02:00
|
|
|
|
--format-options json.sort_keys:false,json.indent:2
|
2020-05-27 15:58:15 +02:00
|
|
|
|
|
|
|
|
|
This is something you will typically put into your config file.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""".format(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
option_list="\n".join(
|
|
|
|
|
f" {option}" for option in DEFAULT_FORMAT_OPTIONS
|
2022-03-07 23:34:04 +01:00
|
|
|
|
).strip()
|
|
|
|
|
),
|
2020-05-27 15:58:15 +02:00
|
|
|
|
)
|
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Output options
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
output_options = options.add_group("Output options")
|
2012-03-04 10:48:30 +01:00
|
|
|
|
|
2012-12-05 04:39:56 +01:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--print",
|
|
|
|
|
"-p",
|
|
|
|
|
dest="output_options",
|
|
|
|
|
metavar="WHAT",
|
|
|
|
|
short_help="Options to specify what the console output should contain.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
String specifying what the output should contain:
|
|
|
|
|
|
2019-08-31 15:17:10 +02:00
|
|
|
|
'{OUT_REQ_HEAD}' request headers
|
|
|
|
|
'{OUT_REQ_BODY}' request body
|
|
|
|
|
'{OUT_RESP_HEAD}' response headers
|
|
|
|
|
'{OUT_RESP_BODY}' response body
|
2021-12-24 09:50:19 +01:00
|
|
|
|
'{OUT_RESP_META}' response metadata
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2019-08-31 15:17:10 +02:00
|
|
|
|
The default behaviour is '{OUTPUT_OPTIONS_DEFAULT}' (i.e., the response
|
|
|
|
|
headers and body is printed), if standard output is not redirected.
|
|
|
|
|
If the output is piped to another program or to a file, then only the
|
|
|
|
|
response body is printed by default.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-14 00:05:44 +01:00
|
|
|
|
)
|
2012-09-24 06:49:12 +02:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--headers",
|
|
|
|
|
"-h",
|
|
|
|
|
dest="output_options",
|
|
|
|
|
action="store_const",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
const=OUT_RESP_HEAD,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Print only the response headers.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2019-08-31 15:17:10 +02:00
|
|
|
|
Print only the response headers. Shortcut for --print={OUT_RESP_HEAD}.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2021-12-23 21:13:25 +01:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--meta",
|
|
|
|
|
"-m",
|
|
|
|
|
dest="output_options",
|
|
|
|
|
action="store_const",
|
2021-12-23 21:13:25 +01:00
|
|
|
|
const=OUT_RESP_META,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Print only the response metadata.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2021-12-23 21:13:25 +01:00
|
|
|
|
Print only the response metadata. Shortcut for --print={OUT_RESP_META}.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2021-12-23 21:13:25 +01:00
|
|
|
|
)
|
2012-09-24 06:49:12 +02:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--body",
|
|
|
|
|
"-b",
|
|
|
|
|
dest="output_options",
|
|
|
|
|
action="store_const",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
const=OUT_RESP_BODY,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Print only the response body.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2019-08-31 15:17:10 +02:00
|
|
|
|
Print only the response body. Shortcut for --print={OUT_RESP_BODY}.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2012-03-14 00:05:44 +01:00
|
|
|
|
|
2016-03-05 19:09:52 +01:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--verbose",
|
|
|
|
|
"-v",
|
|
|
|
|
dest="verbose",
|
|
|
|
|
action="count",
|
2021-12-23 21:13:25 +01:00
|
|
|
|
default=0,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Make output more verbose.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2021-12-24 09:53:15 +01:00
|
|
|
|
Verbose output. For the level one (with single `-v`/`--verbose`), print
|
|
|
|
|
the whole request as well as the response. Also print any intermediary
|
|
|
|
|
requests/responses (such as redirects). For the second level and higher,
|
|
|
|
|
print these as well as the response metadata.
|
2021-12-24 09:53:31 +01:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
Level one is a shortcut for: --all --print={"".join(sorted(BASE_OUTPUT_OPTIONS))}
|
|
|
|
|
Level two is a shortcut for: --all --print={"".join(sorted(OUTPUT_OPTIONS))}
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-05 19:09:52 +01:00
|
|
|
|
)
|
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--all",
|
2016-03-05 19:09:52 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Show any intermediary requests/responses.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-05 19:09:52 +01:00
|
|
|
|
By default, only the final request/response is shown. Use this flag to show
|
|
|
|
|
any intermediary requests/responses as well. Intermediary requests include
|
|
|
|
|
followed redirects (with --follow), the first unauthorized request when
|
|
|
|
|
Digest auth is used (--auth=digest), etc.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-05 19:09:52 +01:00
|
|
|
|
)
|
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--history-print",
|
|
|
|
|
"-P",
|
|
|
|
|
dest="output_options_history",
|
|
|
|
|
metavar="WHAT",
|
2022-05-03 15:29:02 +02:00
|
|
|
|
help=Qualifiers.SUPPRESS,
|
2016-03-05 19:09:52 +01:00
|
|
|
|
)
|
2012-12-05 04:39:56 +01:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--stream",
|
|
|
|
|
"-S",
|
|
|
|
|
action="store_true",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Always stream the response body by line, i.e., behave like `tail -f`.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2020-09-28 12:16:57 +02:00
|
|
|
|
Always stream the response body by line, i.e., behave like `tail -f'.
|
2012-08-03 01:01:15 +02:00
|
|
|
|
|
|
|
|
|
Without --stream and with --pretty (either set or implied),
|
|
|
|
|
HTTPie fetches the whole response before it outputs the processed data.
|
|
|
|
|
|
|
|
|
|
Set this option when you want to continuously display a prettified
|
|
|
|
|
long-lived response, such as one from the Twitter streaming API.
|
|
|
|
|
|
|
|
|
|
It is useful also without --pretty: It ensures that the output is flushed
|
|
|
|
|
more often and in smaller chunks.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-12-05 04:39:56 +01:00
|
|
|
|
)
|
2013-08-10 11:56:19 +02:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--output",
|
|
|
|
|
"-o",
|
|
|
|
|
type=FileType("a+b"),
|
|
|
|
|
dest="output_file",
|
|
|
|
|
metavar="FILE",
|
|
|
|
|
short_help="Save output to FILE instead of stdout.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-01 13:24:50 +01:00
|
|
|
|
Save output to FILE instead of stdout. If --download is also set, then only
|
|
|
|
|
the response body is saved to FILE. Other parts of the HTTP exchange are
|
|
|
|
|
printed to stderr.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--download",
|
|
|
|
|
"-d",
|
|
|
|
|
action="store_true",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Download the body to a file instead of printing it to stdout.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-02-26 15:12:33 +01:00
|
|
|
|
Do not print the response body to stdout. Rather, download it and store it
|
|
|
|
|
in a file. The filename is guessed unless specified with --output
|
|
|
|
|
[filename]. This action is similar to the default behaviour of wget.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
)
|
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--continue",
|
|
|
|
|
"-c",
|
|
|
|
|
dest="download_resume",
|
|
|
|
|
action="store_true",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Resume an interrupted download (--output needs to be specified).",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Resume an interrupted download. Note that the --output option needs to be
|
|
|
|
|
specified as well.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
)
|
2020-06-26 18:28:03 +02:00
|
|
|
|
output_options.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--quiet",
|
|
|
|
|
"-q",
|
|
|
|
|
action="count",
|
2021-10-08 14:18:11 +02:00
|
|
|
|
default=0,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Do not print to stdout or stderr, except for errors and warnings when provided once.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2021-10-08 14:18:11 +02:00
|
|
|
|
Do not print to stdout or stderr, except for errors and warnings when provided once.
|
|
|
|
|
Provide twice to suppress warnings as well.
|
2020-08-11 18:35:14 +02:00
|
|
|
|
stdout is still redirected if --output is specified.
|
|
|
|
|
Flag doesn't affect behaviour of download beyond not printing to terminal.
|
2021-10-08 14:18:11 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2020-06-26 18:28:03 +02:00
|
|
|
|
)
|
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-09-07 12:38:52 +02:00
|
|
|
|
# Sessions
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2013-05-13 14:47:44 +02:00
|
|
|
|
|
|
|
|
|
session_name_validator = SessionNameValidator(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"Session name contains invalid characters."
|
2013-08-10 11:56:19 +02:00
|
|
|
|
)
|
2013-05-13 14:47:44 +02:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
sessions = options.add_group("Sessions", is_mutually_exclusive=True)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2012-09-07 12:38:52 +02:00
|
|
|
|
sessions.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--session",
|
|
|
|
|
metavar="SESSION_NAME_OR_PATH",
|
2013-05-13 14:47:44 +02:00
|
|
|
|
type=session_name_validator,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Create, or reuse and update a session.",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Create, or reuse and update a session. Within a session, custom headers,
|
|
|
|
|
auth credential, as well as any cookies sent by the server persist between
|
|
|
|
|
requests.
|
|
|
|
|
|
|
|
|
|
Session files are stored in:
|
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
[HTTPIE_CONFIG_DIR]/<HOST>/<SESSION_NAME>.json.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
See the following page to find out your default HTTPIE_CONFIG_DIR:
|
|
|
|
|
|
|
|
|
|
https://httpie.io/docs/cli/config-file-directory
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-08-17 23:23:02 +02:00
|
|
|
|
)
|
2012-09-07 12:38:52 +02:00
|
|
|
|
sessions.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--session-read-only",
|
|
|
|
|
metavar="SESSION_NAME_OR_PATH",
|
2013-05-13 14:47:44 +02:00
|
|
|
|
type=session_name_validator,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Create or read a session without updating it",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
Create or read a session without updating it form the request/response
|
|
|
|
|
exchange.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-09-07 12:38:52 +02:00
|
|
|
|
)
|
2012-08-17 23:23:02 +02:00
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Authentication
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2013-05-13 14:47:44 +02:00
|
|
|
|
|
2016-11-23 22:01:58 +01:00
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
def format_auth_help(auth_plugins_mapping, *, isolation_mode: bool = False):
|
|
|
|
|
text = """
|
2013-09-21 23:46:15 +02:00
|
|
|
|
The authentication mechanism to be used. Defaults to "{default}".
|
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
{auth_types}
|
|
|
|
|
"""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-04-14 16:43:10 +02:00
|
|
|
|
auth_plugins = list(auth_plugins_mapping.values())
|
|
|
|
|
if isolation_mode:
|
|
|
|
|
auth_plugins = [
|
|
|
|
|
auth_plugin
|
|
|
|
|
for auth_plugin in auth_plugins
|
|
|
|
|
if issubclass(auth_plugin, BuiltinAuthPlugin)
|
|
|
|
|
]
|
2025-03-06 16:22:23 +01:00
|
|
|
|
text += "\n"
|
|
|
|
|
text += "To see all available auth types on your system, including ones installed via plugins, run:\n\n"
|
|
|
|
|
text += " $ http --auth-type"
|
2022-04-14 16:43:10 +02:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
auth_types = "\n\n ".join(
|
2022-04-14 16:43:10 +02:00
|
|
|
|
'"{type}": {name}{package}{description}'.format(
|
|
|
|
|
type=plugin.auth_type,
|
|
|
|
|
name=plugin.name,
|
|
|
|
|
package=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
""
|
2022-04-14 16:43:10 +02:00
|
|
|
|
if issubclass(plugin, BuiltinAuthPlugin)
|
2025-03-06 16:22:23 +01:00
|
|
|
|
else f" (provided by {plugin.package_name})"
|
2022-04-14 16:43:10 +02:00
|
|
|
|
),
|
|
|
|
|
description=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
""
|
2022-04-14 16:43:10 +02:00
|
|
|
|
if not plugin.description
|
2025-03-06 16:22:23 +01:00
|
|
|
|
else "\n " + ("\n ".join(textwrap.wrap(plugin.description)))
|
2022-04-14 16:43:10 +02:00
|
|
|
|
),
|
|
|
|
|
)
|
|
|
|
|
for plugin in auth_plugins
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
return text.format(
|
2022-03-07 23:34:04 +01:00
|
|
|
|
default=auth_plugins[0].auth_type,
|
2022-04-14 16:43:10 +02:00
|
|
|
|
auth_types=auth_types,
|
2022-03-07 23:34:04 +01:00
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
authentication = options.add_group("Authentication")
|
2021-12-01 19:15:59 +01:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
authentication.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--auth",
|
|
|
|
|
"-a",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
default=None,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
metavar="USER[:PASS] | TOKEN",
|
|
|
|
|
short_help="Credentials for the selected (-A) authentication method.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
|
|
|
|
For username/password based authentication mechanisms (e.g
|
|
|
|
|
basic auth or digest auth) if only the username is provided
|
|
|
|
|
(-a username), HTTPie will prompt for the password.
|
2021-12-01 19:15:59 +01:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
|
|
|
|
)
|
|
|
|
|
authentication.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--auth-type",
|
|
|
|
|
"-A",
|
|
|
|
|
action="lazy_choices",
|
2021-12-01 19:15:59 +01:00
|
|
|
|
default=None,
|
|
|
|
|
getter=plugin_manager.get_auth_plugin_mapping,
|
|
|
|
|
sort=True,
|
|
|
|
|
cache=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The authentication mechanism to be used.",
|
2021-12-01 19:15:59 +01:00
|
|
|
|
help_formatter=format_auth_help,
|
2012-03-22 15:40:03 +01:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
authentication.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--ignore-netrc",
|
2019-08-31 12:09:17 +02:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Ignore credentials from .netrc.",
|
2019-08-31 12:09:17 +02:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Network
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
network = options.add_group("Network")
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2019-09-03 17:14:39 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--offline",
|
2019-09-03 17:14:39 +02:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Build the request and print it but don’t actually send it.",
|
2019-09-03 17:14:39 +02:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--proxy",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=[],
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="append",
|
|
|
|
|
metavar="PROTOCOL:PROXY_URL",
|
2019-08-31 15:17:10 +02:00
|
|
|
|
type=KeyValueArgType(SEPARATOR_PROXY),
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="String mapping of protocol to the URL of the proxy.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-09-25 22:02:29 +02:00
|
|
|
|
String mapping protocol to the URL of the proxy
|
|
|
|
|
(e.g. http:http://foo.bar:3128). You can specify multiple proxies with
|
2019-08-31 12:31:32 +02:00
|
|
|
|
different protocols. The environment variables $ALL_PROXY, $HTTP_PROXY,
|
|
|
|
|
and $HTTPS_proxy are supported as well.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--follow",
|
|
|
|
|
"-F",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Follow 30x Location redirects.",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2016-02-29 06:56:21 +01:00
|
|
|
|
|
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--max-redirects",
|
2016-02-29 06:56:21 +01:00
|
|
|
|
type=int,
|
|
|
|
|
default=30,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The maximum number of redirects that should be followed (with --follow).",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-02-29 06:56:21 +01:00
|
|
|
|
By default, requests have a limit of 30 redirects (works with --follow).
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-02-29 06:56:21 +01:00
|
|
|
|
)
|
2019-08-29 09:39:19 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--max-headers",
|
2019-08-29 09:39:19 +02:00
|
|
|
|
type=int,
|
|
|
|
|
default=0,
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"The maximum number of response headers to be read before "
|
|
|
|
|
"giving up (default 0, i.e., no limit)."
|
|
|
|
|
),
|
2019-08-29 09:39:19 +02:00
|
|
|
|
)
|
|
|
|
|
|
2012-08-18 05:59:20 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--timeout",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
type=float,
|
2019-08-29 09:57:00 +02:00
|
|
|
|
default=0,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
metavar="SECONDS",
|
|
|
|
|
short_help="The connection timeout of the request in seconds.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2019-08-29 10:09:56 +02:00
|
|
|
|
The connection timeout of the request in seconds.
|
2019-08-29 09:57:00 +02:00
|
|
|
|
The default value is 0, i.e., there is no timeout limit.
|
|
|
|
|
This is not a time limit on the entire response download;
|
2019-08-29 10:09:56 +02:00
|
|
|
|
rather, an error is reported if the server has not issued a response for
|
2019-08-29 09:57:00 +02:00
|
|
|
|
timeout seconds (more precisely, if no bytes have been received on
|
2019-08-29 10:09:56 +02:00
|
|
|
|
the underlying socket for timeout seconds).
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--check-status",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Exit with an error status code if the server replies with an error.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2013-08-10 11:56:19 +02:00
|
|
|
|
By default, HTTPie exits with 0 when no network or other fatal errors
|
|
|
|
|
occur. This flag instructs HTTPie to also check the HTTP status code and
|
|
|
|
|
exit with an error if the status indicates one.
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
When the server replies with a 4xx (Client Error) or 5xx (Server Error)
|
|
|
|
|
status code, HTTPie exits with 4 or 5 respectively. If the response is a
|
|
|
|
|
3xx (Redirect) and --follow hasn't been set, then the exit status is 3.
|
|
|
|
|
Also an error message is written to stderr if stdout is redirected.
|
2012-08-18 05:59:20 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-07-30 10:58:16 +02:00
|
|
|
|
)
|
2020-04-13 20:18:01 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--path-as-is",
|
2020-04-13 20:18:01 +02:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
|
|
|
|
short_help="Bypass dot segment (/../ or /./) URL squashing.",
|
2020-04-13 20:18:01 +02:00
|
|
|
|
)
|
2020-09-25 13:44:28 +02:00
|
|
|
|
network.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--chunked",
|
2020-09-25 13:44:28 +02:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
action="store_true",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help=(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"Enable streaming via chunked transfer encoding. "
|
|
|
|
|
"The Transfer-Encoding header is set to chunked."
|
|
|
|
|
),
|
2020-09-25 13:44:28 +02:00
|
|
|
|
)
|
|
|
|
|
|
2016-03-02 05:12:05 +01:00
|
|
|
|
#######################################################################
|
|
|
|
|
# SSL
|
|
|
|
|
#######################################################################
|
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
ssl = options.add_group("SSL")
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
2016-03-02 06:42:42 +01:00
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--verify",
|
|
|
|
|
default="yes",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
short_help='If "no", skip SSL verification. If a file path, use it as a CA bundle.',
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2017-02-17 00:56:07 +01:00
|
|
|
|
Set to "no" (or "false") to skip checking the host's SSL certificate.
|
|
|
|
|
Defaults to "yes" ("true"). You can also pass the path to a CA_BUNDLE file
|
|
|
|
|
for private certs. (Or you can set the REQUESTS_CA_BUNDLE environment
|
|
|
|
|
variable instead.)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-02 06:42:42 +01:00
|
|
|
|
)
|
2016-03-02 05:12:05 +01:00
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--ssl",
|
|
|
|
|
dest="ssl_version",
|
2021-06-01 14:46:58 +02:00
|
|
|
|
choices=sorted(AVAILABLE_SSL_VERSION_ARG_MAPPING.keys()),
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The desired protocol version to used.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-02 05:12:05 +01:00
|
|
|
|
The desired protocol version to use. This will default to
|
|
|
|
|
SSL v2.3 which will negotiate the highest protocol that both
|
|
|
|
|
the server and your installation of OpenSSL support. Available protocols
|
|
|
|
|
may vary depending on OpenSSL installation (only the supported ones
|
|
|
|
|
are shown here).
|
2016-03-02 06:42:42 +01:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-02 05:12:05 +01:00
|
|
|
|
)
|
2023-05-22 20:56:30 +02:00
|
|
|
|
|
|
|
|
|
CIPHERS_CURRENT_DEFAULTS = (
|
|
|
|
|
"""
|
|
|
|
|
See `http --help` for the default ciphers list on you system.
|
|
|
|
|
|
|
|
|
|
"""
|
2025-03-06 16:22:23 +01:00
|
|
|
|
if IS_MAN_PAGE
|
|
|
|
|
else f"""
|
2023-05-22 20:56:30 +02:00
|
|
|
|
By default, the following ciphers are used on your system:
|
|
|
|
|
|
|
|
|
|
{DEFAULT_SSL_CIPHERS_STRING}
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
)
|
2020-05-23 13:26:06 +02:00
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--ciphers",
|
|
|
|
|
short_help="A string in the OpenSSL cipher list format.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help=f"""
|
2020-05-23 13:26:06 +02:00
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
A string in the OpenSSL cipher list format.
|
2020-05-23 13:26:06 +02:00
|
|
|
|
|
2023-05-22 20:56:30 +02:00
|
|
|
|
{CIPHERS_CURRENT_DEFAULTS}
|
2020-05-23 13:26:06 +02:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
""",
|
2020-05-23 13:26:06 +02:00
|
|
|
|
)
|
2016-03-02 05:12:05 +01:00
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--cert",
|
2016-03-02 05:12:05 +01:00
|
|
|
|
default=None,
|
|
|
|
|
type=readable_file_arg,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Specifies a local cert to use as the client-side SSL certificate.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-02 05:12:05 +01:00
|
|
|
|
You can specify a local cert to use as client side SSL certificate.
|
|
|
|
|
This file may either contain both private key and certificate or you may
|
|
|
|
|
specify --cert-key separately.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-02 05:12:05 +01:00
|
|
|
|
)
|
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--cert-key",
|
2016-03-02 05:12:05 +01:00
|
|
|
|
default=None,
|
|
|
|
|
type=readable_file_arg,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The private key to use with SSL. Only needed if --cert is given.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-02 05:12:05 +01:00
|
|
|
|
The private key to use with SSL. Only needed if --cert is given and the
|
|
|
|
|
certificate file does not contain the private key.
|
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2016-03-02 05:12:05 +01:00
|
|
|
|
)
|
|
|
|
|
|
2022-03-01 15:16:37 +01:00
|
|
|
|
ssl.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--cert-key-pass",
|
2022-03-01 15:16:37 +01:00
|
|
|
|
default=None,
|
|
|
|
|
type=SSLCredentials,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="The passphrase to be used to with the given private key.",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
help="""
|
2022-03-01 15:16:37 +01:00
|
|
|
|
The passphrase to be used to with the given private key. Only needed if --cert-key
|
|
|
|
|
is given and the key file requires a passphrase.
|
2022-03-07 14:05:13 +01:00
|
|
|
|
If not provided, you’ll be prompted interactively.
|
2025-03-06 16:22:23 +01:00
|
|
|
|
""",
|
2022-03-01 15:16:37 +01:00
|
|
|
|
)
|
|
|
|
|
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-08-18 05:59:20 +02:00
|
|
|
|
# Troubleshooting
|
2013-08-10 11:56:19 +02:00
|
|
|
|
#######################################################################
|
2012-03-04 10:48:30 +01:00
|
|
|
|
|
2025-03-06 16:22:23 +01:00
|
|
|
|
troubleshooting = options.add_group("Troubleshooting")
|
2013-08-23 10:57:17 +02:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--ignore-stdin",
|
|
|
|
|
"-I",
|
|
|
|
|
action="store_true",
|
2013-08-23 10:57:17 +02:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Do not attempt to read stdin",
|
2013-08-23 10:57:17 +02:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--help",
|
|
|
|
|
action="help",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
default=Qualifiers.SUPPRESS,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Show this help message and exit.",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
)
|
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--manual",
|
|
|
|
|
action="manual",
|
2022-04-14 16:43:10 +02:00
|
|
|
|
default=Qualifiers.SUPPRESS,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Show the full manual.",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2012-12-05 04:39:56 +01:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--version",
|
|
|
|
|
action="version",
|
2013-08-10 11:56:19 +02:00
|
|
|
|
version=__version__,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Show version and exit.",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--traceback",
|
|
|
|
|
action="store_true",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Prints the exception traceback should one occur.",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2015-10-28 23:06:04 +01:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--default-scheme",
|
|
|
|
|
default="http",
|
|
|
|
|
short_help="The default scheme to use if not specified in the URL.",
|
2015-10-28 23:06:04 +01:00
|
|
|
|
)
|
2012-08-18 05:59:20 +02:00
|
|
|
|
troubleshooting.add_argument(
|
2025-03-06 16:22:23 +01:00
|
|
|
|
"--debug",
|
|
|
|
|
action="store_true",
|
2013-02-26 15:12:33 +01:00
|
|
|
|
default=False,
|
2025-03-06 16:22:23 +01:00
|
|
|
|
short_help="Print useful diagnostic information for bug reports.",
|
2022-03-07 23:34:04 +01:00
|
|
|
|
help="""
|
2016-03-01 14:37:26 +01:00
|
|
|
|
Prints the exception traceback should one occur, as well as other
|
|
|
|
|
information useful for debugging HTTPie itself and for reporting bugs.
|
2013-08-10 11:56:19 +02:00
|
|
|
|
|
2022-03-07 23:34:04 +01:00
|
|
|
|
""",
|
2012-03-04 10:48:30 +01:00
|
|
|
|
)
|
2022-03-07 23:34:04 +01:00
|
|
|
|
|
|
|
|
|
#######################################################################
|
|
|
|
|
# Finalization
|
|
|
|
|
#######################################################################
|
|
|
|
|
|
|
|
|
|
options.finalize()
|
|
|
|
|
parser = to_argparse(options)
|