Skip to content

Commit eab9b4a

Browse files
committed
more tests in parsing core
1 parent cb69db6 commit eab9b4a

3 files changed

Lines changed: 94 additions & 15 deletions

File tree

‎paths_cli/parsing/core.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ def parse_attrs(self, dct):
232232
return new_dct
233233

234234
def __call__(self, dct):
235+
# TODO: convert this to taking **dct -- I think that makes more
236+
# sense
235237
ops_dct = self.parse_attrs(dct)
236238
self.logger.debug("Building...")
237239
self.logger.debug(ops_dct)
@@ -258,7 +260,7 @@ def _parse_str(self, name):
258260
try:
259261
return self.named_objs[name]
260262
except KeyError as e:
261-
raise e # TODO: replace with better error
263+
raise InputError.unknown_name(self.label, name)
262264

263265
def _parse_dict(self, dct):
264266
dct = dct.copy() # make a local copy
@@ -272,23 +274,23 @@ def _parse_dict(self, dct):
272274
def register_object(self, obj, name):
273275
if name is not None:
274276
if name in self.named_objs:
275-
raise InputError(f"An object of type {self.name} and name "
277+
raise InputError(f"An object of type {self.label} and name "
276278
f"{name} already exists.")
277-
obj = obj.named(name)
278279
self.named_objs[name] = obj
279-
obj = obj.named(name)
280+
obj = obj.named(name)
280281
self.all_objs.append(obj)
281282
return obj
282283

283284
def register_builder(self, builder, name):
284285
if name in self.type_dispatch:
285-
msg = (f"'{builder.name}' is already registered "
286+
msg = (f"'{name}' is already registered "
286287
f"with {self.label}")
287288
if self.error_on_duplicate:
288289
raise RuntimeError(msg)
289290
else:
290291
warnings.warn(msg)
291-
self.type_dispatch[name] = builder
292+
else:
293+
self.type_dispatch[name] = builder
292294

293295
def parse(self, dct):
294296
if isinstance(dct, str):

‎paths_cli/parsing/errors.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
class InputError(Exception):
2+
"""Raised when users provide bad input in files/interactive sessions.
3+
"""
24
@classmethod
35
def invalid_input(cls, value, attr, type_name=None, name=None):
46
msg = f"'{value}' is not a valid input for {attr}"

‎paths_cli/tests/parsing/test_core.py‎

Lines changed: 84 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@
77

88
from paths_cli.parsing.core import *
99

10+
class MockNamedObject:
11+
# used in the tests for Parser._parse_dict and Parser.register_object
12+
def __init__(self, data):
13+
self.data = data
14+
self.name = None
15+
16+
def named(self, name):
17+
self.name = name
18+
return self
19+
20+
def mock_named_object_factory(dct):
21+
return MockNamedObject(**dct)
22+
23+
1024
class TestParameter:
1125
def setup(self):
1226
self.loader = Mock(
@@ -180,40 +194,101 @@ def test_call(self):
180194

181195

182196
class TestParser:
197+
def setup(self):
198+
self.parser = Parser(
199+
{'foo': mock_named_object_factory},
200+
'foo_parser'
201+
)
202+
203+
def _mock_register_obj(self):
204+
obj = "bar"
205+
self.parser.all_objs.append(obj)
206+
self.parser.named_objs['foo'] = obj
207+
183208
def test_parse_str(self):
184209
# parse_str should load a known object with the input name
185-
pytest.skip()
210+
self._mock_register_obj()
211+
assert self.parser._parse_str('foo') == "bar"
186212

187213
def test_parse_str_error(self):
188214
# if parse_str is given a name that is not known, an InputError
189215
# should be raised
190-
pytest.skip()
216+
self._mock_register_obj()
217+
with pytest.raises(InputError, match="Unable to find"):
218+
self.parser._parse_str('baz')
191219

192-
def test_parse_dict(self):
220+
@pytest.mark.parametrize('named', [True, False])
221+
def test_parse_dict(self, named):
193222
# parse_dct should create the object from the input dict
194-
pytest.skip()
223+
input_dict = {'type': 'foo', 'data': "qux"}
224+
if named:
225+
input_dict['name'] = 'bar'
226+
227+
obj = self.parser._parse_dict(input_dict)
228+
assert obj.data == "qux"
229+
name = {True: 'bar', False: None}[named]
230+
assert obj.name == name
195231

196232
def test_register_object_named(self):
197233
# when registered, a named object should register with the all_objs
198234
# list and with the named_objs dict
199-
pytest.skip()
235+
obj = MockNamedObject('foo')
236+
assert obj.name is None
237+
assert self.parser.all_objs == []
238+
assert self.parser.named_objs == {}
239+
obj = self.parser.register_object(obj, 'bar')
240+
assert obj.name == 'bar'
241+
assert self.parser.all_objs == [obj]
242+
assert self.parser.named_objs == {'bar': obj}
200243

201244
def test_register_object_unnamed(self):
202245
# when registered, an unnamed object should register with the
203246
# all_objs list and leave the named_objs dict unchanged
204-
pytest.skip()
247+
obj = MockNamedObject('foo')
248+
assert obj.name is None
249+
assert self.parser.all_objs == []
250+
assert self.parser.named_objs == {}
251+
obj = self.parser.register_object(obj, None)
252+
assert obj.name is None
253+
assert self.parser.all_objs == [obj]
254+
assert self.parser.named_objs == {}
205255

206256
def test_register_object_duplicate(self):
207257
# if an attempt is made to register an object with a name that is
208258
# already in use, an InputError should be raised, and the object
209259
# should not register with either all_objs or named_objs
210-
pytest.skip()
260+
obj = MockNamedObject('foo').named('bar')
261+
self.parser.named_objs['bar'] = obj
262+
self.parser.all_objs.append(obj)
263+
obj2 = MockNamedObject('baz')
264+
with pytest.raises(InputError, match="already exists"):
265+
self.parser.register_object(obj2, 'bar')
266+
267+
assert self.parser.named_objs == {'bar': obj}
268+
assert self.parser.all_objs == [obj]
269+
assert obj2.name is None
211270

212271
def test_register_builder(self):
213-
pytest.skip()
272+
# a new builder can be registered and used, if it has a new name
273+
assert len(self.parser.type_dispatch) == 1
274+
assert 'bar' not in self.parser.type_dispatch
275+
self.parser.register_builder(lambda dct: 10, 'bar')
276+
assert len(self.parser.type_dispatch) == 2
277+
assert 'bar' in self.parser.type_dispatch
278+
input_dict = {'type': 'bar'}
279+
assert self.parser(input_dict) == 10
214280

215281
def test_register_builder_duplicate(self):
216-
pytest.skip()
282+
# if an attempt is made to registered a builder with a name that is
283+
# already in use, a RuntimeError is raised
284+
orig = self.parser.type_dispatch['foo']
285+
# TODO: this should be an error; need to figure out how to avoid
286+
# duplication
287+
# with pytest.raises(RuntimeError, match="already registered"):
288+
with pytest.warns(UserWarning, match="already registered"):
289+
self.parser.register_builder(lambda dct: 10, 'foo')
290+
291+
assert self.parser.type_dispatch['foo'] is orig
217292

218293
@pytest.mark.parametrize('input_type', ['str', 'dict'])
219294
def test_parse(self, input_type):

0 commit comments

Comments
 (0)