Django documentation

API stability

This document describes Django version 0.95. For current documentation, go here.

Although Django has not reached a 1.0 release, the bulk of Django’s public APIs are stable as of the 0.95 release. This document explains which APIs will and will not change before the 1.0 release.

What “stable” means

In this context, stable means:

  • All the public APIs — everything documented in the linked documents, and all methods that don’t begin with an underscore — will not be moved or renamed without providing backwards-compatible aliases.
  • If new features are added to these APIs — which is quite possible — they will not break or change the meaning of existing methods. In other words, “stable” does not (necessarily) mean “complete.”
  • If, for some reason, an API declared stable must be removed or replaced, it will be declared deprecated but will remain in the API until at least version 1.1. Warnings will be issued when the deprecated method is called.
  • We’ll only break backwards compatibility of these APIs if a bug or security hole makes it completely unavoidable.

Stable APIs

These APIs are stable:

You’ll notice that this list comprises the bulk of Django’s APIs. That’s right — most of the changes planned between now and Django 1.0 are either under the hood, feature additions, or changes to a few select bits. A good estimate is that 90% of Django can be considered forwards-compatible at this point.

That said, these APIs should not be considered stable, and are likely to change:

  • Forms and validation will most likely be compeltely rewritten to deemphasize Manipulators in favor of validation-aware models.
  • Serialization is under heavy development; changes are likely.
  • The authentication framework is changing to be far more flexible, and API changes may be necessary.
  • Generic relations will most likely be moved out of core and into the content-types contrib package to avoid core dependacies on optional components.
  • The comments framework, which is yet undocumented, will likely get a complete rewrite before Django 1.0. Even if the change isn’t quite that drastic, there will at least be moderate changes.

Questions/Feedback

If you notice errors with this documentation, please open a ticket and let us know!

Please only use the ticket tracker for criticisms and improvements on the docs. For tech support, ask in the IRC channel or post to the django-users list.