Skip to content

Commit

Permalink
[AIRFLOW-2984] Convert operator dates to UTC (#3822)
Browse files Browse the repository at this point in the history
Tasks can have start_dates or end_dates separately
from the DAG. These need to be converted to UTC otherwise
we cannot use them for calculation the next execution
date.
  • Loading branch information
bolkedebruin authored and ashb committed Sep 9, 2018
1 parent 96ddc3c commit 794e478
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 33 deletions.
7 changes: 7 additions & 0 deletions airflow/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -2387,10 +2387,17 @@ def __init__(
self.email = email
self.email_on_retry = email_on_retry
self.email_on_failure = email_on_failure

self.start_date = start_date
if start_date and not isinstance(start_date, datetime):
self.log.warning("start_date for %s isn't datetime.datetime", self)
elif start_date:
self.start_date = timezone.convert_to_utc(start_date)

self.end_date = end_date
if end_date:
self.end_date = timezone.convert_to_utc(end_date)

if not TriggerRule.is_valid(trigger_rule):
raise AirflowException(
"The trigger_rule must be one of {all_triggers},"
Expand Down
67 changes: 35 additions & 32 deletions docs/timezone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@ Time zones
==========

Support for time zones is enabled by default. Airflow stores datetime information in UTC internally and in the database.
It allows you to run your DAGs with time zone dependent schedules. At the moment Airflow does not convert them to the
end user’s time zone in the user interface. There it will always be displayed in UTC. Also templates used in Operators
It allows you to run your DAGs with time zone dependent schedules. At the moment Airflow does not convert them to the
end user’s time zone in the user interface. There it will always be displayed in UTC. Also templates used in Operators
are not converted. Time zone information is exposed and it is up to the writer of DAG what do with it.

This is handy if your users live in more than one time zone and you want to display datetime information according to
This is handy if your users live in more than one time zone and you want to display datetime information according to
each user’s wall clock.

Even if you are running Airflow in only one time zone it is still good practice to store data in UTC in your database
(also before Airflow became time zone aware this was also to recommended or even required setup). The main reason is
Daylight Saving Time (DST). Many countries have a system of DST, where clocks are moved forward in spring and backward
in autumn. If you’re working in local time, you’re likely to encounter errors twice a year, when the transitions
happen. (The pendulum and pytz documentation discusses these issues in greater detail.) This probably doesn’t matter
for a simple DAG, but it’s a problem if you are in, for example, financial services where you have end of day
deadlines to meet.
Even if you are running Airflow in only one time zone it is still good practice to store data in UTC in your database
(also before Airflow became time zone aware this was also to recommended or even required setup). The main reason is
Daylight Saving Time (DST). Many countries have a system of DST, where clocks are moved forward in spring and backward
in autumn. If you’re working in local time, you’re likely to encounter errors twice a year, when the transitions
happen. (The pendulum and pytz documentation discusses these issues in greater detail.) This probably doesn’t matter
for a simple DAG, but it’s a problem if you are in, for example, financial services where you have end of day
deadlines to meet.

The time zone is set in `airflow.cfg`. By default it is set to utc, but you change it to use the system’s settings or
an arbitrary IANA time zone, e.g. `Europe/Amsterdam`. It is dependent on `pendulum`, which is more accurate than `pytz`.
The time zone is set in `airflow.cfg`. By default it is set to utc, but you change it to use the system’s settings or
an arbitrary IANA time zone, e.g. `Europe/Amsterdam`. It is dependent on `pendulum`, which is more accurate than `pytz`.
Pendulum is installed when you install Airflow.

Please note that the Web UI currently only runs in UTC.
Expand All @@ -28,8 +28,8 @@ Concepts
Naïve and aware datetime objects
''''''''''''''''''''''''''''''''

Python’s datetime.datetime objects have a tzinfo attribute that can be used to store time zone information,
represented as an instance of a subclass of datetime.tzinfo. When this attribute is set and describes an offset,
Python’s datetime.datetime objects have a tzinfo attribute that can be used to store time zone information,
represented as an instance of a subclass of datetime.tzinfo. When this attribute is set and describes an offset,
a datetime object is aware. Otherwise, it’s naive.

You can use timezone.is_aware() and timezone.is_naive() to determine whether datetimes are aware or naive.
Expand All @@ -39,7 +39,7 @@ Because Airflow uses time-zone-aware datetime objects. If your code creates date
.. code:: python
from airflow.utils import timezone
now = timezone.utcnow()
a_date = timezone.datetime(2017,1,1)
Expand All @@ -49,9 +49,9 @@ Interpretation of naive datetime objects

Although Airflow operates fully time zone aware, it still accepts naive date time objects for `start_dates`
and `end_dates` in your DAG definitions. This is mostly in order to preserve backwards compatibility. In
case a naive `start_date` or `end_date` is encountered the default time zone is applied. It is applied
case a naive `start_date` or `end_date` is encountered the default time zone is applied. It is applied
in such a way that it is assumed that the naive date time is already in the default time zone. In other
words if you have a default time zone setting of `Europe/Amsterdam` and create a naive datetime `start_date` of
words if you have a default time zone setting of `Europe/Amsterdam` and create a naive datetime `start_date` of
`datetime(2017,1,1)` it is assumed to be a `start_date` of Jan 1, 2017 Amsterdam time.

.. code:: python
Expand All @@ -65,16 +65,16 @@ words if you have a default time zone setting of `Europe/Amsterdam` and create a
op = DummyOperator(task_id='dummy', dag=dag)
print(op.owner) # Airflow
Unfortunately, during DST transitions, some datetimes don’t exist or are ambiguous.
In such situations, pendulum raises an exception. That’s why you should always create aware
Unfortunately, during DST transitions, some datetimes don’t exist or are ambiguous.
In such situations, pendulum raises an exception. That’s why you should always create aware
datetime objects when time zone support is enabled.

In practice, this is rarely an issue. Airflow gives you aware datetime objects in the models and DAGs, and most often,
new datetime objects are created from existing ones through timedelta arithmetic. The only datetime that’s often
In practice, this is rarely an issue. Airflow gives you aware datetime objects in the models and DAGs, and most often,
new datetime objects are created from existing ones through timedelta arithmetic. The only datetime that’s often
created in application code is the current time, and timezone.utcnow() automatically does the right thing.


Default time zone
Default time zone
'''''''''''''''''

The default time zone is the time zone defined by the `default_timezone` setting under `[core]`. If
Expand All @@ -92,15 +92,15 @@ it is therefore important to make sure this setting is equal on all Airflow node
Time zone aware DAGs
--------------------

Creating a time zone aware DAG is quite simple. Just make sure to supply a time zone aware `start_date`. It is
Creating a time zone aware DAG is quite simple. Just make sure to supply a time zone aware `start_date`. It is
recommended to use `pendulum` for this, but `pytz` (to be installed manually) can also be used for this.

.. code:: python
import pendulum
local_tz = pendulum.timezone("Europe/Amsterdam")
default_args=dict(
start_date=datetime(2016, 1, 1, tzinfo=local_tz),
owner='Airflow'
Expand All @@ -110,29 +110,32 @@ recommended to use `pendulum` for this, but `pytz` (to be installed manually) ca
op = DummyOperator(task_id='dummy', dag=dag)
print(dag.timezone) # <Timezone [Europe/Amsterdam]>
Please note that while it is possible to set a `start_date` and `end_date` for Tasks always the DAG timezone
or global timezone (in that order) will be used to calculate the next execution date. Upon first encounter
the start date or end date will be converted to UTC using the timezone associated with start_date or end_date,
then for calculations this timezone information will be disregarded.

Templates
'''''''''

Airflow returns time zone aware datetimes in templates, but does not convert them to local time so they remain in UTC.
Airflow returns time zone aware datetimes in templates, but does not convert them to local time so they remain in UTC.
It is left up to the DAG to handle this.

.. code:: python
import pendulum
local_tz = pendulum.timezone("Europe/Amsterdam")
local_tz.convert(execution_date)
Cron schedules
''''''''''''''

In case you set a cron schedule, Airflow assumes you will always want to run at the exact same time. It will
then ignore day light savings time. Thus, if you have a schedule that says
run at end of interval every day at 08:00 GMT+1 it will always run end of interval 08:00 GMT+1,
regardless if day light savings time is in place.
In case you set a cron schedule, Airflow assumes you will always want to run at the exact same time. It will
then ignore day light savings time. Thus, if you have a schedule that says
run at end of interval every day at 08:00 GMT+1 it will always run end of interval 08:00 GMT+1,
regardless if day light savings time is in place.


Time deltas
Expand Down
2 changes: 1 addition & 1 deletion tests/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from airflow.executors import SequentialExecutor
from airflow.models import Variable

configuration.conf.load_test_config()
configuration.conf.load_test_config() # NOQA: E402
from airflow import jobs, models, DAG, utils, macros, settings, exceptions
from airflow.models import BaseOperator
from airflow.operators.bash_operator import BashOperator
Expand Down
10 changes: 10 additions & 0 deletions tests/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1499,6 +1499,16 @@ def test_timezone_awareness(self):
ti = TI(task=op1, execution_date=execution_date)
self.assertEquals(ti.execution_date, utc_date)

def test_task_naive_datetime(self):
NAIVE_DATETIME = DEFAULT_DATE.replace(tzinfo=None)

op_no_dag = DummyOperator(task_id='test_task_naive_datetime',
start_date=NAIVE_DATETIME,
end_date=NAIVE_DATETIME)

self.assertTrue(op_no_dag.start_date.tzinfo)
self.assertTrue(op_no_dag.end_date.tzinfo)

def test_set_dag(self):
"""
Test assigning Operators to Dags, including deferred assignment
Expand Down

0 comments on commit 794e478

Please sign in to comment.