flake8-ban-utcnow
flake8 plugin which checks that datetime.utcnow() and datetime.utcfromtimestamp() are not used. It suggests using datetime.now(timezone.utc) and datetime.fromtimestamp(ts, tz=timezone.utc)instead respectively.
Also, utcnow and utcfromtimestamp are finally deprecated in Python 3.12:
- PR: https://github.com/python/cpython/pull/103858
- Issue: https://github.com/python/cpython/issues/103857
note: timezone must be imported from datetime first:
from datetime import datetime
from datetime import timezone
datetime.now(timezone.utc)
from datetime import datetime
from datetime import timezone
datetime.fromtimestamp(1684079261, tz=timezone.utc)
installation
pip install flake8-ban-utcnow
flake8 code
| Code | Description |
|---|---|
| UTC001 | don't use datetime.datetime.utcnow(), use datetime.datetime.now(datetime.timezone.utc) instead or datetime.now(datetime.UTC) on >= 3.11. |
| UTC002 | don't use datetime.datetime.utcfromtimestamp(), use datetime.datetime.fromtimestamp(..., tz=datetime.timezone.utc) instead or datetime.datetime.fromtimestamp(..., tz=datetime.UTC) on >= 3.11. |
as a pre-commit hook
See pre-commit for instructions
Sample .pre-commit-config.yaml:
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
- id: flake8
additional_dependencies: [flake8-ban-utcnow==0.2.0]
rationale
One could expect that when explicitly calling datetime.utcnow() the datetime
object would be timezone aware, but it's not! A common pitfall is, deriving a
timestamp from the datetime object created using datetime.utcnow().
example
-
the computer is in
CESTand we want to derive adatetimein UTC formatted as a timestamp hence callingutcnow().timestamp().>>> from datetime import datetime >>> datetime.utcnow() datetime.datetime(2022, 8, 7, 23, 40, 17, 7858) >>> datetime.utcnow().timestamp() 1659908656.048843
-
if we convert the timestamp, it says this, which is obviously incorrect.
GMT: Sunday, 7. August 2022 21:44:16 Your time zone: Sunday, 7. August 2022 23:44:16 GMT+02:00 DST Relative: 2 hours ago -
converting it using python and
datetime.fromtimestamp, we by accident get the correct datetime in UTC>>> datetime.fromtimestamp(1659908656.048843) datetime.datetime(2022, 8, 7, 23, 44, 16, 48843)
-
being aware that the timestamp should be in
UTCwe callutcfromtimestampinstead and get the result as above, since the timestamp actually is in local time, but unaware of this.>>> datetime.utcfromtimestamp(1659908656.048843) datetime.datetime(2022, 8, 7, 21, 44, 16, 48843)
the correct way
-
the computer is in
CESTand we want to actually derive adatetimein UTC formatted as a timestamp.>>> from datetime import timezone >>> from datetime import datetime >>> datetime.now(timezone.utc).timestamp() 1659916399.651218
-
we now get what we actually expect
GMT: Sunday, 7. August 2022 23:53:19 Your time zone: Monday, 8. August 2022 01:53:19 GMT+02:00 DST Relative: A few seconds ago -
the next thing to keep in mind is, that only timezone-aware
datetimeobjects can be compared hence using this forces us to always make sure all objects are timezone aware.
Metadata
Release files for flake8-ban-utcnow 0.2.0
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 |
|---|---|---|---|---|
| flake8_ban_utcnow-0.2.0.tar.gz | 4.3 kB | Without provenance | Details for flake8_ban_utcnow-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flake8_ban_utcnow-0.2.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for flake8_ban_utcnow-0.2.0-py2.py3-none-any.whl |
Total release size: 8.9 kB
Release files / flake8_ban_utcnow-0.2.0.tar.gz
| Download URL | flake8_ban_utcnow-0.2.0.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7fe9d5a180658b65ff94ca9742e0f764b7841791b7e7bb4e1435f0c8f8a641b8
|
|
BLAKE2b-256 checksum How to use checksums |
1bb320e684866416fb4af24dcfac2687f0279e9e8cd247bb690081a22eb2a97c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / flake8_ban_utcnow-0.2.0-py2.py3-none-any.whl
| Download URL | flake8_ban_utcnow-0.2.0-py2.py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
b7d9069142ccd96fb1e99c9c892f5c0d03929f6bc94dae58bbabfff27e6510db
|
|
BLAKE2b-256 checksum How to use checksums |
0a2542cbd902af681271dcf990dbaa5df448ea7c89c66ce9d223dcd354a5ebc9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Security for flake8-ban-utcnow 0.2.0
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.