What is a NoReverseMatch error, and how do I fix it?

The NoReverseMatch error is saying that Django cannot find a matching url pattern for the url you’ve provided in any of your installed app’s urls.

The NoReverseMatch exception is raised by django.core.urlresolvers when a matching URL in your URLconf cannot be identified based on the parameters supplied.

To start debugging it, you need to start by disecting the error message given to you.

  • NoReverseMatch at /my_url/ This is the url that is currently being rendered, it is this url that your application is currently trying to access but it contains a url that cannot be matched
  • Reverse for ‘my_url_name’ This is the name of the url that it cannot find
  • with arguments ‘()’ and These are the non-keyword arguments its providing to the url
  • keyword arguments ‘{}’ not found. These are the keyword arguments its providing to the url
  • n pattern(s) tried: [] These are the patterns that it was able to find in your urls.py files that it tried to match against

Start by locating the code in your source relevant to the url that is currently being rendered – the url, the view, and any templates involved. In most cases, this will be the part of the code you’re currently developing.

Once you’ve done this, read through the code in the order that django would be following until you reach the line of code that is trying to construct a url for your my_url_name. Again, this is probably in a place you’ve recently changed.

Now that you’ve discovered where the error is occuring, use the other parts of the error message to work out the issue.

The url name

  • Are there any typos?
  • Have you provided the url you’re trying to access the given name?
  • If you have set app_name in the app’s urls.py (e.g. app_name = 'my_app') or if you included the app with a namespace (e.g. include('myapp.urls', namespace='myapp'), then you need to include the namespace when reversing, e.g. {% url 'myapp:my_url_name' %} or reverse('myapp:my_url_name').

Arguments and Keyword Arguments

The arguments and keyword arguments are used to match against any capture groups that are present within the given url which can be identified by the surrounding () brackets in the url pattern.

Assuming the url you’re matching requires additional arguments, take a look in the error message and first take a look if the value for the given arguments look to be correct.

If they aren’t correct:

  • The value is missing or an empty string This generally means that the value you’re passing in doesn’t contain the value you expect it to be. Take a look where you assign the value for it, set breakpoints, and you’ll need to figure out why this value doesn’t get passed through correctly.
  • The keyword argument has a typo Correct this either in the url pattern, or in the url you’re constructing.

If they are correct:

  • Debug the regex You can use a website such as regexr to quickly test whether your pattern matches the url you think you’re creating, Copy the url pattern into the regex field at the top, and then use the text area to include any urls that you think it should match against. Common Mistakes:
    • Matching against the . wild card character or any other regex characters Remember to escape the specific characters with a \ prefix
    • Only matching against lower/upper case characters Try using either a-Z or \w instead of a-z or A-Z
  • Check that pattern you’re matching is included within the patterns tried If it isn’t here then its possible that you have forgotten to include your app within the INSTALLED_APPS setting (or the ordering of the apps within INSTALLED_APPS may need looking at)

Django Version

In Django 1.10, the ability to reverse a url by its python path was removed. The named path should be used instead.

If you’re still unable to track down the problem, then feel free to ask a new question that includes what you’ve tried, what you’ve researched (You can link to this question), and then include the relevant code to the issue – the url that you’re matching, any relevant url patterns, the part of the error message that shows what django tried to match, and possibly the INSTALLED_APPS setting if applicable.

Related Posts:

  1. How can I upgrade specific packages using pip and a requirements file?
  2. How to switch Python versions in Terminal?
  3. ‘NOT NULL constraint failed’ after adding to models.py
  4. django display message after POST form submit
  5. CommandError: You must set settings.ALLOWED_HOSTS if DEBUG is False
  6. “The path python3 (from –python=python3) does not exist” error
  7. How can I get the file name from request.FILES?
  8. Django TemplateDoesNotExist?
  9. Django: no such table: django_session
  10. Implementing a SOA in Django using celery
  11. Django 1.7 upgrade error: AppRegistryNotReady: Apps aren’t loaded yet
  12. Python/Django: log to console under runserver, log to file under Apache
  13. python: can’t open file ‘manage.py’: [Errno 2] No such file or directory
  14. Is it better to use path() or url() in urls.py for django 2.0?
  15. What is the use of PYTHONUNBUFFERED in docker file?
  16. Cannot find command ‘git’ – windows
  17. How to revert the last migration?
  18. Output Django queryset as JSON
  19. Getting stuck at Django error: No module named registration
  20. Django __str__ returned non-string (type NoneType)
  21. ow to ‘bulk update’ with Django?
  22. Why do I get sqlite error, “unable to open database file”?
  23. Where does pip install its packages?
  24. Does Python have a toString() equivalent, and can I convert a class to String?
  25. Where does pip install its packages?
  26. django: TypeError: ‘tuple’ object is not callable
  27. Getting TypeError: __init__() missing 1 required positional argument: ‘on_delete’ when trying to add parent table after child table with entries
  28. Can’t fix “zipimport.ZipImportError: can’t decompress data; zlib not available” when I type in “python3.6 get-pip.py”
  29. No module named ‘psycopg2’
  30. Is #include bad practice?
  31. Getting TypeError: __init__() missing 1 required positional argument: ‘on_delete’ when trying to add parent table after child table with entries
  32. No module named MySQLdb
  33. No module named MySQLdb
  34. How to check Django version
  35. python3 is not recognized as an internal or external command, operable program or batch file showing for creating django runserver
  36. Django: ImproperlyConfigured: The SECRET_KEY setting must not be empty
  37. is not JSON serializable
  38. Django: ImproperlyConfigured: The SECRET_KEY setting must not be empty
  39. Install mysql-python (Windows)
  40. Can’t connect to local MySQL server through socket ‘/tmp/mysql.sock
  41. django:django.core.exceptions.AppRegistryNotReady: Apps aren’t loaded yet
  42. No module named pkg_resources
  43. Django upgrading to 1.9 error “AppRegistryNotReady: Apps aren’t loaded yet.”
  44. Can’t compare naive and aware datetime.now() <= challenge.datetime_end
  45. django import error – No module named core.management
  46. Forbidden (403) CSRF verification failed. Request aborted. Even using the {% csrf_token %}
  47. Django 2.1.3 Error: __init__() takes 1 positional argument but 2 were given
  48. Can’t connect to local MySQL server through socket ‘/tmp/mysql.sock
  49. Setting Django up to use MySQL
  50. django:django.core.exceptions.AppRegistryNotReady: Apps aren’t loaded yet
  51. OSError – Errno 13 Permission denied
  52. React Error: Target Container is not a DOM Element
  53. Pylint “unresolved import” error in Visual Studio Code
  54. Django – no such table exception
  55. django MultiValueDictKeyError error, how do I deal with it
  56. Django – no such table exception
  57. Print type of variable in python3.5 on django 1.8
  58. Is there a list of Pytz Timezones?
  59. Django – “no module named django.core.management”
  60. Error: “dictionary update sequence element #0 has length 1; 2 is required” on Django 1.4
  61. In Django, how do I know the currently logged-in user?
  62. NumPy array is not JSON serializable
  63. You are trying to add a non-nullable field ‘new_field’ to userprofile without a default
  64. pip install -r requirements.txt [Errno 2] No such file or directory: ‘requirements.txt’
  65. super(type, obj): obj must be an instance or subtype of type
  66. Django Rest Framework — no module named rest_framework
  67. Error: “dictionary update sequence element #0 has length 1; 2 is required” on Django 1.4
  68. Python Django: You’re using the staticfiles app without having set the STATIC_ROOT setting
  69. sqlite3.OperationalError: unable to open database file
  70. TypeError: int() argument must be a string, a bytes-like object or a number, not ‘list’
  71. Django reverse lookup of foreign keys
  72. ImportError: No module named ‘django.core.urlresolvers’
  73. How to fix error “ERROR: Command errored out with exit status 1: python.” when trying to install django-heroku using pip
  74. How to set environment variables in PyCharm?
  75. H14 error in heroku – “no web processes running”
  76. What does this Django regular expression mean? `?P`
  77. OperationalError: database is locked
  78. Uncaught Reference Error: stLight is not defined (in Chrome only)
  79. What is a “slug” in Django?
  80. TemplateDoesNotExist at /
  81. No module named django but it is installed
  82. What is the easiest way to clear a database from the CLI with manage.py in Django?
  83. What does on_delete do on Django models?
  84. Check if an object exists
  85. Find object in list that has attribute equal to some value (that meets any condition)
  86. How to check if a user is logged in (how to properly use user.is_authenticated)?
  87. The view didn’t return an HttpResponse object. It returned None instead
  88. CSV new-line character seen in unquoted field error
  89. gunicorn.errors.HaltServer: django
  90. coercing to Unicode: need string or buffer, NoneType found when rendering in django admin
  91. coercing to Unicode: need string or buffer, NoneType found when rendering in django admin
  92. How to query as GROUP BY in django?
  93. Error loading MySQLdb module: No module named ‘MySQLdb’
  94. What is related_name used for?
  95. TypeError: ManyRelatedManager object is not iterable
  96. What is the most efficient way to store a list in the Django models?
  97. Line is too long. Django PEP8
  98. __init__() got an unexpected keyword argument ‘user’
  99. Why do I need Nginx and something like Gunicorn?
  100. Why do I need nginx when I have uWSGI

Leave a Comment

tech