encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-04 04:20:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Adjust insert_into to raise ValueError

Browse Source
This commit is contained in:
Carlton Gibson 2017-10-05 09:25:48 +02:00
parent fa87a95636
commit a73aa6b5ec
2 changed files with 31 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
rest_framework/schemas/generators.py
View File

@ -51,6 +51,19 @@ def is_api_view(callback):
return (cls is not None) and issubclass(cls, APIView) return (cls is not None) and issubclass(cls, APIView)
INSERT_INTO_COLLISION_FMT = """
Schema Naming Collision.
coreapi.Link for URL path {value_url} cannot be inserted into schema.
Position conflicts with coreapi.Link for URL path {target_url}.
Attemped to insert link with keys: {keys}.
Adjust URLs to avoid naming collision or override `SchemaGenerator.get_keys()`
to customise schema structure.
"""
def insert_into(target, keys, value): def insert_into(target, keys, value):
""" """
Nested dictionary insertion. Nested dictionary insertion.
@ -64,7 +77,15 @@ def insert_into(target, keys, value):
if key not in target: if key not in target:
target[key] = {} target[key] = {}
target = target[key] target = target[key]
target[keys[-1]] = value try:
target[keys[-1]] = value
except TypeError:
msg = INSERT_INTO_COLLISION_FMT.format(
value_url=value.url,
target_url=target.url,
keys=keys
)
raise ValueError(msg)
def is_custom_action(action): def is_custom_action(action):

12
tests/test_schemas.py
View File

@ -778,7 +778,9 @@ class TestURLNamingCollisions(TestCase):
] ]
generator = SchemaGenerator(title='Naming Colisions', patterns=patterns) generator = SchemaGenerator(title='Naming Colisions', patterns=patterns)
schema = generator.get_schema()
with pytest.raises(ValueError):
generator.get_schema()
def test_manually_routing_generic_view(self): def test_manually_routing_generic_view(self):
patterns = [ patterns = [
@ -793,7 +795,9 @@ class TestURLNamingCollisions(TestCase):
] ]
generator = SchemaGenerator(title='Naming Colisions', patterns=patterns) generator = SchemaGenerator(title='Naming Colisions', patterns=patterns)
schema = generator.get_schema()
with pytest.raises(ValueError):
generator.get_schema()
def test_from_router(self): def test_from_router(self):
patterns = [ patterns = [
@ -801,4 +805,6 @@ class TestURLNamingCollisions(TestCase):
] ]
generator = SchemaGenerator(title='Naming Colisions', patterns=patterns) generator = SchemaGenerator(title='Naming Colisions', patterns=patterns)
schema = generator.get_schema()
with pytest.raises(ValueError):
generator.get_schema()