File: test_choices_display_option.py

package info (click to toggle)
python-django-timezone-field 7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 292 kB
  • sloc: python: 1,047; sh: 6; makefile: 3
file content (215 lines) | stat: -rw-r--r-- 8,097 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
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
from collections import Counter

import pytest
from django import forms
from django.db import models

from timezone_field import TimeZoneField, TimeZoneFormField

pytestmark = pytest.mark.filterwarnings("ignore:Model 'tests._choicesdisplaymodel' was already registered.")


@pytest.fixture
def base_tzobjs(to_tzobj, base_tzstrs):
    yield [to_tzobj(tz) for tz in base_tzstrs]


@pytest.fixture
def ChoicesDisplayForm(use_pytz):
    class _ChoicesDisplayForm(forms.Form):
        limited_tzs = [
            "Asia/Tokyo",
            "Asia/Dubai",
            "America/Argentina/Buenos_Aires",
            "Africa/Nairobi",
        ]
        limited_choices = [(tz, tz) for tz in limited_tzs]

        tz_none = TimeZoneFormField(use_pytz=use_pytz)
        tz_standard = TimeZoneFormField(choices_display="STANDARD", use_pytz=use_pytz)
        tz_with_gmt_offset = TimeZoneFormField(choices_display="WITH_GMT_OFFSET", use_pytz=use_pytz)
        tz_limited_none = TimeZoneFormField(choices=limited_choices, use_pytz=use_pytz)
        tz_limited_standard = TimeZoneFormField(
            choices=limited_choices,
            choices_display="STANDARD",
            use_pytz=use_pytz,
        )
        tz_limited_with_gmt_offset = TimeZoneFormField(
            choices=limited_choices,
            choices_display="WITH_GMT_OFFSET",
            use_pytz=use_pytz,
        )

    yield _ChoicesDisplayForm


# we have to define these Models at import time, so django will create the DB table
# we then redefine-the model at runtime to customize the fields further
class _ChoicesDisplayModel(models.Model):
    tz_none = TimeZoneField()
    tz_standard = TimeZoneField()
    tz_with_gmt_offset = TimeZoneField()
    tz_limited_none = TimeZoneField()
    tz_limited_standard = TimeZoneField()
    tz_limited_with_gmt_offset = TimeZoneField()


@pytest.fixture
def ChoicesDisplayModel(use_pytz):
    class _ChoicesDisplayModel(models.Model):
        limited_tzs = [
            "Asia/Tokyo",
            "Asia/Dubai",
            "America/Argentina/Buenos_Aires",
            "Africa/Nairobi",
        ]
        limited_choices = [(tz, tz) for tz in limited_tzs]

        tz_none = TimeZoneField(use_pytz=use_pytz)
        tz_standard = TimeZoneField(choices_display="STANDARD", use_pytz=use_pytz)
        tz_with_gmt_offset = TimeZoneField(choices_display="WITH_GMT_OFFSET", use_pytz=use_pytz)
        tz_limited_none = TimeZoneField(choices=limited_choices, use_pytz=use_pytz)
        tz_limited_standard = TimeZoneField(
            choices=limited_choices,
            choices_display="STANDARD",
            use_pytz=use_pytz,
        )
        tz_limited_with_gmt_offset = TimeZoneField(
            choices=limited_choices,
            choices_display="WITH_GMT_OFFSET",
            use_pytz=use_pytz,
        )

    yield _ChoicesDisplayModel


@pytest.fixture
def ChoicesDisplayModelForm(ChoicesDisplayModel):
    class _ChoicesDisplayModelForm(forms.ModelForm):
        class Meta:
            model = ChoicesDisplayModel
            fields = "__all__"

    yield _ChoicesDisplayModelForm


def test_db_field_invalid_choices_display(use_pytz):
    with pytest.raises(ValueError):
        TimeZoneField(choices_display="invalid", use_pytz=use_pytz)


def test_form_field_invalid_choices_display(use_pytz):
    with pytest.raises(ValueError):
        TimeZoneFormField(choices_display="invalid", use_pytz=use_pytz)


def test_form_field_none(ChoicesDisplayForm, base_tzstrs):
    form = ChoicesDisplayForm()
    values, displays = zip(*form.fields["tz_none"].choices)
    assert sorted(values) == sorted(base_tzstrs)
    assert displays[values.index("America/Los_Angeles")] == "America/Los Angeles"
    assert displays[values.index("Asia/Kolkata")] == "Asia/Kolkata"


def test_form_field_standard(ChoicesDisplayForm):
    form = ChoicesDisplayForm()
    assert form.fields["tz_standard"].choices == form.fields["tz_none"].choices


def test_form_field_with_gmt_offset(ChoicesDisplayForm, base_tzstrs):
    form = ChoicesDisplayForm()
    values, displays = zip(*form.fields["tz_with_gmt_offset"].choices)
    assert values != tuple(base_tzstrs)
    assert sorted(values) == sorted(base_tzstrs)
    assert displays[values.index("America/Argentina/Buenos_Aires")] == "GMT-03:00 America/Argentina/Buenos Aires"
    assert displays[values.index("Europe/Moscow")] == "GMT+03:00 Europe/Moscow"


