Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/pendulum/tz/timezone.py: 76%

1# mypy: no-warn-redundant-casts 

2from __future__ import annotations 

3 

4import datetime as _datetime 

5 

6from abc import ABC 

7from abc import abstractmethod 

8from typing import TYPE_CHECKING 

9from typing import TypeVar 

10from typing import cast 

11 

12from pendulum.tz.exceptions import AmbiguousTime 

13from pendulum.tz.exceptions import InvalidTimezone 

14from pendulum.tz.exceptions import NonExistingTime 

15from pendulum.utils._compat import zoneinfo 

16 

17 

18if TYPE_CHECKING: 

19 from typing_extensions import Self 

20 

21POST_TRANSITION = "post" 

22PRE_TRANSITION = "pre" 

23TRANSITION_ERROR = "error" 

24 

25 

26_DT = TypeVar("_DT", bound=_datetime.datetime) 

27 

28 

29class PendulumTimezone(ABC): 

30 @property 

31 @abstractmethod 

32 def name(self) -> str: 

33 raise NotImplementedError 

34 

35 @abstractmethod 

36 def convert(self, dt: _DT, raise_on_unknown_times: bool = False) -> _DT: 

37 raise NotImplementedError 

38 

39 @abstractmethod 

40 def datetime( 

41 self, 

42 year: int, 

43 month: int, 

44 day: int, 

45 hour: int = 0, 

46 minute: int = 0, 

47 second: int = 0, 

48 microsecond: int = 0, 

49 ) -> _datetime.datetime: 

50 raise NotImplementedError 

51 

52 

53class Timezone(zoneinfo.ZoneInfo, PendulumTimezone): 

54 """ 

55 Represents a named timezone. 

56 

57 The accepted names are those provided by the IANA time zone database. 

58 

59 >>> from pendulum.tz.timezone import Timezone 

60 >>> tz = Timezone('Europe/Paris') 

61 """ 

62 

63 def __new__(cls, key: str) -> Self: 

64 try: 

65 return super().__new__(cls, key) # type: ignore[call-arg] 

66 except zoneinfo.ZoneInfoNotFoundError: 

67 raise InvalidTimezone(key) 

68 

69 @property 

70 def name(self) -> str: 

71 return self.key 

72 

73 def convert(self, dt: _DT, raise_on_unknown_times: bool = False) -> _DT: 

74 """ 

75 Converts a datetime in the current timezone. 

76 

77 If the datetime is naive, it will be normalized. 

78 

79 >>> from datetime import datetime 

80 >>> from pendulum import timezone 

81 >>> paris = timezone('Europe/Paris') 

82 >>> dt = datetime(2013, 3, 31, 2, 30, fold=1) 

83 >>> in_paris = paris.convert(dt) 

84 >>> in_paris.isoformat() 

85 '2013-03-31T03:30:00+02:00' 

86 

87 If the datetime is aware, it will be properly converted. 

88 

89 >>> new_york = timezone('America/New_York') 

90 >>> in_new_york = new_york.convert(in_paris) 

91 >>> in_new_york.isoformat() 

92 '2013-03-30T21:30:00-04:00' 

93 """ 

94 

95 if dt.tzinfo is None: 

96 # Technically, utcoffset() can return None, but none of the zone information 

97 # in tzdata sets _tti_before to None. This can be checked with the following 

98 # code: 

99 # 

100 # >>> import zoneinfo 

101 # >>> from zoneinfo._zoneinfo import ZoneInfo 

102 # 

103 # >>> for tzname in zoneinfo.available_timezones(): 

104 # >>> if ZoneInfo(tzname)._tti_before is None: 

105 # >>> print(tzname) 

106 

107 offset_before = cast( 

108 _datetime.timedelta, 

109 (self.utcoffset(dt.replace(fold=0)) if dt.fold else self.utcoffset(dt)), 

110 ) 

111 offset_after = cast( 

112 _datetime.timedelta, 

113 (self.utcoffset(dt) if dt.fold else self.utcoffset(dt.replace(fold=1))), 

114 ) 

