v0.2.7

`--stream` can be used to enable streaming also with `--pretty` and to ensure
a more frequent output flushing.

.gitignore

@@ -3,3 +3,7 @@ httpie.egg-info
 build
 *.pyc
 .tox
+README.html
+.coverage
+htmlcov
+

.travis.yml

@@ -3,7 +3,6 @@ python:
   - 2.6
   - 2.7
   - pypy
-  - 3.1
   - 3.2
 script: python setup.py test
 install:

AUTHORS.rst

@@ -0,0 +1,29 @@
+==============
+HTTPie authors
+==============
+
+* `Jakub Roztocil <https://github.com/jkbr>`_
+
+
+Patches and ideas
+-----------------
+
+* `Hank Gay <https://github.com/gthank>`_
+* `Jake Basile <https://github.com/jakebasile>`_
+* `Vladimir Berkutov <https://github.com/dair-targ>`_
+* `Jakob Kramer <https://github.com/gandaro>`_
+* `Chris Faulkner <https://github.com/faulkner>`_
+* `Alen Mujezinovic <https://github.com/flashingpumpkin>`_
+* `Praful Mathur <https://github.com/tictactix>`_
+* `Marc Abramowitz <https://github.com/msabramo>`_
+* `Ismail Badawi <https://github.com/isbadawi>`_
+* `Laurent Bachelier <https://github.com/laurentb>`_
+* `Isman Firmansyah <https://github.com/iromli>`_
+* `Simon Olofsson <https://github.com/simono>`_
+* `Churkin Oleg <https://github.com/Bahus>`_
+* `Jökull Sólberg Auðunsson <https://github.com/jokull>`_
+* `Matthew M. Boedicker <https://github.com/mmb>`_
+* `marblar <https://github.com/marblar>`_
+* `Tomek Wójcik <https://github.com/tomekwojcik>`_
+* `Davey Shafik <https://github.com/dshafik>`_
+* `cido <https://github.com/cido>`_

httpie/__init__.py

@@ -3,5 +3,14 @@ HTTPie - cURL for humans.
 
 """
 __author__ = 'Jakub Roztocil'
-__version__ = '0.2.4'
+__version__ = '0.2.7'
 __licence__ = 'BSD'
+
+
+class EXIT:
+    OK = 0
+    ERROR = 1
+    # Used only when requested:
+    ERROR_HTTP_3XX = 3
+    ERROR_HTTP_4XX = 4
+    ERROR_HTTP_5XX = 5

httpie/__main__.py

@@ -1,130 +1,10 @@
 #!/usr/bin/env python
+"""The main entry point. Invoke as `http' or `python -m httpie'.
+
+"""
 import sys
-import json
-
-import requests
-
-from requests.compat import str
-
-from . import httpmessage
-from . import cliparse
-from . import cli
-from . import pretty
-
-
-TYPE_FORM = 'application/x-www-form-urlencoded; charset=utf-8'
-TYPE_JSON = 'application/json; charset=utf-8'
-
-
-def _get_response(args):
-
-    auto_json = args.data and not args.form
-    if args.json or auto_json:
-        # JSON
-        if 'Content-Type' not in args.headers:
-            args.headers['Content-Type'] = TYPE_JSON
-
-        if 'Accept' not in args.headers:
-            # Default Accept to JSON as well.
-            args.headers['Accept'] = 'application/json'
-
-        if isinstance(args.data, dict):
-            # If not empty, serialize the data `dict` parsed from arguments.
-            # Otherwise set it to `None` avoid sending "{}".
-            args.data = json.dumps(args.data) if args.data else None
-
-    elif args.form:
-        # Form
-        if not args.files and 'Content-Type' not in args.headers:
-            # If sending files, `requests` will set
-            # the `Content-Type` for us.
-            args.headers['Content-Type'] = TYPE_FORM
-
-    # Fire the request.
-    try:
-        credentials = None
-        if args.auth:
-            auth_type = (requests.auth.HTTPDigestAuth
-                         if args.auth_type == 'digest'
-                         else requests.auth.HTTPBasicAuth)
-            credentials = auth_type(args.auth.key, args.auth.value)
-
-        return requests.request(
-            method=args.method.lower(),
-            url=args.url if '://' in args.url else 'http://%s' % args.url,
-            headers=args.headers,
-            data=args.data,
-            verify={'yes': True, 'no': False}.get(args.verify, args.verify),
-            timeout=args.timeout,
-            auth=credentials,
-            proxies=dict((p.key, p.value) for p in args.proxy),
-            files=args.files,
-            allow_redirects=args.allow_redirects,
-        )
-
-    except (KeyboardInterrupt, SystemExit):
-        sys.stderr.write('\n')
-        sys.exit(1)
-    except Exception as e:
-        if args.traceback:
-            raise
-        sys.stderr.write(str(e.message) + '\n')
-        sys.exit(1)
-
-
-def _get_output(args, stdout_isatty, response):
-
-    do_prettify = (args.prettify is True or
-                   (args.prettify == cliparse.PRETTIFY_STDOUT_TTY_ONLY
-                    and stdout_isatty))
-
-    do_output_request = (cliparse.OUT_REQ_HEADERS in args.output_options
-                         or cliparse.OUT_REQ_BODY in args.output_options)
-
-    do_output_response = (cliparse.OUT_RESP_HEADERS in args.output_options
-                          or cliparse.OUT_RESP_BODY in args.output_options)
-
-    prettifier = pretty.PrettyHttp(args.style) if do_prettify else None
-    output = []
-
-    if do_output_request:
-        output.append(httpmessage.format(
-            message=httpmessage.from_request(response.request),
-            prettifier=prettifier,
-            with_headers=cliparse.OUT_REQ_HEADERS in args.output_options,
-            with_body=cliparse.OUT_REQ_BODY in args.output_options
-        ))
-        output.append('\n')
-        if do_output_response:
-            output.append('\n')
-
-    if do_output_response:
-        output.append(httpmessage.format(
-            message=httpmessage.from_response(response),
-            prettifier=prettifier,
-            with_headers=cliparse.OUT_RESP_HEADERS in args.output_options,
-            with_body=cliparse.OUT_RESP_BODY in args.output_options
-        ))
-        output.append('\n')
-
-    return ''.join(output)
-
-
-def main(args=None,
-         stdin=sys.stdin, stdin_isatty=sys.stdin.isatty(),
-         stdout=sys.stdout, stdout_isatty=sys.stdout.isatty()):
-    parser = cli.parser
-    args = parser.parse_args(
-        args=args if args is not None else sys.argv[1:],
-        stdin=stdin,
-        stdin_isatty=stdin_isatty
-    )
-    response = _get_response(args)
-    output = _get_output(args, stdout_isatty, response)
-    output_bytes = output.encode('utf8')
-    f = (stdout.buffer if hasattr(stdout, 'buffer') else stdout)
-    f.write(output_bytes)
+from .core import main
 
 
 if __name__ == '__main__':
-    main()
+    sys.exit(main())

httpie/cli.py

@@ -1,20 +1,28 @@
-"""
-CLI definition.
+"""CLI arguments definition.
+
+NOTE: the CLI interface may change before reaching v1.0.
 
 """
-from . import pretty
+import argparse
+
+from requests.compat import is_windows
+
 from . import __doc__
 from . import __version__
-from . import cliparse
+from .output import AVAILABLE_STYLES, DEFAULT_STYLE
+from .input import (Parser, AuthCredentialsArgType, KeyValueArgType,
+                    PRETTIFY_STDOUT_TTY_ONLY,
+                    SEP_PROXY, SEP_CREDENTIALS, SEP_GROUP_ITEMS,
+                    OUT_REQ_HEAD, OUT_REQ_BODY, OUT_RESP_HEAD,
+                    OUT_RESP_BODY, OUTPUT_OPTIONS)
 
 
 def _(text):
