httpie-cli/httpie/cli.py

288 lines
8.9 KiB
Python
Raw Normal View History

2012-07-26 06:37:03 +02:00
"""CLI arguments definition.
NOTE: the CLI interface may change before reaching v1.0.
2012-04-25 01:32:53 +02:00
"""
import argparse
from requests.compat import is_windows
2012-04-25 02:10:58 +02:00
from . import __doc__
from . import __version__
from .output import AVAILABLE_STYLES, DEFAULT_STYLE
2012-07-26 06:37:03 +02:00
from .input import (Parser, AuthCredentialsArgType, KeyValueArgType,
SEP_PROXY, SEP_CREDENTIALS, SEP_GROUP_ITEMS,
OUT_REQ_HEAD, OUT_REQ_BODY, OUT_RESP_HEAD,
OUT_RESP_BODY, OUTPUT_OPTIONS,
PRETTY_STDOUT_TTY_ONLY, PRETTY_ALL,
PRETTY_FORMAT, PRETTY_COLORS)
2012-03-04 10:48:30 +01:00
def _(text):
2012-07-26 06:37:03 +02:00
"""Normalize whitespace."""
2012-03-04 10:48:30 +01:00
return ' '.join(text.strip().split())
2012-07-26 06:37:03 +02:00
parser = Parser(description='%s <http://httpie.org>' % __doc__.strip())
2012-04-25 02:10:58 +02:00
parser.add_argument('--version', action='version', version=__version__)
2012-03-04 10:48:30 +01:00
2012-04-25 01:32:53 +02:00
2012-03-04 10:48:30 +01:00
# Content type.
#############################################
group_type = parser.add_mutually_exclusive_group(required=False)
group_type.add_argument(
'--json', '-j', action='store_true',
help=_('''
2012-07-17 07:01:30 +02:00
(default) Data items from the command
line are serialized as a JSON object.
2012-04-25 02:10:58 +02:00
The Content-Type and Accept headers
are set to application/json (if not specified).
2012-03-04 10:48:30 +01:00
''')
)
group_type.add_argument(
'--form', '-f', action='store_true',
help=_('''
Data items from the command line are serialized as form fields.
2012-07-17 07:01:30 +02:00
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.
2012-03-04 10:48:30 +01:00
''')
)
# Output options.
2012-03-04 10:48:30 +01:00
#############################################
parser.add_argument(
'--output', '-o', type=argparse.FileType('w+b'),
metavar='FILE',
help= argparse.SUPPRESS if not is_windows else _(
'''
Save output to FILE.
This option is a replacement for piping output to FILE,
which would on Windows result in corrupted data
being saved.
'''
)
2012-03-04 10:48:30 +01:00
)
prettify = parser.add_mutually_exclusive_group(required=False)
prettify.add_argument(
'--pretty', dest='prettify', action='store_const', const=PRETTY_ALL,
default=PRETTY_STDOUT_TTY_ONLY,
2012-03-04 10:48:30 +01:00
help=_('''
Apply both colors and formatting. Default for terminal output.
2012-03-04 10:48:30 +01:00
''')
)
prettify.add_argument(
'--colors', dest='prettify', action='store_const', const=PRETTY_COLORS,
help=_('''Apply colors to the output.''')
)
prettify.add_argument(
'--format', dest='prettify', action='store_const', const=PRETTY_FORMAT,
help=_('''Apply formatting to the output.''')
)
2012-03-04 10:48:30 +01:00
prettify.add_argument(
'--ugly', '-u', dest='prettify', action='store_false',
help=_('''
Disables output processing.
Default for redirected output.
''')
2012-03-04 10:48:30 +01:00
)
output_options = parser.add_mutually_exclusive_group(required=False)
output_options.add_argument('--print', '-p', dest='output_options',
help=_('''
String specifying what the output should contain:
"{request_headers}" stands for the request headers, and
2012-04-25 02:10:58 +02:00
"{request_body}" for the request body.
"{response_headers}" stands for the response headers and
"{response_body}" for response the body.
The default behaviour is "hb" (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 body is printed by default.
'''.format(
2012-07-26 06:37:03 +02:00
request_headers=OUT_REQ_HEAD,
request_body=OUT_REQ_BODY,
response_headers=OUT_RESP_HEAD,
response_body=OUT_RESP_BODY,
))
)
output_options.add_argument(
'--verbose', '-v', dest='output_options',
2012-07-26 06:37:03 +02:00
action='store_const', const=''.join(OUTPUT_OPTIONS),
help=_('''
2012-04-25 02:10:58 +02:00
Print the whole request as well as the response.
Shortcut for --print={0}.
2012-07-26 06:37:03 +02:00
'''.format(''.join(OUTPUT_OPTIONS)))
)
output_options.add_argument(
'--headers', '-h', dest='output_options',
2012-07-26 06:37:03 +02:00
action='store_const', const=OUT_RESP_HEAD,
help=_('''
2012-03-04 10:48:30 +01:00
Print only the response headers.
Shortcut for --print={0}.
2012-07-26 06:37:03 +02:00
'''.format(OUT_RESP_HEAD))
2012-03-04 10:48:30 +01:00
)
output_options.add_argument(
'--body', '-b', dest='output_options',
2012-07-26 06:37:03 +02:00
action='store_const', const=OUT_RESP_BODY,
help=_('''
2012-03-04 10:48:30 +01:00
Print only the response body.
Shortcut for --print={0}.
2012-07-26 06:37:03 +02:00
'''.format(OUT_RESP_BODY))
2012-03-04 10:48:30 +01:00
)
2012-03-04 10:48:30 +01:00
parser.add_argument(
'--style', '-s', dest='style', default=DEFAULT_STYLE, metavar='STYLE',
choices=AVAILABLE_STYLES,
2012-03-04 10:48:30 +01:00
help=_('''
Output coloring style, one of %s. Defaults to "%s".
2012-04-25 02:10:58 +02:00
For this option 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).
''') % (', '.join(sorted(AVAILABLE_STYLES)), DEFAULT_STYLE)
2012-03-04 10:48:30 +01:00
)
parser.add_argument('--stream', '-S', action='store_true', default=False,
help=_('''
Always stream the output by line, i.e., behave like `tail -f'.
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.
'''
))
parser.add_argument(
'--check-status', default=False, action='store_true',
help=_('''
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.
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 --allow-redirects
hasn't been set, then the exit status is 3.
Also an error message is written to stderr if stdout is redirected.
''')
)
2012-03-04 10:48:30 +01:00
# ``requests.request`` keyword arguments.
parser.add_argument(
'--auth', '-a', metavar='USER:PASS',
2012-07-26 06:37:03 +02:00
type=AuthCredentialsArgType(SEP_CREDENTIALS),
help=_('''
username:password.
2012-07-17 07:01:30 +02:00
If only the username is provided (-a username),
HTTPie will prompt for the password.
'''),
2012-03-04 10:48:30 +01:00
)
2012-03-22 15:40:03 +01:00
parser.add_argument(
'--auth-type', choices=['basic', 'digest'], default='basic',
2012-07-17 07:01:30 +02:00
help=_('''
The authentication mechanism to be used.
Defaults to "basic".
''')
2012-03-22 15:40:03 +01:00
)
2012-03-04 10:48:30 +01:00
parser.add_argument(
'--verify', default='yes',
2012-03-04 10:48:30 +01:00
help=_('''
Set to "no" to skip checking the host\'s SSL certificate.
2012-03-04 10:48:30 +01:00
You can also pass the path to a CA_BUNDLE
file for private certs. You can also set
the REQUESTS_CA_BUNDLE environment variable.
Defaults to "yes".
2012-03-04 10:48:30 +01:00
''')
)
parser.add_argument(
'--proxy', default=[], action='append',
2012-07-26 06:37:03 +02:00
type=KeyValueArgType(SEP_PROXY),
2012-03-04 10:48:30 +01:00
help=_('''
String mapping protocol to the URL of the proxy
(e.g. http:foo.bar:3128).
''')
)
parser.add_argument(
'--allow-redirects', default=False, action='store_true',
help=_('''
Set this flag if full redirects are allowed
(e.g. re-POST-ing of data at new ``Location``)
''')
)
parser.add_argument(
'--timeout', type=float, default=30, metavar='SECONDS',
2012-03-04 10:48:30 +01:00
help=_('''
The connection timeout of the request in seconds.
The default value is 30 seconds.
2012-08-07 14:50:51 +02:00
''')
)
parser.add_argument(
'--traceback', action='store_true', default=False,
help=_('''
Prints exception traceback should one occur.
2012-03-04 10:48:30 +01:00
''')
)
parser.add_argument(
'--debug', action='store_true', default=False,
help=_('''
2012-08-07 14:50:51 +02:00
Prints exception traceback should one occur, and also other
information useful for debugging HTTPie itself and bug reports.
''')
)
2012-03-04 10:48:30 +01:00
# Positional arguments.
#############################################
parser.add_argument(
'method', metavar='METHOD',
2012-06-16 18:08:31 +02:00
nargs='?',
default=None,
2012-03-04 10:48:30 +01:00
help=_('''
2012-04-25 02:10:58 +02:00
The HTTP method to be used for the request
2012-03-04 10:48:30 +01:00
(GET, POST, PUT, DELETE, PATCH, ...).
2012-07-17 07:01:30 +02:00
If this argument is omitted, then HTTPie
will guess the HTTP method. If there is some
data to be sent, then it will be POST, otherwise GET.
2012-03-04 10:48:30 +01:00
''')
)
parser.add_argument(
'url', metavar='URL',
help=_('''
2012-04-25 02:10:58 +02:00
The protocol defaults to http:// if the
URL does not include one.
2012-03-04 10:48:30 +01:00
''')
)
parser.add_argument(
'items', nargs='*',
2012-04-25 02:10:58 +02:00
metavar='ITEM',
2012-07-26 06:37:03 +02:00
type=KeyValueArgType(*SEP_GROUP_ITEMS),
2012-03-04 10:48:30 +01:00
help=_('''
2012-07-17 07:01:30 +02:00
A key-value pair whose type is defined by the
separator used. It can be an HTTP header (header:value),
2012-04-25 02:10:58 +02:00
a data field to be used in the request body (field_name=value),
a raw JSON data field (field_name:=value),
a query parameter (name==value),
2012-04-25 02:10:58 +02:00
or a file field (field_name@/path/to/file).
2012-07-17 07:01:30 +02:00
You can use a backslash to escape a colliding
separator in the field name.
2012-03-04 10:48:30 +01:00
''')
)