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

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_RSS: Final[str] = "ddd, DD MMM YYYY HH:mm:ss Z" 

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

22 

23 

24class DateTimeFormatter: 

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

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

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

28 

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

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

31 ) 

32 

33 locale: locales.Locale 

34 

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

36 self.locale = locales.get_locale(locale) 

37 

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

39 # FIXME: _format_token() is nullable 

40 return cls._FORMAT_RE.sub( 

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

42 ) 

43 

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

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

46 return token[1:-1] 

47 

48 if token == "YYYY": 

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

50 if token == "YY": 

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

52 

53 if token == "MMMM": 

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

55 if token == "MMM": 

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

57 if token == "MM": 

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

59 if token == "M": 

60 return f"{dt.month}" 

61 

62 if token == "DDDD": 

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

64 if token == "DDD": 

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

66 if token == "DD": 

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

68 if token == "D": 

69 return f"{dt.day}" 

70 

71 if token == "Do": 

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

73 

74 if token == "dddd": 

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

76 if token == "ddd": 

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

78 if token == "d": 

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

80 

81 if token == "HH": 

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

83 if token == "H": 

84 return f"{dt.hour}" 

85 if token == "hh": 

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

87 if token == "h": 

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

89 

90 if token == "mm": 

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

92 if token == "m": 

93 return f"{dt.minute}" 

94 

95 if token == "ss": 

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

97 if token == "s": 

98 return f"{dt.second}" 

99 

100 if token == "SSSSSS": 

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

102 if token == "SSSSS": 

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

104 if token == "SSSS": 

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

106 if token == "SSS": 

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

108 if token == "SS": 

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

110 if token == "S": 

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

112 

113 if token == "X": 

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

115 

116 if token == "x": 

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

118 

119 if token == "ZZZ": 

120 return dt.tzname() 

121 

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

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

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

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

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

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

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

129 

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

131 total_minutes = abs(total_minutes) 

132 hour, minute = divmod(total_minutes, 60) 

133 

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

135 

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

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

138 

139 if token == "W": 

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

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