Implement HTTPie Nested JSON v2

This commit is contained in:
Batuhan Taskaya 2022-01-04 12:04:20 +03:00
parent 21faddc4b9
commit 7bf373751d
7 changed files with 665 additions and 228 deletions

View File

@ -57,7 +57,7 @@ class KeyValueArgType:
def __init__(self, *separators: str): def __init__(self, *separators: str):
self.separators = separators self.separators = separators
self.special_characters = set('\\') self.special_characters = set()
for separator in separators: for separator in separators:
self.special_characters.update(separator) self.special_characters.update(separator)
@ -113,7 +113,7 @@ class KeyValueArgType:
There are only two token types - strings and escaped characters: There are only two token types - strings and escaped characters:
>>> KeyValueArgType('=').tokenize(r'foo\=bar\\baz') >>> KeyValueArgType('=').tokenize(r'foo\=bar\\baz')
['foo', Escaped('='), 'bar', Escaped('\\'), 'baz'] ['foo', Escaped('='), 'bar\\\\baz']
""" """
tokens = [''] tokens = ['']

View File

@ -52,6 +52,8 @@ SEPARATOR_GROUP_DATA_EMBED_ITEMS = frozenset({
SEPARATOR_GROUP_NESTED_JSON_ITEMS = frozenset([ SEPARATOR_GROUP_NESTED_JSON_ITEMS = frozenset([
SEPARATOR_DATA_STRING, SEPARATOR_DATA_STRING,
SEPARATOR_DATA_RAW_JSON, SEPARATOR_DATA_RAW_JSON,
SEPARATOR_DATA_EMBED_FILE_CONTENTS,
SEPARATOR_DATA_EMBED_RAW_JSON_FILE,
]) ])
# Separators allowed in ITEM arguments # Separators allowed in ITEM arguments

View File

@ -1,150 +0,0 @@
"""
Routines for JSON form syntax, used to support nested JSON request items.
Highly inspired from the great jarg project <https://github.com/jdp/jarg/blob/master/jarg/jsonform.py>.
"""
import re
import operator
from typing import Optional
def step(value: str, is_escaped: bool) -> str:
if is_escaped:
value = value.replace(r'\[', '[').replace(r'\]', ']')
return value
def find_opening_bracket(
value: str,
search=re.compile(r'(?<!\\)\[').search
) -> Optional[int]:
match = search(value)
if not match:
return None
return match.start()
def find_closing_bracket(
value: str,
search=re.compile(r'(?<!\\)\]').search
) -> Optional[int]:
match = search(value)
if not match:
return None
return match.start()
def parse_path(path):
"""
Parse a string as a JSON path.
An implementation of 'steps to parse a JSON encoding path'.
<https://www.w3.org/TR/html-json-forms/#dfn-steps-to-parse-a-json-encoding-path>
"""
original = path
is_escaped = r'\[' in original
opening_bracket = find_opening_bracket(original)
last_step = [(step(path, is_escaped), {'last': True, 'type': 'object'})]
if opening_bracket is None:
return last_step
steps = [(step(original[:opening_bracket], is_escaped), {'type': 'object'})]
path = original[opening_bracket:]
while path:
if path.startswith('[]'):
steps[-1][1]['append'] = True
path = path[2:]
if path:
return last_step
elif path[0] == '[':
path = path[1:]
closing_bracket = find_closing_bracket(path)
if closing_bracket is None:
return last_step
key = path[:closing_bracket]
path = path[closing_bracket + 1:]
try:
steps.append((int(key), {'type': 'array'}))
except ValueError:
steps.append((key, {'type': 'object'}))
elif path[:2] == r'\[':
key = step(path[1:path.index(r'\]') + 2], is_escaped)
path = path[path.index(r'\]') + 2:]
steps.append((key, {'type': 'object'}))
else:
return last_step
for i in range(len(steps) - 1):
steps[i][1]['type'] = steps[i + 1][1]['type']
steps[-1][1]['last'] = True
return steps
def set_value(context, step, current_value, entry_value):
"""Apply a JSON value to a context object.
An implementation of 'steps to set a JSON encoding value'.
<https://www.w3.org/TR/html-json-forms/#dfn-steps-to-set-a-json-encoding-value>
"""
key, flags = step
if flags.get('last', False):
if current_value is None:
if flags.get('append', False):
context[key] = [entry_value]
else:
if isinstance(context, list) and len(context) <= key:
context.extend([None] * (key - len(context) + 1))
context[key] = entry_value
elif isinstance(current_value, list):
context[key].append(entry_value)
else:
context[key] = [current_value, entry_value]
return context
if current_value is None:
if flags.get('type') == 'array':
context[key] = []
else:
if isinstance(context, list) and len(context) <= key:
context.extend([None] * (key - len(context) + 1))
context[key] = {}
return context[key]
elif isinstance(current_value, dict):
return context[key]
elif isinstance(current_value, list):
if flags.get('type') == 'array':
return current_value
obj = {}
for i, item in enumerate(current_value):
if item is not None:
obj[i] = item
else:
context[key] = obj
return obj
else:
obj = {'': current_value}
context[key] = obj
return obj
def interpret_json_form(pairs):
"""The application/json form encoding algorithm.
<https://www.w3.org/TR/html-json-forms/#dfn-application-json-encoding-algorithm>
"""
result = {}
for key, value in pairs:
steps = parse_path(key)
context = result
for step in steps:
try:
current_value = operator.getitem(context, step[0])
except LookupError:
current_value = None
context = set_value(context, step, current_value, value)
return result

311
httpie/cli/nested_json.py Normal file
View File

@ -0,0 +1,311 @@
from enum import Enum, auto
from typing import (
Any,
Iterator,
NamedTuple,
Optional,
List,
NoReturn,
Type,
Union,
)
class HTTPieSyntaxError(ValueError):
def __init__(
self,
source: str,
token: Optional['Token'],
message: str,
message_kind: str = 'Syntax',
) -> None:
self.source = source
self.token = token
self.message = message
self.message_kind = message_kind
def __str__(self):
lines = [f'HTTPie {self.message_kind} Error: {self.message}']
if self.token is not None:
lines.append(self.source)
lines.append(
' ' * (self.token.start)
+ '^' * (self.token.end - self.token.start)
)
return '\n'.join(lines)
class TokenKind(Enum):
TEXT = auto()
NUMBER = auto()
LEFT_BRACKET = auto()
RIGHT_BRACKET = auto()
def to_name(self) -> str:
for key, value in OPERATORS.items():
if value is self:
return repr(key)
else:
return 'a ' + self.name.lower()
OPERATORS = {'[': TokenKind.LEFT_BRACKET, ']': TokenKind.RIGHT_BRACKET}
SPECIAL_CHARS = OPERATORS.keys() | {'\\'}
class Token(NamedTuple):
kind: TokenKind
value: Union[str, int]
start: int
end: int
def assert_cant_happen() -> NoReturn:
raise ValueError("Unexpected value")
def tokenize(source: str) -> Iterator[Token]:
cursor = 0
backslashes = 0
buffer = []
def send_buffer() -> Iterator[Token]:
nonlocal backslashes
if not buffer:
return None
value = ''.join(buffer)
try:
value = int(value)
except ValueError:
kind = TokenKind.TEXT
else:
kind = TokenKind.NUMBER
yield Token(
kind, value, start=cursor - (len(buffer) + backslashes), end=cursor
)
buffer.clear()
backslashes = 0
def can_advance() -> bool:
return cursor < len(source)
while can_advance():
index = source[cursor]
if index in OPERATORS:
yield from send_buffer()
yield Token(OPERATORS[index], index, cursor, cursor + 1)
elif index == '\\' and can_advance():
if source[cursor + 1] in SPECIAL_CHARS:
backslashes += 1
else:
buffer.append(index)
buffer.append(source[cursor + 1])
cursor += 1
else:
buffer.append(index)
cursor += 1
yield from send_buffer()
class Path:
def __init__(
self,
kind: str,
accessor: Optional[Union[str, int]] = None,
tokens: Optional[List[Token]] = None,
is_root: bool = False,
):
self.kind = kind
self.accessor = accessor
self.tokens = tokens or []
self.is_root = is_root
def reconstruct(self) -> str:
if self.kind == 'key':
if self.is_root:
return self.accessor
return '[' + self.accessor + ']'
elif self.kind == 'index':
return '[' + str(self.accessor) + ']'
elif self.kind == 'append':
return '[]'
else:
assert_cant_happen()
def parse(source: str) -> Iterator[Path]:
"""
start: literal? path*
literal: TEXT | NUMBER
path:
key_path
| index_path
| append_path
key_path: LEFT_BRACKET TEXT RIGHT_BRACKET
index_path: LEFT_BRACKET NUMBER RIGHT_BRACKET
append_path: LEFT_BRACKET RIGHT_BRACKET
"""
tokens = list(tokenize(source))
cursor = 0
def can_advance():
return cursor < len(tokens)
def expect(*kinds):
nonlocal cursor
assert len(kinds) > 0
if can_advance():
token = tokens[cursor]
cursor += 1
if token.kind in kinds:
return token
else:
token = tokens[-1]._replace(
start=tokens[-1].end + 0, end=tokens[-1].end + 1
)
if len(kinds) == 1:
suffix = kinds[0].to_name()
else:
suffix = ', '.join(kind.to_name() for kind in kinds[:-1])
suffix += ' or ' + kinds[-1].to_name()
message = f'Expecting {suffix}'
raise HTTPieSyntaxError(source, token, message)
root = Path('key', '', is_root=True)
if can_advance():
token = tokens[cursor]
if token.kind in {TokenKind.TEXT, TokenKind.NUMBER}:
token = expect(TokenKind.TEXT, TokenKind.NUMBER)
root.accessor = str(token.value)
root.tokens.append(token)
yield root
while can_advance():
path_tokens = []
path_tokens.append(expect(TokenKind.LEFT_BRACKET))
token = expect(
TokenKind.TEXT, TokenKind.NUMBER, TokenKind.RIGHT_BRACKET
)
path_tokens.append(token)
if token.kind is TokenKind.RIGHT_BRACKET:
path = Path('append', tokens=path_tokens)
elif token.kind is TokenKind.TEXT:
path = Path('key', token.value, tokens=path_tokens)
path_tokens.append(expect(TokenKind.RIGHT_BRACKET))
elif token.kind is TokenKind.NUMBER:
path = Path('index', token.value, tokens=path_tokens)
path_tokens.append(expect(TokenKind.RIGHT_BRACKET))
else:
assert_cant_happen()
yield path
JSON_TYPE_MAPPING = {
dict: 'object',
list: 'array',
int: 'number',
float: 'number',
str: 'string',
}
def interpret(context: Any, key: str, value: Any) -> Any:
cursor = context
paths = list(parse(key))
paths.append(Path('set', value))
def type_check(index: int, path: Path, expected_type: Type[Any]) -> None:
if not isinstance(cursor, expected_type):
if path.tokens:
pseudo_token = Token(
None, None, path.tokens[0].start, path.tokens[-1].end
)
else:
pseudo_token = None
cursor_type = JSON_TYPE_MAPPING.get(
type(cursor), type(cursor).__name__
)
required_type = JSON_TYPE_MAPPING[expected_type]
message = f"Can't perform {path.kind!r} based access on "
message += repr(
''.join(path.reconstruct() for path in paths[:index])
)
message += (
f' which has a type of {cursor_type!r} but this operation'
)
message += f' requires a type of {required_type!r}.'
raise HTTPieSyntaxError(
key, pseudo_token, message, message_kind='Type'
)
def object_for(kind: str) -> str:
if kind == 'key':
return {}
elif kind in {'index', 'append'}:
return []
else:
assert_cant_happen()
for index, (path, next_path) in enumerate(zip(paths, paths[1:])):
if path.kind == 'key':
type_check(index, path, dict)
if next_path.kind == 'set':
cursor[path.accessor] = next_path.accessor
break
cursor = cursor.setdefault(
path.accessor, object_for(next_path.kind)
)
elif path.kind == 'index':
type_check(index, path, list)
if path.accessor < 0:
raise HTTPieSyntaxError(
key,
path.tokens[1],
'Negative indexes are not supported.',
message_kind='Value',
)
cursor.extend([None] * (path.accessor - len(cursor) + 1))
if next_path.kind == 'set':
cursor[path.accessor] = next_path.accessor
break
if cursor[path.accessor] is None:
cursor[path.accessor] = object_for(next_path.kind)
cursor = cursor[path.accessor]
elif path.kind == 'append':
type_check(index, path, list)
if next_path.kind == 'set':
cursor.append(next_path.accessor)
break
cursor.append(object_for(next_path.kind))
cursor = cursor[-1]
else:
assert_cant_happen()
return context
def interpret_nested_json(pairs):
context = {}
for key, value in pairs:
interpret(context, key, value)
return context

View File

@ -17,7 +17,7 @@ from .dicts import (
RequestQueryParamsDict, RequestQueryParamsDict,
) )
from .exceptions import ParseError from .exceptions import ParseError
from .json_form import interpret_json_form from .nested_json import interpret_nested_json
from ..utils import get_content_type, load_json_preserve_order_and_dupe_keys, split from ..utils import get_content_type, load_json_preserve_order_and_dupe_keys, split
@ -202,7 +202,7 @@ def process_data_raw_json_embed_arg(arg: KeyValueArg) -> JSONType:
def process_data_nested_json_embed_args(pairs) -> Dict[str, JSONType]: def process_data_nested_json_embed_args(pairs) -> Dict[str, JSONType]:
return interpret_json_form(pairs) return interpret_nested_json(pairs)
def load_text_file(item: KeyValueArg) -> str: def load_text_file(item: KeyValueArg) -> str:

View File

@ -11,6 +11,7 @@ from requests import __version__ as requests_version
from . import __version__ as httpie_version from . import __version__ as httpie_version
from .cli.constants import OUT_REQ_BODY from .cli.constants import OUT_REQ_BODY
from .cli.nested_json import HTTPieSyntaxError
from .client import collect_messages from .client import collect_messages
from .context import Environment from .context import Environment
from .downloads import Downloader from .downloads import Downloader
@ -69,6 +70,11 @@ def raw_main(
args=args, args=args,
env=env, env=env,
) )
except HTTPieSyntaxError as exc:
env.stderr.write(str(exc) + "\n")
if include_traceback:
raise
exit_status = ExitStatus.ERROR
except KeyboardInterrupt: except KeyboardInterrupt:
env.stderr.write('\n') env.stderr.write('\n')
if include_traceback: if include_traceback:

