|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- """
- PHP date() style date formatting
- See https://www.php.net/date for format strings
-
- Usage:
- >>> import datetime
- >>> d = datetime.datetime.now()
- >>> df = DateFormat(d)
- >>> print(df.format('jS F Y H:i'))
- 7th October 2003 11:39
- >>>
- """
- import calendar
- import datetime
- from email.utils import format_datetime as format_datetime_rfc5322
-
- from django.utils.dates import (
- MONTHS,
- MONTHS_3,
- MONTHS_ALT,
- MONTHS_AP,
- WEEKDAYS,
- WEEKDAYS_ABBR,
- )
- from django.utils.regex_helper import _lazy_re_compile
- from django.utils.timezone import (
- _datetime_ambiguous_or_imaginary,
- get_default_timezone,
- is_naive,
- make_aware,
- )
- from django.utils.translation import gettext as _
-
- re_formatchars = _lazy_re_compile(r"(?<!\\)([aAbcdDeEfFgGhHiIjlLmMnNoOPrsStTUuwWyYzZ])")
- re_escaped = _lazy_re_compile(r"\\(.)")
-
-
- class Formatter:
- def format(self, formatstr):
- pieces = []
- for i, piece in enumerate(re_formatchars.split(str(formatstr))):
- if i % 2:
- if type(self.data) is datetime.date and hasattr(TimeFormat, piece):
- raise TypeError(
- "The format for date objects may not contain "
- "time-related format specifiers (found '%s')." % piece
- )
- pieces.append(str(getattr(self, piece)()))
- elif piece:
- pieces.append(re_escaped.sub(r"\1", piece))
- return "".join(pieces)
-
-
- class TimeFormat(Formatter):
- def __init__(self, obj):
- self.data = obj
- self.timezone = None
-
- # We only support timezone when formatting datetime objects,
- # not date objects (timezone information not appropriate),
- # or time objects (against established django policy).
- if isinstance(obj, datetime.datetime):
- if is_naive(obj):
- self.timezone = get_default_timezone()
- else:
- self.timezone = obj.tzinfo
-
- @property
- def _no_timezone_or_datetime_is_ambiguous_or_imaginary(self):
- return not self.timezone or _datetime_ambiguous_or_imaginary(
- self.data, self.timezone
- )
-
- def a(self):
- "'a.m.' or 'p.m.'"
- if self.data.hour > 11:
- return _("p.m.")
- return _("a.m.")
-
- def A(self):
- "'AM' or 'PM'"
- if self.data.hour > 11:
- return _("PM")
- return _("AM")
-
- def e(self):
- """
- Timezone name.
-
- If timezone information is not available, return an empty string.
- """
- if not self.timezone:
- return ""
-
- try:
- if hasattr(self.data, "tzinfo") and self.data.tzinfo:
- return self.data.tzname() or ""
- except NotImplementedError:
- pass
- return ""
-
- def f(self):
- """
- Time, in 12-hour hours and minutes, with minutes left off if they're
- zero.
- Examples: '1', '1:30', '2:05', '2'
- Proprietary extension.
- """
- hour = self.data.hour % 12 or 12
- minute = self.data.minute
- return "%d:%02d" % (hour, minute) if minute else hour
-
- def g(self):
- "Hour, 12-hour format without leading zeros; i.e. '1' to '12'"
- return self.data.hour % 12 or 12
-
- def G(self):
- "Hour, 24-hour format without leading zeros; i.e. '0' to '23'"
- return self.data.hour
-
- def h(self):
- "Hour, 12-hour format; i.e. '01' to '12'"
- return "%02d" % (self.data.hour % 12 or 12)
-
- def H(self):
- "Hour, 24-hour format; i.e. '00' to '23'"
- return "%02d" % self.data.hour
-
- def i(self):
- "Minutes; i.e. '00' to '59'"
- return "%02d" % self.data.minute
-
- def O(self): # NOQA: E743, E741
- """
- Difference to Greenwich time in hours; e.g. '+0200', '-0430'.
-
- If timezone information is not available, return an empty string.
- """
- if self._no_timezone_or_datetime_is_ambiguous_or_imaginary:
- return ""
-
- seconds = self.Z()
- sign = "-" if seconds < 0 else "+"
- seconds = abs(seconds)
- return "%s%02d%02d" % (sign, seconds // 3600, (seconds // 60) % 60)
-
- def P(self):
- """
- Time, in 12-hour hours, minutes and 'a.m.'/'p.m.', with minutes left off
- if they're zero and the strings 'midnight' and 'noon' if appropriate.
- Examples: '1 a.m.', '1:30 p.m.', 'midnight', 'noon', '12:30 p.m.'
- Proprietary extension.
- """
- if self.data.minute == 0 and self.data.hour == 0:
- return _("midnight")
- if self.data.minute == 0 and self.data.hour == 12:
- return _("noon")
- return "%s %s" % (self.f(), self.a())
-
- def s(self):
- "Seconds; i.e. '00' to '59'"
- return "%02d" % self.data.second
-
- def T(self):
- """
- Time zone of this machine; e.g. 'EST' or 'MDT'.
-
- If timezone information is not available, return an empty string.
- """
- if self._no_timezone_or_datetime_is_ambiguous_or_imaginary:
- return ""
-
- return str(self.timezone.tzname(self.data))
-
- def u(self):
- "Microseconds; i.e. '000000' to '999999'"
- return "%06d" % self.data.microsecond
-
- def Z(self):
- """
- Time zone offset in seconds (i.e. '-43200' to '43200'). The offset for
- timezones west of UTC is always negative, and for those east of UTC is
- always positive.
-
- If timezone information is not available, return an empty string.
- """
- if self._no_timezone_or_datetime_is_ambiguous_or_imaginary:
- return ""
-
- offset = self.timezone.utcoffset(self.data)
-
- # `offset` is a datetime.timedelta. For negative values (to the west of
- # UTC) only days can be negative (days=-1) and seconds are always
- # positive. e.g. UTC-1 -> timedelta(days=-1, seconds=82800, microseconds=0)
- # Positive offsets have days=0
- return offset.days * 86400 + offset.seconds
-
-
- class DateFormat(TimeFormat):
- def b(self):
- "Month, textual, 3 letters, lowercase; e.g. 'jan'"
- return MONTHS_3[self.data.month]
-
- def c(self):
- """
- ISO 8601 Format
- Example : '2008-01-02T10:30:00.000123'
- """
- return self.data.isoformat()
-
- def d(self):
- "Day of the month, 2 digits with leading zeros; i.e. '01' to '31'"
- return "%02d" % self.data.day
-
- def D(self):
- "Day of the week, textual, 3 letters; e.g. 'Fri'"
- return WEEKDAYS_ABBR[self.data.weekday()]
-
- def E(self):
- "Alternative month names as required by some locales. Proprietary extension."
- return MONTHS_ALT[self.data.month]
-
- def F(self):
- "Month, textual, long; e.g. 'January'"
- return MONTHS[self.data.month]
-
- def I(self): # NOQA: E743, E741
- "'1' if daylight saving time, '0' otherwise."
- if self._no_timezone_or_datetime_is_ambiguous_or_imaginary:
- return ""
- return "1" if self.timezone.dst(self.data) else "0"
-
- def j(self):
- "Day of the month without leading zeros; i.e. '1' to '31'"
- return self.data.day
-
- def l(self): # NOQA: E743, E741
- "Day of the week, textual, long; e.g. 'Friday'"
- return WEEKDAYS[self.data.weekday()]
-
- def L(self):
- "Boolean for whether it is a leap year; i.e. True or False"
- return calendar.isleap(self.data.year)
-
- def m(self):
- "Month; i.e. '01' to '12'"
- return "%02d" % self.data.month
-
- def M(self):
- "Month, textual, 3 letters; e.g. 'Jan'"
- return MONTHS_3[self.data.month].title()
-
- def n(self):
- "Month without leading zeros; i.e. '1' to '12'"
- return self.data.month
-
- def N(self):
- "Month abbreviation in Associated Press style. Proprietary extension."
- return MONTHS_AP[self.data.month]
-
- def o(self):
- "ISO 8601 year number matching the ISO week number (W)"
- return self.data.isocalendar()[0]
-
- def r(self):
- "RFC 5322 formatted date; e.g. 'Thu, 21 Dec 2000 16:01:07 +0200'"
- if type(self.data) is datetime.date:
- raise TypeError(
- "The format for date objects may not contain time-related "
- "format specifiers (found 'r')."
- )
- if is_naive(self.data):
- dt = make_aware(self.data, timezone=self.timezone)
- else:
- dt = self.data
- return format_datetime_rfc5322(dt)
-
- def S(self):
- """
- English ordinal suffix for the day of the month, 2 characters; i.e.
- 'st', 'nd', 'rd' or 'th'.
- """
- if self.data.day in (11, 12, 13): # Special case
- return "th"
- last = self.data.day % 10
- if last == 1:
- return "st"
- if last == 2:
- return "nd"
- if last == 3:
- return "rd"
- return "th"
-
- def t(self):
- "Number of days in the given month; i.e. '28' to '31'"
- return "%02d" % calendar.monthrange(self.data.year, self.data.month)[1]
-
- def U(self):
- "Seconds since the Unix epoch (January 1 1970 00:00:00 GMT)"
- value = self.data
- if not isinstance(value, datetime.datetime):
- value = datetime.datetime.combine(value, datetime.time.min)
- return int(value.timestamp())
-
- def w(self):
- "Day of the week, numeric, i.e. '0' (Sunday) to '6' (Saturday)"
- return (self.data.weekday() + 1) % 7
-
- def W(self):
- "ISO-8601 week number of year, weeks starting on Monday"
- return self.data.isocalendar()[1]
-
- def y(self):
- """Year, 2 digits with leading zeros; e.g. '99'."""
- return "%02d" % (self.data.year % 100)
-
- def Y(self):
- """Year, 4 digits with leading zeros; e.g. '1999'."""
- return "%04d" % self.data.year
-
- def z(self):
- """Day of the year, i.e. 1 to 366."""
- return self.data.timetuple().tm_yday
-
-
- def format(value, format_string):
- "Convenience function"
- df = DateFormat(value)
- return df.format(format_string)
-
-
- def time_format(value, format_string):
- "Convenience function"
- tf = TimeFormat(value)
- return tf.format(format_string)
|