django-slack-tools 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

django_slack_tools/slack_messages/message.py

@@ -1,110 +0,0 @@
-"""Handy APIs for sending Slack messages."""
-
-from __future__ import annotations
-
-import logging
-from typing import TYPE_CHECKING, Any
-
-from django_slack_tools.app_settings import app_settings
-from django_slack_tools.slack_messages.models.message_recipient import SlackMessageRecipient
-from django_slack_tools.utils.slack import MessageBody, MessageHeader
-
-from .models import SlackMessagingPolicy
-
-logger = logging.getLogger(__name__)
-
-if TYPE_CHECKING:
-    from django_slack_tools.slack_messages.backends.base import BaseBackend
-
-    from .models import SlackMessage
-
-
-def slack_message(  # noqa: PLR0913
-    body: str | MessageBody | dict[str, Any],
-    *,
-    channel: str,
-    header: MessageHeader | dict[str, Any] | None = None,
-    raise_exception: bool = False,
-    get_permalink: bool = False,
-    backend: BaseBackend = app_settings.backend,
-) -> SlackMessage:
-    """Send a simple text message.
-
-    Args:
-        body: Message content, simple message or full request body.
-        channel: Channel to send message.
-        header: Slack message control header.
-        raise_exception: Whether to re-raise caught exception while sending messages.
-        get_permalink: Try to get the message permalink via extraneous Slack API calls.
-        backend: Messaging backend. If not set, use `app_settings.backend`.
-
-    Returns:
-        Sent message instance or `None`.
-    """
-    body = MessageBody.from_any(body)
-    header = MessageHeader.from_any(header)
-    message = backend.prepare_message(channel=channel, header=header, body=body)
-
-    return backend.send_message(message, raise_exception=raise_exception, get_permalink=get_permalink)
-
-
-def slack_message_via_policy(  # noqa: PLR0913
-    policy: str | SlackMessagingPolicy = app_settings.default_policy_code,
-    *,
-    header: MessageHeader | dict[str, Any] | None = None,
-    raise_exception: bool = False,
-    lazy: bool = False,
-    get_permalink: bool = False,
-    context: dict[str, Any] | None = None,
-    backend: BaseBackend = app_settings.backend,
-) -> int:
-    """Send a simple text message.
-
-    Some default context variables are populated and available for use in templates.
-    See corresponding backend implementation for available context variables.
-
-    Args:
-        policy: Messaging policy code or policy instance. Defaults to app's default policy.
-        header: Slack message control header.
-        raise_exception: Whether to re-raise caught exception while sending messages.
-        lazy: Decide whether try create policy with disabled, if not exists.
-        get_permalink: Try to get the message permalink via extraneous Slack API calls.
-        context: Dictionary to pass to template for rendering.
-        backend: Messaging backend. If not set, use `app_settings.backend`.
-
-    Returns:
-        Count of messages sent successfully.
-
-    Raises:
-        SlackMessagingPolicy.DoesNotExist: Policy for given code does not exists.
-    """
-    if isinstance(policy, str):
-        if lazy:
-            policy, created = SlackMessagingPolicy.objects.get_or_create(
-                code=policy,
-                defaults={
-                    "enabled": app_settings.lazy_policy_enabled,
-                    "template": app_settings.default_template,
-                },
-            )
-            if created:
-                # Add default recipient for created policy
-                recipient = SlackMessageRecipient.objects.get(alias=app_settings.default_recipient)
-                policy.recipients.add(recipient)
-                logger.warning("Policy for code %r created because `lazy` is set.", policy)
-        else:
-            policy = SlackMessagingPolicy.objects.get(code=policy)
-
-    header = MessageHeader.from_any(header)
-    context = context or {}
-
-    messages = backend.prepare_messages_from_policy(policy, header=header, context=context)
-    if not policy.enabled:
-        logger.warning(
-            "Created %d messages but not sending because policy %s is not enabled.",
-            len(messages),
-            policy.code,
-        )
-        return 0
-
-    return backend.send_messages(*messages, raise_exception=raise_exception, get_permalink=get_permalink)

django_slack_tools/utils/slack/message.py

