django-timezone-field
A Django app providing database, form and serializer fields for pytz timezone objects.
Examples
Database Field
import pytz
from django.db import models
from timezone_field import TimeZoneField
class MyModel(models.Model):
tz1 = TimeZoneField(default='Europe/London') # defaults supported
tz2 = TimeZoneField() # in ModelForm displays like "America/Los Angeles"
tz3 = TimeZoneField(choices_display='WITH_GMT_OFFSET') # in ModelForm displays like "GMT-08:00 America/Los Angeles"
my_model = MyModel(
tz1='America/Los_Angeles', # assignment of a string
tz2=pytz.timezone('Turkey'), # assignment of a pytz.DstTzInfo
tz3=pytz.UTC, # assignment of pytz.UTC singleton
)
my_model.full_clean() # validates against pytz.common_timezones by default
my_model.save() # values stored in DB as strings
my_model.tz1 # values retrieved as pytz objects: <DstTzInfo 'America/Los_Angeles' PST-1 day, 16:00:00 STD>
Form Field
from django import forms
from timezone_field import TimeZoneFormField
class MyForm(forms.Form):
tz = TimeZoneFormField() # displays like "America/Los Angeles"
tz2 = TimeZoneFormField(choices_display='WITH_GMT_OFFSET') # displays like "GMT-08:00 America/Los Angeles"
my_form = MyForm({'tz': 'America/Los_Angeles'})
my_form.full_clean() # validates against pytz.common_timezones by default
my_form.cleaned_data['tz'] # values retrieved as pytz objects: <DstTzInfo 'America/Los_Angeles' PST-1 day, 16:00:00 STD>
REST Framework Serializer Field
import pytz
from rest_framework import serializers
from timezone_field.rest_framework import TimeZoneSerializerField
class MySerializer(serializers.Serializer):
tz1 = TimeZoneSerializerField()
tz2 = TimeZoneSerializerField()
my_serializer = MySerializer(data={
'tz1': 'America/Argentina/Buenos_Aires',
'tz2': pytz.timezone('America/Argentina/Buenos_Aires'),
})
my_serializer.is_valid() # true
my_serializer.validated_data['tz1'] # <DstTzInfo 'America/Argentina/Buenos_Aires' LMT-1 day, 20:06:00 STD>
my_serializer.validated_data['tz2'] # <DstTzInfo 'America/Argentina/Buenos_Aires' LMT-1 day, 20:06:00 STD>
Installation
Install from pypi
pip install django-timezone-field
Running the tests
From the repository root, with poetry
poetry install
poetry run pytest
Changelog
4.2.3 (2022-01-13)
- Fix sdist installs (#78)
- Officially support python 3.10
4.2.1 (2021-07-07)
- Reinstate
TimeZoneField.default_choices(#76)
4.2 (2021-07-07)
- Officially support django 3.2, python 3.9
- Fix bug with field deconstruction (#74)
- Housekeeping: use poetry, github actions, pytest
4.1.2 (2021-03-17)
- Avoid
NonExistentTimeErrorduring DST transition (#70)
4.1.1 (2020-11-28)
- Don't import
rest_frameworkfrom package root (#67)
4.1 (2020-11-28)
- Add Django REST Framework serializer field
- Add new
choices_displaykwarg with supported valuesWITH_GMT_OFFSETandSTANDARD - Deprecate
display_GMT_offsetkwarg
4.0 (2019-12-03)
- Add support for django 3.0, python 3.8
- Drop support for django 1.11, 2.0, 2.1, python 2.7, 3.4
3.1 (2019-10-02)
- Officially support django 2.2 (already worked)
- Add option to display TZ offsets in form field (#46)
3.0 (2018-09-15)
- Support django 1.11, 2.0, 2.1
- Add support for python 3.7
- Change default human-readable timezone names to exclude underscores (#32 & #37)
2.1 (2018-03-01)
- Add support for django 1.10, 1.11
- Add support for python 3.6
- Add wheel support
- Support bytes in DB fields (#38 & #39)
2.0 (2016-01-31)
- Drop support for django 1.7, add support for django 1.9
- Drop support for python 3.2, 3.3, add support for python 3.5
- Remove tests from source distribution
1.3 (2015-10-12)
- Drop support for django 1.6, add support for django 1.8
- Various bug fixes
1.2 (2015-02-05)
- For form field, changed default list of accepted timezones from
pytz.all_timezonestopytz.common_timezones, to match DB field behavior.
1.1 (2014-10-05)
- Django 1.7 compatibility
- Added support for formatting
choiceskwarg as[[<str>, <str>], ...], in addition to previous format of[[<pytz.timezone>, <str>], ...]. - Changed default list of accepted timezones from
pytz.all_timezonestopytz.common_timezones. If you have timezones in your DB that are inpytz.all_timezonesbut not inpytz.common_timezones, this is a backward-incompatible change. Old behavior can be restored by specifyingchoices=[(tz, tz) for tz in pytz.all_timezones]in your model definition.
1.0 (2013-08-04)
- Initial release as
timezone_field.
Credits
Originally adapted from Brian Rosner's django-timezones.
Made possible thanks to the work of the contributors.
Metadata
Release files for django-timezone-field 4.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-timezone-field-4.2.3.tar.gz | 8.3 kB | Without provenance | Details for django-timezone-field-4.2.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_timezone_field-4.2.3-py3-none-any.whl | Python 3 | none | any | Details for django_timezone_field-4.2.3-py3-none-any.whl |
Total release size: 18.0 kB
Release files / django-timezone-field-4.2.3.tar.gz
| Download URL | django-timezone-field-4.2.3.tar.gz |
|---|---|
| Size | 8.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5dd5bd9249382bef8847d3e7e4c32b7be182a4b538f354130d1252ed228892f8
|
|
BLAKE2b-256 checksum How to use checksums |
49d24ff4e4a895c94c46e5178e8a561ef2695d67f26de346da8d429a5783fb0d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Release files / django_timezone_field-4.2.3-py3-none-any.whl
| Download URL | django_timezone_field-4.2.3-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7552d2b0f145684b7de3fb5046101c7efd600cc6ba951b15c630fa1e1b83558e
|
|
BLAKE2b-256 checksum How to use checksums |
9337e300b764af70e068758deda74c6b2a419d065d7256696542a24f2954fcf8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Security for django-timezone-field 4.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.