wutta/wuttaweb
3
0
Fork 0
Code Issues Activity

feat: add "complete" (sic) timezone support

Browse source 
at least for now, this is enough to let admin define the global
default timezone for app, and override system local timezone.

eventually should support per-user timezone..some day..
This commit is contained in:
Lance Edgar 2025-12-16 22:52:33 -06:00
parent 286c683c93
commit 7fcb331806
10 changed files with 274 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

124
tests/forms/test_schema.py
View file

@ -11,88 +11,86 @@ from pyramid import testing
from sqlalchemy import orm
from wuttjamaican.conf import WuttaConfig
from wuttjamaican.util import get_timezone_by_name
from wuttjamaican.testing import DataTestCase
from wuttaweb.forms import schema as mod
from wuttaweb.forms import widgets
from wuttaweb.testing import WebTestCase
class TestWuttaDateTime(TestCase):
class TestWuttaDateTime(WebTestCase):
def test_serialize(self):
typ = mod.WuttaDateTime()
node = colander.SchemaNode(typ)
tzlocal = get_timezone_by_name("America/Los_Angeles")
with patch.object(self.app, "get_timezone", return_value=tzlocal):
typ = mod.WuttaDateTime()
node = colander.SchemaNode(
typ, widget=widgets.WuttaDateTimeWidget(self.request)
)
result = typ.serialize(node, colander.null)
self.assertIs(result, colander.null)
# null
self.assertIs(typ.serialize(node, colander.null), colander.null)
self.assertIs(typ.serialize(node, None), colander.null)
self.assertIs(typ.serialize(node, ""), colander.null)
result = typ.serialize(node, None)
self.assertIs(result, colander.null)
# naive, UTC
result = typ.serialize(node, datetime.datetime(2024, 12, 11, 22, 33))
self.assertEqual(result, "2024-12-11T14:33:00-08:00")
result = typ.serialize(node, "")
self.assertIs(result, colander.null)
# aware, UTC
result = typ.serialize(
node,
datetime.datetime(2024, 12, 11, 22, 33, tzinfo=datetime.timezone.utc),
)
self.assertEqual(result, "2024-12-11T14:33:00-08:00")
# naive, UTC
# TODO: must override local timezone for a complete test
result = typ.serialize(node, datetime.datetime(2024, 12, 11, 22, 33))
self.assertTrue(result.startswith("2024-12-"))
# aware, local
result = typ.serialize(
node,
datetime.datetime(2024, 12, 11, 14, 33, tzinfo=tzlocal),
)
self.assertEqual(result, "2024-12-11T14:33:00-08:00")
# aware, UTC
result = typ.serialize(
node, datetime.datetime(2024, 12, 11, 22, 33, tzinfo=datetime.timezone.utc)
)
self.assertEqual(result, "2024-12-11T22:33:00+00:00")
# aware, local
result = typ.serialize(
node,
datetime.datetime(
2024,
12,
11,
22,
33,
tzinfo=datetime.timezone(-datetime.timedelta(hours=5)),
),
)
self.assertEqual(result, "2024-12-11T22:33:00-05:00")
# custom format
typ = mod.WuttaDateTime(format="%Y-%m-%d %I:%M %p")
node = colander.SchemaNode(typ)
result = typ.serialize(
node, datetime.datetime(2024, 12, 11, 22, 33, tzinfo=datetime.timezone.utc)
)
self.assertEqual(result, "2024-12-11 10:33 PM")
# custom format
typ = mod.WuttaDateTime(format="%Y-%m-%d %I:%M %p")
node = colander.SchemaNode(
typ, widget=widgets.WuttaDateTimeWidget(self.request)
)
result = typ.serialize(
node,
datetime.datetime(2024, 12, 11, 22, 33, tzinfo=datetime.timezone.utc),
)
self.assertEqual(result, "2024-12-11 02:33 PM")
def test_deserialize(self):
typ = mod.WuttaDateTime()
node = colander.SchemaNode(typ)
tzlocal = get_timezone_by_name("America/Los_Angeles")
with patch.object(self.app, "get_timezone", return_value=tzlocal):
typ = mod.WuttaDateTime()
node = colander.SchemaNode(
typ, widget=widgets.WuttaDateTimeWidget(self.request)
)
result = typ.deserialize(node, colander.null)
self.assertIs(result, colander.null)
# null
self.assertIs(typ.deserialize(node, colander.null), colander.null)
self.assertIs(typ.deserialize(node, None), colander.null)
self.assertIs(typ.deserialize(node, ""), colander.null)
result = typ.deserialize(node, None)
self.assertIs(result, colander.null)
# format #1
result = typ.deserialize(node, "2024-12-11T22:33:00")
self.assertIsInstance(result, datetime.datetime)
self.assertEqual(
result, datetime.datetime(2024, 12, 12, 6, 33, tzinfo=None)
)
result = typ.deserialize(node, "")
self.assertIs(result, colander.null)
# format #2
result = typ.deserialize(node, "2024-12-11T10:33 PM")
self.assertIsInstance(result, datetime.datetime)
self.assertEqual(
result, datetime.datetime(2024, 12, 12, 6, 33, tzinfo=None)
)
# TODO: must override local timezone for a complete test
result = typ.deserialize(node, "2024-12-11T10:33 PM")
self.assertIsInstance(result, datetime.datetime)
dt = datetime.datetime(2024, 12, 11, 22, 33)
self.assertLess(abs((result - dt).total_seconds()), 60 * 60 * 24)
self.assertIsNone(result.tzinfo)
# TODO: must override local timezone for a complete test
result = typ.deserialize(node, "2024-12-11T22:33:00")
self.assertIsInstance(result, datetime.datetime)
dt = datetime.datetime(2024, 12, 11, 22, 33)
self.assertLess(abs((result - dt).total_seconds()), 60 * 60 * 24)
self.assertIsNone(result.tzinfo)
self.assertRaises(colander.Invalid, typ.deserialize, node, "bogus")
# invalid
self.assertRaises(colander.Invalid, typ.deserialize, node, "bogus")
class TestObjectNode(DataTestCase):

