Madiator2011/lbry-sdk
1
0
Fork 0
forked from LBRYCommunity/lbry-sdk
Code Pull requests Activity

raise when -- ends up in a continuation line instead of auto fixing

Browse source
This commit is contained in:
Victor Shyba 2020-09-04 00:42:52 -03:00
parent c981c767b9
commit 42b7f8ff71
2 changed files with 15 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lbry/service/parser.py
View file

@ -218,9 +218,8 @@ def generate_options(method, indent) -> List[str]:
# dont break on -- or docopt will parse as a new option # dont break on -- or docopt will parse as a new option
for line_number, line in enumerate(wrapped): for line_number, line in enumerate(wrapped):
if line.strip().startswith('--'): if line.strip().startswith('--'):
lines[-1] = lines[-1] + ' ' + line.strip() raise Exception(f"Continuation line starts with -- on {method['cli']}: \"{line.strip()}\"")
else: lines.append(f"{' ' * len(left)} {line}")
lines.append(f"{' ' * len(left)} {line}")
options.extend(lines) options.extend(lines)
return options return options

38
tests/unit/service/test_parser.py
View file

@ -45,6 +45,9 @@ class FakeAPI:
) -> Paginated[Wallet]: # list of wallets ) -> Paginated[Wallet]: # list of wallets
"""list command doc""" """list command doc"""
def thing_save(self, **another_test_kwargs):
"""save command doc"""
def thing_update(self, value1: str) -> Wallet: # updated wallet def thing_update(self, value1: str) -> Wallet: # updated wallet
"""update command doc""" """update command doc"""
@ -89,11 +92,20 @@ class BadAPI(FakeAPI):
class TestParser(TestCase): class TestParser(TestCase):
maxDiff = None maxDiff = None
def test_parse_does_not_duplicate_arguments(self): def test_parse_does_not_allow_duplicate_arguments(self):
with self.assertRaises(Exception) as exc: with self.assertRaises(Exception) as exc:
parse_method(BadAPI.thing_search, get_expanders()) parse_method(BadAPI.thing_search, get_expanders())
self.assertEqual(exc.exception.args[0], "Expander 'another_test' argument repeated: thing_search.") self.assertEqual(exc.exception.args[0], "Expander 'another_test' argument repeated: thing_search.")
def test_parse_does_not_allow_line_break_with_two_dashes(self):
# breaking with two dashes breaks docopt parsing
with self.assertRaises(Exception) as exc:
get_api_definitions(FakeAPI)
self.assertEqual(
exc.exception.args[0],
"Continuation line starts with -- on thing save: \"--angry [default: 3]\""
)
def test_parse_method(self): def test_parse_method(self):
expanders = get_expanders() expanders = get_expanders()
self.assertEqual( self.assertEqual(
@ -301,27 +313,3 @@ class TestGenerator(TestCase):
(str) cheese (str) cheese
foo bar""") foo bar""")
) )
def test_parse_does_not_break_with_two_dashes(self):
# breaking with two dashes breaks docopt parsing
definitions = get_api_definitions(FakeAPI)
self.assertEqual(definitions['commands']['thing_search']['help'], """search command doc
Usage:
thing search [--query=<query>]
[--somevalue=<somevalue>] [--repeated=<repeated>]
[--bad_description=<bad_description>] [--angry=<angry>]
Options:
--query=<query> : (str) [default: 'a']
--somevalue=<somevalue> : (int) [default: 1]
--repeated=<repeated> : (int) [default: 2]
--bad_description=<bad_description> : (int) using linebreaks makes docopt very very --angry [default: 3]
--angry=<angry> : (int) [default: 4]
Returns:
(Wallet)
{
"id": "wallet_id",
"name": "optional wallet name"
}""")