[Django] #33163: Detail how to connect signals
Django
-------------------------------------+-------------------------------------
Reporter: | Owner: roxanebellot
roxanebellot |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 3.2
Documentation | Keywords: documentation
Severity: Normal | signals app config
Triage Stage: | Has patch: 1
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
See https://forum.djangoproject.com/t/load-signals-automatically/9666
My original idea was to import automatically everything in the submodule
`signals` to avoid wondering why the signals do not work. Finally, we
setted on detailling the documentation, expanding the
[https://docs.djangoproject.com/en/dev/topics/signals/#connecting-
receiver-functions "Where should this code live ?" note] and including a
sample AppConfig
--
Ticket URL: <https://code.djangoproject.com/ticket/33163>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Type: | roxanebellot
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:
Keywords: documentation | Triage Stage:
signals app config | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by roxanebellot):
You can find the [https://github.com/django/django/pull/14925 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:1>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* cc: Adam Johnson (added)
* keywords: documentation signals app config => signals appconfig
* stage: Unreviewed => Accepted
* needs_better_patch: 0 => 1
Comment:
Thanks for this suggestion. I agree that `AppConfig.ready()` example would
be helpful, but I don't think a separate section is needed.
[https://github.com/django/django/pull/14925 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:2>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:3>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: signals appconfig | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"350d15d79c01d2dd7c6c3196a4a01a5f63b45148" 350d15d7]:
{{{
#!CommitTicketReference repository=""
revision="350d15d79c01d2dd7c6c3196a4a01a5f63b45148"
[4.0.x] Fixed #33163 -- Added example of connection signal handlers in
AppConfig.ready() to docs.
Backport of 2d124f6a1c45afdde8be90c01043e0b14455d41e from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:5>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: signals appconfig | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"2d124f6a1c45afdde8be90c01043e0b14455d41e" 2d124f6a]:
{{{
#!CommitTicketReference repository=""
revision="2d124f6a1c45afdde8be90c01043e0b14455d41e"
Fixed #33163 -- Added example of connection signal handlers in
AppConfig.ready() to docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:4>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: signals appconfig | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"75ee7057e98dd9725fabb98cabe42966fa4c8222" 75ee7057]:
{{{
#!CommitTicketReference repository=""
revision="75ee7057e98dd9725fabb98cabe42966fa4c8222"
Refs #33163 -- Corrected example of connection signal handlers in
AppConfig.ready().
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:6>
Django
functions.
-------------------------------------+-------------------------------------
Reporter: roxanebellot | Owner:
Type: | roxanebellot
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: signals appconfig | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"1ab5842760749e5cc8e46ebf794b3071b6c31ccf" 1ab58427]:
{{{
#!CommitTicketReference repository=""
revision="1ab5842760749e5cc8e46ebf794b3071b6c31ccf"
[4.0.x] Refs #33163 -- Corrected example of connection signal handlers in
AppConfig.ready().
Backport of 75ee7057e98dd9725fabb98cabe42966fa4c8222 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33163#comment:7>