File: messages.py

package info (click to toggle)
python-pytest-djangoapp 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 396 kB
  • sloc: python: 1,116; makefile: 114; sh: 6
file content (58 lines) | stat: -rw-r--r-- 1,462 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
from typing import List, Dict

import pytest

from collections import defaultdict

if False:  # pragma: nocover
    from django.contrib.messages.storage.base import Message  # noqa


class DjangoappMessageStorage:

    def __init__(self):
        self.all: List['Message'] = []
        self.tags: Dict[str, List['Message']] = defaultdict(list)

    def __contains__(self, item):
        for msg in self.all:
            if item in f'{msg}':
                return True

        return False

    def __len__(self):
        return len(self.all)

    def add(self, level, message, extra_tags=''):
        from django.contrib.messages.storage.base import Message

        msg = Message(level, message, extra_tags)
        self.all.append(msg)
        self.tags[msg.level_tag].append(msg)


@pytest.fixture
def messages(monkeypatch) -> DjangoappMessageStorage:
    """Holds messages sent by Django Messages framework.

    Attributes:
        * all -- a list of all messages
        * tags -- messages dictionary indexed by tags

    Example::

        def test_this(messages):
            assert len(messages.all)
            assert len(messages.tags['error'])
            assert 'another error' in messages

    """
    messages = DjangoappMessageStorage()

    def add(request, level, message, extra_tags='', **kwargs):
        messages.add(level, message, extra_tags)

    monkeypatch.setattr('django.contrib.messages.api.add_message', add)

    return messages