@@ -1,93 +0,0 @@
-"""Utils for Slack messaging."""
-
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from typing import Any, List, Optional
-
-NoneType = type(None)
-
-
-@dataclass
-class MessageHeader:
-    """Message header data definition."""
-
-    mrkdwn: Optional[str] = field(default=None)  # noqa: UP007
-    parse: Optional[str] = field(default=None)  # noqa: UP007
-    reply_broadcast: Optional[bool] = field(default=None)  # noqa: UP007
-    thread_ts: Optional[str] = field(default=None)  # noqa: UP007
-    unfurl_links: Optional[bool] = field(default=None)  # noqa: UP007
-    unfurl_media: Optional[bool] = field(default=None)  # noqa: UP007
-
-    def __post_init__(self) -> None:
-        _assert_type(self.mrkdwn, (str, NoneType))
-        _assert_type(self.parse, (str, NoneType))
-        _assert_type(self.reply_broadcast, (bool, NoneType))
-        _assert_type(self.thread_ts, (str, NoneType))
-        _assert_type(self.unfurl_links, (bool, NoneType))
-        _assert_type(self.unfurl_media, (bool, NoneType))
-
-    @classmethod
-    def from_any(
-        cls,
-        obj: MessageHeader | dict[str, Any] | None = None,
-    ) -> MessageHeader:
-        """Create instance from compatible types."""
-        if obj is None:
-            return cls()
-
-        if isinstance(obj, dict):
-            return cls(**obj)
-
-        msg = f"Unsupported type {type(obj)}"
-        raise TypeError(msg)
-
-
-@dataclass
-class MessageBody:
-    """Data definition for message body."""
-
-    attachments: Optional[List[dict]] = field(default=None)  # noqa: UP006, UP007
-
-    # See more about blocks at https://api.slack.com/reference/block-kit/blocks
-    blocks: Optional[List[dict]] = field(default=None)  # noqa: UP006, UP007
-
-    text: Optional[str] = field(default=None)  # noqa: UP007
-    icon_emoji: Optional[str] = field(default=None)  # noqa: UP007
-    icon_url: Optional[str] = field(default=None)  # noqa: UP007
-    metadata: Optional[dict] = field(default=None)  # noqa: UP007
-    username: Optional[str] = field(default=None)  # noqa: UP007
-
-    def __post_init__(self) -> None:
-        _assert_type(self.attachments, (list, NoneType))
-        _assert_type(self.blocks, (list, NoneType))
-        _assert_type(self.text, (str, NoneType))
-        _assert_type(self.icon_emoji, (str, NoneType))
-        _assert_type(self.icon_url, (str, NoneType))
-        _assert_type(self.metadata, (dict, NoneType))
-        _assert_type(self.username, (str, NoneType))
-
-        if not any((self.attachments, self.blocks, self.text)):
-            msg = "At least one of `attachments`, `blocks` and `text` must set"
-            raise ValueError(msg)
-
-    @classmethod
-    def from_any(cls, obj: str | MessageBody | dict[str, Any]) -> MessageBody:
-        """Create instance from compatible types."""
-        if isinstance(obj, dict):
-            return cls(**obj)
-
-        if isinstance(obj, str):
-            return cls(text=obj)
-
-        msg = f"Unsupported type {type(obj)}"
-        raise TypeError(msg)
-
-
-def _assert_type(obj: Any, cls: type | tuple[type, ...]) -> None:
-    if not isinstance(obj, cls):
-        msg = f"Invalid value type, expected {cls}, got {type(obj)}"
-        raise TypeError(msg)

django_slack_tools/utils/template/__init__.py

@@ -1,5 +0,0 @@
-from .base import BaseTemplate
-from .dict import DictTemplate
-from .django import DjangoTemplate
-
-__all__ = ("BaseTemplate", "DictTemplate", "DjangoTemplate")

django_slack_tools/utils/template/base.py

@@ -1,17 +0,0 @@
-"""Abstraction for dictionary templates."""
-
-from __future__ import annotations
-
-from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from typing import Any
-
-
-class BaseTemplate(ABC):
-    """Abstract base class for dictionary templates."""
-
-    @abstractmethod
-    def render(self, *, context: dict[str, Any] | None = None) -> dict:
-        """Render template with given context."""

django_slack_tools/utils/template/dict.py

