test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #15207 -- Added versionadded directives for the "using" argument sent by signals, and cleaned up some incidental indentation/formatting inconsistencies. Thanks to Keryn Knight for the report. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@15443 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Gabriel Hurley 2011-02-07 22:18:14 +00:00
parent f6e38f3800
commit 608877c066
1 changed files with 132 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

254
docs/ref/signals.txt
View File

@ -51,16 +51,16 @@ of the model's :meth:`~django.db.models.Model.__init__` method.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The model class that just had an instance created. The model class that just had an instance created.
``args`` ``args``
A list of positional arguments passed to A list of positional arguments passed to
:meth:`~django.db.models.Model.__init__`: :meth:`~django.db.models.Model.__init__`:
``kwargs`` ``kwargs``
A dictionary of keyword arguments passed to A dictionary of keyword arguments passed to
:meth:`~django.db.models.Model.__init__`:. :meth:`~django.db.models.Model.__init__`:.
For example, the :doc:`tutorial </intro/tutorial01>` has this line: For example, the :doc:`tutorial </intro/tutorial01>` has this line:
@ -91,11 +91,11 @@ Like pre_init, but this one is sent when the :meth:`~django.db.models.Model.__in
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
As above: the model class that just had an instance created. As above: the model class that just had an instance created.
``instance`` ``instance``
The actual instance of the model that's just been created. The actual instance of the model that's just been created.
pre_save pre_save
-------- --------
@ -108,14 +108,16 @@ method.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The model class. The model class.
``instance`` ``instance``
The actual instance being saved. The actual instance being saved.
``using`` .. versionadded:: 1.3
The database alias being used.
``using``
The database alias being used.
post_save post_save
--------- ---------
@ -128,17 +130,19 @@ Like :data:`pre_save`, but sent at the end of the
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The model class. The model class.
``instance`` ``instance``
The actual instance being saved. The actual instance being saved.
``created`` ``created``
A boolean; ``True`` if a new record was created. A boolean; ``True`` if a new record was created.
``using`` .. versionadded:: 1.3
The database alias being used.
``using``
The database alias being used.
pre_delete pre_delete
---------- ----------
@ -151,14 +155,16 @@ method.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The model class. The model class.
``instance`` ``instance``
The actual instance being deleted. The actual instance being deleted.
``using`` .. versionadded:: 1.3
The database alias being used.
``using``
The database alias being used.
post_delete post_delete
----------- -----------
@ -171,17 +177,19 @@ Like :data:`pre_delete`, but sent at the end of the
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The model class. The model class.
``instance`` ``instance``
The actual instance being deleted. The actual instance being deleted.
Note that the object will no longer be in the database, so be very Note that the object will no longer be in the database, so be very
careful what you do with this instance. careful what you do with this instance.
``using`` .. versionadded:: 1.3
The database alias being used.
``using``
The database alias being used.
m2m_changed m2m_changed
----------- -----------
@ -199,51 +207,53 @@ when it comes to tracking changes to models, it is included here.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The intermediate model class describing the :class:`ManyToManyField`. The intermediate model class describing the :class:`ManyToManyField`.
This class is automatically created when a many-to-many field is This class is automatically created when a many-to-many field is
defined; you can access it using the ``through`` attribute on the defined; you can access it using the ``through`` attribute on the
many-to-many field. many-to-many field.
``instance`` ``instance``
The instance whose many-to-many relation is updated. This can be an The instance whose many-to-many relation is updated. This can be an
instance of the ``sender``, or of the class the :class:`ManyToManyField` instance of the ``sender``, or of the class the :class:`ManyToManyField`
is related to. is related to.
``action`` ``action``
A string indicating the type of update that is done on the relation. A string indicating the type of update that is done on the relation.
This can be one of the following: This can be one of the following:
``"pre_add"`` ``"pre_add"``
Sent *before* one or more objects are added to the relation Sent *before* one or more objects are added to the relation
``"post_add"`` ``"post_add"``
Sent *after* one or more objects are added to the relation Sent *after* one or more objects are added to the relation
``"pre_remove"`` ``"pre_remove"``
Sent *after* one or more objects are removed from the relation Sent *after* one or more objects are removed from the relation
``"post_remove"`` ``"post_remove"``
Sent *after* one or more objects are removed from the relation Sent *after* one or more objects are removed from the relation
``"pre_clear"`` ``"pre_clear"``
Sent *before* the relation is cleared Sent *before* the relation is cleared
``"post_clear"`` ``"post_clear"``
Sent *after* the relation is cleared Sent *after* the relation is cleared
``reverse`` ``reverse``
Indicates which side of the relation is updated (i.e., if it is the Indicates which side of the relation is updated (i.e., if it is the
forward or reverse relation that is being modified). forward or reverse relation that is being modified).
``model`` ``model``
The class of the objects that are added to, removed from or cleared The class of the objects that are added to, removed from or cleared
from the relation. from the relation.
``pk_set`` ``pk_set``
For the ``pre_add``, ``post_add``, ``pre_remove`` and ``post_remove`` For the ``pre_add``, ``post_add``, ``pre_remove`` and ``post_remove``
actions, this is a list of primary key values that have been added to actions, this is a list of primary key values that have been added to
or removed from the relation. or removed from the relation.
For the ``pre_clear`` and ``post_clear`` actions, this is ``None``. For the ``pre_clear`` and ``post_clear`` actions, this is ``None``.
``using`` .. versionadded:: 1.3
The database alias being used.
``using``
The database alias being used.
For example, if a ``Pizza`` can have multiple ``Topping`` objects, modeled For example, if a ``Pizza`` can have multiple ``Topping`` objects, modeled
like this: like this:
@ -351,32 +361,32 @@ handlers are registered anywhere else they may not be loaded by
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The ``models`` module that was just installed. That is, if The ``models`` module that was just installed. That is, if
:djadmin:`syncdb` just installed an app called ``"foo.bar.myapp"``, :djadmin:`syncdb` just installed an app called ``"foo.bar.myapp"``,
``sender`` will be the ``foo.bar.myapp.models`` module. ``sender`` will be the ``foo.bar.myapp.models`` module.
``app`` ``app``
Same as ``sender``. Same as ``sender``.
``created_models`` ``created_models``
A list of the model classes from any app which :djadmin:`syncdb` has A list of the model classes from any app which :djadmin:`syncdb` has
created so far. created so far.
``verbosity`` ``verbosity``
Indicates how much information manage.py is printing on screen. See Indicates how much information manage.py is printing on screen. See
the :djadminopt:`--verbosity` flag for details. the :djadminopt:`--verbosity` flag for details.
Functions which listen for :data:`post_syncdb` should adjust what they Functions which listen for :data:`post_syncdb` should adjust what they
output to the screen based on the value of this argument. output to the screen based on the value of this argument.
``interactive`` ``interactive``
If ``interactive`` is ``True``, it's safe to prompt the user to input If ``interactive`` is ``True``, it's safe to prompt the user to input
things on the command line. If ``interactive`` is ``False``, functions things on the command line. If ``interactive`` is ``False``, functions
which listen for this signal should not try to prompt for anything. which listen for this signal should not try to prompt for anything.
For example, the :mod:`django.contrib.auth` app only prompts to create a For example, the :mod:`django.contrib.auth` app only prompts to create a
superuser when ``interactive`` is ``True``. superuser when ``interactive`` is ``True``.
For example, yourapp/signals/__init__.py could be written like:: For example, yourapp/signals/__init__.py could be written like::
@ -407,10 +417,10 @@ Sent when Django begins processing an HTTP request.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The handler class -- e.g. The handler class -- e.g.
:class:`django.core.handlers.wsgi.WsgiHandler` -- that handled :class:`django.core.handlers.wsgi.WsgiHandler` -- that handled
the request. the request.
request_finished request_finished
---------------- ----------------
@ -422,8 +432,8 @@ Sent when Django finishes processing an HTTP request.
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The handler class, as above. The handler class, as above.
got_request_exception got_request_exception
--------------------- ---------------------
@ -435,11 +445,11 @@ This signal is sent whenever Django encounters an exception while processing an
Arguments sent with this signal: Arguments sent with this signal:
``sender`` ``sender``
The handler class, as above. The handler class, as above.
``request`` ``request``
The :class:`~django.http.HttpRequest` object. The :class:`~django.http.HttpRequest` object.
Test signals Test signals
============ ============
@ -460,15 +470,15 @@ normal operation of a Django server -- it is only available during testing.
Arguments sent with this signal: Arguments sent with this signal:
sender ``sender``
The :class:`~django.template.Template` object which was rendered. The :class:`~django.template.Template` object which was rendered.
template ``template``
Same as sender Same as sender
context ``context``
The :class:`~django.template.Context` with which the template was The :class:`~django.template.Context` with which the template was
rendered. rendered.
Database Wrappers Database Wrappers
================= =================
@ -494,12 +504,12 @@ connection commands to the SQL backend.
Arguments sent with this signal: Arguments sent with this signal:
sender ``sender``
The database wrapper class -- i.e. The database wrapper class -- i.e.
:class:`django.db.backends.postgresql_psycopg2.DatabaseWrapper` or :class:`django.db.backends.postgresql_psycopg2.DatabaseWrapper` or
:class:`django.db.backends.mysql.DatabaseWrapper`, etc. :class:`django.db.backends.mysql.DatabaseWrapper`, etc.
connection ``connection``
The database connection that was opened. This can be used in a The database connection that was opened. This can be used in a
multiple-database configuration to differentiate connection signals multiple-database configuration to differentiate connection signals
from different databases. from different databases.