Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/arrow/formatter.py: 23%

1"""Provides the :class:`Arrow <arrow.formatter.DateTimeFormatter>` class, an improved formatter for datetimes.""" 

2 

3import re 

4from datetime import datetime, timedelta 

5from typing import Final, Optional, Pattern, cast 

6 

7from dateutil import tz as dateutil_tz 

8 

9from arrow import locales 

10from arrow.constants import DEFAULT_LOCALE 

11 

12FORMAT_ATOM: Final[str] = "YYYY-MM-DD HH:mm:ssZZ" 

13FORMAT_COOKIE: Final[str] = "dddd, DD-MMM-YYYY HH:mm:ss ZZZ" 

14FORMAT_RFC822: Final[str] = "ddd, DD MMM YY HH:mm:ss Z" 

15FORMAT_RFC850: Final[str] = "dddd, DD-MMM-YY HH:mm:ss ZZZ" 

16FORMAT_RFC1036: Final[str] = "ddd, DD MMM YY HH:mm:ss Z" 

17FORMAT_RFC1123: Final[str] = "ddd, DD MMM YYYY HH:mm:ss Z" 

18FORMAT_RFC2822: Final[str] = "ddd, DD MMM YYYY HH:mm:ss Z" 

19FORMAT_RFC3339: Final[str] = "YYYY-MM-DD HH:mm:ssZZ" 

20FORMAT_RFC3339_STRICT: Final[str] = "YYYY-MM-DDTHH:mm:ssZZ" 

21FORMAT_RSS: Final[str] = "ddd, DD MMM YYYY HH:mm:ss Z" 

22FORMAT_W3C: Final[str] = "YYYY-MM-DD HH:mm:ssZZ" 

23 

24 

25class DateTimeFormatter: 

26 # This pattern matches characters enclosed in square brackets are matched as 

27 # an atomic group. For more info on atomic groups and how to they are 

28 # emulated in Python's re library, see https://stackoverflow.com/a/13577411/2701578 

29 

30 _FORMAT_RE: Final[Pattern[str]] = re.compile( 

31 r"(\[(?:(?=(?P<literal>[^]]))(?P=literal))*\]|YYY?Y?|MM?M?M?|Do|DD?D?D?|d?dd?d?|HH?|hh?|mm?|ss?|SS?S?S?S?S?|ZZ?Z?|a|A|X|x|W)" 

32 ) 

33 

34 locale: locales.Locale 

35 

36 def __init__(self, locale: str = DEFAULT_LOCALE) -> None: 

37 self.locale = locales.get_locale(locale) 

38 

39 def format(cls, dt: datetime, fmt: str) -> str: 

40 # FIXME: _format_token() is nullable 

41 return cls._FORMAT_RE.sub( 

42 lambda m: cast(str, cls._format_token(dt, m.group(0))), fmt 

43 ) 

44 

45 def _format_token(self, dt: datetime, token: Optional[str]) -> Optional[str]: 

46 if token and token.startswith("[") and token.endswith("]"): 

47 return token[1:-1] 

48 

49 if token == "YYYY": 

50 return self.locale.year_full(dt.year) 

51 if token == "YY": 

52 return self.locale.year_abbreviation(dt.year) 

53 

54 if token == "MMMM": 

55 return self.locale.month_name(dt.month) 

56 if token == "MMM": 

57 return self.locale.month_abbreviation(dt.month) 

58 if token == "MM": 

59 return f"{dt.month:02d}" 

60 if token == "M": 

61 return f"{dt.month}" 

62 

63 if token == "DDDD": 

64 return f"{dt.timetuple().tm_yday:03d}" 

65 if token == "DDD": 

66 return f"{dt.timetuple().tm_yday}" 

67 if token == "DD": 

68 return f"{dt.day:02d}" 

69 if token == "D": 

70 return f"{dt.day}" 

71 

72 if token == "Do": 

73 return self.locale.ordinal_number(dt.day) 

74 

75 if token == "dddd": 

76 return self.locale.day_name(dt.isoweekday()) 

77 if token == "ddd": 

78 return self.locale.day_abbreviation(dt.isoweekday()) 

79 if token == "d": 

80 return f"{dt.isoweekday()}" 

81 

82 if token == "HH": 

83 return f"{dt.hour:02d}" 

84 if token == "H": 

85 return f"{dt.hour}" 

86 if token == "hh": 

87 return f"{dt.hour if 0 < dt.hour < 13 else abs(dt.hour - 12):02d}" 

88 if token == "h": 

89 return f"{dt.hour if 0 < dt.hour < 13 else abs(dt.hour - 12)}" 

90 

91 if token == "mm": 

92 return f"{dt.minute:02d}" 

93 if token == "m": 

94 return f"{dt.minute}" 

95 

96 if token == "ss": 

97 return f"{dt.second:02d}" 

98 if token == "s": 

99 return f"{dt.second}" 

100 

101 if token == "SSSSSS": 

102 return f"{dt.microsecond:06d}" 

103 if token == "SSSSS": 

104 return f"{dt.microsecond // 10:05d}" 

105 if token == "SSSS": 

106 return f"{dt.microsecond // 100:04d}" 

107 if token == "SSS": 

108 return f"{dt.microsecond // 1000:03d}" 

109 if token == "SS": 

110 return f"{dt.microsecond // 10000:02d}" 

111 if token == "S": 

112 return f"{dt.microsecond // 100000}" 

113 

114 if token == "X": 

115 return f"{dt.timestamp()}" 

116 

117 if token == "x": 

118 return f"{dt.timestamp() * 1_000_000:.0f}" 

119 

120 if token == "ZZZ": 

121 return dt.tzname() 

122 

123 if token in ["ZZ", "Z"]: 

124 separator = ":" if token == "ZZ" else "" 

125 tz = dateutil_tz.tzutc() if dt.tzinfo is None else dt.tzinfo 

126 # `dt` must be aware object. Otherwise, this line will raise AttributeError 

127 # https://github.com/arrow-py/arrow/pull/883#discussion_r529866834 

128 # datetime awareness: https://docs.python.org/3/library/datetime.html#aware-and-naive-objects 

129 total_minutes = int(cast(timedelta, tz.utcoffset(dt)).total_seconds() / 60) 

130 

131 sign = "+" if total_minutes >= 0 else "-" 

132 total_minutes = abs(total_minutes) 

133 hour, minute = divmod(total_minutes, 60) 

134 

135 return f"{sign}{hour:02d}{separator}{minute:02d}" 

136 

137 if token in ("a", "A"): 

138 return self.locale.meridian(dt.hour, token) 

139 

140 if token == "W": 

141 year, week, day = dt.isocalendar() 

142 return f"{year}-W{week:02d}-{day}"