@@ -1,52 +0,0 @@
-# noqa: D100
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, TypeVar
-
-from .base import BaseTemplate
-
-if TYPE_CHECKING:
-    from typing import Any
-
-
-import logging
-
-logger = logging.getLogger(__name__)
-
-
-class DictTemplate(BaseTemplate):
-    """Simple dictionary-based template."""
-
-    def __init__(self, template: dict) -> None:
-        """Initialize template.
-
-        Args:
-            template: Dictionary template.
-            kwargs: Keyword arguments passed to template.
-        """
-        self.template = template
-
-    def render(self, *, context: dict[str, Any] | None = None) -> dict:  # noqa: D102
-        context = {} if context is None else context
-        result = self.template.copy()
-        for k, v in result.items():
-            result[k] = _format_obj(v, context=context)
-
-        return result
-
-
-T = TypeVar("T", dict, list, str)
-
-
-def _format_obj(obj: T, *, context: dict[str, Any]) -> T:
-    """Format object recursively."""
-    if isinstance(obj, dict):
-        return {k: _format_obj(v, context=context) for k, v in obj.items()}
-
-    if isinstance(obj, str):
-        return obj.format_map(context)
-
-    if isinstance(obj, list):
-        return [_format_obj(item, context=context) for item in obj]
-
-    return obj

django_slack_tools-0.2.2.dist-info/RECORD

