FreezeGun is a library that allows your python tests to travel through time by mocking the datetime module.
Usage
Once the decorator or context manager have been invoked, all calls to datetime.datetime.now(), datetime.datetime.utcnow(), datetime.date.today(), time.time(), time.localtime(), time.gmtime(), and time.strftime() will return the time that has been frozen.
Decorator
from freezegun import freeze_time
@freeze_time("2012-01-14")
def test():
assert datetime.datetime.now() == datetime.datetime(2012, 01, 14)
# Or class based
@freeze_time("2012-01-14")
class Tester(object):
def test_the_class(self):
assert datetime.datetime.now() == datetime.datetime(2012, 01, 14)
Context Manager
from freezegun import freeze_time
def test():
assert datetime.datetime.now() != datetime.datetime(2012, 01, 14)
with freeze_time("2012-01-14"):
assert datetime.datetime.now() == datetime.datetime(2012, 01, 14)
assert datetime.datetime.now() != datetime.datetime(2012, 01, 14)
Raw use
from freezegun import freeze_time
freezer = freeze_time("2012-01-14 12:00:01")
freezer.start()
assert datetime.datetime.now() == datetime.datetime(2012, 01, 14, 12, 00, 01)
freezer.stop()
Timezones
from freezegun import freeze_time
@freeze_time("2012-01-14 03:21:34", tz_offset=-4)
def test():
assert datetime.datetime.utcnow() == datetime.datetime(2012, 01, 14, 03, 21, 34)
assert datetime.datetime.now() == datetime.datetime(2012, 01, 13, 23, 21, 34)
# datetime.date.today() uses local time
assert datetime.date.today() == datetime.datetime(2012, 01, 13)
Nice inputs
FreezeGun uses dateutil behind the scenes so you can have nice-looking datetimes
@freeze_time("Jan 14th, 2012")
def test_nice_datetime():
assert datetime.datetime.now() == datetime.datetime(2012, 01, 14)
Installation
To install FreezeGun, simply:
$ pip install freezegun
On Debian (Testing and Unstable) systems:
$ sudo apt-get install python-freezegun
Metadata
Release files for freezegun 0.3.4
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 |
|---|---|---|---|---|
| freezegun-0.3.4.tar.gz | 42.0 kB | Without provenance | Details for freezegun-0.3.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| freezegun-0.3.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for freezegun-0.3.4-py2.py3-none-any.whl |
Total release size: 47.4 kB
Release files / freezegun-0.3.4.tar.gz
| Download URL | freezegun-0.3.4.tar.gz |
|---|---|
| Size | 42.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d5eb5656c324125cce80e2e9ae572af6da997b7065b3bb6599c20f1b28dcf46
|
|
BLAKE2b-256 checksum How to use checksums |
f83ab05189bd13b2bdf724d8e486ff245e1cbec21d54d6d0da54db59feeff0f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / freezegun-0.3.4-py2.py3-none-any.whl
| Download URL | freezegun-0.3.4-py2.py3-none-any.whl |
|---|---|
| Size | 5.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
d15d5daa22260891955d436899f94c8b80525daa895aec74c0afa5a25ac0230e
|
|
BLAKE2b-256 checksum How to use checksums |
edac64b9d6b80a2c425428971b8333c05667b1f43126ea84e679676c14e1e160
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for freezegun 0.3.4
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.