httpie-cli/httpie/input.py

457 lines
13 KiB
Python
Raw Normal View History

2012-07-26 06:37:03 +02:00
"""Parsing and processing of CLI input (args, auth credentials, files, stdin).
2012-04-25 01:32:53 +02:00
"""
import os
import sys
2012-04-25 01:32:53 +02:00
import re
2012-04-28 14:18:59 +02:00
import json
import argparse
import mimetypes
import getpass
from io import BytesIO
2012-04-28 14:18:59 +02:00
2012-04-25 01:32:53 +02:00
try:
from collections import OrderedDict
except ImportError:
OrderedDict = dict
2012-04-28 14:18:59 +02:00
2012-04-25 01:32:53 +02:00
from requests.structures import CaseInsensitiveDict
2012-08-04 16:59:36 +02:00
from requests.compat import str, urlparse
2012-04-28 14:18:59 +02:00
2012-04-25 01:32:53 +02:00
from . import __version__
2012-07-26 03:16:42 +02:00
HTTP_POST = 'POST'
HTTP_GET = 'GET'
2012-08-04 16:59:36 +02:00
HTTP = 'http://'
HTTPS = 'https://'
2012-07-26 03:16:42 +02:00
# Various separators used in args
SEP_HEADERS = ':'
SEP_CREDENTIALS = ':'
SEP_PROXY = ':'
2012-04-25 01:32:53 +02:00
SEP_DATA = '='
SEP_DATA_RAW_JSON = ':='
SEP_FILES = '@'
SEP_QUERY = '=='
2012-07-26 03:16:42 +02:00
# Separators that become request data
SEP_GROUP_DATA_ITEMS = frozenset([
SEP_DATA,
SEP_DATA_RAW_JSON,
SEP_FILES
])
# Separators allowed in ITEM arguments
SEP_GROUP_ITEMS = frozenset([
SEP_HEADERS,
SEP_QUERY,
SEP_DATA,
SEP_DATA_RAW_JSON,
SEP_FILES
2012-07-26 03:16:42 +02:00
])
2012-04-25 01:32:53 +02:00
2012-07-26 03:16:42 +02:00
# Output options
OUT_REQ_HEAD = 'H'
2012-04-25 01:32:53 +02:00
OUT_REQ_BODY = 'B'
OUT_RESP_HEAD = 'h'
2012-04-25 01:32:53 +02:00
OUT_RESP_BODY = 'b'
2012-07-26 03:16:42 +02:00
OUTPUT_OPTIONS = frozenset([
OUT_REQ_HEAD,
OUT_REQ_BODY,
OUT_RESP_HEAD,
OUT_RESP_BODY
])
2012-04-25 01:32:53 +02:00
2012-07-26 03:16:42 +02:00
# Defaults
OUTPUT_OPTIONS_DEFAULT = OUT_RESP_HEAD + OUT_RESP_BODY
OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED = OUT_RESP_BODY
PRETTIFY_STDOUT_TTY_ONLY = object()
2012-04-25 01:32:53 +02:00
DEFAULT_UA = 'HTTPie/%s' % __version__
2012-06-24 03:43:08 +02:00
class Parser(argparse.ArgumentParser):
2012-07-26 06:37:03 +02:00
"""Adds additional logic to `argparse.ArgumentParser`.
Handles all input (CLI args, file args, stdin), applies defaults,
and performs extra validation.
"""
2012-04-25 01:32:53 +02:00
def __init__(self, *args, **kwargs):
kwargs['add_help'] = False
super(Parser, self).__init__(*args, **kwargs)
# Help only as --help (-h is used for --headers).
self.add_argument('--help',
action='help', default=argparse.SUPPRESS,
help=argparse._('show this help message and exit'))
2012-07-26 00:26:23 +02:00
#noinspection PyMethodOverriding
def parse_args(self, env, args=None, namespace=None):
self.env = env
2012-06-24 03:43:08 +02:00
args = super(Parser, self).parse_args(args, namespace)
if args.output:
env.stdout = args.output
env.stdout_isatty = False
self._process_output_options(args, env)
self._guess_method(args, env)
2012-04-25 01:32:53 +02:00
self._parse_items(args)
if not env.stdin_isatty:
2012-08-01 00:52:30 +02:00
self._body_from_file(args, env.stdin)
2012-07-26 03:16:42 +02:00
2012-08-04 16:59:36 +02:00
if not (args.url.startswith(HTTP) or args.url.startswith(HTTPS)):
scheme = HTTPS if env.progname == 'https' else HTTP
args.url = scheme + args.url
if args.auth and not args.auth.has_password():
2012-07-26 03:16:42 +02:00
# Stdin already read (if not a tty) so it's save to prompt.
2012-08-04 16:59:36 +02:00
args.auth.prompt_password(urlparse(args.url).netloc)
if args.prettify == PRETTIFY_STDOUT_TTY_ONLY:
args.prettify = env.stdout_isatty
elif args.prettify and env.is_windows:
self.error('Only terminal output can be prettified on Windows.')
2012-04-25 01:32:53 +02:00
return args
def _print_message(self, message, file=None):
# Sneak in our stderr/stdout.
file = {
sys.stdout: self.env.stdout,
sys.stderr: self.env.stderr,
None: self.env.stderr
}.get(file, file)
#if isinstance(message, str):
# message = message.encode('utf8')
super(Parser, self)._print_message(message, file)
2012-08-01 00:52:30 +02:00
def _body_from_file(self, args, fd):
"""There can only be one source of request data.
Bytes are always read.
"""
if args.data:
self.error('Request body (from stdin or a file) and request '
'data (key=value) cannot be mixed.')
2012-08-01 00:52:30 +02:00
args.data = getattr(fd, 'buffer', fd).read()
def _guess_method(self, args, env):
2012-07-26 06:37:03 +02:00
"""Set `args.method` if not specified to either POST or GET
2012-06-24 03:43:08 +02:00
based on whether the request has data or not.
2012-06-17 19:46:56 +02:00
"""
if args.method is None:
# Invoked as `http URL'.
2012-06-17 19:46:56 +02:00
assert not args.items
if not env.stdin_isatty:
2012-07-26 03:16:42 +02:00
args.method = HTTP_POST
else:
2012-07-26 03:16:42 +02:00
args.method = HTTP_GET
# FIXME: False positive, e.g., "localhost" matches but is a valid URL.
2012-06-17 19:46:56 +02:00
elif not re.match('^[a-zA-Z]+$', args.method):
2012-07-26 03:16:42 +02:00
# Invoked as `http URL item+'. The URL is now in `args.method`
# and the first ITEM is now incorrectly in `args.url`.
try:
# Parse the URL as an ITEM and store it as the first ITEM arg.
args.items.insert(
0, KeyValueArgType(*SEP_GROUP_ITEMS).__call__(args.url))
except argparse.ArgumentTypeError as e:
if args.debug:
2012-07-26 03:16:42 +02:00
raise
self.error(e.message)
2012-06-17 19:46:56 +02:00
else:
2012-07-26 03:16:42 +02:00
# Set the URL correctly
args.url = args.method
# Infer the method
has_data = not env.stdin_isatty or any(
item.sep in SEP_GROUP_DATA_ITEMS for item in args.items)
args.method = HTTP_POST if has_data else HTTP_GET
2012-06-17 19:46:56 +02:00
2012-04-25 01:32:53 +02:00
def _parse_items(self, args):
2012-07-26 06:37:03 +02:00
"""Parse `args.items` into `args.headers`, `args.data`,
`args.`, and `args.files`.
"""
2012-04-25 01:32:53 +02:00
args.headers = CaseInsensitiveDict()
args.headers['User-Agent'] = DEFAULT_UA
args.data = ParamDict() if args.form else OrderedDict()
2012-04-25 01:32:53 +02:00
args.files = OrderedDict()
args.params = ParamDict()
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
try:
parse_items(items=args.items,
headers=args.headers,
data=args.data,
files=args.files,
params=args.params)
2012-04-25 01:32:53 +02:00
except ParseError as e:
if args.debug:
2012-04-25 01:32:53 +02:00
raise
self.error(e.message)
if args.files and not args.form:
# `http url @/path/to/file`
2012-07-29 07:14:54 +02:00
file_fields = list(args.files.keys())
if file_fields != ['']:
self.error(
2012-07-29 07:14:54 +02:00
'Invalid file fields (perhaps you meant --form?): %s'
% ','.join(file_fields))
2012-07-26 03:16:42 +02:00
2012-08-01 00:52:30 +02:00
fn, fd = args.files['']
args.files = {}
2012-08-01 00:52:30 +02:00
self._body_from_file(args, fd)
if 'Content-Type' not in args.headers:
mime, encoding = mimetypes.guess_type(fn, strict=False)
if mime:
content_type = mime
if encoding:
content_type = '%s; charset=%s' % (mime, encoding)
args.headers['Content-Type'] = content_type
def _process_output_options(self, args, env):
2012-07-26 06:37:03 +02:00
"""Apply defaults to output options or validate the provided ones.
The default output options are stdout-type-sensitive.
"""
if not args.output_options:
2012-07-26 03:16:42 +02:00
args.output_options = (OUTPUT_OPTIONS_DEFAULT if env.stdout_isatty
else OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED)
2012-07-26 03:16:42 +02:00
unknown = set(args.output_options) - OUTPUT_OPTIONS
2012-07-17 07:01:30 +02:00
if unknown:
2012-07-26 03:16:42 +02:00
self.error('Unknown output options: %s' % ','.join(unknown))
2012-04-25 01:32:53 +02:00
class ParseError(Exception):
pass
class KeyValue(object):
"""Base key-value pair parsed from CLI."""
def __init__(self, key, value, sep, orig):
self.key = key
self.value = value
self.sep = sep
self.orig = orig
def __eq__(self, other):
return self.__dict__ == other.__dict__
2012-04-25 01:32:53 +02:00
class KeyValueArgType(object):
2012-07-26 06:37:03 +02:00
"""A key-value pair argument type used with `argparse`.
Parses a key-value arg and constructs a `KeyValue` instance.
Used for headers, form data, and other key-value pair types.
"""
2012-04-25 01:32:53 +02:00
key_value_class = KeyValue
2012-04-25 01:32:53 +02:00
def __init__(self, *separators):
self.separators = separators
def __call__(self, string):
2012-07-26 06:37:03 +02:00
"""Parse `string` and return `self.key_value_class()` instance.
The best of `self.separators` is determined (first found, longest).
Back slash escaped characters aren't considered as separators
(or parts thereof). Literal back slash characters have to be escaped
as well (r'\\').
"""
class Escaped(str):
2012-07-26 06:37:03 +02:00
"""Represents an escaped character."""
def tokenize(s):
2012-07-26 06:37:03 +02:00
"""Tokenize `s`. There are only two token types - strings
and escaped characters:
>>> tokenize(r'foo\=bar\\baz')
['foo', Escaped('='), 'bar', Escaped('\\'), 'baz']
"""
tokens = ['']
esc = False
for c in s:
if esc:
tokens.extend([Escaped(c), ''])
esc = False
else:
if c == '\\':
esc = True
else:
tokens[-1] += c
return tokens
tokens = tokenize(string)
# Sorting by length ensures that the longest one will be
# chosen as it will overwrite any shorter ones starting
# at the same position in the `found` dictionary.
separators = sorted(self.separators, key=len)
for i, token in enumerate(tokens):
if isinstance(token, Escaped):
continue
found = {}
for sep in separators:
pos = token.find(sep)
if pos != -1:
found[pos] = sep
if found:
# Starting first, longest separator found.
sep = found[min(found.keys())]
key, value = token.split(sep, 1)
# Any preceding tokens are part of the key.
key = ''.join(tokens[:i]) + key
# Any following tokens are part of the value.
value += ''.join(tokens[i + 1:])
break
else:
2012-04-25 01:32:53 +02:00
raise argparse.ArgumentTypeError(
'"%s" is not a valid value' % string)
return self.key_value_class(
key=key, value=value, sep=sep, orig=string)
class AuthCredentials(KeyValue):
2012-07-26 06:37:03 +02:00
"""Represents parsed credentials."""
def _getpass(self, prompt):
2012-07-17 00:05:09 +02:00
# To allow mocking.
return getpass.getpass(prompt)
def has_password(self):
return self.value is not None
2012-08-04 16:59:36 +02:00
def prompt_password(self, host):
try:
2012-08-04 16:59:36 +02:00
self.value = self._getpass(
'http: password for %s@%s: ' % (self.key, host))
except (EOFError, KeyboardInterrupt):
sys.stderr.write('\n')
sys.exit(0)
class AuthCredentialsArgType(KeyValueArgType):
2012-07-26 06:37:03 +02:00
"""A key-value arg type that parses credentials."""
2012-04-25 01:32:53 +02:00
key_value_class = AuthCredentials
2012-04-25 01:32:53 +02:00
def __call__(self, string):
2012-07-26 06:37:03 +02:00
"""Parse credentials from `string`.
("username" or "username:password").
"""
try:
return super(AuthCredentialsArgType, self).__call__(string)
except argparse.ArgumentTypeError:
# No password provided, will prompt for it later.
return self.key_value_class(
key=string,
value=None,
2012-07-26 03:16:42 +02:00
sep=SEP_CREDENTIALS,
orig=string
)
class ParamDict(OrderedDict):
2012-07-26 06:37:03 +02:00
"""Multi-value dict for URL parameters and form data."""
2012-07-26 00:26:23 +02:00
#noinspection PyMethodOverriding
def __setitem__(self, key, value):
2012-07-26 06:37:03 +02:00
""" If `key` is assigned more than once, `self[key]` holds a
`list` of all the values.
This allows having multiple fields with the same name in form
data and URL params.
"""
# NOTE: Won't work when used for form data with multiple values
# for a field and a file field is present:
# https://github.com/kennethreitz/requests/issues/737
if key not in self:
super(ParamDict, self).__setitem__(key, value)
else:
if not isinstance(self[key], list):
super(ParamDict, self).__setitem__(key, [self[key]])
self[key].append(value)
def parse_items(items, data=None, headers=None, files=None, params=None):
2012-07-26 06:37:03 +02:00
"""Parse `KeyValue` `items` into `data`, `headers`, `files`,
and `params`.
"""
2012-04-25 01:32:53 +02:00
if headers is None:
2012-07-26 03:16:42 +02:00
headers = CaseInsensitiveDict()
2012-04-25 01:32:53 +02:00
if data is None:
2012-07-26 03:16:42 +02:00
data = OrderedDict()
2012-04-25 01:32:53 +02:00
if files is None:
2012-07-26 03:16:42 +02:00
files = OrderedDict()
if params is None:
params = ParamDict()
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
for item in items:
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
value = item.value
key = item.key
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
if item.sep == SEP_HEADERS:
target = headers
elif item.sep == SEP_QUERY:
target = params
2012-04-25 01:32:53 +02:00
elif item.sep == SEP_FILES:
try:
with open(os.path.expanduser(value), 'rb') as f:
value = (os.path.basename(value),
BytesIO(f.read()))
2012-04-25 01:32:53 +02:00
except IOError as e:
raise ParseError(
2012-07-26 03:16:42 +02:00
'Invalid argument "%s": %s' % (item.orig, e))
2012-04-25 01:32:53 +02:00
target = files
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
elif item.sep in [SEP_DATA, SEP_DATA_RAW_JSON]:
if item.sep == SEP_DATA_RAW_JSON:
try:
value = json.loads(item.value)
except ValueError:
2012-07-26 03:16:42 +02:00
raise ParseError('"%s" is not valid JSON' % item.orig)
2012-04-25 01:32:53 +02:00
target = data
2012-07-26 03:16:42 +02:00
2012-04-25 01:32:53 +02:00
else:
2012-07-26 03:16:42 +02:00
raise TypeError(item)
2012-04-25 01:32:53 +02:00
target[key] = value
return headers, data, files, params