@@ -1,43 +0,0 @@
-django_slack_tools/__init__.py,sha256=m6kyaNpwBcP1XYcqrelX2oS3PJuOnElOcRdBa9pEb8c,22
-django_slack_tools/app_settings.py,sha256=N_xWW1TxkvF1-LuDjuNZFiE0XKpQiVmse2_ZH3lbUok,3837
-django_slack_tools/views.py,sha256=XuQh0g9A2O51DVkMUhm8x8cswZytZcECNIsDuLsM0UI,1168
-django_slack_tools/locale/ko_KR/LC_MESSAGES/django.po,sha256=ySlOJgCeqFzesrWLm1BugmdLb878GSGQJZp7a1uXopw,14864
-django_slack_tools/slack_messages/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_slack_tools/slack_messages/apps.py,sha256=nLVxuLE-1VIqkcVYEdtlg6ffD3blonGCMKaTd_F5jis,610
-django_slack_tools/slack_messages/message.py,sha256=W6ZiwUF9R4jFNLdoUxUmNZdLHr4qENFJzVREd1yalRM,4170
-django_slack_tools/slack_messages/tasks.py,sha256=EOj84Svncpa3I1ZWSKqlzYydFMhT59z2XkOro0ZwIv8,3316
-django_slack_tools/slack_messages/admin/__init__.py,sha256=FEBZlgze8Nf5wn8ixm9FcsL3na2WYykmm2U-iJXh_mQ,305
-django_slack_tools/slack_messages/admin/mention.py,sha256=Z3Cx-6WKECsbXnyby1qCEMllvxJEIn_TdwexsjEaiIo,4399
-django_slack_tools/slack_messages/admin/message.py,sha256=bC4LHhUc07oq2RaWDPZnxAqrthXXofjqlTpfkkADs2o,4126
-django_slack_tools/slack_messages/admin/message_recipient.py,sha256=CVhvUGT4_jD3kJ2CEW8f-DnG3hcsbFbtlccfL_TcS10,4035
-django_slack_tools/slack_messages/admin/messaging_policy.py,sha256=NRzKGgGMCMfABXZrN9okDXb9NvsyxWFLt8hBRfFzwug,4576
-django_slack_tools/slack_messages/backends/__init__.py,sha256=5wIJbp1n6_3kp1nk8x4LyFDqiHw1H13XsqwuIUiqeJo,276
-django_slack_tools/slack_messages/backends/base.py,sha256=VE1xjxrlaE-4fv_ynf-3S6f7h6NXiQIUdcc-yPVsFN4,8179
-django_slack_tools/slack_messages/backends/dummy.py,sha256=OE9pMhAZH8sAewseK_yuPXDgkSHvLH_X_vIItbwpaMc,1155
-django_slack_tools/slack_messages/backends/logging.py,sha256=2P-pEJFI5r6-45rXt43tzQHzokT9wRlEmhSXZIWvvgU,903
-django_slack_tools/slack_messages/backends/slack.py,sha256=uRfrQSDj7Tf2lB76uD_Ma51dplsoIKViolGR26-KOL4,4948
-django_slack_tools/slack_messages/migrations/0001_initial.py,sha256=mLH8mk__OajzisYuO5j0Y-hmgMOM9ANJSKV-q32-FVY,11594
-django_slack_tools/slack_messages/migrations/0002_default_policy.py,sha256=a1pf6bGhFszOz2awUudQnm9FyxIdWcs3ILsWCADG4YU,1145
-django_slack_tools/slack_messages/migrations/0003_default_recipient.py,sha256=SqqawYxEHItmCYAgfv-EAsnc7Fxg3mJtKw6ccDCF1Eo,1153
-django_slack_tools/slack_messages/migrations/0004_slackmessagingpolicy_template_type.py,sha256=u5WkhdPxzXLraw8oTvC0sBV5GUFR0fDghtoc2RvTFQU,679
-django_slack_tools/slack_messages/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_slack_tools/slack_messages/models/__init__.py,sha256=5niO9vU-YMGRCt7wQMXbN-hSrLpJLtukMKjjv-aFeaQ,265
-django_slack_tools/slack_messages/models/mention.py,sha256=C_nowbRv7JU-tD-5boJKu-e3bqG_kTGrrB1WE0ZX1Us,2077
-django_slack_tools/slack_messages/models/message.py,sha256=Ih9lHqJ6M6kKuwRw5_mnoY2kT_RVglUJfOxxpd0vZE4,3644
-django_slack_tools/slack_messages/models/message_recipient.py,sha256=FxaSIOAhZPSa_Tib58P4WXAs0zn8GsK4UgxOjktyduE,1666
-django_slack_tools/slack_messages/models/messaging_policy.py,sha256=Za0wJs5xQ2TWAwUzHuHom98FxdTW4TspgUL387c4mmE,2954
-django_slack_tools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_slack_tools/utils/model_mixins.py,sha256=bNPx3yudzUku8TnjstestOs6YEww58FmBUypL5caYdI,634
-django_slack_tools/utils/widgets.py,sha256=v1EorzDSDXn_ZZgBHVFYMhWPG5RsfEI3L3VFf282svg,876
-django_slack_tools/utils/slack/__init__.py,sha256=_3oJZqfw3VpuXjDT3vEUnjGT3qK1rYhTwCh268f6Jmk,279
-django_slack_tools/utils/slack/django.py,sha256=H6OiGyMYLD6mpZhpPSiosSd7AczBoCXqQHEKhW_LSQE,743
-django_slack_tools/utils/slack/message.py,sha256=FkbM9okHOwJ1NDcg8eX3H3uCA47L-jzu6P-70AFtpqQ,3243
-django_slack_tools/utils/slack/misc.py,sha256=bl7xp43IsTt0FUZWfGH9kk4qYMU0UjIhuGs35zkLyyE,1099
-django_slack_tools/utils/template/__init__.py,sha256=4aMW_Qum7p_-5hm0s5rQXOVSikAwzVBM0MWLmQY93Mo,159
-django_slack_tools/utils/template/base.py,sha256=Ql14Z_ZRnsXS3W724hTbPebzqBoxewf98GaXyny8rYg,422
-django_slack_tools/utils/template/dict.py,sha256=99vNwlO4WzDZuhPvPIcrwkB-sRYl0Ci5tOnW4sqYNTY,1262
-django_slack_tools/utils/template/django.py,sha256=971UIqU8wMtcPT_K2yhn4VdnZB8fOAe28q1YbSoKS58,4104
-django_slack_tools-0.2.2.dist-info/METADATA,sha256=aOFCx3nd4sfcD1M8aE1HyDNvao61BioAPnkAcUcjNZM,4493
-django_slack_tools-0.2.2.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
-django_slack_tools-0.2.2.dist-info/licenses/LICENSE,sha256=lPgIV-vu4gapOeftp1Dp5RsN6zlsiMiubqCNeP466hw,1067
-django_slack_tools-0.2.2.dist-info/RECORD,,