40
tests/forms/test_widgets.py
View file

@ -8,6 +8,7 @@ import colander
import deform
from pyramid import testing
from wuttjamaican.util import get_timezone_by_name
from wuttaweb import grids
from wuttaweb.forms import widgets as mod
from wuttaweb.forms import schema
@ -145,19 +146,36 @@ class TestWuttaDateTimeWidget(WebTestCase):
def make_widget(self, **kwargs):
return mod.WuttaDateTimeWidget(self.request, **kwargs)
def test_serialize(self):
node = colander.SchemaNode(WuttaDateTime())
field = self.make_field(node)
widget = self.make_widget()
dt = datetime.datetime(2024, 12, 12, 13, 49, tzinfo=datetime.timezone.utc)
def test_serialize_editable(self):
tzlocal = get_timezone_by_name("America/New_York")
with patch.object(self.app, "get_timezone", return_value=tzlocal):
widget = self.make_widget()
self.assertFalse(widget.readonly)
node = colander.SchemaNode(WuttaDateTime(), widget=widget)
field = self.make_field(node)
# editable widget has normal picker html
result = widget.serialize(field, str(dt))
self.assertIn("<wutta-datepicker", result)
# nb. input data (from schema type) is always "local, zone-aware, isoformat"
dt = datetime.datetime(2024, 12, 12, 13, 49, tzinfo=tzlocal)
result = widget.serialize(field, dt.isoformat())
self.assertIn("<wutta-datepicker", result)
# readonly is rendered per app convention
result = widget.serialize(field, str(dt), readonly=True)
self.assertEqual(result, "2024-12-12 13:49+0000")
def test_serialize_readonly(self):
tzlocal = get_timezone_by_name("America/New_York")
with patch.object(self.app, "get_timezone", return_value=tzlocal):
widget = self.make_widget(readonly=True)
self.assertTrue(widget.readonly)
node = colander.SchemaNode(WuttaDateTime(), widget=widget)
field = self.make_field(node)
# null
self.assertEqual(widget.serialize(field, colander.null), "")
self.assertEqual(widget.serialize(field, None), "")
self.assertEqual(widget.serialize(field, ""), "")
# input data (from schema type) is always "local, zone-aware, isoformat"
dt = datetime.datetime(2024, 12, 12, 13, 49, tzinfo=tzlocal)
result = widget.serialize(field, dt.isoformat())
self.assertEqual(result, "2024-12-12 13:49-0500")
class TestWuttaMoneyInputWidget(WebTestCase):