115 

116 if offset_after > offset_before: 

117 # Skipped time 

118 if raise_on_unknown_times: 

119 raise NonExistingTime(dt) 

120 

121 dt = cast( 

122 _DT, 

123 dt 

124 + ( 

125 (offset_after - offset_before) 

126 if dt.fold 

127 else (offset_before - offset_after) 

128 ), 

129 ) 

130 elif offset_before > offset_after and raise_on_unknown_times: 

131 # Repeated time 

132 raise AmbiguousTime(dt) 

133 

134 return dt.replace(tzinfo=self) 

135 

136 return cast(_DT, dt.astimezone(self)) 

137 

138 def datetime( 

139 self, 

140 year: int, 

141 month: int, 

142 day: int, 

143 hour: int = 0, 

144 minute: int = 0, 

145 second: int = 0, 

146 microsecond: int = 0, 

147 ) -> _datetime.datetime: 

148 """ 

149 Return a normalized datetime for the current timezone. 

150 """ 

151 return self.convert( 

152 _datetime.datetime( 

153 year, month, day, hour, minute, second, microsecond, fold=1 

154 ) 

155 ) 

156 

157 def __repr__(self) -> str: 

158 return f"{self.__class__.__name__}('{self.name}')" 

159 

160 

161class FixedTimezone(_datetime.tzinfo, PendulumTimezone): 

162 def __init__(self, offset: int, name: str | None = None) -> None: 

163 sign = "-" if offset < 0 else "+" 

164 

165 minutes = offset / 60 

166 hour, minute = divmod(abs(int(minutes)), 60) 

167 

168 if not name: 

169 name = f"{sign}{hour:02d}:{minute:02d}" 

170 

171 self._name = name 

172 self._offset = offset 

173 self._utcoffset = _datetime.timedelta(seconds=offset) 

174 

175 @property 

176 def name(self) -> str: 

177 return self._name 

178 

179 def convert(self, dt: _DT, raise_on_unknown_times: bool = False) -> _DT: 

180 if dt.tzinfo is None: 

181 return dt.__class__( 

182 dt.year, 

183 dt.month, 

184 dt.day, 

185 dt.hour, 

186 dt.minute, 

187 dt.second, 

188 dt.microsecond, 

189 tzinfo=self, 

190 fold=0, 

191 ) 

192 

193 return cast(_DT, dt.astimezone(self)) 

194 

195 def datetime( 

196 self, 

197 year: int, 

198 month: int, 

199 day: int, 

200 hour: int = 0, 

201 minute: int = 0, 

202 second: int = 0, 

203 microsecond: int = 0, 

204 ) -> _datetime.datetime: 

205 return self.convert( 

206 _datetime.datetime( 

207 year, month, day, hour, minute, second, microsecond, fold=1 

208 ) 

209 ) 

210 

211 @property 

212 def offset(self) -> int: 

213 return self._offset 

214 

215 def utcoffset(self, dt: _datetime.datetime | None) -> _datetime.timedelta: 

216 return self._utcoffset 

217 

218 def dst(self, dt: _datetime.datetime | None) -> _datetime.timedelta: 

219 return _datetime.timedelta() 

220 

221 def fromutc(self, dt: _datetime.datetime) -> _datetime.datetime: 

222 # Use the stdlib datetime's add method to avoid infinite recursion 

223 return (_datetime.datetime.__add__(dt, self._utcoffset)).replace(tzinfo=self) 

224 

225 def tzname(self, dt: _datetime.datetime | None) -> str | None: 

226 return self._name 

227 

228 def __getinitargs__(self) -> tuple[int, str]: 

229 return self._offset, self._name 

230 

231 def __repr__(self) -> str: 

232 name = "" 

233 if self._name: 

234 name = f', name="{self._name}"' 

235 

236 return f"{self.__class__.__name__}({self._offset}{name})" 

237 

238 

239UTC = Timezone("UTC")