IsoWeekDate
class¶
iso_week_date.isoweekdate.IsoWeekDate
¶
Bases: BaseIsoWeek
Represents ISO Week date in the "YYYY-WNN-D" format.
The class implements methods and functionalities to work directly with iso week date format and avoid moving back
and forth between date
, datetime
and str
objects.
Attributes:
Name | Type | Description |
---|---|---|
value_ |
iso-week string of format "YYYY-WNN-D" where:
|
Source code in iso_week_date/isoweekdate.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
|
day: int
property
¶
isoweek: str
property
¶
__add__(other)
¶
Addition operation.
It supports addition with the following types:
int
: interpreted as number of days to be added to theIsoWeekDate
value.timedelta
: convertsIsoWeekDate
todatetime
, addstimedelta
and converts back toIsoWeekDate
object.Iterable
ofint
and/ortimedelta
: adds each element of the iterable to theIsoWeekDate
value and returns a generator ofIsoWeekDate
objects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other |
Union[int, timedelta, Iterable[Union[int, timedelta]]]
|
Object to add to |
required |
Returns:
Type | Description |
---|---|
Union[Self, Generator[Self, None, None]]
|
New |
Raises:
Type | Description |
---|---|
TypeError
|
If |
Examples:
from datetime import timedelta
from iso_week_date import IsoWeekDate
IsoWeekDate("2023-W01-1") + 1 # IsoWeekDate("2023-W01-2")
IsoWeekDate("2023-W01-1") + timedelta(weeks=2) # IsoWeekDate("2023-W03-1")
tuple(IsoWeekDate("2023-W01-1") + (1, 2))
# (IsoWeekDate("2023-W01-2"), IsoWeekDate("2023-W01-3"))
Source code in iso_week_date/isoweekdate.py
__sub__(other)
¶
Subtraction operation.
It supports subtraction with the following types:
int
: interpreted as number of days to be subtracted to theIsoWeekDate
value.timedelta
: convertsIsoWeekDate
todatetime
, subtractstimedelta
and converts back toIsoWeekDate
object.IsoWeekDate
: will result in the difference between values in days (int
type).Iterable
ofint
,timedelta
and/orIsoWeekDate
: subtracts each element of the iterable to theIsoWeekDate
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other |
Union[int, timedelta, Self, Iterable[Union[int, timedelta, Self]]]
|
Object to subtract to |
required |
Returns:
Type | Description |
---|---|
Union[int, Self, Generator[Union[int, Self], None, None]]
|
Results from the subtraction, can be |
Raises:
Type | Description |
---|---|
TypeError
|
If |
Examples:
from datetime import timedelta
from iso_week_date import IsoWeekDate
IsoWeekDate("2023-W01-1") - 1 # IsoWeekDate("2022-W52-7")
IsoWeekDate("2023-W01-1") - timedelta(weeks=2) # IsoWeekDate("2022-W51-1")
tuple(IsoWeekDate("2023-W01-1") - (1, 2))
# (IsoWeekDate("2022-W52-7"), IsoWeekDate("2022-W52-6"))
IsoWeekDate("2023-W01-1") - IsoWeekDate("2022-W52-3") # 5
Source code in iso_week_date/isoweekdate.py
daysout(n_days, *, step=1, as_str=True)
¶
Generate range of IsoWeekDate
(or str
) from one to n_days
ahead of current value
, with given step
.
If as_str
is flagged as True
, it will return str
values, otherwise it will return IsoWeekDate
objects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n_days |
int
|
Number of days to be generated from current value. |
required |
step |
int
|
Step between days, must be positive integer. |
1
|
as_str |
bool
|
Whether to return |
True
|
Returns:
Type | Description |
---|---|
None
|
Generator of |
Raises:
Type | Description |
---|---|
TypeError
|
If |
ValueError
|
If |
Examples:
from iso_week_date import IsoWeekDate
iso = IsoWeekDate("2023-W01-1")
tuple(iso.daysout(3)) # ('2023-W01-2', '2023-W01-3', '2023-W01-4')
tuple(iso.daysout(6, step=2)) # ('2023-W01-2', '2023-W01-4', '2023-W01-6')
Source code in iso_week_date/isoweekdate.py
to_date()
¶
Converts IsoWeekDate
to date
object.
Returns:
Type | Description |
---|---|
date
|
|
Examples:
from iso_week_date import IsoWeekDate
IsoWeekDate("2023-W01-1").to_date() # datetime.date(2023, 1, 2)
IsoWeekDate("2023-W01-3").to_date() # datetime.date(2023, 1, 4)
Source code in iso_week_date/isoweekdate.py
to_datetime()
¶
Converts IsoWeekDate
to datetime
object.
Returns:
Type | Description |
---|---|
datetime
|
|
Examples:
from iso_week_date import IsoWeekDate
IsoWeekDate("2023-W01-1").to_datetime() # datetime.datetime(2023, 1, 2, 0, 0)
IsoWeekDate("2023-W01-3").to_datetime() # datetime.datetime(2023, 1, 4, 0, 0)