def test_form_field_limited_none(ChoicesDisplayForm):
    form = ChoicesDisplayForm()
    assert form.fields["tz_limited_none"].choices == [
        ("Asia/Tokyo", "Asia/Tokyo"),
        ("Asia/Dubai", "Asia/Dubai"),
        ("America/Argentina/Buenos_Aires", "America/Argentina/Buenos_Aires"),
        ("Africa/Nairobi", "Africa/Nairobi"),
    ]


def test_form_field_limited_standard(ChoicesDisplayForm):
    form = ChoicesDisplayForm()
    assert form.fields["tz_limited_standard"].choices == [
        ("Africa/Nairobi", "Africa/Nairobi"),
        ("America/Argentina/Buenos_Aires", "America/Argentina/Buenos Aires"),
        ("Asia/Dubai", "Asia/Dubai"),
        ("Asia/Tokyo", "Asia/Tokyo"),
    ]


def test_form_field_limited_with_gmt_offset(ChoicesDisplayForm):
    form = ChoicesDisplayForm()
    assert form.fields["tz_limited_with_gmt_offset"].choices == [
        ("America/Argentina/Buenos_Aires", "GMT-03:00 America/Argentina/Buenos Aires"),
        ("Africa/Nairobi", "GMT+03:00 Africa/Nairobi"),
        ("Asia/Dubai", "GMT+04:00 Asia/Dubai"),
        ("Asia/Tokyo", "GMT+09:00 Asia/Tokyo"),
    ]


def test_model_form_field_none(ChoicesDisplayModelForm, to_tzobj, base_tzobjs):
    form = ChoicesDisplayModelForm()
    values, displays = zip(*form.fields["tz_none"].choices)
    assert Counter(values) == Counter(("",) + tuple(base_tzobjs))
    assert displays[values.index(to_tzobj("America/Los_Angeles"))] == "America/Los Angeles"
    assert displays[values.index(to_tzobj("Asia/Kolkata"))] == "Asia/Kolkata"


def test_model_form_field_standard(ChoicesDisplayModelForm):
    form = ChoicesDisplayModelForm()
    assert form.fields["tz_standard"].choices == form.fields["tz_none"].choices


def test_model_form_field_with_gmt_offset(ChoicesDisplayModelForm, to_tzobj, base_tzobjs):
    form = ChoicesDisplayModelForm()
    values, displays = zip(*form.fields["tz_with_gmt_offset"].choices)
    assert values != tuple(base_tzobjs)
    assert sorted(str(v) for v in values) == sorted([""] + [str(tz) for tz in base_tzobjs])
    assert (
        displays[values.index(to_tzobj("America/Argentina/Buenos_Aires"))] == "GMT-03:00 America/Argentina/Buenos Aires"
    )
    assert displays[values.index(to_tzobj("Europe/Moscow"))] == "GMT+03:00 Europe/Moscow"


def test_model_form_field_limited_none(ChoicesDisplayModelForm, to_tzobj):
    form = ChoicesDisplayModelForm()
    assert form.fields["tz_limited_none"].choices == [
        ("", "---------"),
        (to_tzobj("Asia/Tokyo"), "Asia/Tokyo"),
        (to_tzobj("Asia/Dubai"), "Asia/Dubai"),
        (to_tzobj("America/Argentina/Buenos_Aires"), "America/Argentina/Buenos_Aires"),
        (to_tzobj("Africa/Nairobi"), "Africa/Nairobi"),
    ]


def test_moel_form_field_limited_standard(ChoicesDisplayModelForm, to_tzobj):
    form = ChoicesDisplayModelForm()
    assert form.fields["tz_limited_standard"].choices == [
        ("", "---------"),
        (to_tzobj("Africa/Nairobi"), "Africa/Nairobi"),
        (to_tzobj("America/Argentina/Buenos_Aires"), "America/Argentina/Buenos Aires"),
        (to_tzobj("Asia/Dubai"), "Asia/Dubai"),
        (to_tzobj("Asia/Tokyo"), "Asia/Tokyo"),
    ]


def test_model_form_field_limited_with_gmt_offset(ChoicesDisplayModelForm, to_tzobj):
    form = ChoicesDisplayModelForm()
    assert form.fields["tz_limited_with_gmt_offset"].choices == [
        ("", "---------"),
        (
            to_tzobj("America/Argentina/Buenos_Aires"),
            "GMT-03:00 America/Argentina/Buenos Aires",
        ),
        (to_tzobj("Africa/Nairobi"), "GMT+03:00 Africa/Nairobi"),
        (to_tzobj("Asia/Dubai"), "GMT+04:00 Asia/Dubai"),
        (to_tzobj("Asia/Tokyo"), "GMT+09:00 Asia/Tokyo"),
    ]