22
tests/grids/test_base.py
View file

@ -14,6 +14,7 @@ from paginate_sqlalchemy import SqlalchemyOrmPage
from pyramid import testing
from wuttjamaican.conf import WuttaConfig
from wuttjamaican.util import get_timezone_by_name
from wuttaweb.grids import base as mod
from wuttaweb.grids.filters import (
GridFilter,
@ -1654,16 +1655,21 @@ class TestGrid(WebTestCase):
self.assertEqual(result, "2025-01-13")
def test_render_datetime(self):
grid = self.make_grid(columns=["foo", "bar"])
tzlocal = get_timezone_by_name("America/Los_Angeles")
with patch.object(self.app, "get_timezone", return_value=tzlocal):
grid = self.make_grid(columns=["foo", "bar"])
obj = MagicMock(dt=None)
result = grid.render_datetime(obj, "dt", None)
self.assertEqual(result, "")
# null
obj = MagicMock(dt=None)
result = grid.render_datetime(obj, "dt", None)
self.assertEqual(result, "")
dt = datetime.datetime(2024, 12, 12, 13, 44, tzinfo=datetime.timezone.utc)
obj = MagicMock(dt=dt)
result = grid.render_datetime(obj, "dt", str(dt))
self.assertEqual(result, "2024-12-12 13:44+0000")
# normal (naive utc)
dt = datetime.datetime(2024, 12, 12, 13, 44)
obj = MagicMock(dt=dt)
result = grid.render_datetime(obj, "dt", str(dt))
self.assertEqual(result, "2024-12-12 05:44-0800")
self.assertNotEqual(result, str(dt))
def test_render_vue_tag(self):
grid = self.make_grid(columns=["foo", "bar"])

4
tests/views/test_master.py
View file

@ -1663,6 +1663,9 @@ class TestMasterView(WebTestCase):
def test_configure(self):
self.pyramid_config.include("wuttaweb.views.common")
self.pyramid_config.include("wuttaweb.views.auth")
self.pyramid_config.add_route(
"appinfo.check_timezone", "/appinfo/check-timezone"
)
model = self.app.model
# mock settings
@ -1697,6 +1700,7 @@ class TestMasterView(WebTestCase):
def get_context(**kw):
kw = original_context(**kw)
kw["menu_handlers"] = []
kw["default_timezone"] = "UTC"
return kw
with patch.object(view, "configure_get_context", new=get_context):

20
tests/views/test_settings.py
View file

@ -46,6 +46,26 @@ class TestAppInfoView(WebTestCase):
view = self.make_view()
context = view.configure_get_context()
def test_configure_check_timezone(self):
view = self.make_view()
# normal
with patch.object(self.request, "GET", new={"tzname": "America/Chicago"}):
result = view.configure_check_timezone()
self.assertFalse(result["invalid"])
# invalid
with patch.object(self.request, "GET", new={"tzname": "bad_name"}):
result = view.configure_check_timezone()
self.assertEqual(
result["invalid"], "'No time zone found with key bad_name'"
)
# missing input
with patch.object(self.request, "GET", new={}):
result = view.configure_check_timezone()
self.assertEqual(result["invalid"], "Must provide 'tzname' parameter.")
class TestSettingView(WebTestCase):