Messenger
django_slack_tools.messenger.backends
BaseBackend
Bases: ABC
Abstract base class for messaging backends.
Source code in django_slack_tools/messenger/backends/base.py
deliver(request)
Deliver message request.
Source code in django_slack_tools/messenger/backends/base.py
DummyBackend
Bases: BaseBackend
An dummy backend that does nothing with message.
Source code in django_slack_tools/messenger/backends/dummy.py
LoggingBackend
Bases: DummyBackend
Backend that log the message rather than sending it.
Source code in django_slack_tools/messenger/backends/logging_.py
SlackBackend
Bases: BaseBackend
Backend actually sending the messages.
Source code in django_slack_tools/messenger/backends/slack.py
__init__(*, slack_app)
Initialize backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
slack_app
|
App | str
|
Slack app instance or import string. |
required |
Source code in django_slack_tools/messenger/backends/slack.py
SlackRedirectBackend
Bases: SlackBackend
Inherited Slack backend with redirection to specific channels.
Source code in django_slack_tools/messenger/backends/slack.py
__init__(*, slack_app, redirect_channel, inform_redirect=True)
Initialize backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
slack_app
|
App | str
|
Slack app instance or import string. |
required |
redirect_channel
|
str
|
Slack channel to redirect. |
required |
inform_redirect
|
bool
|
Whether to append an attachment informing that the message has been redirected.
Defaults to |
True
|
Source code in django_slack_tools/messenger/backends/slack.py
django_slack_tools.messenger.message_templates
BaseTemplate
Bases: ABC
, Generic[_T]
Base class for templates.
Source code in django_slack_tools/messenger/message_templates/base.py
PythonTemplate
Bases: BaseTemplate[_PyObj]
Template that renders a dictionary.
Source code in django_slack_tools/messenger/message_templates/python.py
django_slack_tools.messenger.middlewares
BaseMiddleware
Base class for middleware components.
Source code in django_slack_tools/messenger/middlewares/base.py
process_request(request)
Process the incoming requests.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request
|
MessageRequest
|
Message request. |
required |
Returns:
Type | Description |
---|---|
MessageRequest | None
|
MessageRequest objects or |
Source code in django_slack_tools/messenger/middlewares/base.py
process_response(response)
Processes a sequence of MessageResponse objects and returns the processed sequence.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response
|
MessageResponse
|
Message response. |
required |
Returns:
Type | Description |
---|---|
MessageResponse | None
|
MessageResponse objects or |
Source code in django_slack_tools/messenger/middlewares/base.py
django_slack_tools.messenger.template_loaders
BaseTemplateLoader
Bases: ABC
Base class for template loaders.
Source code in django_slack_tools/messenger/template_loaders/base.py
TemplateLoadError
TemplateNotFoundError
Bases: TemplateLoadError
Template not found error.
django_slack_tools.messenger.messenger
Messenger
Messenger class that sends message using templates and middlewares.
Components evaluated in order:
- Request processing middlewares
- Load template by key and render message in-place
- Send message
- Response processing middlewares (in reverse order)
Source code in django_slack_tools/messenger/messenger.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
|
__init__(*, template_loaders, middlewares, messaging_backend)
Initialize the Messenger.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
template_loaders
|
Sequence[BaseTemplateLoader]
|
A sequence of template loaders. It is tried in order to load the template and the first one that returns a template is used. |
required |
middlewares
|
Sequence[BaseMiddleware]
|
A sequence of middlewares. Middlewares are applied in the order they are provided for request, and in reverse order for response. |
required |
messaging_backend
|
BaseBackend
|
The messaging backend to be used. |
required |
Source code in django_slack_tools/messenger/messenger.py
send(to, *, template=None, context, header=None)
Simplified shortcut for .send_request()
.
Source code in django_slack_tools/messenger/messenger.py
send_request(request)
Sends a message request and processes the response.
Source code in django_slack_tools/messenger/messenger.py
django_slack_tools.messenger.request
MessageBody
Bases: BaseModel
Source code in django_slack_tools/messenger/request.py
from_any(obj)
classmethod
Create instance from compatible types.
Source code in django_slack_tools/messenger/request.py
MessageHeader
Bases: BaseModel
Source code in django_slack_tools/messenger/request.py
from_any(obj=None)
classmethod
Create instance from compatible types.
Source code in django_slack_tools/messenger/request.py
MessageRequest
Bases: BaseModel
Message request object.
Source code in django_slack_tools/messenger/request.py
django_slack_tools.messenger.response
MessageResponse
Bases: BaseModel
Response from a messaging backend.