This document describes the current stable version of Celery (5.2). For development docs, go here.

celery.utils.time

Utilities related to dates, times, intervals, and timezones.

class celery.utils.time.LocalTimezone

Local time implementation.

Note

Used only when the enable_utc setting is disabled.

dst(dt)

datetime -> DST offset as timedelta positive east of UTC.

fromutc(dt)

datetime in UTC -> datetime in local time.

tzname(dt)

datetime -> string name of time zone.

utcoffset(dt)

datetime -> timedelta showing offset from UTC, negative values indicating West of UTC

celery.utils.time.adjust_timestamp(ts, offset, here=<function utcoffset>)

Adjust timestamp based on provided utcoffset.

celery.utils.time.delta_resolution(dt, delta)

Round a datetime to the resolution of timedelta.

If the timedelta is in days, the datetime will be rounded to the nearest days, if the timedelta is in hours the datetime will be rounded to the nearest hour, and so on until seconds, which will just return the original datetime.

class celery.utils.time.ffwd(year=None, month=None, weeks=0, weekday=None, day=None, hour=None, minute=None, second=None, microsecond=None, **kwargs)

Version of dateutil.relativedelta that only supports addition.

celery.utils.time.get_exponential_backoff_interval(factor, retries, maximum, full_jitter=False)

Calculate the exponential backoff wait time.

celery.utils.time.humanize_seconds(secs, prefix='', sep='', now='now', microseconds=False)

Show seconds in human form.

For example, 60 becomes “1 minute”, and 7200 becomes “2 hours”.

Parameters:

• prefix (str) – can be used to add a preposition to the output (e.g., ‘in’ will give ‘in 1 second’, but add nothing to ‘now’).

• now (str) – Literal ‘now’.

• microseconds (bool) – Include microseconds.

celery.utils.time.is_naive(dt)

Return True if datetime is naive.

celery.utils.time.localize(dt, tz)

Convert aware datetime to another timezone.

celery.utils.time.make_aware(dt, tz)

Set timezone for a datetime object.

celery.utils.time.maybe_iso8601(dt)

Either datetime | str -> datetime or None -> None.

celery.utils.time.maybe_make_aware(dt, tz=None)

Convert dt to aware datetime, do nothing if dt is already aware.

celery.utils.time.maybe_timedelta(delta)

Convert integer to timedelta, if argument is an integer.

celery.utils.time.rate(r)

Convert rate string (“100/m”, “2/h” or “0.5/s”) to seconds.

celery.utils.time.remaining(start, ends_in, now=None, relative=False)

Calculate the remaining time for a start date and a timedelta.

For example, “how many seconds left for 30 seconds after start?”

Parameters:

• start (datetime) – Starting date.

• ends_in (timedelta) – The end delta.

• relative (bool) – If enabled the end time will be calculated using delta_resolution() (i.e., rounded to the resolution of ends_in).

• now (Callable) – Function returning the current time and date. Defaults to datetime.utcnow().

Returns:

Remaining time.

Return type:

timedelta

celery.utils.time.to_utc(dt)

Convert naive datetime to UTC.

celery.utils.time.utcoffset(time=<module 'time' (built-in)>, localtime=<built-in function localtime>)

Return the current offset to UTC in hours.

celery.utils.time.weekday(name)

Return the position of a weekday: 0 - 7, where 0 is Sunday.

Example

>>> weekday('sunday'), weekday('sun'), weekday('mon')
(0, 0, 1)