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, timezone 

5from typing import Final, Optional, Pattern, cast 

6 

7from arrow import locales 

8from arrow.constants import DEFAULT_LOCALE 

9 

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

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

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

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

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

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

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

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

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

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

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

21 

22 

23class DateTimeFormatter: 

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

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

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

27 

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

29 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)" 

30 ) 

31 

32 locale: locales.Locale 

33 

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

35 self.locale = locales.get_locale(locale) 

36 

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

38 # FIXME: _format_token() is nullable 

39 return cls._FORMAT_RE.sub( 

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

41 ) 

42 

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

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

45 return token[1:-1] 

46 

47 if token == "YYYY": 

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

49 if token == "YY": 

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

51 

52 if token == "MMMM": 

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

54 if token == "MMM": 

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

56 if token == "MM": 

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

58 if token == "M": 

59 return f"{dt.month}" 

60 

61 if token == "DDDD": 

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

63 if token == "DDD": 

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

65 if token == "DD": 

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

67 if token == "D": 

68 return f"{dt.day}" 

69 

70 if token == "Do": 

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

72 

73 if token == "dddd": 

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

75 if token == "ddd": 

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

77 if token == "d": 

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

79 

80 if token == "HH": 

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

82 if token == "H": 

83 return f"{dt.hour}" 

84 if token == "hh": 

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

86 if token == "h": 

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

88 

89 if token == "mm": 

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

91 if token == "m": 

92 return f"{dt.minute}" 

93 

94 if token == "ss": 

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

96 if token == "s": 

97 return f"{dt.second}" 

98 

99 if token == "SSSSSS": 

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

101 if token == "SSSSS": 

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

103 if token == "SSSS": 

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

105 if token == "SSS": 

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

107 if token == "SS": 

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

109 if token == "S": 

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

111 

112 if token == "X": 

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

114 

115 if token == "x": 

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

117 

118 if token == "ZZZ": 

119 return dt.tzname() 

120 

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

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

123 tz = timezone.utc if dt.tzinfo is None else dt.tzinfo 

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

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

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

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

128 

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

130 total_minutes = abs(total_minutes) 

131 hour, minute = divmod(total_minutes, 60) 

132 

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

134 

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

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

137 

138 if token == "W": 

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

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