"Fossies" - the Fresh Open Source Software Archive

Member "Django-1.11.25/docs/misc/api-stability.txt" (1 Oct 2019, 2492 Bytes) of package /linux/www/Django-1.11.25.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 =============
    2 API stability
    3 =============
    4 
    5 Django promises API stability and forwards-compatibility since version 1.0. In
    6 a nutshell, this means that code you develop against a version of Django will
    7 continue to work with future releases. You may need to make minor changes when
    8 upgrading the version of Django your project uses: see the "Backwards
    9 incompatible changes" section of the :doc:`release note </releases/index>` for
   10 the version or versions to which you are upgrading.
   11 
   12 What "stable" means
   13 ===================
   14 
   15 In this context, stable means:
   16 
   17 - All the public APIs (everything in this documentation) will not be moved
   18   or renamed without providing backwards-compatible aliases.
   19 
   20 - If new features are added to these APIs -- which is quite possible --
   21   they will not break or change the meaning of existing methods. In other
   22   words, "stable" does not (necessarily) mean "complete."
   23 
   24 - If, for some reason, an API declared stable must be removed or replaced, it
   25   will be declared deprecated but will remain in the API for at least two
   26   feature releases. Warnings will be issued when the deprecated method is
   27   called.
   28 
   29   See :ref:`official-releases` for more details on how Django's version
   30   numbering scheme works, and how features will be deprecated.
   31 
   32 - We'll only break backwards compatibility of these APIs if a bug or
   33   security hole makes it completely unavoidable.
   34 
   35 Stable APIs
   36 ===========
   37 
   38 In general, everything covered in the documentation -- with the exception of
   39 anything in the :doc:`internals area </internals/index>` is considered stable.
   40 
   41 Exceptions
   42 ==========
   43 
   44 There are a few exceptions to this stability and backwards-compatibility
   45 promise.
   46 
   47 Security fixes
   48 --------------
   49 
   50 If we become aware of a security problem -- hopefully by someone following our
   51 :ref:`security reporting policy <reporting-security-issues>` -- we'll do
   52 everything necessary to fix it. This might mean breaking backwards
   53 compatibility; security trumps the compatibility guarantee.
   54 
   55 APIs marked as internal
   56 -----------------------
   57 
   58 Certain APIs are explicitly marked as "internal" in a couple of ways:
   59 
   60 - Some documentation refers to internals and mentions them as such. If the
   61   documentation says that something is internal, we reserve the right to
   62   change it.
   63 
   64 - Functions, methods, and other objects prefixed by a leading underscore
   65   (``_``). This is the standard Python way of indicating that something is
   66   private; if any method starts with a single ``_``, it's an internal API.