openstack/deb-python-falcon
Code Issues Proposed changes

fix(CompiledRouter): Provide a detailed error message for route conflicts (#984)

Browse Source 
Many people are confused by the terse error message that "The URI
template for this route conflicts with another route's template."

Expand this message to provide an example of what typically causes
this conflict, and how to remedy it.
This commit is contained in:
Kurt Griffiths
2017-01-26 14:28:39 -07:00
committed by Fran Fitzpatrick
parent f690c4a634
commit ca79d36c9c
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
falcon/routing/compiled.py
View File

@@ -83,9 +83,17 @@ class CompiledRouter(object):
return
if node.conflicts_with(segment):
raise ValueError('The URI template for this route '
"conflicts with another route's "
'template.')
msg = (
'The URI template for this route conflicts with another'
"route's template. This is usually caused by using "
'different field names at the same level in the path. '
'For example, given the route paths '
"'/parents/{id}' and '/parents/{parent_id}/children', "
'the conflict can be resolved by renaming one of the '
'fields to match the other, i.e.: '
"'/parents/{parent_id}' and '/parents/{parent_id}/children'."
)
raise ValueError(msg)
# NOTE(richardolsson): If we got this far, the node doesn't already
# exist and needs to be created. This builds a new branch of the