-    """Normalize white space."""
+    """Normalize whitespace."""
     return ' '.join(text.strip().split())
 
 
-desc = '%s <http://httpie.org>'
-parser = cliparse.Parser(description=desc % __doc__.strip(),)
+parser = Parser(description='%s <http://httpie.org>' % __doc__.strip())
 parser.add_argument('--version', action='version', version=__version__)
 
 
@@ -25,7 +33,8 @@ group_type = parser.add_mutually_exclusive_group(required=False)
 group_type.add_argument(
     '--json', '-j', action='store_true',
     help=_('''
-        (default) Data items from the command line are serialized as a JSON object.
+        (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).
     ''')
@@ -34,8 +43,10 @@ group_type.add_argument(
     '--form', '-f', action='store_true',
     help=_('''
         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 into a multipart/form-data request.
+        The Content-Type is set to application/x-www-form-urlencoded
+        (if not specified).
+        The presence of any file fields results
+        into a multipart/form-data request.
      ''')
 )
 
@@ -43,17 +54,25 @@ group_type.add_argument(
 # Output options.
 #############################################
 
+
 parser.add_argument(
-    '--traceback', action='store_true', default=False,
-    help=_('''
-        Print exception traceback should one occur.
-    ''')
+    '--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 into corrupted data
+        being saved.
+
+        '''
+    )
 )
 
 prettify = parser.add_mutually_exclusive_group(required=False)
 prettify.add_argument(
     '--pretty', dest='prettify', action='store_true',
-    default=cliparse.PRETTIFY_STDOUT_TTY_ONLY,
+    default=PRETTIFY_STDOUT_TTY_ONLY,
     help=_('''
         If stdout is a terminal, the response is prettified
         by default (colorized and indented if it is JSON).
@@ -69,70 +88,110 @@ prettify.add_argument(
 
 output_options = parser.add_mutually_exclusive_group(required=False)
 output_options.add_argument('--print', '-p', dest='output_options',
-    default=cliparse.OUT_RESP_HEADERS + cliparse.OUT_RESP_BODY,
     help=_('''
-        String specifying what should the output contain.
-        "{request_headers}" stands for the request headers and
+        String specifying what the output should contain:
+        "{request_headers}" stands for the request headers,  and
         "{request_body}" for the request body.
         "{response_headers}" stands for the response headers and
         "{response_body}" for response the body.
-        Defaults to "hb" which means that the whole response
-        (headers and body) is printed.
+        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(
-        request_headers=cliparse.OUT_REQ_HEADERS,
-        request_body=cliparse.OUT_REQ_BODY,
-        response_headers=cliparse.OUT_RESP_HEADERS,
-        response_body=cliparse.OUT_RESP_BODY,
+        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',
-    action='store_const', const=''.join(cliparse.OUTPUT_OPTIONS),
+    action='store_const', const=''.join(OUTPUT_OPTIONS),
     help=_('''
         Print the whole request as well as the response.
         Shortcut for --print={0}.
-    '''.format(''.join(cliparse.OUTPUT_OPTIONS)))
+    '''.format(''.join(OUTPUT_OPTIONS)))
 )
 output_options.add_argument(
-    '--headers', '-t', dest='output_options',
-    action='store_const', const=cliparse.OUT_RESP_HEADERS,
+    '--headers', '-h', dest='output_options',
+    action='store_const', const=OUT_RESP_HEAD,
     help=_('''
         Print only the response headers.
         Shortcut for --print={0}.
-    '''.format(cliparse.OUT_RESP_HEADERS))
+    '''.format(OUT_RESP_HEAD))
 )
 output_options.add_argument(
     '--body', '-b', dest='output_options',
-    action='store_const', const=cliparse.OUT_RESP_BODY,
+    action='store_const', const=OUT_RESP_BODY,
     help=_('''
         Print only the response body.
         Shortcut for --print={0}.
-    '''.format(cliparse.OUT_RESP_BODY))
+    '''.format(OUT_RESP_BODY))
 )
 
 parser.add_argument(
-    '--style', '-s', dest='style', default='solarized', metavar='STYLE',
-    choices=pretty.AVAILABLE_STYLES,
+    '--style', '-s', dest='style', default=DEFAULT_STYLE, metavar='STYLE',
+    choices=AVAILABLE_STYLES,
     help=_('''
-        Output coloring style, one of %s. Defaults to solarized.
+        Output coloring style, one of %s. Defaults to "%s".
         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(pretty.AVAILABLE_STYLES))
+    ''') % (', '.join(sorted(AVAILABLE_STYLES)), DEFAULT_STYLE)
+)
+
+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.
+
+    ''')
 )
 
 # ``requests.request`` keyword arguments.
 parser.add_argument(
-    '--auth', '-a', type=cliparse.AuthCredentialsType(cliparse.SEP_COMMON),
+    '--auth', '-a',
+    type=AuthCredentialsArgType(SEP_CREDENTIALS),
     help=_('''
         username:password.
-        If only the username is provided (-a username), HTTPie will prompt for the password.
+        If only the username is provided (-a username),
+        HTTPie will prompt for the password.
     '''),
 )
 
 parser.add_argument(
-    '--auth-type', choices=['basic', 'digest'],
-    help=_('The authentication mechanism to be used. Defaults to "basic".')
+    '--auth-type', choices=['basic', 'digest'], default='basic',
+    help=_('''
+        The authentication mechanism to be used.
+        Defaults to "basic".
+    ''')
 )
 
 parser.add_argument(
@@ -147,7 +206,7 @@ parser.add_argument(
 )
 parser.add_argument(
     '--proxy', default=[], action='append',
-    type=cliparse.KeyValueType(cliparse.SEP_COMMON),
+    type=KeyValueArgType(SEP_PROXY),
     help=_('''
         String mapping protocol to the URL of the proxy
         (e.g. http:foo.bar:3128).
@@ -167,6 +226,13 @@ parser.add_argument(
         (Use socket.setdefaulttimeout() as fallback).
     ''')
 )
+parser.add_argument(
+    '--debug', action='store_true', default=False,
+    help=_('''
+        Prints exception traceback should one occur and other
+        information useful for debugging HTTPie itself.
+    ''')
+)
 
 
 # Positional arguments.
@@ -179,8 +245,9 @@ parser.add_argument(
     help=_('''
         The HTTP method to be used for the request
         (GET, POST, PUT, DELETE, PATCH, ...).
-        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.
+        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.
     ''')
 )
 parser.add_argument(
@@ -193,18 +260,15 @@ parser.add_argument(
 parser.add_argument(
     'items', nargs='*',
     metavar='ITEM',
-    type=cliparse.KeyValueType(
-        cliparse.SEP_COMMON,
-        cliparse.SEP_DATA,
-        cliparse.SEP_DATA_RAW_JSON,
-        cliparse.SEP_FILES
-    ),
+    type=KeyValueArgType(*SEP_GROUP_ITEMS),
     help=_('''
-        A key-value pair whose type is defined by the separator used. It can be an
-        HTTP header (header:value),
+        A key-value pair whose type is defined by the
+        separator used. It can be an HTTP header (header:value),
         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),
         or a file field (field_name@/path/to/file).
-        You can use a backslash to escape a colliding separator in the field name.
+        You can use a backslash to escape a colliding
+        separator in the field name.
     ''')
 )

httpie/cliparse.py

@@ -1,301 +0,0 @@
-"""
-CLI argument parsing logic.
-
-"""
-import os
-import sys
-import re
-import json
-import argparse
-import mimetypes
-import getpass
-
-try:
-    from collections import OrderedDict
-except ImportError:
-    OrderedDict = dict
-
-from requests.structures import CaseInsensitiveDict
-
-from . import __version__
-
-
-SEP_COMMON = ':'
-SEP_HEADERS = SEP_COMMON
-SEP_DATA = '='
-SEP_DATA_RAW_JSON = ':='
-SEP_FILES = '@'
-DATA_ITEM_SEPARATORS = [
-    SEP_DATA,
-    SEP_DATA_RAW_JSON,
-    SEP_FILES
-]
-
-
-OUT_REQ_HEADERS = 'H'
-OUT_REQ_BODY = 'B'
-OUT_RESP_HEADERS = 'h'
-OUT_RESP_BODY = 'b'
-OUTPUT_OPTIONS = [OUT_REQ_HEADERS,
-                  OUT_REQ_BODY,
-                  OUT_RESP_HEADERS,
-                  OUT_RESP_BODY]
-
-
-PRETTIFY_STDOUT_TTY_ONLY = object()
-
-DEFAULT_UA = 'HTTPie/%s' % __version__
-
-
-class Parser(argparse.ArgumentParser):
-
-    def parse_args(self, args=None, namespace=None,
-                   stdin=sys.stdin,
-                   stdin_isatty=sys.stdin.isatty()):
-
-        args = super(Parser, self).parse_args(args, namespace)
-
-        self._validate_output_options(args)
-        self._validate_auth_options(args)
-        self._guess_method(args, stdin_isatty)
-        self._parse_items(args)
-
-        if not stdin_isatty:
-            self._body_from_file(args, stdin)
-
-        if args.auth and not args.auth.has_password():
-            # stdin has already been read (if not a tty) so
-            # it's save to prompt now.
-            args.auth.prompt_password()
-
-        return args
-
-    def _body_from_file(self, args, f):
-        if args.data:
-            self.error('Request body (from stdin or a file) and request '
-                       'data (key=value) cannot be mixed.')
-        args.data = f.read()
-
-    def _guess_method(self, args, stdin_isatty=sys.stdin.isatty()):
-        """
-        Set `args.method`, if not specified, to either POST or GET
-        based on whether the request has data or not.
-
-        """
-        if args.method is None:
-            # Invoked as `http URL'.
-            assert not args.items
-            if not stdin_isatty:
-                args.method = 'POST'
-            else:
-                args.method = 'GET'
-        # FIXME: False positive, e.g., "localhost" matches but is a valid URL.
-        elif not re.match('^[a-zA-Z]+$', args.method):
-            # Invoked as `http URL item+':
-            # - The URL is now in `args.method`.
-            # - The first item is now in `args.url`.
-            #
-            # So we need to:
-            # - Guess the HTTP method.
-            # - Set `args.url` correctly.
-            # - Parse the first item and move it to `args.items[0]`.
-
-            item = KeyValueType(
-                SEP_COMMON,
-                SEP_DATA,
-                SEP_DATA_RAW_JSON,
-                SEP_FILES).__call__(args.url)
-
-            args.url = args.method
-            args.items.insert(0, item)
-
-            has_data = not stdin_isatty or any(
-                item.sep in DATA_ITEM_SEPARATORS for item in args.items)
-            if has_data:
-                args.method = 'POST'
-            else:
-                args.method = 'GET'
-
-    def _parse_items(self, args):
-        """
-        Parse `args.items` into `args.headers`, `args.data` and `args.files`.
-
-        """
-        args.headers = CaseInsensitiveDict()
-        args.headers['User-Agent'] = DEFAULT_UA
-        args.data = OrderedDict()
-        args.files = OrderedDict()
-        try:
-            parse_items(items=args.items, headers=args.headers,
-                        data=args.data, files=args.files)
-        except ParseError as e:
-            if args.traceback:
-                raise
-            self.error(e.message)
-
-        if args.files and not args.form:
-            # `http url @/path/to/file`
-            # It's not --form so the file contents will be used as the
-            # body of the requests. Also, we try to detect the appropriate
-            # Content-Type.
-            if len(args.files) > 1:
-                self.error(
-                    'Only one file can be specified unless'
-                    ' --form is used. File fields: %s'
-                    % ','.join(args.files.keys()))
-            f = list(args.files.values())[0]
-            self._body_from_file(args, f)
-            args.files = {}
-            if 'Content-Type' not in args.headers:
-                mime, encoding = mimetypes.guess_type(f.name, strict=False)
-                if mime:
-                    content_type = mime
-                    if encoding:
-                        content_type = '%s; charset=%s' % (mime, encoding)
-                    args.headers['Content-Type'] = content_type
-
-    def _validate_output_options(self, args):
-        unknown_output_options = set(args.output_options) - set(OUTPUT_OPTIONS)
-        if unknown_output_options:
-            self.error('Unknown output options: %s' % ','.join(unknown_output_options))
-
-    def _validate_auth_options(self, args):
-        if args.auth_type and not args.auth:
-            self.error('--auth-type can only be used with --auth')
-
-
-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__
-
-
-class KeyValueType(object):
-    """A type used with `argparse`."""
-
-    key_value_class = KeyValue
-
-    def __init__(self, *separators):
-        self.separators = separators
-        self.escapes = ['\\\\' + sep for sep in separators]
-
-    def __call__(self, string):
-        found = {}
-        found_escapes = []
-        for esc in self.escapes:
-            found_escapes += [m.span() for m in re.finditer(esc, string)]
-        for sep in self.separators:
-            matches = re.finditer(sep, string)
-            for match in matches:
-                start, end = match.span()
-                inside_escape = False
-                for estart, eend in found_escapes:
-                    if start >= estart and end <= eend:
-                        inside_escape = True
-                        break
-                if not inside_escape:
-                    found[start] = sep
-
-        if not found:
-            raise argparse.ArgumentTypeError(
-                '"%s" is not a valid value' % string)
-
-        # split the string at the earliest non-escaped separator.
-        seploc = min(found.keys())
-        sep = found[seploc]
-        key = string[:seploc]
-        value = string[seploc + len(sep):]
-
-        # remove escape chars
-        for sepstr in self.separators:
-            key = key.replace('\\' + sepstr, sepstr)
-            value = value.replace('\\' + sepstr, sepstr)
-        return self.key_value_class(key=key, value=value, sep=sep, orig=string)
-
-
-class AuthCredentials(KeyValue):
-    """
-    Represents parsed credentials.
-
-    """
-    def _getpass(self, prompt):
-        # To allow mocking.
-        return getpass.getpass(prompt)
-
-    def has_password(self):
-        return self.value is not None
-
-    def prompt_password(self):
-        try:
-            self.value = self._getpass("Password for user '%s': " % self.key)
-        except (EOFError, KeyboardInterrupt):
-            sys.stderr.write('\n')
-            sys.exit(0)
-
-
-class AuthCredentialsType(KeyValueType):
-
-    key_value_class = AuthCredentials
-
-    def __call__(self, string):
-        try:
-            return super(AuthCredentialsType, self).__call__(string)
-        except argparse.ArgumentTypeError:
-            # No password provided, will prompt for it later.
-            return self.key_value_class(
-                key=string,
-                value=None,
-                sep=SEP_COMMON,
-                orig=string
-            )
-
-
-def parse_items(items, data=None, headers=None, files=None):
-    """Parse `KeyValueType` `items` into `data`, `headers` and `files`."""
-    if headers is None:
-        headers = {}
-    if data is None:
-        data = {}
-    if files is None:
-        files = {}
-    for item in items:
-        value = item.value
-        key = item.key
-        if item.sep == SEP_HEADERS:
-            target = headers
-        elif item.sep == SEP_FILES:
-            try:
-                value = open(os.path.expanduser(item.value), 'r')
-            except IOError as e:
-                raise ParseError(
-                    'Invalid argument %r. %s' % (item.orig, e))
-            if not key:
-                key = os.path.basename(value.name)
-            target = files
-        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:
-                    raise ParseError('%s is not valid JSON' % item.orig)
-            target = data
-        else:
-            raise ParseError('%s is not valid item' % item.orig)
-
-        if key in target:
-            ParseError('duplicate item %s (%s)' % (item.key, item.orig))
-
-        target[key] = value
-
-    return headers, data, files

httpie/core.py

@@ -0,0 +1,144 @@
+"""This module provides the main functionality of HTTPie.
+
+Invocation flow:
+
+    1. Read, validate and process the input (args, `stdin`).
+    2. Create and send a request.
+    3. Stream, and possibly process and format, the requested parts
+       of the request-response exchange.
+    4. Simultaneously write to `stdout`
+    5. Exit.
+
+"""
+import sys
+import json
+import errno
+
+import requests
+import requests.auth
+from requests.compat import str
+
+from .cli import parser
+from .models import Environment
+from .output import output_stream, write
+from . import EXIT
+
+
+FORM = 'application/x-www-form-urlencoded; charset=utf-8'
+JSON = 'application/json; charset=utf-8'
+
+
+def get_response(args):
+    """Send the request and return a `request.Response`."""
+
+    auto_json = args.data and not args.form
+    if args.json or auto_json:
+        if 'Content-Type' not in args.headers and args.data:
+            args.headers['Content-Type'] = JSON
+
+        if 'Accept' not in args.headers:
+            # Default Accept to JSON as well.
+            args.headers['Accept'] = 'application/json'
+
+        if isinstance(args.data, dict):
+            # If not empty, serialize the data `dict` parsed from arguments.
+            # Otherwise set it to `None` avoid sending "{}".
+            args.data = json.dumps(args.data) if args.data else None
+
+    elif args.form:
+        if not args.files and 'Content-Type' not in args.headers:
+            # If sending files, `requests` will set
+            # the `Content-Type` for us.
+            args.headers['Content-Type'] = FORM
+
+    credentials = None
+    if args.auth:
+        credentials = {
+            'basic': requests.auth.HTTPBasicAuth,
+            'digest': requests.auth.HTTPDigestAuth,
+        }[args.auth_type](args.auth.key, args.auth.value)
+
+    return requests.request(
+        prefetch=False,
+        method=args.method.lower(),
+        url=args.url,
+        headers=args.headers,
+        data=args.data,
+        verify={'yes': True, 'no': False}.get(args.verify, args.verify),
+        timeout=args.timeout,
+        auth=credentials,
+        proxies=dict((p.key, p.value) for p in args.proxy),
+        files=args.files,
+        allow_redirects=args.allow_redirects,
+        params=args.params,
+    )
+
+
+def get_exist_status(code, allow_redirects=False):
+    """Translate HTTP status code to exit status."""
+    if 300 <= code <= 399 and not allow_redirects:
+        # Redirect
+        return EXIT.ERROR_HTTP_3XX
+    elif 400 <= code <= 499:
+        # Client Error
+        return EXIT.ERROR_HTTP_4XX
+    elif 500 <= code <= 599:
+        # Server Error
+        return EXIT.ERROR_HTTP_5XX
+    else:
+        return EXIT.OK
+
+
+def main(args=sys.argv[1:], env=Environment()):
+    """Run the main program and write the output to ``env.stdout``.
+
+    Return exit status.
+
+    """
+
+    def error(msg, *args):
+        msg = msg % args
+        env.stderr.write('\nhttp: error: %s\n' % msg)
+
+    debug = '--debug' in args
+    status = EXIT.OK
+
+    try:
+        args = parser.parse_args(args=args, env=env)
+        response = get_response(args)
+
+        if args.check_status:
+            status = get_exist_status(response.status_code,
+                                      args.allow_redirects)
+            if status and not env.stdout_isatty:
+                error('%s %s', response.raw.status, response.raw.reason)
+
+        stream = output_stream(args, env, response.request, response)
+
+        try:
+            write(stream=stream,
+                  outfile=env.stdout,
+                  flush=env.stdout_isatty or args.stream)
+
+        except IOError as e:
+            if not debug and e.errno == errno.EPIPE:
+                # Ignore broken pipes unless --debug.
+                env.stderr.write('\n')
+            else:
+                raise
+
+    except (KeyboardInterrupt, SystemExit):
+        if debug:
+            raise
+        env.stderr.write('\n')
+        status = EXIT.ERROR
+
+    except Exception as e:
+        # TODO: distinguish between expected and unexpected errors.
+        #       network errors vs. bugs, etc.
+        if debug:
+            raise
+        error('%s: %s', type(e).__name__, str(e))
+        status = EXIT.ERROR
+
+    return status

httpie/httpmessage.py

@@ -1,79 +0,0 @@
-from requests.compat import urlparse
-
-
-class HTTPMessage(object):
-    """Model representing an HTTP message."""
-
-    def __init__(self, line, headers, body, content_type=None):
-        # {Request,Status}-Line
-        self.line = line
-        self.headers = headers
-        self.body = body
-        self.content_type = content_type
-
-
-def from_request(request):
-    """Make an `HTTPMessage` from `requests.models.Request`."""
-    url = urlparse(request.url)
-    request_headers = dict(request.headers)
-    if 'Host' not in request_headers:
-        request_headers['Host'] = url.netloc
-
-    try:
-        body = request.data
-    except AttributeError:
-        # requests < 0.12.1
-        body = request._enc_data
-
-    if isinstance(body, dict):
-        # --form
-        body = request.__class__._encode_params(body)
-
-    return HTTPMessage(
-        line='{method} {path}{query} HTTP/1.1'.format(
-                method=request.method,
-                path=url.path or '/',
-                query='' if url.query is '' else '?' + url.query),
-        headers='\n'.join(str('%s: %s') % (name, value)
-                          for name, value
-                          in request_headers.items()),
-        body=body,
-        content_type=request_headers.get('Content-Type')
-    )
-
-
-def from_response(response):
-    """Make an `HTTPMessage` from `requests.models.Response`."""
-    encoding = response.encoding or 'ISO-8859-1'
-    original = response.raw._original_response
-    response_headers = response.headers
-    return HTTPMessage(
-        line='HTTP/{version} {status} {reason}'.format(
-                version='.'.join(str(original.version)),
-                status=original.status, reason=original.reason),
-        headers=str(original.msg),
-        body=response.content.decode(encoding) if response.content else '',
-        content_type=response_headers.get('Content-Type'))
-
-
-def format(message, prettifier=None,
-           with_headers=True, with_body=True):
-    """Return a `unicode` representation of `message`. """
-    pretty = prettifier is not None
-    bits = []
-
-    if with_headers:
-        bits.append(message.line)
-        bits.append(message.headers)
-        if pretty:
-            bits = [prettifier.headers('\n'.join(bits))]
-        if with_body and message.body:
-            bits.append('\n')
-
-    if with_body and message.body:
-        if pretty and message.content_type:
-            bits.append(prettifier.body(message.body, message.content_type))
-        else:
-            bits.append(message.body)
-
-    return '\n'.join(bit.strip() for bit in bits)

httpie/input.py

@@ -0,0 +1,457 @@
+"""Parsing and processing of CLI input (args, auth credentials, files, stdin).
+
+"""
+import os
+import sys
+import re
+import json
+import argparse
+import mimetypes
+import getpass
+from io import BytesIO
+
+try:
+    from collections import OrderedDict
+except ImportError:
+    OrderedDict = dict
+
+from requests.structures import CaseInsensitiveDict
+from requests.compat import str, urlparse
+
+from . import __version__
+
+
+HTTP_POST = 'POST'
+HTTP_GET = 'GET'
+HTTP = 'http://'
+HTTPS = 'https://'
+
+
+# Various separators used in args
+SEP_HEADERS = ':'
+SEP_CREDENTIALS = ':'
+SEP_PROXY = ':'
+SEP_DATA = '='
+SEP_DATA_RAW_JSON = ':='
+SEP_FILES = '@'
+SEP_QUERY = '=='
+
+# 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
+])
+
+
+# Output options
+OUT_REQ_HEAD = 'H'
+OUT_REQ_BODY = 'B'
+OUT_RESP_HEAD = 'h'
+OUT_RESP_BODY = 'b'
+
+OUTPUT_OPTIONS = frozenset([
+    OUT_REQ_HEAD,
+    OUT_REQ_BODY,
+    OUT_RESP_HEAD,
+    OUT_RESP_BODY
+])
+
+
+# Defaults
+OUTPUT_OPTIONS_DEFAULT = OUT_RESP_HEAD + OUT_RESP_BODY
+OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED = OUT_RESP_BODY
+PRETTIFY_STDOUT_TTY_ONLY = object()
+DEFAULT_UA = 'HTTPie/%s' % __version__
+
+
+class Parser(argparse.ArgumentParser):
+    """Adds additional logic to `argparse.ArgumentParser`.
+
+    Handles all input (CLI args, file args, stdin), applies defaults,
+    and performs extra validation.
+
+    """
+
+    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'))
+
+    #noinspection PyMethodOverriding
+    def parse_args(self, env, args=None, namespace=None):
+
+        self.env = env
+
+        if env.is_windows and not env.stdout_isatty:
+            self.error('Output redirection is not supported on Windows.'
+                  ' Please use `--output FILE\' instead.')
+
+        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)
+        self._parse_items(args)
+
+        if not env.stdin_isatty:
+            self._body_from_file(args, env.stdin)
+
+        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():
+            # Stdin already read (if not a tty) so it's save to prompt.
+            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.')
+
+        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)
+
+        super(Parser, self)._print_message(message, file)
+
+    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.')
+        args.data = getattr(fd, 'buffer', fd).read()
+
+    def _guess_method(self, args, env):
+        """Set `args.method` if not specified to either POST or GET
+        based on whether the request has data or not.
+
+        """
+        if args.method is None:
+            # Invoked as `http URL'.
+            assert not args.items
+            if not env.stdin_isatty:
+                args.method = HTTP_POST
+            else:
+                args.method = HTTP_GET
+
+        # FIXME: False positive, e.g., "localhost" matches but is a valid URL.
+        elif not re.match('^[a-zA-Z]+$', args.method):
+            # 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:
+                    raise
+                self.error(e.message)
+
+            else:
+                # 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
+
+    def _parse_items(self, args):
+        """Parse `args.items` into `args.headers`, `args.data`,
+        `args.`, and `args.files`.
+
+        """
+        args.headers = CaseInsensitiveDict()
+        args.headers['User-Agent'] = DEFAULT_UA
+        args.data = ParamDict() if args.form else OrderedDict()
+        args.files = OrderedDict()
+        args.params = ParamDict()
+
+        try:
+            parse_items(items=args.items,
+                        headers=args.headers,
+                        data=args.data,
+                        files=args.files,
+                        params=args.params)
+        except ParseError as e:
+            if args.debug:
+                raise
+            self.error(e.message)
+
+        if args.files and not args.form:
+            # `http url @/path/to/file`
+            file_fields = list(args.files.keys())
+            if file_fields != ['']:
+                self.error(
+                    'Invalid file fields (perhaps you meant --form?): %s'
+                    % ','.join(file_fields))
+
+            fn, fd = args.files['']
+            args.files = {}
+            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):
+        """Apply defaults to output options or validate the provided ones.
+
+        The default output options are stdout-type-sensitive.
+
+        """
+        if not args.output_options:
+            args.output_options = (OUTPUT_OPTIONS_DEFAULT if env.stdout_isatty
+                                else OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED)
+
+        unknown = set(args.output_options) - OUTPUT_OPTIONS
+        if unknown:
+            self.error('Unknown output options: %s' % ','.join(unknown))
+
+
+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__
+
+
+class KeyValueArgType(object):
+    """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.
+
+    """
+
+    key_value_class = KeyValue
+
+    def __init__(self, *separators):
+        self.separators = separators
+
+    def __call__(self, string):
+        """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):
+            """Represents an escaped character."""
+
+        def tokenize(s):
+            """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:
+            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):
+    """Represents parsed credentials."""
+
+    def _getpass(self, prompt):
+        # To allow mocking.
+        return getpass.getpass(prompt)
+
+    def has_password(self):
+        return self.value is not None
+
+    def prompt_password(self, host):
+        try:
+            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):
+    """A key-value arg type that parses credentials."""
+
+    key_value_class = AuthCredentials
+
+    def __call__(self, string):
+        """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,
+                sep=SEP_CREDENTIALS,
+                orig=string
+            )
+
+
+class ParamDict(OrderedDict):
+    """Multi-value dict for URL parameters and form data."""
+
+    #noinspection PyMethodOverriding
+    def __setitem__(self, key, value):
+        """ 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):
+    """Parse `KeyValue` `items` into `data`, `headers`, `files`,
+    and `params`.
+
+    """
+    if headers is None:
+        headers = CaseInsensitiveDict()
+    if data is None:
+        data = OrderedDict()
+    if files is None:
+        files = OrderedDict()
+    if params is None:
+        params = ParamDict()
+
+    for item in items:
+
+        value = item.value
+        key = item.key
+
+        if item.sep == SEP_HEADERS:
+            target = headers
+        elif item.sep == SEP_QUERY:
+            target = params
+        elif item.sep == SEP_FILES:
+            try:
+                with open(os.path.expanduser(value), 'rb') as f:
+                    value = (os.path.basename(value),
+                             BytesIO(f.read()))
+            except IOError as e:
+                raise ParseError(
+                    'Invalid argument "%s": %s' % (item.orig, e))
+            target = files
+
+        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:
+                    raise ParseError('"%s" is not valid JSON' % item.orig)
+            target = data
+
+        else:
+            raise TypeError(item)
+
+        target[key] = value
+
+    return headers, data, files, params

httpie/models.py

@@ -0,0 +1,184 @@
+import os
+import sys
+from requests.compat import urlparse, is_windows, bytes, str
+
+
+class Environment(object):
+    """Holds information about the execution context.
+
+    Groups various aspects of the environment in a changeable object
+    and allows for mocking.
+
+    """
+
+    #noinspection PyUnresolvedReferences
+    is_windows = is_windows
+
+    progname = os.path.basename(sys.argv[0])
+    if progname not in ['http', 'https']:
+        progname = 'http'
+
+    if is_windows:
+        import colorama.initialise
+        colorama.initialise.init()
+
+    stdin_isatty = sys.stdin.isatty()
+    stdin = sys.stdin
+    stdout_isatty = sys.stdout.isatty()
+    stdout = sys.stdout
+    stderr = sys.stderr
+
+    # Can be set to 0 to disable colors completely.
+    colors = 256 if '256color' in os.environ.get('TERM', '') else 88
+
+    def __init__(self, **kwargs):
+        assert all(hasattr(type(self), attr)
+                   for attr in kwargs.keys())
+        self.__dict__.update(**kwargs)
+
+
+class HTTPMessage(object):
+    """Abstract class for HTTP messages."""
+
+    def __init__(self, orig):
+        self._orig = orig
+
+    def iter_body(self, chunk_size):
+        """Return an iterator over the body."""
+        raise NotImplementedError()
+
+    def iter_lines(self, chunk_size):
+        """Return an iterator over the body yielding (`line`, `line_feed`)."""
+        raise NotImplementedError()
+
+    @property
+    def headers(self):
+        """Return a `str` with the message's headers."""
+        raise NotImplementedError()
+
+    @property
+    def encoding(self):
+        """Return a `str` with the message's encoding, if known."""
+        raise NotImplementedError()
+
+    @property
+    def body(self):
+        """Return a `bytes` with the message's body."""
+        raise NotImplementedError()
+
+    @property
+    def content_type(self):
+        """Return the message content type."""
+        ct = self._orig.headers.get('Content-Type', '')
+        if isinstance(ct, bytes):
+            ct = ct.decode()
+        return ct
+
+
+class HTTPResponse(HTTPMessage):
+    """A :class:`requests.models.Response` wrapper."""
+
+    def iter_body(self, chunk_size=1):
+        return self._orig.iter_content(chunk_size=chunk_size)
+
+    def iter_lines(self, chunk_size):
+        for line in self._orig.iter_lines(chunk_size):
+            yield line, b'\n'
+
+    @property
+    def headers(self):
+        original = self._orig.raw._original_response
+        status_line = 'HTTP/{version} {status} {reason}'.format(
+             version='.'.join(str(original.version)),
+             status=original.status,
+             reason=original.reason
+         )
+        headers = str(original.msg)
+        return '\n'.join([status_line, headers]).strip()
+
+    @property
+    def encoding(self):
+        return self._orig.encoding or 'utf8'
+
+    @property
+    def body(self):
+        # Only now the response body is fetched.
+        # Shouldn't be touched unless the body is actually needed.
+        return self._orig.content
+
+
+class HTTPRequest(HTTPMessage):
+    """A :class:`requests.models.Request` wrapper."""
+
+    def iter_body(self, chunk_size):
+        yield self.body
+
+    def iter_lines(self, chunk_size):
+        yield self.body, b''
+
+    @property
+    def headers(self):
+        """Return Request-Line"""
+        url = urlparse(self._orig.url)
+
+        # Querystring
+        qs = ''
+        if url.query or self._orig.params:
+            qs = '?'
+            if url.query:
+                qs += url.query
+            # Requests doesn't make params part of ``request.url``.
+            if self._orig.params:
+                if url.query:
+                    qs += '&'
+                #noinspection PyUnresolvedReferences
+                qs += type(self._orig)._encode_params(self._orig.params)
+
+        # Request-Line
+        request_line = '{method} {path}{query} HTTP/1.1'.format(
+            method=self._orig.method,
+            path=url.path or '/',
+            query=qs
+        )
+
+        headers = dict(self._orig.headers)
+
+        if 'Host' not in headers:
+            headers['Host'] = urlparse(self._orig.url).netloc
+
+        headers = ['%s: %s' % (name, value)
+                   for name, value in headers.items()]
+
+        headers.insert(0, request_line)
+
+        return '\n'.join(headers).strip()
+
+    @property
+    def encoding(self):
+        return 'utf8'
+
+    @property
+    def body(self):
+        """Reconstruct and return the original request body bytes."""
+        if self._orig.files:
+            # TODO: would be nice if we didn't need to encode the files again
+            # FIXME: Also the boundary header doesn't match the one used.
+            for fn, fd in self._orig.files.values():
+                # Rewind the files as they have already been read before.
+                fd.seek(0)
+            body, _ = self._orig._encode_files(self._orig.files)
+        else:
+            try:
+                body = self._orig.data
+            except AttributeError:
+                # requests < 0.12.1
+                body = self._orig._enc_data
+
+            if isinstance(body, dict):
+                #noinspection PyUnresolvedReferences
+                body = type(self._orig)._encode_params(body)
+
+            if isinstance(body, str):
+                body = body.encode('utf8')
+
+        return body

httpie/output.py

@@ -0,0 +1,476 @@
+"""Output streaming, processing and formatting.
+
+"""
+import json
+from functools import partial
+from itertools import chain
+
+import pygments
+from pygments import token, lexer
+from pygments.styles import get_style_by_name, STYLE_MAP
+from pygments.lexers import get_lexer_for_mimetype, get_lexer_by_name
+from pygments.formatters.terminal import TerminalFormatter
+from pygments.formatters.terminal256 import Terminal256Formatter
+from pygments.util import ClassNotFound
+from requests.compat import is_windows
+
+from .solarized import Solarized256Style
+from .models import HTTPRequest, HTTPResponse, Environment
+from .input import (OUT_REQ_BODY, OUT_REQ_HEAD,
+                    OUT_RESP_HEAD, OUT_RESP_BODY)
+
+
+# Colors on Windows via colorama aren't that great and fruity
+# seems to give the best result there.
+DEFAULT_STYLE = 'solarized' if not is_windows else 'fruity'
+
+#noinspection PySetFunctionToLiteral
+AVAILABLE_STYLES = set([DEFAULT_STYLE]) | set(STYLE_MAP.keys())
+
+
+BINARY_SUPPRESSED_NOTICE = (
+    b'\n'
+    b'+-----------------------------------------+\n'
+    b'| NOTE: binary data not shown in terminal |\n'
+    b'+-----------------------------------------+'
+)
+
+
+class BinarySuppressedError(Exception):
+    """An error indicating that the body is binary and won't be written,
+     e.g., for terminal output)."""
+
+    message = BINARY_SUPPRESSED_NOTICE
+
+
+###############################################################################
+# Output Streams
+###############################################################################
+
+
+def write(stream, outfile, flush):
+    """Write the output stream."""
+    try:
+        # Writing bytes so we use the buffer interface (Python 3).
+        buf = outfile.buffer
+    except AttributeError:
+        buf = outfile
+
+    for chunk in stream:
+        buf.write(chunk)
+        if flush:
+            outfile.flush()
+
+
+def output_stream(args, env, request, response):
+    """Build and return a chain of iterators over the `request`-`response`
+    exchange each of which yields `bytes` chunks.
+
+    """
+
+    Stream = make_stream(env, args)
+
+    req_h = OUT_REQ_HEAD in args.output_options
+    req_b = OUT_REQ_BODY in args.output_options
+    resp_h = OUT_RESP_HEAD in args.output_options
+    resp_b = OUT_RESP_BODY  in args.output_options
+
+    req = req_h or req_b
+    resp = resp_h or resp_b
+
+    output = []
+
+    if req:
+        output.append(Stream(
+            msg=HTTPRequest(request),
+            with_headers=req_h,
+            with_body=req_b))
+
+    if req and resp:
+        output.append([b'\n\n\n'])
+
+    if resp:
+        output.append(Stream(
+            msg=HTTPResponse(response),
+            with_headers=resp_h,
+            with_body=resp_b))
+
+    if env.stdout_isatty:
+        output.append([b'\n\n'])
+
+    return chain(*output)
+
+
+def make_stream(env, args):
+    """Pick the right stream type based on `env` and `args`.
+    Wrap it in a partial with the type-specific args so that
+    we don't need to think what stream we are dealing with.
+
+    """
+    if not env.stdout_isatty and not args.prettify:
+        Stream = partial(
+            RawStream,
+            chunk_size=RawStream.CHUNK_SIZE_BY_LINE
+                       if args.stream
+                       else RawStream.CHUNK_SIZE)
+    elif args.prettify:
+        Stream = partial(
+            PrettyStream if args.stream else BufferedPrettyStream,
+            processor=OutputProcessor(env, pygments_style=args.style),
+            env=env)
+    else:
+        Stream = partial(EncodedStream, env=env)
+
+    return Stream
+
+
+class BaseStream(object):
+    """Base HTTP message stream class."""
+
+    def __init__(self, msg, with_headers=True, with_body=True):
+        """
+        :param msg: a :class:`models.HTTPMessage` subclass
+        :param with_headers: if `True`, headers will be included
+        :param with_body: if `True`, body will be included
+
+        """
+        self.msg = msg
+        self.with_headers = with_headers
+        self.with_body = with_body
+
+    def _headers(self):
+        """Return the headers' bytes."""
+        return self.msg.headers.encode('ascii')
+
+    def _body(self):
+        """Return an iterator over the message body."""
+        raise NotImplementedError()
+
+    def __iter__(self):
+        """Return an iterator over `self.msg`."""
+        if self.with_headers:
+            yield self._headers()
+
+        if self.with_body:
+            it = self._body()
+
+            try:
+                if self.with_headers:
+                    # Yield the headers/body separator only if needed.
+                    chunk = next(it)
+                    if chunk:
+                        yield b'\n\n'
+                        yield chunk
+
+                for chunk in it:
+                    yield chunk
+
+            except BinarySuppressedError as e:
+                if self.with_headers:
+                    yield b'\n'
+                yield e.message
+
+
+class RawStream(BaseStream):
+    """The message is streamed in chunks with no processing."""
+
+    CHUNK_SIZE = 1024 * 100
+    CHUNK_SIZE_BY_LINE = 1024 * 5
+
+    def __init__(self, chunk_size=CHUNK_SIZE, **kwargs):
+        super(RawStream, self).__init__(**kwargs)
+        self.chunk_size = chunk_size
+
+    def _body(self):
+        return self.msg.iter_body(self.chunk_size)
+
+
+class EncodedStream(BaseStream):
+    """Encoded HTTP message stream.
+
+    The message bytes are converted to an encoding suitable for
+    `self.env.stdout`. Unicode errors are replaced and binary data
+    is suppressed. The body is always streamed by line.
+
+    """
+    CHUNK_SIZE = 1024 * 5
+    def __init__(self, env=Environment(), **kwargs):
+
+        super(EncodedStream, self).__init__(**kwargs)
+
+        if env.stdout_isatty:
+            # Use the encoding supported by the terminal.
+            output_encoding = getattr(env.stdout, 'encoding', None)
+        else:
+            # Preserve the message encoding.
+            output_encoding = self.msg.encoding
+
+        # Default to utf8 when unsure.
+        self.output_encoding = output_encoding or 'utf8'
+
+    def _body(self):
+
+        for line, lf in self.msg.iter_lines(self.CHUNK_SIZE):
+
+            if b'\0' in line:
+                raise BinarySuppressedError()
+
+            yield line.decode(self.msg.encoding)\
+                      .encode(self.output_encoding, 'replace') + lf
+
+
+class PrettyStream(EncodedStream):
+    """In addition to :class:`EncodedStream` behaviour, this stream applies
+    content processing.
+
+    Useful for long-lived HTTP responses that stream by lines
+    such as the Twitter streaming API.
+
+    """
+
+    CHUNK_SIZE = 1024 * 5
+
+    def __init__(self, processor, **kwargs):
+        super(PrettyStream, self).__init__(**kwargs)
+        self.processor = processor
+
+    def _headers(self):
+        return self.processor.process_headers(
+            self.msg.headers).encode(self.output_encoding)
+
+    def _body(self):
+        for line, lf in self.msg.iter_lines(self.CHUNK_SIZE):
+            if b'\0' in line:
+                raise BinarySuppressedError()
+            yield self._process_body(line) + lf
+
+    def _process_body(self, chunk):
+        return (self.processor
+                    .process_body(
+                        chunk.decode(self.msg.encoding, 'replace'),
+                        self.msg.content_type)
+                    .encode(self.output_encoding, 'replace'))
+
+
+class BufferedPrettyStream(PrettyStream):
+    """The same as :class:`PrettyStream` except that the body is fully
+    fetched before it's processed.
+
+    Suitable regular HTTP responses.
+
+    """
+
+    CHUNK_SIZE = 1024 * 10
+
+    def _body(self):
+
+        #noinspection PyArgumentList
+        # Read the whole body before prettifying it,
+        # but bail out immediately if the body is binary.
+        body = bytearray()
+        for chunk in self.msg.iter_body(self.CHUNK_SIZE):
+            if b'\0' in chunk:
+                raise BinarySuppressedError()
+            body.extend(chunk)
+
+        yield self._process_body(body)
+
+
+###############################################################################
+# Processing
+###############################################################################
+
+class HTTPLexer(lexer.RegexLexer):
+    """Simplified HTTP lexer for Pygments.
+
+    It only operates on headers and provides a stronger contrast between
+    their names and values than the original one bundled with Pygments
+    (:class:`pygments.lexers.text import HttpLexer`), especially when
+    Solarized color scheme is used.
+
+    """
+    name = 'HTTP'
+    aliases = ['http']
+    filenames = ['*.http']
+    tokens = {
+        'root': [
+            # Request-Line
+            (r'([A-Z]+)( +)([^ ]+)( +)(HTTP)(/)(\d+\.\d+)',
+             lexer.bygroups(
+                token.Name.Function,
+                token.Text,
+                token.Name.Namespace,
+                token.Text,
+                token.Keyword.Reserved,
+                token.Operator,
+                token.Number
+             )),
+            # Response Status-Line
+            (r'(HTTP)(/)(\d+\.\d+)( +)(\d{3})( +)(.+)',
+             lexer.bygroups(
+                 token.Keyword.Reserved,  # 'HTTP'
+                 token.Operator,  # '/'
+                 token.Number,  # Version
+                 token.Text,
+                 token.Number,  # Status code
+                 token.Text,
+                 token.Name.Exception,  # Reason
+             )),
+            # Header
+            (r'(.*?)( *)(:)( *)(.+)', lexer.bygroups(
+                token.Name.Attribute, # Name
+                token.Text,
+                token.Operator,  # Colon
+                token.Text,
+                token.String  # Value
+            ))
+    ]}
+
+
+class BaseProcessor(object):
+    """Base, noop output processor class."""
+
+    enabled = True
+
+    def __init__(self, env, **kwargs):
+        """
+        :param env:
+            an class:`Environment` instance
+        :param kwargs:
+            additional keyword argument that some processor might require.
+
+        """
+        self.env = env
+        self.kwargs = kwargs
+
+    def process_headers(self, headers):
+        """Return processed `headers`
+
+        :param headers:
+            The headers as text.
+
+        """
+        return headers
+
+    def process_body(self, content, content_type, subtype):
+        """Return processed `content`.
+
+        :param content:
+            The body content as text
+
+        :param content_type:
+            Full content type, e.g., 'application/atom+xml'.
+
+        :param subtype:
+            E.g. 'xml'.
+
+        """
+        return content
+
+
+class JSONProcessor(BaseProcessor):
+    """JSON body processor."""
+
+    def process_body(self, content, content_type, subtype):
+        if subtype == 'json':
+            try:
+                # Indent the JSON data, sort keys by name, and
+                # avoid unicode escapes to improve readability.
+                content = json.dumps(json.loads(content),
+                                     sort_keys=True,
+                                     ensure_ascii=False,
+                                     indent=4)
+            except ValueError:
+                # Invalid JSON but we don't care.
+                pass
+        return content
+
+
+class PygmentsProcessor(BaseProcessor):
+    """A processor that applies syntax-highlighting using Pygments
+    to the headers, and to the body as well if its content type is recognized.
+
+    """
+    def __init__(self, *args, **kwargs):
+        super(PygmentsProcessor, self).__init__(*args, **kwargs)
+
+        # Cache that speeds up when we process streamed body by line.
+        self.lexers_by_type = {}
+
+        if not self.env.colors:
+            self.enabled = False
+            return
+
+        try:
+            style = get_style_by_name(self.kwargs['pygments_style'])
+        except ClassNotFound:
+            style = Solarized256Style
+
+        if self.env.is_windows or self.env.colors == 256:
+            fmt_class = Terminal256Formatter
+        else:
+            fmt_class = TerminalFormatter
+        self.formatter = fmt_class(style=style)
+
+    def process_headers(self, headers):
+        return pygments.highlight(
+            headers, HTTPLexer(), self.formatter).strip()
+
+    def process_body(self, content, content_type, subtype):
+        try:
+            lexer = self.lexers_by_type.get(content_type)
+            if not lexer:
+                try:
+                    lexer = get_lexer_for_mimetype(content_type)
+                except ClassNotFound:
+                    lexer = get_lexer_by_name(subtype)
+                self.lexers_by_type[content_type] = lexer
+        except ClassNotFound:
+            pass
+        else:
+            content = pygments.highlight(content, lexer, self.formatter)
+        return content.strip()
+
+
+class HeadersProcessor(BaseProcessor):
+    """Sorts headers by name retaining relative order of multiple headers
+    with the same name.
+
+    """
+    def process_headers(self, headers):
+        lines = headers.splitlines()
+        headers = sorted(lines[1:], key=lambda h: h.split(':')[0])
+        return '\n'.join(lines[:1] + headers)
+
+
+class OutputProcessor(object):
+    """A delegate class that invokes the actual processors."""
+
+    installed_processors = [
+        JSONProcessor,
+        HeadersProcessor,
+        PygmentsProcessor
+    ]
+
+    def __init__(self, env, **kwargs):
+        processors = [
+            cls(env, **kwargs)
+            for cls in self.installed_processors
+        ]
+        self.processors = [p for p in processors if p.enabled]
+
+    def process_headers(self, headers):
+        for processor in self.processors:
+            headers = processor.process_headers(headers)
+        return headers
+
+    def process_body(self, content, content_type):
+        # e.g., 'application/atom+xml'
+        content_type = content_type.split(';')[0]
+        # e.g., 'xml'
+        subtype = content_type.split('/')[-1].split('+')[-1]
+
+        for processor in self.processors:
+            content = processor.process_body(content, content_type, subtype)
+
+        return content

httpie/pretty.py

@@ -1,59 +0,0 @@
-import os
-import re
-import json
-
-import pygments
-
-from pygments.util import ClassNotFound
-from pygments.styles import get_style_by_name, STYLE_MAP
-from pygments.lexers import get_lexer_for_mimetype, HttpLexer
-from pygments.formatters.terminal256 import Terminal256Formatter
-from pygments.formatters.terminal import TerminalFormatter
-
-from . import solarized
-
-
-DEFAULT_STYLE = 'solarized'
-AVAILABLE_STYLES = [DEFAULT_STYLE] + list(STYLE_MAP.keys())
-FORMATTER = (Terminal256Formatter
-             if '256color' in os.environ.get('TERM', '')
-             else TerminalFormatter)
-
-application_content_type_re = re.compile(r'application/(.+\+)?(json|xml)$')
-
-
-class PrettyHttp(object):
-
-    def __init__(self, style_name):
-        if style_name == 'solarized':
-            style = solarized.SolarizedStyle
-        else:
-            style = get_style_by_name(style_name)
-        self.formatter = FORMATTER(style=style)
-
-    def headers(self, content):
-        return pygments.highlight(content, HttpLexer(), self.formatter)
-
-    def body(self, content, content_type):
-        content_type = content_type.split(';')[0]
-        application_match = re.match(application_content_type_re, content_type)
-        if application_match:
-            # Strip vendor and extensions from Content-Type
-            vendor, extension = application_match.groups()
-            content_type = content_type.replace(vendor, u"")
-
-        try:
-            lexer = get_lexer_for_mimetype(content_type)
-        except ClassNotFound:
-            return content
-
-        if content_type == "application/json":
-            try:
-                # Indent and sort the JSON data.
-                content = json.dumps(json.loads(content),
-                                     sort_keys=True, indent=4,
-                                     ensure_ascii=False)
-            except:
-                pass
-
-        return pygments.highlight(content, lexer, self.formatter)

httpie/solarized.py

@@ -1,74 +1,57 @@
-"""
-A Pygments_ style based on the dark background variant of Solarized_.
-
-.. _Pygments: http://pygments.org/
-.. _Solarized: http://ethanschoonover.com/solarized
-
-Copyright (c) 2011 Hank Gay
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
+# -*- coding: utf-8 -*-
 
 """
+    solarized256
+    ------------
+
+    A Pygments style inspired by Solarized's 256 color mode.
+
+    :copyright: (c) 2011 by Hank Gay, (c) 2012 by John Mastro.
+    :license: BSD, see LICENSE for more details.
+"""
+
 from pygments.style import Style
-from pygments.token import (Token, Comment, Name, Keyword, Generic, Number,
-                            Operator, String)
+from pygments.token import Token, Comment, Name, Keyword, Generic, Number, \
+    Operator, String
+
+BASE03  = "#1c1c1c"
+BASE02  = "#262626"
+BASE01  = "#4e4e4e"
+BASE00  = "#585858"
+BASE0   = "#808080"
+BASE1   = "#8a8a8a"
+BASE2   = "#d7d7af"
+BASE3   = "#ffffd7"
+YELLOW  = "#af8700"
+ORANGE  = "#d75f00"
+RED     = "#af0000"
+MAGENTA = "#af005f"
+VIOLET  = "#5f5faf"
+BLUE    = "#0087ff"
+CYAN    = "#00afaf"
+GREEN   = "#5f8700"
 
 
-BASE03 = '#002B36'
-BASE02 = '#073642'
-BASE01 = '#586E75'
-BASE00 = '#657B83'
-BASE0 = '#839496'
-BASE1 = '#93A1A1'
-BASE2 = '#EEE8D5'
-BASE3 = '#FDF6E3'
-YELLOW = '#B58900'
-ORANGE = '#CB4B16'
-RED = '#DC322F'
-MAGENTA = '#D33682'
-VIOLET = '#6C71C4'
-BLUE = '#268BD2'
-CYAN = '#2AA198'
-GREEN = '#859900'
-
-
-class SolarizedStyle(Style):
+class Solarized256Style(Style):
     background_color = BASE03
     styles = {
         Keyword: GREEN,
         Keyword.Constant: ORANGE,
         Keyword.Declaration: BLUE,
-        #Keyword.Namespace
+        Keyword.Namespace: ORANGE,
         #Keyword.Pseudo
         Keyword.Reserved: BLUE,
         Keyword.Type: RED,
 
         #Name
         Name.Attribute: BASE1,
-        Name.Builtin: YELLOW,
+        Name.Builtin: BLUE,
         Name.Builtin.Pseudo: BLUE,
         Name.Class: BLUE,
         Name.Constant: ORANGE,
         Name.Decorator: BLUE,
         Name.Entity: ORANGE,
-        Name.Exception: ORANGE,
+        Name.Exception: YELLOW,
         Name.Function: BLUE,
         #Name.Label
         #Name.Namespace
@@ -84,10 +67,10 @@ class SolarizedStyle(Style):
         String: CYAN,
         String.Backtick: BASE01,
         String.Char: CYAN,
-        String.Doc: BASE1,
+        String.Doc: CYAN,
         #String.Double
-        String.Escape: ORANGE,
-        String.Heredoc: BASE1,
+        String.Escape: RED,
+        String.Heredoc: CYAN,
         #String.Interpol
         #String.Other
         String.Regex: RED,
@@ -100,8 +83,8 @@ class SolarizedStyle(Style):
         #Number.Integer.Long
         #Number.Oct
 
-        Operator: GREEN,
-        #Operator.Word
+        Operator: BASE1,
+        Operator.Word: GREEN,
 
         #Punctuation: ORANGE,
 

setup.py

@@ -5,7 +5,8 @@ import httpie
 
 
 if sys.argv[-1] == 'test':
-    sys.exit(os.system('python tests/tests.py'))
+    status = os.system('python tests/tests.py')
+    sys.exit(1 if status > 127 else status)
 
 
 requirements = [
@@ -16,6 +17,9 @@ requirements = [
 if sys.version_info[:2] in ((2, 6), (3, 1)):
     # argparse has been added in Python 3.2 / 2.7
     requirements.append('argparse>=1.2.1')
+if 'win32' in str(sys.platform).lower():
+    # Terminal colors for Windows
+    requirements.append('colorama>=0.2.4')
 
 
 setup(
@@ -51,5 +55,6 @@ setup(
         'Topic :: System :: Networking',
         'Topic :: Terminals',
         'Topic :: Text Processing',
+        'Topic :: Utilities'
     ],
 )

tox.ini

@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py26, py27, py30, py31, py32, pypy
+envlist = py26, py27, py32, pypy
 
 [testenv]
 commands = {envpython} setup.py test