mirror of
https://github.com/httpie/cli.git
synced 2025-08-11 08:05:56 +02:00
Compare commits
45 Commits
Author | SHA1 | Date | |
---|---|---|---|
1ce02ebbd5 | |||
8a7f4c0d6e | |||
f29c458611 | |||
2d7df0afb4 | |||
16a7d0a719 | |||
0cffda86f6 | |||
f42ee6da85 | |||
deeb7cbbac | |||
12f2fb4a92 | |||
489bd64295 | |||
9b8cb42efd | |||
2036337a53 | |||
5ca8bec9ff | |||
df79792fd9 | |||
5a82c79fdf | |||
05b321d38f | |||
681b652bf9 | |||
85b3a016eb | |||
929ead437a | |||
36de166b28 | |||
7bc2de2f9d | |||
cb7ead04e2 | |||
cd2ca41f48 | |||
c71de95505 | |||
6ab03b21b4 | |||
50196be0f2 | |||
41d640920c | |||
3179631603 | |||
2f7921091c | |||
180313d80c | |||
926d3f5caf | |||
4613d947a8 | |||
5a47f00bac | |||
0e1affbbc4 | |||
d920f20847 | |||
bca36f0464 | |||
78fff98712 | |||
e06c448a75 | |||
9cdbd6b0ec | |||
cbc6d02127 | |||
284a75fa2f | |||
b3ea273a21 | |||
0d129d5f69 | |||
1388206f1a | |||
28dbe9f76c |
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,3 +2,4 @@ dist
|
|||||||
httpie.egg-info
|
httpie.egg-info
|
||||||
build
|
build
|
||||||
*.pyc
|
*.pyc
|
||||||
|
.tox
|
||||||
|
@ -2,10 +2,9 @@ language: python
|
|||||||
python:
|
python:
|
||||||
- 2.6
|
- 2.6
|
||||||
- 2.7
|
- 2.7
|
||||||
|
- pypy
|
||||||
- 3.1
|
- 3.1
|
||||||
- 3.2
|
- 3.2
|
||||||
script: python tests/tests.py
|
script: python setup.py test
|
||||||
install:
|
install:
|
||||||
- pip install requests pygments
|
- pip install . --use-mirrors
|
||||||
- "if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]] || [[ $TRAVIS_PYTHON_VERSION == '3.1' ]]; then pip install argparse; fi"
|
|
||||||
|
|
||||||
|
112
README.rst
112
README.rst
@ -29,16 +29,19 @@ Or, you can install the **development version** directly from GitHub:
|
|||||||
pip install -U https://github.com/jkbr/httpie/tarball/master
|
pip install -U https://github.com/jkbr/httpie/tarball/master
|
||||||
|
|
||||||
|
|
||||||
|
There are packages available for `Ubuntu <http://packages.ubuntu.com/quantal/httpie>`_ and `Debian <http://packages.debian.org/wheezy/httpie>`_.
|
||||||
|
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Hello world::
|
Hello world::
|
||||||
|
|
||||||
http GET httpie.org
|
http httpie.org
|
||||||
|
|
||||||
Synopsis::
|
Synopsis::
|
||||||
|
|
||||||
http [flags] METHOD URL [items]
|
http [flags] [METHOD] URL [items]
|
||||||
|
|
||||||
There are four types of key-value pair items available:
|
There are four types of key-value pair items available:
|
||||||
|
|
||||||
@ -72,7 +75,7 @@ The following request is issued::
|
|||||||
{"name": "John", "email": "john@example.org", "age": 29}
|
{"name": "John", "email": "john@example.org", "age": 29}
|
||||||
|
|
||||||
|
|
||||||
It can easily be changed to a 'form' request using the ``-f`` (or ``--form``) flag, which produces::
|
It can easily be changed to a **form** request using the ``-f`` (or ``--form``) flag, which produces::
|
||||||
|
|
||||||
PATCH /person/1 HTTP/1.1
|
PATCH /person/1 HTTP/1.1
|
||||||
User-Agent: HTTPie/0.1
|
User-Agent: HTTPie/0.1
|
||||||
@ -81,7 +84,7 @@ It can easily be changed to a 'form' request using the ``-f`` (or ``--form``) fl
|
|||||||
|
|
||||||
age=29&name=John&email=john%40example.org
|
age=29&name=John&email=john%40example.org
|
||||||
|
|
||||||
It is also possible to send ``multipart/form-data`` requests, i.e., to simulate a file upload form submission. It is done using the ``--form`` / ``-f`` flag and passing one or more file fields::
|
It is also possible to send ``multipart/form-data`` requests, i.e., to simulate a **file upload form** submission. It is done using the ``--form`` / ``-f`` flag and passing one or more file fields::
|
||||||
|
|
||||||
http -f POST example.com/jobs name=John cv@~/Documents/cv.pdf
|
http -f POST example.com/jobs name=John cv@~/Documents/cv.pdf
|
||||||
|
|
||||||
@ -92,50 +95,68 @@ The above will send the same request as if the following HTML form were submitte
|
|||||||
<input type="file" name="cv" />
|
<input type="file" name="cv" />
|
||||||
</form>
|
</form>
|
||||||
|
|
||||||
A whole request body can be passed in via ``stdin`` instead::
|
A whole request body can be passed in via **``stdin``** instead, in which case it will be used with no further processing::
|
||||||
|
|
||||||
echo '{"name": "John"}' | http PATCH example.com/person/1 X-API-Token:123
|
echo '{"name": "John"}' | http PATCH example.com/person/1 X-API-Token:123
|
||||||
# Or:
|
# Or:
|
||||||
http POST example.com/person/1 X-API-Token:123 < person.json
|
http POST example.com/person/1 X-API-Token:123 < person.json
|
||||||
|
|
||||||
|
That can be used for **piping services together**. The following example ``GET``s JSON data from the Github API and ``POST``s it to httpbin.org::
|
||||||
|
|
||||||
|
http -b GET https://api.github.com/repos/jkbr/httpie | http POST httpbin.org/post
|
||||||
|
|
||||||
|
The above can be further simplified by omitting ``GET`` and ``POST`` because they are both default here. The first command has no request data, whereas the second one does via ``stdin``::
|
||||||
|
|
||||||
|
http -b https://api.github.com/repos/jkbr/httpie | http httpbin.org/post
|
||||||
|
|
||||||
|
An alternative to ``stdin`` is to pass a file name whose content will be used as the request body. It has the advantage that the ``Content-Type`` header will automatically be set to the appropriate value based on the filename extension (using the ``mimetypes`` module). Therefore, the following will request will send the verbatim contents of the file with ``Content-Type: application/xml``::
|
||||||
|
|
||||||
|
http PUT httpbin.org/put @/data/file.xml
|
||||||
|
|
||||||
|
|
||||||
Flags
|
Flags
|
||||||
^^^^^
|
^^^^^
|
||||||
Most of the flags mirror the arguments understood by ``requests.request``. See ``http -h`` for more details::
|
Most of the flags mirror the arguments understood by ``requests.request``. See ``http -h`` for more details::
|
||||||
|
|
||||||
|
$ http --help
|
||||||
usage: http [-h] [--version] [--json | --form] [--traceback]
|
usage: http [-h] [--version] [--json | --form] [--traceback]
|
||||||
[--pretty | --ugly]
|
[--pretty | --ugly]
|
||||||
[--print OUTPUT_OPTIONS | --verbose | --headers | --body]
|
[--print OUTPUT_OPTIONS | --verbose | --headers | --body]
|
||||||
[--style STYLE] [--auth AUTH] [--auth-type {basic,digest}]
|
[--style STYLE] [--auth AUTH] [--auth-type {basic,digest}]
|
||||||
[--verify VERIFY] [--proxy PROXY] [--allow-redirects]
|
[--verify VERIFY] [--proxy PROXY] [--allow-redirects]
|
||||||
[--timeout TIMEOUT]
|
[--timeout TIMEOUT]
|
||||||
METHOD URL [ITEM [ITEM ...]]
|
[METHOD] URL [ITEM [ITEM ...]]
|
||||||
|
|
||||||
HTTPie - cURL for humans. <http://httpie.org>
|
HTTPie - cURL for humans. <http://httpie.org>
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
METHOD The HTTP method to be used for the request (GET, POST,
|
METHOD The HTTP method to be used for the request (GET, POST,
|
||||||
PUT, DELETE, PATCH, ...).
|
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.
|
||||||
URL The protocol defaults to http:// if the URL does not
|
URL The protocol defaults to http:// if the URL does not
|
||||||
include one.
|
include one.
|
||||||
ITEM A key-value pair whose type is defined by the
|
ITEM A key-value pair whose type is defined by the
|
||||||
separator used. It can be an HTTP header
|
separator used. It can be an HTTP header
|
||||||
(header:value), a data field to be used in the request
|
(header:value), a data field to be used in the request
|
||||||
body (field_name=value), a raw JSON data field
|
body (field_name=value), a raw JSON data field
|
||||||
(field_name:=value) or a file field
|
(field_name:=value), or a file field
|
||||||
(field_name@/path/to/file). You can use a backslash to
|
(field_name@/path/to/file). You can use a backslash to
|
||||||
escape a colliding separator in the field name.
|
escape a colliding separator in the field name.
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
--version show program's version number and exit
|
--version show program's version number and exit
|
||||||
--json, -j (default) Data items are serialized as a JSON object.
|
--json, -j (default) Data items from the command line are
|
||||||
The Content-Type and Accept headers are set to
|
serialized as a JSON object. The Content-Type and
|
||||||
application/json (if not set via the command line).
|
Accept headers are set to application/json (if not
|
||||||
--form, -f Data items are serialized as form fields. The Content-
|
specified).
|
||||||
Type is set to application/x-www-form-urlencoded (if
|
--form, -f Data items from the command line are serialized as
|
||||||
not specifid). The presence of any file fields results
|
form fields. The Content-Type is set to application/x
|
||||||
into a multipart/form-data request.
|
-www-form-urlencoded (if not specified). The presence
|
||||||
|
of any file fields results into a multipart/form-data
|
||||||
|
request.
|
||||||
--traceback Print exception traceback should one occur.
|
--traceback Print exception traceback should one occur.
|
||||||
--pretty If stdout is a terminal, the response is prettified by
|
--pretty If stdout is a terminal, the response is prettified by
|
||||||
default (colorized and indented if it is JSON). This
|
default (colorized and indented if it is JSON). This
|
||||||
@ -156,13 +177,14 @@ Most of the flags mirror the arguments understood by ``requests.request``. See `
|
|||||||
--style STYLE, -s STYLE
|
--style STYLE, -s STYLE
|
||||||
Output coloring style, one of autumn, borland, bw,
|
Output coloring style, one of autumn, borland, bw,
|
||||||
colorful, default, emacs, friendly, fruity, manni,
|
colorful, default, emacs, friendly, fruity, manni,
|
||||||
monokai, murphy, native, pastie, perldoc, solarized,
|
monokai, murphy, native, pastie, perldoc, rrt,
|
||||||
tango, trac, vim, vs. Defaults to solarized. For this
|
solarized, tango, trac, vim, vs. Defaults to
|
||||||
option to work properly, please make sure that the
|
solarized. For this option to work properly, please
|
||||||
$TERM environment variable is set to "xterm-256color"
|
make sure that the $TERM environment variable is set
|
||||||
or similar (e.g., via `export TERM=xterm-256color' in
|
to "xterm-256color" or similar (e.g., via `export TERM
|
||||||
your ~/.bashrc).
|
=xterm-256color' in your ~/.bashrc).
|
||||||
--auth AUTH, -a AUTH username:password
|
--auth AUTH, -a AUTH username:password. If the password is omitted (-a
|
||||||
|
username), HTTPie will prompt for it.
|
||||||
--auth-type {basic,digest}
|
--auth-type {basic,digest}
|
||||||
The authentication mechanism to be used. Defaults to
|
The authentication mechanism to be used. Defaults to
|
||||||
"basic".
|
"basic".
|
||||||
@ -179,21 +201,44 @@ Most of the flags mirror the arguments understood by ``requests.request``. See `
|
|||||||
socket.setdefaulttimeout() as fallback).
|
socket.setdefaulttimeout() as fallback).
|
||||||
|
|
||||||
|
|
||||||
Contributors
|
Contribute
|
||||||
------------
|
-----------
|
||||||
|
|
||||||
`View contributors on GitHub <https://github.com/jkbr/httpie/contributors>`_.
|
`View contributors on GitHub <https://github.com/jkbr/httpie/contributors>`_.
|
||||||
|
|
||||||
|
If you have found a bug or have a feature request, the `issue tracker <https://github.com/jkbr/httpie/issues?state=open>`_ is the place to start a discussion about it.
|
||||||
|
|
||||||
|
To contribute code or documentation, please first browse the existing issues to see if the feature/bug has previously been discussed. Then fork `the repository <https://github.com/jkbr/httpie>`_, make changes in your develop branch and submit a pull request. Note: Pull requests with tests and documentation are 53.6% more awesome :)
|
||||||
|
|
||||||
|
Before a pull requests is submitted, it's a good idea to run the existing suite of tests::
|
||||||
|
|
||||||
|
python setup.py test
|
||||||
|
|
||||||
|
`Tox <http://tox.testrun.org/>`_ can used to conveniently run tests in all of the `supported Python environments <https://github.com/jkbr/httpie/blob/master/tox.ini>`_::
|
||||||
|
|
||||||
|
# Install tox
|
||||||
|
pip install tox
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
tox
|
||||||
|
|
||||||
Changelog
|
Changelog
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* `New in development version <https://github.com/jkbr/httpie/compare/0.2.1...master>`_
|
* `0.2.5 <https://github.com/jkbr/httpie/compare/0.2.2...0.2.5>`_ (2012-07-17)
|
||||||
* 0.2.1 (2012-06-13)
|
* Unicode characters in prettified JSON now don't get escaped to improve readability.
|
||||||
|
* --auth now prompts for a password if only a username provided.
|
||||||
|
* Added support for request payloads from a file path with automatic ``Content-Type`` (``http URL @/path``).
|
||||||
|
* Fixed missing query string when displaing the request headers via ``--verbose``.
|
||||||
|
* Fixed Content-Type for requests with no data.
|
||||||
|
* `0.2.2 <https://github.com/jkbr/httpie/compare/0.2.1...0.2.2>`_ (2012-06-24)
|
||||||
|
* The ``METHOD`` positional argument can now be omitted (defaults to ``GET``, or to ``POST`` with data).
|
||||||
|
* Fixed --verbose --form.
|
||||||
|
* Added support for `Tox <http://tox.testrun.org/>`_.
|
||||||
|
* `0.2.1 <https://github.com/jkbr/httpie/compare/0.2.0...0.2.1>`_ (2012-06-13)
|
||||||
* Added compatibility with ``requests-0.12.1``.
|
* Added compatibility with ``requests-0.12.1``.
|
||||||
* Dropped custom JSON and HTTP lexers in favor of the ones newly included in ``pygments-1.5``.
|
* Dropped custom JSON and HTTP lexers in favor of the ones newly included in ``pygments-1.5``.
|
||||||
* `Complete changelog <https://github.com/jkbr/httpie/compare/0.2.0...0.2.1>`_
|
* `0.2.0 <https://github.com/jkbr/httpie/compare/0.1.6...0.2.0>`_ (2012-04-25)
|
||||||
* 0.2.0 (2012-04-25)
|
|
||||||
* Added Python 3 support.
|
* Added Python 3 support.
|
||||||
* Added the ability to print the HTTP request as well as the response (see ``--print`` and ``--verbose``).
|
* Added the ability to print the HTTP request as well as the response (see ``--print`` and ``--verbose``).
|
||||||
* Added support for Digest authentication.
|
* Added support for Digest authentication.
|
||||||
@ -201,5 +246,4 @@ Changelog
|
|||||||
* Improved syntax highlighting for JSON.
|
* Improved syntax highlighting for JSON.
|
||||||
* Added support for field name escaping.
|
* Added support for field name escaping.
|
||||||
* Many bug fixes.
|
* Many bug fixes.
|
||||||
* `Complete changelog <https://github.com/jkbr/httpie/compare/0.1.6...0.2.0>`_
|
|
||||||
* `0.1.6 <https://github.com/jkbr/httpie/compare/0.1.4...0.1.6>`_ (2012-03-04)
|
* `0.1.6 <https://github.com/jkbr/httpie/compare/0.1.4...0.1.6>`_ (2012-03-04)
|
||||||
|
@ -3,5 +3,5 @@ HTTPie - cURL for humans.
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
__author__ = 'Jakub Roztocil'
|
__author__ = 'Jakub Roztocil'
|
||||||
__version__ = '0.2.1'
|
__version__ = '0.2.5'
|
||||||
__licence__ = 'BSD'
|
__licence__ = 'BSD'
|
||||||
|
@ -16,29 +16,29 @@ TYPE_FORM = 'application/x-www-form-urlencoded; charset=utf-8'
|
|||||||
TYPE_JSON = 'application/json; charset=utf-8'
|
TYPE_JSON = 'application/json; charset=utf-8'
|
||||||
|
|
||||||
|
|
||||||
def _get_response(parser, args, stdin, stdin_isatty):
|
def _get_response(args):
|
||||||
|
|
||||||
if not stdin_isatty:
|
auto_json = args.data and not args.form
|
||||||
if args.data:
|
if args.json or auto_json:
|
||||||
parser.error('Request body (stdin) and request '
|
|
||||||
'data (key=value) cannot be mixed.')
|
|
||||||
args.data = stdin.read()
|
|
||||||
|
|
||||||
if args.json or (not args.form and args.data):
|
|
||||||
# JSON
|
# JSON
|
||||||
if not args.files and (
|
if 'Content-Type' not in args.headers:
|
||||||
'Content-Type' not in args.headers
|
args.headers['Content-Type'] = TYPE_JSON
|
||||||
and (args.data or args.json)):
|
|
||||||
args.headers['Content-Type'] = TYPE_JSON
|
|
||||||
if stdin_isatty:
|
|
||||||
# Serialize the parsed data.
|
|
||||||
args.data = json.dumps(args.data)
|
|
||||||
if 'Accept' not in args.headers:
|
if 'Accept' not in args.headers:
|
||||||
# Default Accept to JSON as well.
|
# Default Accept to JSON as well.
|
||||||
args.headers['Accept'] = 'application/json'
|
args.headers['Accept'] = 'application/json'
|
||||||
elif not args.files and 'Content-Type' not in args.headers:
|
|
||||||
|
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
|
# Form
|
||||||
args.headers['Content-Type'] = TYPE_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.
|
# Fire the request.
|
||||||
try:
|
try:
|
||||||
@ -114,8 +114,12 @@ def main(args=None,
|
|||||||
stdin=sys.stdin, stdin_isatty=sys.stdin.isatty(),
|
stdin=sys.stdin, stdin_isatty=sys.stdin.isatty(),
|
||||||
stdout=sys.stdout, stdout_isatty=sys.stdout.isatty()):
|
stdout=sys.stdout, stdout_isatty=sys.stdout.isatty()):
|
||||||
parser = cli.parser
|
parser = cli.parser
|
||||||
args = parser.parse_args(args if args is not None else sys.argv[1:])
|
args = parser.parse_args(
|
||||||
response = _get_response(parser, args, stdin, stdin_isatty)
|
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 = _get_output(args, stdout_isatty, response)
|
||||||
output_bytes = output.encode('utf8')
|
output_bytes = output.encode('utf8')
|
||||||
f = (stdout.buffer if hasattr(stdout, 'buffer') else stdout)
|
f = (stdout.buffer if hasattr(stdout, 'buffer') else stdout)
|
||||||
|
@ -14,7 +14,7 @@ def _(text):
|
|||||||
|
|
||||||
|
|
||||||
desc = '%s <http://httpie.org>'
|
desc = '%s <http://httpie.org>'
|
||||||
parser = cliparse.HTTPieArgumentParser(description=desc % __doc__.strip(),)
|
parser = cliparse.Parser(description=desc % __doc__.strip(),)
|
||||||
parser.add_argument('--version', action='version', version=__version__)
|
parser.add_argument('--version', action='version', version=__version__)
|
||||||
|
|
||||||
|
|
||||||
@ -25,16 +25,16 @@ group_type = parser.add_mutually_exclusive_group(required=False)
|
|||||||
group_type.add_argument(
|
group_type.add_argument(
|
||||||
'--json', '-j', action='store_true',
|
'--json', '-j', action='store_true',
|
||||||
help=_('''
|
help=_('''
|
||||||
(default) Data items 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
|
The Content-Type and Accept headers
|
||||||
are set to application/json (if not set via the command line).
|
are set to application/json (if not specified).
|
||||||
''')
|
''')
|
||||||
)
|
)
|
||||||
group_type.add_argument(
|
group_type.add_argument(
|
||||||
'--form', '-f', action='store_true',
|
'--form', '-f', action='store_true',
|
||||||
help=_('''
|
help=_('''
|
||||||
Data items are serialized as form fields.
|
Data items from the command line are serialized as form fields.
|
||||||
The Content-Type is set to application/x-www-form-urlencoded (if not specifid).
|
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 presence of any file fields results into a multipart/form-data request.
|
||||||
''')
|
''')
|
||||||
)
|
)
|
||||||
@ -123,8 +123,11 @@ parser.add_argument(
|
|||||||
|
|
||||||
# ``requests.request`` keyword arguments.
|
# ``requests.request`` keyword arguments.
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'--auth', '-a', help='username:password',
|
'--auth', '-a', type=cliparse.AuthCredentialsType(cliparse.SEP_COMMON),
|
||||||
type=cliparse.KeyValueType(cliparse.SEP_COMMON)
|
help=_('''
|
||||||
|
username:password.
|
||||||
|
If only the username is provided (-a username), HTTPie will prompt for the password.
|
||||||
|
'''),
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
@ -171,9 +174,13 @@ parser.add_argument(
|
|||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
'method', metavar='METHOD',
|
'method', metavar='METHOD',
|
||||||
|
nargs='?',
|
||||||
|
default=None,
|
||||||
help=_('''
|
help=_('''
|
||||||
The HTTP method to be used for the request
|
The HTTP method to be used for the request
|
||||||
(GET, POST, PUT, DELETE, PATCH, ...).
|
(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.
|
||||||
''')
|
''')
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
@ -196,7 +203,7 @@ parser.add_argument(
|
|||||||
A key-value pair whose type is defined by the separator used. It can be an
|
A key-value pair whose type is defined by the separator used. It can be an
|
||||||
HTTP header (header:value),
|
HTTP header (header:value),
|
||||||
a data field to be used in the request body (field_name=value),
|
a data field to be used in the request body (field_name=value),
|
||||||
a raw JSON data field (field_name:=value)
|
a raw JSON data field (field_name:=value),
|
||||||
or a file field (field_name@/path/to/file).
|
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.
|
||||||
''')
|
''')
|
||||||
|
@ -3,11 +3,12 @@ CLI argument parsing logic.
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
import os
|
import os
|
||||||
|
import sys
|
||||||
import re
|
import re
|
||||||
import json
|
import json
|
||||||
import argparse
|
import argparse
|
||||||
|
import mimetypes
|
||||||
from collections import namedtuple
|
import getpass
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from collections import OrderedDict
|
from collections import OrderedDict
|
||||||
@ -24,6 +25,11 @@ SEP_HEADERS = SEP_COMMON
|
|||||||
SEP_DATA = '='
|
SEP_DATA = '='
|
||||||
SEP_DATA_RAW_JSON = ':='
|
SEP_DATA_RAW_JSON = ':='
|
||||||
SEP_FILES = '@'
|
SEP_FILES = '@'
|
||||||
|
DATA_ITEM_SEPARATORS = [
|
||||||
|
SEP_DATA,
|
||||||
|
SEP_DATA_RAW_JSON,
|
||||||
|
SEP_FILES
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
OUT_REQ_HEADERS = 'H'
|
OUT_REQ_HEADERS = 'H'
|
||||||
@ -41,16 +47,80 @@ PRETTIFY_STDOUT_TTY_ONLY = object()
|
|||||||
DEFAULT_UA = 'HTTPie/%s' % __version__
|
DEFAULT_UA = 'HTTPie/%s' % __version__
|
||||||
|
|
||||||
|
|
||||||
class HTTPieArgumentParser(argparse.ArgumentParser):
|
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)
|
||||||
|
|
||||||
def parse_args(self, args=None, namespace=None):
|
|
||||||
args = super(HTTPieArgumentParser, self).parse_args(args, namespace)
|
|
||||||
self._validate_output_options(args)
|
self._validate_output_options(args)
|
||||||
self._validate_auth_options(args)
|
self._validate_auth_options(args)
|
||||||
|
self._guess_method(args, stdin_isatty)
|
||||||
self._parse_items(args)
|
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
|
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):
|
def _parse_items(self, args):
|
||||||
|
"""
|
||||||
|
Parse `args.items` into `args.headers`, `args.data` and `args.files`.
|
||||||
|
|
||||||
|
"""
|
||||||
args.headers = CaseInsensitiveDict()
|
args.headers = CaseInsensitiveDict()
|
||||||
args.headers['User-Agent'] = DEFAULT_UA
|
args.headers['User-Agent'] = DEFAULT_UA
|
||||||
args.data = OrderedDict()
|
args.data = OrderedDict()
|
||||||
@ -64,12 +134,25 @@ class HTTPieArgumentParser(argparse.ArgumentParser):
|
|||||||
self.error(e.message)
|
self.error(e.message)
|
||||||
|
|
||||||
if args.files and not args.form:
|
if args.files and not args.form:
|
||||||
# We could just switch to --form automatically here,
|
# `http url @/path/to/file`
|
||||||
# but I think it's better to make it explicit.
|
# It's not --form so the file contents will be used as the
|
||||||
self.error(
|
# body of the requests. Also, we try to detect the appropriate
|
||||||
' You need to set the --form / -f flag to'
|
# Content-Type.
|
||||||
' to issue a multipart request. File fields: %s'
|
if len(args.files) > 1:
|
||||||
% ','.join(args.files.keys()))
|
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):
|
def _validate_output_options(self, args):
|
||||||
unknown_output_options = set(args.output_options) - set(OUTPUT_OPTIONS)
|
unknown_output_options = set(args.output_options) - set(OUTPUT_OPTIONS)
|
||||||
@ -85,12 +168,24 @@ class ParseError(Exception):
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
KeyValue = namedtuple('KeyValue', ['key', 'value', 'sep', 'orig'])
|
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):
|
class KeyValueType(object):
|
||||||
"""A type used with `argparse`."""
|
"""A type used with `argparse`."""
|
||||||
|
|
||||||
|
key_value_class = KeyValue
|
||||||
|
|
||||||
def __init__(self, *separators):
|
def __init__(self, *separators):
|
||||||
self.separators = separators
|
self.separators = separators
|
||||||
self.escapes = ['\\\\' + sep for sep in separators]
|
self.escapes = ['\\\\' + sep for sep in separators]
|
||||||
@ -126,7 +221,44 @@ class KeyValueType(object):
|
|||||||
for sepstr in self.separators:
|
for sepstr in self.separators:
|
||||||
key = key.replace('\\' + sepstr, sepstr)
|
key = key.replace('\\' + sepstr, sepstr)
|
||||||
value = value.replace('\\' + sepstr, sepstr)
|
value = value.replace('\\' + sepstr, sepstr)
|
||||||
return KeyValue(key=key, value=value, sep=sep, orig=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):
|
||||||
|
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):
|
def parse_items(items, data=None, headers=None, files=None):
|
||||||
|
@ -25,10 +25,15 @@ def from_request(request):
|
|||||||
# requests < 0.12.1
|
# requests < 0.12.1
|
||||||
body = request._enc_data
|
body = request._enc_data
|
||||||
|
|
||||||
|
if isinstance(body, dict):
|
||||||
|
# --form
|
||||||
|
body = request.__class__._encode_params(body)
|
||||||
|
|
||||||
return HTTPMessage(
|
return HTTPMessage(
|
||||||
line='{method} {path} HTTP/1.1'.format(
|
line='{method} {path}{query} HTTP/1.1'.format(
|
||||||
method=request.method,
|
method=request.method,
|
||||||
path=url.path or '/'),
|
path=url.path or '/',
|
||||||
|
query='' if url.query is '' else '?' + url.query),
|
||||||
headers='\n'.join(str('%s: %s') % (name, value)
|
headers='\n'.join(str('%s: %s') % (name, value)
|
||||||
for name, value
|
for name, value
|
||||||
in request_headers.items()),
|
in request_headers.items()),
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import os
|
import os
|
||||||
|
import re
|
||||||
import json
|
import json
|
||||||
|
|
||||||
import pygments
|
import pygments
|
||||||
@ -18,6 +19,8 @@ FORMATTER = (Terminal256Formatter
|
|||||||
if '256color' in os.environ.get('TERM', '')
|
if '256color' in os.environ.get('TERM', '')
|
||||||
else TerminalFormatter)
|
else TerminalFormatter)
|
||||||
|
|
||||||
|
application_content_type_re = re.compile(r'application/(.+\+)(json|xml)$')
|
||||||
|
|
||||||
|
|
||||||
class PrettyHttp(object):
|
class PrettyHttp(object):
|
||||||
|
|
||||||
@ -33,16 +36,23 @@ class PrettyHttp(object):
|
|||||||
|
|
||||||
def body(self, content, content_type):
|
def body(self, content, content_type):
|
||||||
content_type = content_type.split(';')[0]
|
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, '')
|
||||||
|
|
||||||
try:
|
try:
|
||||||
lexer = get_lexer_for_mimetype(content_type)
|
lexer = get_lexer_for_mimetype(content_type)
|
||||||
except ClassNotFound:
|
except ClassNotFound:
|
||||||
return content
|
return content
|
||||||
|
|
||||||
if content_type == 'application/json':
|
if content_type == "application/json":
|
||||||
try:
|
try:
|
||||||
# Indent and sort the JSON data.
|
# Indent and sort the JSON data.
|
||||||
content = json.dumps(json.loads(content),
|
content = json.dumps(json.loads(content),
|
||||||
sort_keys=True, indent=4)
|
sort_keys=True, indent=4,
|
||||||
|
ensure_ascii=False)
|
||||||
except:
|
except:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
11
setup.py
11
setup.py
@ -5,12 +5,15 @@ import httpie
|
|||||||
|
|
||||||
|
|
||||||
if sys.argv[-1] == 'test':
|
if sys.argv[-1] == 'test':
|
||||||
os.system('python tests.py')
|
status = os.system('python tests/tests.py')
|
||||||
sys.exit()
|
sys.exit(1 if status > 127 else status)
|
||||||
|
|
||||||
|
|
||||||
# Debian has only requests==0.10.1 and httpie.deb depends on that.
|
requirements = [
|
||||||
requirements = ['requests>=0.10.1', 'Pygments>=1.5']
|
# Debian has only requests==0.10.1 and httpie.deb depends on that.
|
||||||
|
'requests>=0.10.1',
|
||||||
|
'Pygments>=1.5'
|
||||||
|
]
|
||||||
if sys.version_info[:2] in ((2, 6), (3, 1)):
|
if sys.version_info[:2] in ((2, 6), (3, 1)):
|
||||||
# argparse has been added in Python 3.2 / 2.7
|
# argparse has been added in Python 3.2 / 2.7
|
||||||
requirements.append('argparse>=1.2.1')
|
requirements.append('argparse>=1.2.1')
|
||||||
|
1
tests/file2.txt
Normal file
1
tests/file2.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
__test_file_content__
|
443
tests/tests.py
443
tests/tests.py
@ -1,23 +1,37 @@
|
|||||||
# coding:utf-8
|
# -*- coding: utf-8 -*-
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
import unittest
|
import unittest
|
||||||
import argparse
|
import argparse
|
||||||
from requests.compat import is_py26
|
import os
|
||||||
|
import sys
|
||||||
import tempfile
|
import tempfile
|
||||||
|
import json
|
||||||
|
from requests.compat import is_py26, is_py3
|
||||||
|
from requests import Response
|
||||||
|
|
||||||
|
|
||||||
|
#################################################################
|
||||||
|
# Utils/setup
|
||||||
|
#################################################################
|
||||||
|
|
||||||
|
# HACK: Prepend ../ to PYTHONPATH so that we can import httpie form there.
|
||||||
TESTS_ROOT = os.path.dirname(__file__)
|
TESTS_ROOT = os.path.dirname(__file__)
|
||||||
sys.path.insert(0, os.path.realpath(os.path.join(TESTS_ROOT, '..')))
|
sys.path.insert(0, os.path.realpath(os.path.join(TESTS_ROOT, '..')))
|
||||||
from httpie import __main__
|
|
||||||
from httpie import cliparse
|
from httpie import __main__, cliparse
|
||||||
|
|
||||||
|
|
||||||
TEST_FILE = os.path.join(TESTS_ROOT, 'file.txt')
|
TEST_FILE_PATH = os.path.join(TESTS_ROOT, 'file.txt')
|
||||||
|
TEST_FILE2_PATH = os.path.join(TESTS_ROOT, 'file2.txt')
|
||||||
|
TEST_FILE_CONTENT = open(TEST_FILE_PATH).read().strip()
|
||||||
TERMINAL_COLOR_PRESENCE_CHECK = '\x1b['
|
TERMINAL_COLOR_PRESENCE_CHECK = '\x1b['
|
||||||
|
|
||||||
|
|
||||||
def http(*args, **kwargs):
|
def http(*args, **kwargs):
|
||||||
|
"""
|
||||||
|
Invoke `httpie.__main__.main` with `args` and `kwargs`,
|
||||||
|
and return a unicode response.
|
||||||
|
|
||||||
|
"""
|
||||||
http_kwargs = {
|
http_kwargs = {
|
||||||
'stdin_isatty': True,
|
'stdin_isatty': True,
|
||||||
'stdout_isatty': False
|
'stdout_isatty': False
|
||||||
@ -31,7 +45,7 @@ def http(*args, **kwargs):
|
|||||||
return response
|
return response
|
||||||
|
|
||||||
|
|
||||||
class BaseTest(unittest.TestCase):
|
class BaseTestCase(unittest.TestCase):
|
||||||
|
|
||||||
if is_py26:
|
if is_py26:
|
||||||
def assertIn(self, member, container, msg=None):
|
def assertIn(self, member, container, msg=None):
|
||||||
@ -45,7 +59,252 @@ class BaseTest(unittest.TestCase):
|
|||||||
self.assertEqual(sorted(d1.values()), sorted(d2.values()), msg)
|
self.assertEqual(sorted(d1.values()), sorted(d2.values()), msg)
|
||||||
|
|
||||||
|
|
||||||
class TestItemParsing(BaseTest):
|
#################################################################
|
||||||
|
# High-level tests using httpbin.org.
|
||||||
|
#################################################################
|
||||||
|
|
||||||
|
class HTTPieTest(BaseTestCase):
|
||||||
|
|
||||||
|
def test_GET(self):
|
||||||
|
r = http('GET', 'http://httpbin.org/get')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
|
||||||
|
def test_DELETE(self):
|
||||||
|
r = http('DELETE', 'http://httpbin.org/delete')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
|
||||||
|
def test_PUT(self):
|
||||||
|
r = http('PUT', 'http://httpbin.org/put', 'foo=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"foo": "bar"', r)
|
||||||
|
|
||||||
|
def test_POST_JSON_data(self):
|
||||||
|
r = http('POST', 'http://httpbin.org/post', 'foo=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"foo": "bar"', r)
|
||||||
|
|
||||||
|
def test_POST_form(self):
|
||||||
|
r = http('--form', 'POST', 'http://httpbin.org/post', 'foo=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"foo": "bar"', r)
|
||||||
|
|
||||||
|
def test_POST_stdin(self):
|
||||||
|
r = http('--form', 'POST', 'http://httpbin.org/post',
|
||||||
|
stdin=open(TEST_FILE_PATH), stdin_isatty=False)
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn(TEST_FILE_CONTENT, r)
|
||||||
|
|
||||||
|
def test_headers(self):
|
||||||
|
r = http('GET', 'http://httpbin.org/headers', 'Foo:bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"User-Agent": "HTTPie', r)
|
||||||
|
self.assertIn('"Foo": "bar"', r)
|
||||||
|
|
||||||
|
|
||||||
|
class AutoContentTypeAndAcceptHeadersTest(BaseTestCase):
|
||||||
|
"""
|
||||||
|
Test that Accept and Content-Type correctly defaults to JSON,
|
||||||
|
but can still be overridden. The same with Content-Type when --form
|
||||||
|
-f is used.
|
||||||
|
|
||||||
|
"""
|
||||||
|
def test_GET_no_data_no_auto_headers(self):
|
||||||
|
# https://github.com/jkbr/httpie/issues/62
|
||||||
|
r = http('GET', 'http://httpbin.org/headers')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "*/*"', r)
|
||||||
|
# Although an empty header is present in the response from httpbin,
|
||||||
|
# it's not included in the request.
|
||||||
|
self.assertIn('"Content-Type": ""', r)
|
||||||
|
|
||||||
|
def test_POST_no_data_no_auto_headers(self):
|
||||||
|
# JSON headers shouldn't be automatically set for POST with no data.
|
||||||
|
r = http('POST', 'http://httpbin.org/post')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "*/*"', r)
|
||||||
|
# Although an empty header is present in the response from httpbin,
|
||||||
|
# it's not included in the request.
|
||||||
|
self.assertIn(' "Content-Type": ""', r)
|
||||||
|
|
||||||
|
def test_POST_with_data_auto_JSON_headers(self):
|
||||||
|
r = http('POST', 'http://httpbin.org/post', 'a=b')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "application/json"', r)
|
||||||
|
self.assertIn('"Content-Type": "application/json; charset=utf-8', r)
|
||||||
|
|
||||||
|
def test_GET_with_data_auto_JSON_headers(self):
|
||||||
|
# JSON headers should automatically be set also for GET with data.
|
||||||
|
r = http('POST', 'http://httpbin.org/post', 'a=b')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "application/json"', r)
|
||||||
|
self.assertIn('"Content-Type": "application/json; charset=utf-8', r)
|
||||||
|
|
||||||
|
def test_POST_explicit_JSON_auto_JSON_headers(self):
|
||||||
|
r = http('-j', 'POST', 'http://httpbin.org/post')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "application/json"', r)
|
||||||
|
self.assertIn('"Content-Type": "application/json; charset=utf-8', r)
|
||||||
|
|
||||||
|
def test_GET_explicit_JSON_explicit_headers(self):
|
||||||
|
r = http('-j', 'GET', 'http://httpbin.org/headers',
|
||||||
|
'Accept:application/xml',
|
||||||
|
'Content-Type:application/xml')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Accept": "application/xml"', r)
|
||||||
|
self.assertIn('"Content-Type": "application/xml"', r)
|
||||||
|
|
||||||
|
def test_POST_form_auto_Content_Type(self):
|
||||||
|
r = http('-f', 'POST', 'http://httpbin.org/post')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Content-Type": "application/x-www-form-urlencoded; charset=utf-8"', r)
|
||||||
|
|
||||||
|
def test_POST_form_Content_Type_override(self):
|
||||||
|
r = http('-f', 'POST', 'http://httpbin.org/post', 'Content-Type:application/xml')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Content-Type": "application/xml"', r)
|
||||||
|
|
||||||
|
|
||||||
|
class ImplicitHTTPMethodTest(BaseTestCase):
|
||||||
|
|
||||||
|
def test_implicit_GET(self):
|
||||||
|
r = http('http://httpbin.org/get')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
|
||||||
|
def test_implicit_GET_with_headers(self):
|
||||||
|
r = http('http://httpbin.org/headers', 'Foo:bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"Foo": "bar"', r)
|
||||||
|
|
||||||
|
def test_implicit_POST_json(self):
|
||||||
|
r = http('http://httpbin.org/post', 'hello=world')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"hello": "world"', r)
|
||||||
|
|
||||||
|
def test_implicit_POST_form(self):
|
||||||
|
r = http('--form', 'http://httpbin.org/post', 'foo=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"foo": "bar"', r)
|
||||||
|
|
||||||
|
def test_implicit_POST_stdin(self):
|
||||||
|
r = http('--form', 'http://httpbin.org/post',
|
||||||
|
stdin=open(TEST_FILE_PATH), stdin_isatty=False)
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
|
||||||
|
|
||||||
|
class PrettyFlagTest(BaseTestCase):
|
||||||
|
"""Test the --pretty / --ugly flag handling."""
|
||||||
|
|
||||||
|
def test_pretty_enabled_by_default(self):
|
||||||
|
r = http('GET', 'http://httpbin.org/get', stdout_isatty=True)
|
||||||
|
self.assertIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
||||||
|
|
||||||
|
def test_pretty_enabled_by_default_unless_stdin_redirected(self):
|
||||||
|
r = http('GET', 'http://httpbin.org/get', stdout_isatty=False)
|
||||||
|
self.assertNotIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
||||||
|
|
||||||
|
def test_force_pretty(self):
|
||||||
|
r = http('--pretty', 'GET', 'http://httpbin.org/get', stdout_isatty=False)
|
||||||
|
self.assertIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
||||||
|
|
||||||
|
def test_force_ugly(self):
|
||||||
|
r = http('--ugly', 'GET', 'http://httpbin.org/get', stdout_isatty=True)
|
||||||
|
self.assertNotIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
||||||
|
|
||||||
|
|
||||||
|
class VerboseFlagTest(BaseTestCase):
|
||||||
|
|
||||||
|
def test_verbose(self):
|
||||||
|
r = http('--verbose', 'GET', 'http://httpbin.org/get', 'test-header:__test__')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertEqual(r.count('__test__'), 2)
|
||||||
|
|
||||||
|
def test_verbose_form(self):
|
||||||
|
# https://github.com/jkbr/httpie/issues/53
|
||||||
|
r = http('--verbose', '--form', 'POST', 'http://httpbin.org/post', 'foo=bar', 'baz=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('foo=bar&baz=bar', r)
|
||||||
|
|
||||||
|
|
||||||
|
class MultipartFormDataFileUploadTest(BaseTestCase):
|
||||||
|
|
||||||
|
def test_non_existent_file_raises_parse_error(self):
|
||||||
|
self.assertRaises(cliparse.ParseError, http,
|
||||||
|
'--form', '--traceback',
|
||||||
|
'POST', 'http://httpbin.org/post',
|
||||||
|
'foo@/__does_not_exist__')
|
||||||
|
|
||||||
|
def test_upload_ok(self):
|
||||||
|
r = http('--form', 'POST', 'http://httpbin.org/post',
|
||||||
|
'test-file@%s' % TEST_FILE_PATH, 'foo=bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"test-file": "%s' % TEST_FILE_CONTENT, r)
|
||||||
|
self.assertIn('"foo": "bar"', r)
|
||||||
|
|
||||||
|
|
||||||
|
class RequestBodyFromFilePathTest(BaseTestCase):
|
||||||
|
"""
|
||||||
|
`http URL @file'
|
||||||
|
|
||||||
|
"""
|
||||||
|
def test_request_body_from_file_by_path(self):
|
||||||
|
r = http('POST', 'http://httpbin.org/post', '@' + TEST_FILE_PATH)
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn(TEST_FILE_CONTENT, r)
|
||||||
|
self.assertIn('"Content-Type": "text/plain"', r)
|
||||||
|
|
||||||
|
def test_request_body_from_file_by_path_with_explicit_content_type(self):
|
||||||
|
r = http('POST', 'http://httpbin.org/post', '@' + TEST_FILE_PATH, 'Content-Type:x-foo/bar')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn(TEST_FILE_CONTENT, r)
|
||||||
|
self.assertIn('"Content-Type": "x-foo/bar"', r)
|
||||||
|
|
||||||
|
def test_request_body_from_file_by_path_only_one_file_allowed(self):
|
||||||
|
self.assertRaises(SystemExit, lambda: http(
|
||||||
|
'POST',
|
||||||
|
'http://httpbin.org/post',
|
||||||
|
'@' + TEST_FILE_PATH,
|
||||||
|
'@' + TEST_FILE2_PATH))
|
||||||
|
|
||||||
|
def test_request_body_from_file_by_path_no_data_items_allowed(self):
|
||||||
|
self.assertRaises(SystemExit, lambda: http(
|
||||||
|
'POST',
|
||||||
|
'http://httpbin.org/post',
|
||||||
|
'@' + TEST_FILE_PATH,
|
||||||
|
'foo=bar'))
|
||||||
|
|
||||||
|
|
||||||
|
class AuthTest(BaseTestCase):
|
||||||
|
|
||||||
|
def test_basic_auth(self):
|
||||||
|
r = http('--auth', 'user:password',
|
||||||
|
'GET', 'httpbin.org/basic-auth/user/password')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"authenticated": true', r)
|
||||||
|
self.assertIn('"user": "user"', r)
|
||||||
|
|
||||||
|
def test_digest_auth(self):
|
||||||
|
r = http('--auth-type=digest', '--auth', 'user:password',
|
||||||
|
'GET', 'httpbin.org/digest-auth/auth/user/password')
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"authenticated": true', r)
|
||||||
|
self.assertIn('"user": "user"', r)
|
||||||
|
|
||||||
|
def test_password_prompt(self):
|
||||||
|
cliparse.AuthCredentials._getpass = lambda self, prompt: 'password'
|
||||||
|
|
||||||
|
r = http('--auth', 'user',
|
||||||
|
'GET', 'httpbin.org/basic-auth/user/password')
|
||||||
|
|
||||||
|
self.assertIn('HTTP/1.1 200', r)
|
||||||
|
self.assertIn('"authenticated": true', r)
|
||||||
|
self.assertIn('"user": "user"', r)
|
||||||
|
|
||||||
|
|
||||||
|
#################################################################
|
||||||
|
# CLI argument parsing related tests.
|
||||||
|
#################################################################
|
||||||
|
|
||||||
|
class ItemParsingTest(BaseTestCase):
|
||||||
|
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
self.key_value_type = cliparse.KeyValueType(
|
self.key_value_type = cliparse.KeyValueType(
|
||||||
@ -69,7 +328,7 @@ class TestItemParsing(BaseTest):
|
|||||||
# data
|
# data
|
||||||
self.key_value_type('baz\\=bar=foo'),
|
self.key_value_type('baz\\=bar=foo'),
|
||||||
# files
|
# files
|
||||||
self.key_value_type('bar\\@baz@%s' % TEST_FILE)
|
self.key_value_type('bar\\@baz@%s' % TEST_FILE_PATH)
|
||||||
])
|
])
|
||||||
self.assertDictEqual(headers, {
|
self.assertDictEqual(headers, {
|
||||||
'foo:bar': 'baz',
|
'foo:bar': 'baz',
|
||||||
@ -97,7 +356,7 @@ class TestItemParsing(BaseTest):
|
|||||||
self.key_value_type('eh:'),
|
self.key_value_type('eh:'),
|
||||||
self.key_value_type('ed='),
|
self.key_value_type('ed='),
|
||||||
self.key_value_type('bool:=true'),
|
self.key_value_type('bool:=true'),
|
||||||
self.key_value_type('test-file@%s' % TEST_FILE),
|
self.key_value_type('test-file@%s' % TEST_FILE_PATH),
|
||||||
])
|
])
|
||||||
self.assertDictEqual(headers, {
|
self.assertDictEqual(headers, {
|
||||||
'header': 'value',
|
'header': 'value',
|
||||||
@ -113,80 +372,128 @@ class TestItemParsing(BaseTest):
|
|||||||
self.assertIn('test-file', files)
|
self.assertIn('test-file', files)
|
||||||
|
|
||||||
|
|
||||||
class TestHTTPie(BaseTest):
|
class ArgumentParserTestCase(unittest.TestCase):
|
||||||
|
|
||||||
def test_get(self):
|
def setUp(self):
|
||||||
http('GET', 'http://httpbin.org/get')
|
self.parser = cliparse.Parser()
|
||||||
|
|
||||||
def test_verbose(self):
|
def test_guess_when_method_set_and_valid(self):
|
||||||
r = http('--verbose', 'GET', 'http://httpbin.org/get', 'test-header:__test__')
|
args = argparse.Namespace()
|
||||||
self.assertEqual(r.count('__test__'), 2)
|
args.method = 'GET'
|
||||||
|
args.url = 'http://example.com/'
|
||||||
|
args.items = []
|
||||||
|
|
||||||
def test_json(self):
|
self.parser._guess_method(args)
|
||||||
response = http('POST', 'http://httpbin.org/post', 'foo=bar')
|
|
||||||
self.assertIn('"foo": "bar"', response)
|
|
||||||
response2 = http('-j', 'GET', 'http://httpbin.org/headers')
|
|
||||||
self.assertIn('"Accept": "application/json"', response2)
|
|
||||||
response3 = http('-j', 'GET', 'http://httpbin.org/headers', 'Accept:application/xml')
|
|
||||||
self.assertIn('"Accept": "application/xml"', response3)
|
|
||||||
|
|
||||||
def test_form(self):
|
self.assertEquals(args.method, 'GET')
|
||||||
response = http('--form', 'POST', 'http://httpbin.org/post', 'foo=bar')
|
self.assertEquals(args.url, 'http://example.com/')
|
||||||
self.assertIn('"foo": "bar"', response)
|
self.assertEquals(args.items, [])
|
||||||
|
|
||||||
def test_headers(self):
|
def test_guess_when_method_not_set(self):
|
||||||
response = http('GET', 'http://httpbin.org/headers', 'Foo:bar')
|
args = argparse.Namespace()
|
||||||
self.assertIn('"User-Agent": "HTTPie', response)
|
args.method = None
|
||||||
self.assertIn('"Foo": "bar"', response)
|
args.url = 'http://example.com/'
|
||||||
|
args.items = []
|
||||||
|
|
||||||
|
self.parser._guess_method(args)
|
||||||
|
|
||||||
|
self.assertEquals(args.method, 'GET')
|
||||||
|
self.assertEquals(args.url, 'http://example.com/')
|
||||||
|
self.assertEquals(args.items, [])
|
||||||
|
|
||||||
|
def test_guess_when_method_set_but_invalid_and_data_field(self):
|
||||||
|
args = argparse.Namespace()
|
||||||
|
args.method = 'http://example.com/'
|
||||||
|
args.url = 'data=field'
|
||||||
|
args.items = []
|
||||||
|
|
||||||
|
self.parser._guess_method(args)
|
||||||
|
|
||||||
|
self.assertEquals(args.method, 'POST')
|
||||||
|
self.assertEquals(args.url, 'http://example.com/')
|
||||||
|
self.assertEquals(
|
||||||
|
args.items,
|
||||||
|
[cliparse.KeyValue(key='data', value='field', sep='=', orig='data=field')])
|
||||||
|
|
||||||
|
def test_guess_when_method_set_but_invalid_and_header_field(self):
|
||||||
|
args = argparse.Namespace()
|
||||||
|
args.method = 'http://example.com/'
|
||||||
|
args.url = 'test:header'
|
||||||
|
args.items = []
|
||||||
|
|
||||||
|
self.parser._guess_method(args)
|
||||||
|
|
||||||
|
self.assertEquals(args.method, 'GET')
|
||||||
|
self.assertEquals(args.url, 'http://example.com/')
|
||||||
|
self.assertEquals(
|
||||||
|
args.items,
|
||||||
|
[cliparse.KeyValue(key='test', value='header', sep=':', orig='test:header')])
|
||||||
|
|
||||||
|
def test_guess_when_method_set_but_invalid_and_item_exists(self):
|
||||||
|
args = argparse.Namespace()
|
||||||
|
args.method = 'http://example.com/'
|
||||||
|
args.url = 'new_item=a'
|
||||||
|
args.items = [
|
||||||
|
cliparse.KeyValue(key='old_item', value='b', sep='=', orig='old_item=b')
|
||||||
|
]
|
||||||
|
|
||||||
|
self.parser._guess_method(args)
|
||||||
|
|
||||||
|
self.assertEquals(args.items, [
|
||||||
|
cliparse.KeyValue(key='new_item', value='a', sep='=', orig='new_item=a'),
|
||||||
|
cliparse.KeyValue(key='old_item', value='b', sep='=', orig='old_item=b'),
|
||||||
|
])
|
||||||
|
|
||||||
|
|
||||||
class TestPrettyFlag(BaseTest):
|
class FakeResponse(Response):
|
||||||
"""Test the --pretty / --ugly flag handling."""
|
|
||||||
|
|
||||||
def test_pretty_enabled_by_default(self):
|
class Mock(object):
|
||||||
r = http('GET', 'http://httpbin.org/get', stdout_isatty=True)
|
|
||||||
self.assertIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
|
||||||
|
|
||||||
def test_pretty_enabled_by_default_unless_stdin_redirected(self):
|
def __getattr__(self, item):
|
||||||
r = http('GET', 'http://httpbin.org/get', stdout_isatty=False)
|
return self
|
||||||
self.assertNotIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
|
||||||
|
|
||||||
def test_force_pretty(self):
|
def __repr__(self):
|
||||||
r = http('--pretty', 'GET', 'http://httpbin.org/get', stdout_isatty=False)
|
return 'Mock string'
|
||||||
self.assertIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
|
||||||
|
|
||||||
def test_force_ugly(self):
|
def __unicode__(self):
|
||||||
r = http('--ugly', 'GET', 'http://httpbin.org/get', stdout_isatty=True)
|
return self.__repr__()
|
||||||
self.assertNotIn(TERMINAL_COLOR_PRESENCE_CHECK, r)
|
|
||||||
|
def __init__(self, content=None, encoding='utf-8'):
|
||||||
|
super(FakeResponse, self).__init__()
|
||||||
|
self.headers['Content-Type'] = 'application/json'
|
||||||
|
self.encoding = encoding
|
||||||
|
self._content = content.encode(encoding)
|
||||||
|
self.raw = self.Mock()
|
||||||
|
|
||||||
|
|
||||||
class TestFileUpload(BaseTest):
|
class UnicodeOutputTestCase(BaseTestCase):
|
||||||
|
|
||||||
def test_non_existent_file_raises_parse_error(self):
|
def test_unicode_output(self):
|
||||||
self.assertRaises(cliparse.ParseError, http,
|
# some cyrillic and simplified chinese symbols
|
||||||
'--form', '--traceback',
|
response_dict = {'Привет': 'Мир!',
|
||||||
'POST', 'http://httpbin.org/post',
|
'Hello': '世界'}
|
||||||
'foo@/__does_not_exist__')
|
if not is_py3:
|
||||||
|
response_dict = dict(
|
||||||
|
(k.decode('utf8'), v.decode('utf8'))
|
||||||
|
for k, v in response_dict.items()
|
||||||
|
)
|
||||||
|
response_body = json.dumps(response_dict)
|
||||||
|
# emulate response
|
||||||
|
response = FakeResponse(response_body)
|
||||||
|
|
||||||
def test_upload_ok(self):
|
# emulate cli arguments
|
||||||
r = http('--form', 'POST', 'http://httpbin.org/post',
|
args = argparse.Namespace()
|
||||||
'test-file@%s' % TEST_FILE)
|
args.prettify = True
|
||||||
self.assertIn('"test-file": "__test_file_content__', r)
|
args.output_options = 'b'
|
||||||
|
args.forced_content_type = None
|
||||||
|
args.style = 'default'
|
||||||
|
|
||||||
|
# colorized output contains escape sequences
|
||||||
|
output = __main__._get_output(args, True, response)
|
||||||
|
|
||||||
class TestAuth(BaseTest):
|
for key, value in response_dict.items():
|
||||||
|
self.assertIn(key, output)
|
||||||
def test_basic_auth(self):
|
self.assertIn(value, output)
|
||||||
r = http('--auth', 'user:password',
|
|
||||||
'GET', 'httpbin.org/basic-auth/user/password')
|
|
||||||
self.assertIn('"authenticated": true', r)
|
|
||||||
self.assertIn('"user": "user"', r)
|
|
||||||
|
|
||||||
def test_digest_auth(self):
|
|
||||||
r = http('--auth-type=digest', '--auth', 'user:password',
|
|
||||||
'GET', 'httpbin.org/digest-auth/auth/user/password')
|
|
||||||
self.assertIn('"authenticated": true', r)
|
|
||||||
self.assertIn('"user": "user"', r)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
19
tox.ini
Normal file
19
tox.ini
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Tox (http://tox.testrun.org/) is a tool for running tests
|
||||||
|
# in multiple virtualenvs. This configuration file will run the
|
||||||
|
# test suite on all supported python versions. To use it, "pip install tox"
|
||||||
|
# and then run "tox" from this directory.
|
||||||
|
|
||||||
|
[tox]
|
||||||
|
envlist = py26, py27, py30, py31, py32, pypy
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
commands = {envpython} setup.py test
|
||||||
|
|
||||||
|
[testenv:py26]
|
||||||
|
deps = argparse
|
||||||
|
|
||||||
|
[testenv:py30]
|
||||||
|
deps = argparse
|
||||||
|
|
||||||
|
[testenv:py31]
|
||||||
|
deps = argparse
|
Reference in New Issue
Block a user