View File

@ -5,12 +5,19 @@ import responses
from httpie.cli.constants import PRETTY_MAP from httpie.cli.constants import PRETTY_MAP
from httpie.cli.exceptions import ParseError from httpie.cli.exceptions import ParseError
from httpie.cli.nested_json import HTTPieSyntaxError
from httpie.compat import is_windows from httpie.compat import is_windows
from httpie.output.formatters.colors import ColorFormatter from httpie.output.formatters.colors import ColorFormatter
from httpie.utils import JsonDictPreservingDuplicateKeys from httpie.utils import JsonDictPreservingDuplicateKeys
from .fixtures import JSON_WITH_DUPE_KEYS_FILE_PATH from .fixtures import (
from .utils import MockEnvironment, http, DUMMY_URL FILE_CONTENT,
FILE_PATH,
JSON_FILE_CONTENT,
JSON_FILE_PATH,
JSON_WITH_DUPE_KEYS_FILE_PATH,
)
from .utils import DUMMY_URL, MockEnvironment, http
TEST_JSON_XXSI_PREFIXES = [ TEST_JSON_XXSI_PREFIXES = [
r")]}',\n", r")]}',\n",
@ -35,25 +42,27 @@ TEST_JSON_VALUES = [
TEST_PREFIX_TOKEN_COLOR = '\x1b[38;5;15m' if is_windows else '\x1b[04m\x1b[91m' TEST_PREFIX_TOKEN_COLOR = '\x1b[38;5;15m' if is_windows else '\x1b[04m\x1b[91m'
JSON_WITH_DUPES_RAW = '{"key": 15, "key": 15, "key": 3, "key": 7}' JSON_WITH_DUPES_RAW = '{"key": 15, "key": 15, "key": 3, "key": 7}'
JSON_WITH_DUPES_FORMATTED_SORTED = '''{ JSON_WITH_DUPES_FORMATTED_SORTED = """{
"key": 3, "key": 3,
"key": 7, "key": 7,
"key": 15, "key": 15,
"key": 15 "key": 15
}''' }"""
JSON_WITH_DUPES_FORMATTED_UNSORTED = '''{ JSON_WITH_DUPES_FORMATTED_UNSORTED = """{
"key": 15, "key": 15,
"key": 15, "key": 15,
"key": 3, "key": 3,
"key": 7 "key": 7
}''' }"""
@pytest.mark.parametrize('data_prefix', TEST_JSON_XXSI_PREFIXES) @pytest.mark.parametrize('data_prefix', TEST_JSON_XXSI_PREFIXES)
@pytest.mark.parametrize('json_data', TEST_JSON_VALUES) @pytest.mark.parametrize('json_data', TEST_JSON_VALUES)
@pytest.mark.parametrize('pretty', PRETTY_MAP.keys()) @pytest.mark.parametrize('pretty', PRETTY_MAP.keys())
@responses.activate @responses.activate
def test_json_formatter_with_body_preceded_by_non_json_data(data_prefix, json_data, pretty): def test_json_formatter_with_body_preceded_by_non_json_data(
data_prefix, json_data, pretty
):
"""Test JSON bodies preceded by non-JSON data.""" """Test JSON bodies preceded by non-JSON data."""
body = data_prefix + json.dumps(json_data) body = data_prefix + json.dumps(json_data)
content_type = 'application/json;charset=utf8' content_type = 'application/json;charset=utf8'
@ -71,11 +80,15 @@ def test_json_formatter_with_body_preceded_by_non_json_data(data_prefix, json_da
indent = None if pretty in {'none', 'colors'} else 4 indent = None if pretty in {'none', 'colors'} else 4
expected_body = data_prefix + json.dumps(json_data, indent=indent) expected_body = data_prefix + json.dumps(json_data, indent=indent)
if colored_output: if colored_output:
fmt = ColorFormatter(env, format_options={'json': {'format': True, 'indent': 4}}) fmt = ColorFormatter(
env, format_options={'json': {'format': True, 'indent': 4}}
)
expected_body = fmt.format_body(expected_body, content_type) expected_body = fmt.format_body(expected_body, content_type)
# Check to ensure the non-JSON data prefix is colored only one time, # Check to ensure the non-JSON data prefix is colored only one time,
# meaning it was correctly handled as a whole. # meaning it was correctly handled as a whole.
assert TEST_PREFIX_TOKEN_COLOR + data_prefix in expected_body, expected_body assert (
TEST_PREFIX_TOKEN_COLOR + data_prefix in expected_body
), expected_body
assert expected_body in r assert expected_body in r
@ -119,12 +132,7 @@ def test_duplicate_keys_support_from_input_file():
assert JSON_WITH_DUPES_FORMATTED_UNSORTED in r assert JSON_WITH_DUPES_FORMATTED_UNSORTED in r
@pytest.mark.parametrize("value", [ @pytest.mark.parametrize('value', [1, 1.1, True, 'some_value'])
1,
1.1,
True,
'some_value'
])
def test_simple_json_arguments_with_non_json(httpbin, value): def test_simple_json_arguments_with_non_json(httpbin, value):
r = http( r = http(
'--form', '--form',
@ -134,15 +142,14 @@ def test_simple_json_arguments_with_non_json(httpbin, value):
assert r.json['form'] == {'option': str(value)} assert r.json['form'] == {'option': str(value)}
@pytest.mark.parametrize("request_type", [ @pytest.mark.parametrize(
"--form", 'request_type',
"--multipart", [
]) '--form',
@pytest.mark.parametrize("value", [ '--multipart',
[1, 2, 3], ],
{'a': 'b'}, )
None @pytest.mark.parametrize('value', [[1, 2, 3], {'a': 'b'}, None])
])
def test_complex_json_arguments_with_non_json(httpbin, request_type, value): def test_complex_json_arguments_with_non_json(httpbin, request_type, value):
with pytest.raises(ParseError) as cm: with pytest.raises(ParseError) as cm:
http( http(
@ -151,61 +158,322 @@ def test_complex_json_arguments_with_non_json(httpbin, request_type, value):
f'option:={json.dumps(value)}', f'option:={json.dumps(value)}',
) )
cm.match('Can\'t use complex JSON value types') cm.match("Can't use complex JSON value types")
@pytest.mark.parametrize('input_json, expected_json', [ @pytest.mark.parametrize(
# Examples taken from https://www.w3.org/TR/html-json-forms/ 'input_json, expected_json',
( [
['bottle-on-wall:=1', 'bottle-on-wall:=2', 'bottle-on-wall:=3'], # Examples taken from https://www.w3.org/TR/html-json-forms/
{'bottle-on-wall': [1, 2, 3]}, (
), [
( 'bottle-on-wall[]:=1',
['pet[species]=Dahut', 'pet[name]:="Hypatia"', 'kids[1]=Thelma', 'kids[0]:="Ashley"'], 'bottle-on-wall[]:=2',
{'pet': {'species': 'Dahut', 'name': 'Hypatia'}, 'kids': ['Ashley', 'Thelma']}, 'bottle-on-wall[]:=3',
), ],
( {'bottle-on-wall': [1, 2, 3]},
['pet[0][species]=Dahut', 'pet[0][name]=Hypatia', 'pet[1][species]=Felis Stultus', 'pet[1][name]:="Billie"'], ),
{'pet': [{'species': 'Dahut', 'name': 'Hypatia'}, {'species': 'Felis Stultus', 'name': 'Billie'}]}, (
), [
( 'pet[species]=Dahut',
['wow[such][deep][3][much][power][!]=Amaze'], 'pet[name]:="Hypatia"',
{'wow': {'such': {'deep': [None, None, None, {'much': {'power': {'!': 'Amaze'}}}]}}}, 'kids[1]=Thelma',
), 'kids[0]:="Ashley"',
( ],
['mix=scalar', 'mix[0]=array 1', 'mix[2]:="array 2"', 'mix[key]:="key key"', 'mix[car]=car key'], {
{'mix': {'': 'scalar', '0': 'array 1', '2': 'array 2', 'key': 'key key', 'car': 'car key'}}, 'pet': {'species': 'Dahut', 'name': 'Hypatia'},
), 'kids': ['Ashley', 'Thelma'],
( },
['highlander[]=one'], ),
{'highlander': ['one']}, (
), [
( 'pet[0][species]=Dahut',
['error[good]=BOOM!', 'error[bad:="BOOM BOOM!"'], 'pet[0][name]=Hypatia',
{'error': {'good': 'BOOM!'}, 'error[bad': 'BOOM BOOM!'}, 'pet[1][species]=Felis Stultus',
), 'pet[1][name]:="Billie"',
( ],
['special[]:=true', 'special[]:=false', 'special[]:="true"', 'special[]:=null'], {
{'special': [True, False, 'true', None]}, 'pet': [
), {'species': 'Dahut', 'name': 'Hypatia'},
( {'species': 'Felis Stultus', 'name': 'Billie'},
[r'\[\]:=1', r'escape\[d\]:=1', r'escaped\[\]:=1', r'e\[s\][c][a][p]\[ed\][]:=1'], ]
{'[]': 1, 'escape[d]': 1, 'escaped[]': 1, 'e[s]': {'c': {'a': {'p': {'[ed]': [1]}}}}}, },
), ),
( (
['[]:=1', '[]=foo'], ['wow[such][deep][3][much][power][!]=Amaze'],
[1, 'foo'], {
), 'wow': {
( 'such': {
[']:=1', '[]1:=1', '[1]]:=1'], 'deep': [
{']': 1, '[]1': 1, '[1]]': 1}, None,
), None,
]) None,
def test_nested_json_syntax(input_json, expected_json, httpbin_both): {'much': {'power': {'!': 'Amaze'}}},
r = http(httpbin_both + '/post', *input_json) ]
}
}
},
),
(
['mix[]=scalar', 'mix[2]=something', 'mix[4]:="something 2"'],
{'mix': ['scalar', None, 'something', None, 'something 2']},
),
(
['highlander[]=one'],
{'highlander': ['one']},
),
(
['error[good]=BOOM!', r'error\[bad:="BOOM BOOM!"'],
{'error': {'good': 'BOOM!'}, 'error[bad': 'BOOM BOOM!'},
),
(
[
'special[]:=true',
'special[]:=false',
'special[]:="true"',
'special[]:=null',
],
{'special': [True, False, 'true', None]},
),
(
[
r'\[\]:=1',
r'escape\[d\]:=1',
r'escaped\[\]:=1',
r'e\[s\][c][a][p][\[ed\]][]:=1',
],
{
'[]': 1,
'escape[d]': 1,
'escaped[]': 1,
'e[s]': {'c': {'a': {'p': {'[ed]': [1]}}}},
},
),
(
['[]:=1', '[]=foo'],
[1, 'foo'],
),
(
[r'\]:=1', r'\[\]1:=1', r'\[1\]\]:=1'],
{']': 1, '[]1': 1, '[1]]': 1},
),
(
[
r'foo\[bar\][baz]:=1',
r'foo\[bar\]\[baz\]:=3',
r'foo[bar][\[baz\]]:=4',
],
{
'foo[bar]': {'baz': 1},
'foo[bar][baz]': 3,
'foo': {'bar': {'[baz]': 4}},
},
),
(
['key[]:=1', 'key[][]:=2', 'key[][][]:=3', 'key[][][]:=4'],
{'key': [1, [2], [[3]], [[4]]]},
),
(
['x[0]:=1', 'x[]:=2', 'x[]:=3', 'x[][]:=4', 'x[][]:=5'],
{'x': [1, 2, 3, [4], [5]]},
),
(
[
f'x=@{FILE_PATH}',
f'y[z]=@{FILE_PATH}',
f'q[u][]:=@{JSON_FILE_PATH}',
],
{
'x': FILE_CONTENT,
'y': {'z': FILE_CONTENT},
'q': {'u': [json.loads(JSON_FILE_CONTENT)]},
},
),
(
[
'foo[bar][5][]:=5',
'foo[bar][]:=6',
'foo[bar][][]:=7',
'foo[bar][][x]=dfasfdas',
'foo[baz]:=[1, 2, 3]',
'foo[baz][]:=4',
],
{
'foo': {
'bar': [
None,
None,
None,
None,
None,
[5],
6,
[7],
{'x': 'dfasfdas'},
],
'baz': [1, 2, 3, 4],
}
},
),
(
[
'foo[]:=1',
'foo[]:=2',
'foo[][key]=value',
'foo[2][key 2]=value 2',
r'foo[2][key \[]=value 3',
r'[nesting][under][!][empty][?][\\key]:=4',
],
{
'foo': [
1,
2,
{'key': 'value', 'key 2': 'value 2', 'key [': 'value 3'},
],
'': {
'nesting': {'under': {'!': {'empty': {'?': {'\\key': 4}}}}}
},
},
),
(
[
r'foo\[key\]:=1',
r'bar\[1\]:=2',
r'baz\[\]:3',
r'quux[key\[escape\]]:=4',
r'quux[key 2][\\][\\\\][\\\[\]\\\]\\\[\n\\]:=5',
],
{
'foo[key]': 1,
'bar[1]': 2,
'quux': {
'key[escape]': 4,
'key 2': {'\\': {'\\\\': {'\\[]\\]\\[\\n\\': 5}}},
},
},
),
(
[r'A[B\\]=C', r'A[B\\\\]=C', r'A[\B\\]=C'],
{'A': {'B\\': 'C', 'B\\\\': 'C', '\\B\\': 'C'}},
),
(
[
'name=python',
'version:=3',
'date[year]:=2021',
'date[month]=December',
'systems[]=Linux',
'systems[]=Mac',
'systems[]=Windows',
'people[known_ids][1]:=1000',
'people[known_ids][5]:=5000',
],
{
'name': 'python',
'version': 3,
'date': {'year': 2021, 'month': 'December'},
'systems': ['Linux', 'Mac', 'Windows'],
'people': {'known_ids': [None, 1000, None, None, None, 5000]},
},
),
],
)
def test_nested_json_syntax(input_json, expected_json, httpbin):
r = http(httpbin + '/post', *input_json)
assert r.json['json'] == expected_json assert r.json['json'] == expected_json
@pytest.mark.parametrize(
'input_json, expected_error',
[
(
['A[:=1'],
"HTTPie Syntax Error: Expecting a text, a number or ']'\nA[\n ^",
),
(['A[1:=1'], "HTTPie Syntax Error: Expecting ']'\nA[1\n ^"),
(['A[text:=1'], "HTTPie Syntax Error: Expecting ']'\nA[text\n ^"),
(
['A[text][:=1'],
"HTTPie Syntax Error: Expecting a text, a number or ']'\nA[text][\n ^",
),
(
['A[key]=value', 'B[something]=u', 'A[text][:=1', 'C[key]=value'],
"HTTPie Syntax Error: Expecting a text, a number or ']'\nA[text][\n ^",
),
(
['A[text]1:=1'],
"HTTPie Syntax Error: Expecting '['\nA[text]1\n ^",
),
(['A\\[]:=1'], "HTTPie Syntax Error: Expecting '['\nA\\[]\n ^"),
(
['A[something\\]:=1'],
"HTTPie Syntax Error: Expecting ']'\nA[something\\]\n ^",
),
(
['foo\\[bar\\]\\\\[ bleh:=1'],
"HTTPie Syntax Error: Expecting ']'\nfoo\\[bar\\]\\\\[ bleh\n ^",
),
(
['foo\\[bar\\]\\\\[ bleh :=1'],
"HTTPie Syntax Error: Expecting ']'\nfoo\\[bar\\]\\\\[ bleh \n ^",
),
(
['foo[bar][1]][]:=2'],
"HTTPie Syntax Error: Expecting '['\nfoo[bar][1]][]\n ^",
),
(
['foo[bar][1]something[]:=2'],
"HTTPie Syntax Error: Expecting '['\nfoo[bar][1]something[]\n ^^^^^^^^^",
),
(
['foo[bar][1][142241[]:=2'],
"HTTPie Syntax Error: Expecting ']'\nfoo[bar][1][142241[]\n ^",
),
(
['foo[bar][1]\\[142241[]:=2'],
"HTTPie Syntax Error: Expecting '['\nfoo[bar][1]\\[142241[]\n ^^^^^^^^",
),
(
['foo=1', 'foo[key]:=2'],
"HTTPie Type Error: Can't perform 'key' based access on 'foo' which has a type of 'string' but this operation requires a type of 'object'.\nfoo[key]\n ^^^^^",
),
(
['foo=1', 'foo[0]:=2'],
"HTTPie Type Error: Can't perform 'index' based access on 'foo' which has a type of 'string' but this operation requires a type of 'array'.\nfoo[0]\n ^^^",
),
(
['foo=1', 'foo[]:=2'],
"HTTPie Type Error: Can't perform 'append' based access on 'foo' which has a type of 'string' but this operation requires a type of 'array'.\nfoo[]\n ^^",
),
(
['data[key]=value', 'data[key 2]=value 2', 'data[0]=value'],
"HTTPie Type Error: Can't perform 'index' based access on 'data' which has a type of 'object' but this operation requires a type of 'array'.\ndata[0]\n ^^^",
),
(
['data[key]=value', 'data[key 2]=value 2', 'data[]=value'],
"HTTPie Type Error: Can't perform 'append' based access on 'data' which has a type of 'object' but this operation requires a type of 'array'.\ndata[]\n ^^",
),
(
[
'foo[bar][baz][5]:=[1,2,3]',
'foo[bar][baz][5][]:=4',
'foo[bar][baz][key][]:=5',
],
"HTTPie Type Error: Can't perform 'key' based access on 'foo[bar][baz]' which has a type of 'array' but this operation requires a type of 'object'.\nfoo[bar][baz][key][]\n ^^^^^",
),
(
['foo[-10]:=[1,2]'],
'HTTPie Value Error: Negative indexes are not supported.\nfoo[-10]\n ^^^',
),
],
)
def test_nested_json_errors(input_json, expected_error, httpbin):
with pytest.raises(HTTPieSyntaxError) as exc:
http(httpbin + '/post', *input_json)
assert str(exc.value) == expected_error
def test_nested_json_sparse_array(httpbin_both): def test_nested_json_sparse_array(httpbin_both):
r = http(httpbin_both + '/post', 'test[0]:=1', 'test[100]:=1') r = http(httpbin_both + '/post', 'test[0]:=1', 'test[100]:=1')
assert len(r.json['json']['test']) == 101 assert len(r.json['json']['test']) == 101