-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
io.jl
560 lines (459 loc) · 18.2 KB
/
io.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
# This file is a part of Julia. License is MIT: https://julialang.org/license
"""
AbstractDateToken
A token used in parsing or formatting a date time string. Each subtype must
define the tryparsenext and format methods.
"""
abstract type AbstractDateToken end
"""
tryparsenext(tok::AbstractDateToken, str::String, i::Int, len::Int, locale::DateLocale)
`tryparsenext` parses for the `tok` token in `str` starting at index `i`.
`len` is the length of the string. parsing can be optionally based on the
`locale`. If a `tryparsenext` method does not need a locale, it can leave
the argument out in the method definition.
If parsing succeeds, returns a tuple of 2 elements `(res, idx)`, where:
* `res` is the result of the parsing.
* `idx::Int`, is the index _after_ the index at which parsing ended.
"""
function tryparsenext end
"""
format(io::IO, tok::AbstractDateToken, dt::TimeType, locale)
Format the `tok` token from `dt` and write it to `io`. The formatting can
be based on `locale`.
All subtypes of `AbstractDateToken` must define this method in order
to be able to print a Date / DateTime object according to a `DateFormat`
containing that token.
"""
function format end
# fallback to tryparsenext/format methods that don't care about locale
@inline function tryparsenext(d::AbstractDateToken, str, i, len, locale)
return tryparsenext(d, str, i, len)
end
function Base.string(t::Time)
h, mi, s = hour(t), minute(t), second(t)
hh = lpad(h, 2, "0")
mii = lpad(mi, 2, "0")
ss = lpad(s, 2, "0")
nss = tons(Millisecond(t)) + tons(Microsecond(t)) + tons(Nanosecond(t))
ns = nss == 0 ? "" : rstrip(@sprintf("%.9f", nss / 1e+9)[2:end], '0')
return "$hh:$mii:$ss$ns"
end
Base.show(io::IO, x::Time) = print(io, string(x))
@inline function format(io, d::AbstractDateToken, dt, locale)
format(io, d, dt)
end
# Information for parsing and formatting date time values.
struct DateFormat{S, T<:Tuple}
tokens::T
locale::DateLocale
end
### Token types ###
struct DatePart{letter} <: AbstractDateToken
width::Int
fixed::Bool
end
@inline min_width(d::DatePart) = d.fixed ? d.width : 1
@inline max_width(d::DatePart) = d.fixed ? d.width : 0
function _show_content(io::IO, d::DatePart{c}) where c
for i = 1:d.width
print(io, c)
end
end
function Base.show(io::IO, d::DatePart{c}) where c
print(io, "DatePart(")
_show_content(io, d)
print(io, ")")
end
### Parse tokens
for c in "yYmdHMS"
@eval begin
@inline function tryparsenext(d::DatePart{$c}, str, i, len)
return tryparsenext_base10(str, i, len, min_width(d), max_width(d))
end
end
end
for (tok, fn) in zip("uUeE", [monthabbr_to_value, monthname_to_value, dayabbr_to_value, dayname_to_value])
@eval @inline function tryparsenext(d::DatePart{$tok}, str, i, len, locale)
next = tryparsenext_word(str, i, len, locale, max_width(d))
next === nothing && return nothing
word, i = next
val = $fn(word, locale)
val == 0 && return nothing
return val, i
end
end
# 3-digit (base 10) number following a decimal point. For InexactError below.
struct Decimal3 end
@inline function tryparsenext(d::DatePart{'s'}, str, i, len)
val = tryparsenext_base10(str, i, len, min_width(d), max_width(d))
val === nothing && return nothing
ms0, ii = val
len = ii - i
if len > 3
ms, r = divrem(ms0, Int64(10) ^ (len - 3))
r == 0 || throw(InexactError(:convert, Decimal3, ms0))
else
ms = ms0 * Int64(10) ^ (3 - len)
end
return ms, ii
end
### Format tokens
for (c, fn) in zip("YmdHMS", [year, month, day, hour, minute, second])
@eval function format(io, d::DatePart{$c}, dt)
print(io, string($fn(dt), base = 10, pad = d.width))
end
end
for (tok, fn) in zip("uU", [monthabbr, monthname])
@eval function format(io, d::DatePart{$tok}, dt, locale)
print(io, $fn(month(dt), locale))
end
end
for (tok, fn) in zip("eE", [dayabbr, dayname])
@eval function format(io, ::DatePart{$tok}, dt, locale)
print(io, $fn(dayofweek(dt), locale))
end
end
@inline function format(io, d::DatePart{'y'}, dt)
y = year(dt)
n = d.width
# the last n digits of y
# will be 0 padded if y has less than n digits
str = string(y, base = 10, pad = n)
l = lastindex(str)
if l == n
# fast path
print(io, str)
else
print(io, SubString(str, l - (n - 1), l))
end
end
function format(io, d::DatePart{'s'}, dt)
ms = millisecond(dt)
if ms % 100 == 0
str = string(div(ms, 100))
elseif ms % 10 == 0
str = string(div(ms, 10), pad = 2)
else
str = string(ms, pad = 3)
end
print(io, rpad(str, d.width, '0'))
end
### Delimiters
struct Delim{T, length} <: AbstractDateToken
d::T
end
Delim(d::T) where {T<:AbstractChar} = Delim{T, 1}(d)
Delim(d::String) = Delim{String, length(d)}(d)
@inline function tryparsenext(d::Delim{<:AbstractChar, N}, str, i::Int, len) where N
for j = 1:N
i > len && return nothing
next = iterate(str, i)
@assert next !== nothing
c, i = next
c != d.d && return nothing
end
return true, i
end
@inline function tryparsenext(d::Delim{String, N}, str, i::Int, len) where N
i1 = i
i2 = firstindex(d.d)
for j = 1:N
if i1 > len
return nothing
end
next1 = iterate(str, i1)
@assert next1 !== nothing
c1, i1 = next1
next2 = iterate(d.d, i2)
@assert next2 !== nothing
c2, i2 = next2
if c1 != c2
return nothing
end
end
return true, i1
end
@inline function format(io, d::Delim, dt, locale)
print(io, d.d)
end
function _show_content(io::IO, d::Delim{<:AbstractChar, N}) where N
if d.d in keys(CONVERSION_SPECIFIERS)
for i = 1:N
print(io, '\\', d.d)
end
else
for i = 1:N
print(io, d.d)
end
end
end
function _show_content(io::IO, d::Delim)
for c in d.d
if c in keys(CONVERSION_SPECIFIERS)
print(io, '\\')
end
print(io, c)
end
end
function Base.show(io::IO, d::Delim)
print(io, "Delim(")
_show_content(io, d)
print(io, ")")
end
### DateFormat construction
abstract type DayOfWeekToken end # special addition to Period types
# Map conversion specifiers or character codes to tokens.
# Note: Allow addition of new character codes added by packages
const CONVERSION_SPECIFIERS = Dict{Char, Type}(
'y' => Year,
'Y' => Year,
'm' => Month,
'u' => Month,
'U' => Month,
'e' => DayOfWeekToken,
'E' => DayOfWeekToken,
'd' => Day,
'H' => Hour,
'M' => Minute,
'S' => Second,
's' => Millisecond,
)
# Default values are needed when a conversion specifier is used in a DateFormat for parsing
# and we have reached the end of the input string.
# Note: Allow `Any` value as a default to support extensibility
const CONVERSION_DEFAULTS = IdDict{Type, Any}(
Year => Int64(1),
Month => Int64(1),
DayOfWeekToken => Int64(0),
Day => Int64(1),
Hour => Int64(0),
Minute => Int64(0),
Second => Int64(0),
Millisecond => Int64(0),
Microsecond => Int64(0),
Nanosecond => Int64(0),
)
# Specifies the required fields in order to parse a TimeType
# Note: Allows for addition of new TimeTypes
const CONVERSION_TRANSLATIONS = IdDict{Type, Any}(
Date => (Year, Month, Day),
DateTime => (Year, Month, Day, Hour, Minute, Second, Millisecond),
Time => (Hour, Minute, Second, Millisecond, Microsecond, Nanosecond),
)
"""
DateFormat(format::AbstractString, locale="english") -> DateFormat
Construct a date formatting object that can be used for parsing date strings or
formatting a date object as a string. The following character codes can be used to construct the `format`
string:
| Code | Matches | Comment |
|:-----------|:----------|:-------------------------------------------------------------|
| `y` | 1996, 96 | Returns year of 1996, 0096 |
| `Y` | 1996, 96 | Returns year of 1996, 0096. Equivalent to `y` |
| `m` | 1, 01 | Matches 1 or 2-digit months |
| `u` | Jan | Matches abbreviated months according to the `locale` keyword |
| `U` | January | Matches full month names according to the `locale` keyword |
| `d` | 1, 01 | Matches 1 or 2-digit days |
| `H` | 00 | Matches hours |
| `M` | 00 | Matches minutes |
| `S` | 00 | Matches seconds |
| `s` | .500 | Matches milliseconds |
| `e` | Mon, Tues | Matches abbreviated days of the week |
| `E` | Monday | Matches full name days of the week |
| `yyyymmdd` | 19960101 | Matches fixed-width year, month, and day |
Characters not listed above are normally treated as delimiters between date and time slots.
For example a `dt` string of "1996-01-15T00:00:00.0" would have a `format` string like
"y-m-dTH:M:S.s". If you need to use a code character as a delimiter you can escape it using
backslash. The date "1995y01m" would have the format "y\\ym\\m".
Creating a DateFormat object is expensive. Whenever possible, create it once and use it many times
or try the `dateformat""` string macro. Using this macro creates the DateFormat object once at
macro expansion time and reuses it later. see [`@dateformat_str`](@ref).
See [`DateTime`](@ref) and [`format`](@ref) for how to use a DateFormat object to parse and write Date strings
respectively.
"""
function DateFormat(f::AbstractString, locale::DateLocale=ENGLISH)
tokens = AbstractDateToken[]
prev = ()
prev_offset = 1
letters = String(collect(keys(CONVERSION_SPECIFIERS)))
for m in eachmatch(Regex("(?<!\\\\)([\\Q$letters\\E])\\1*"), f)
tran = replace(f[prev_offset:prevind(f, m.offset)], r"\\(.)" => s"\1")
if !isempty(prev)
letter, width = prev
typ = CONVERSION_SPECIFIERS[letter]
push!(tokens, DatePart{letter}(width, isempty(tran)))
end
if !isempty(tran)
push!(tokens, Delim(length(tran) == 1 ? first(tran) : tran))
end
letter = f[m.offset]
width = length(m.match)
prev = (letter, width)
prev_offset = m.offset + width
end
tran = replace(f[prev_offset:lastindex(f)], r"\\(.)" => s"\1")
if !isempty(prev)
letter, width = prev
typ = CONVERSION_SPECIFIERS[letter]
push!(tokens, DatePart{letter}(width, false))
end
if !isempty(tran)
push!(tokens, Delim(length(tran) == 1 ? first(tran) : tran))
end
tokens_tuple = (tokens...,)
return DateFormat{Symbol(f),typeof(tokens_tuple)}(tokens_tuple, locale)
end
function DateFormat(f::AbstractString, locale::AbstractString)
DateFormat(f, LOCALES[locale])
end
function Base.show(io::IO, df::DateFormat)
print(io, "dateformat\"")
for t in df.tokens
_show_content(io, t)
end
print(io, '"')
end
Base.Broadcast.broadcastable(x::DateFormat) = Ref(x)
"""
dateformat"Y-m-d H:M:S"
Create a [`DateFormat`](@ref) object. Similar to `DateFormat("Y-m-d H:M:S")`
but creates the DateFormat object once during macro expansion.
See [`DateFormat`](@ref) for details about format specifiers.
"""
macro dateformat_str(str)
DateFormat(str)
end
# Standard formats
const ISODateTimeFormat = DateFormat("yyyy-mm-dd\\THH:MM:SS.s")
const ISODateFormat = DateFormat("yyyy-mm-dd")
const ISOTimeFormat = DateFormat("HH:MM:SS.s")
const RFC1123Format = DateFormat("e, dd u yyyy HH:MM:SS")
default_format(::Type{DateTime}) = ISODateTimeFormat
default_format(::Type{Date}) = ISODateFormat
default_format(::Type{Time}) = ISOTimeFormat
### API
const Locale = Union{DateLocale, String}
"""
DateTime(dt::AbstractString, format::AbstractString; locale="english") -> DateTime
Construct a `DateTime` by parsing the `dt` date time string following the
pattern given in the `format` string.
This method creates a `DateFormat` object each time it is called. If you are
parsing many date time strings of the same format, consider creating a
[`DateFormat`](@ref) object once and using that as the second argument instead.
"""
function DateTime(dt::AbstractString, format::AbstractString; locale::Locale=ENGLISH)
return parse(DateTime, dt, DateFormat(format, locale))
end
"""
DateTime(dt::AbstractString, df::DateFormat) -> DateTime
Construct a `DateTime` by parsing the `dt` date time string following the
pattern given in the [`DateFormat`](@ref) object. Similar to
`DateTime(::AbstractString, ::AbstractString)` but more efficient when
repeatedly parsing similarly formatted date time strings with a pre-created
`DateFormat` object.
"""
DateTime(dt::AbstractString, df::DateFormat=ISODateTimeFormat) = parse(DateTime, dt, df)
"""
Date(d::AbstractString, format::AbstractString; locale="english") -> Date
Construct a `Date` by parsing the `d` date string following the pattern given
in the `format` string.
This method creates a `DateFormat` object each time it is called. If you are
parsing many date strings of the same format, consider creating a
[`DateFormat`](@ref) object once and using that as the second argument instead.
"""
function Date(d::AbstractString, format::AbstractString; locale::Locale=ENGLISH)
parse(Date, d, DateFormat(format, locale))
end
"""
Date(d::AbstractString, df::DateFormat) -> Date
Parse a date from a date string `d` using a `DateFormat` object `df`.
"""
Date(d::AbstractString, df::DateFormat=ISODateFormat) = parse(Date, d, df)
"""
Time(t::AbstractString, format::AbstractString; locale="english") -> Time
Construct a `Time` by parsing the `t` time string following the pattern given
in the `format` string.
This method creates a `DateFormat` object each time it is called. If you are
parsing many time strings of the same format, consider creating a
[`DateFormat`](@ref) object once and using that as the second argument instead.
"""
function Time(t::AbstractString, format::AbstractString; locale::Locale=ENGLISH)
parse(Time, t, DateFormat(format, locale))
end
"""
Time(t::AbstractString, df::DateFormat) -> Time
Parse a time from a time string `t` using a `DateFormat` object `df`.
"""
Time(t::AbstractString, df::DateFormat=ISOTimeFormat) = parse(Time, t, df)
@generated function format(io::IO, dt::TimeType, fmt::DateFormat{<:Any,T}) where T
N = fieldcount(T)
quote
ts = fmt.tokens
loc = fmt.locale
Base.@nexprs $N i -> format(io, ts[i], dt, loc)
end
end
function format(dt::TimeType, fmt::DateFormat, bufsize=12)
# preallocate to reduce resizing
io = IOBuffer(Vector{UInt8}(undef, bufsize), read=true, write=true)
format(io, dt, fmt)
String(io.data[1:io.ptr - 1])
end
"""
format(dt::TimeType, format::AbstractString; locale="english") -> AbstractString
Construct a string by using a `TimeType` object and applying the provided `format`. The
following character codes can be used to construct the `format` string:
| Code | Examples | Comment |
|:-----------|:----------|:-------------------------------------------------------------|
| `y` | 6 | Numeric year with a fixed width |
| `Y` | 1996 | Numeric year with a minimum width |
| `m` | 1, 12 | Numeric month with a minimum width |
| `u` | Jan | Month name shortened to 3-chars according to the `locale` |
| `U` | January | Full month name according to the `locale` keyword |
| `d` | 1, 31 | Day of the month with a minimum width |
| `H` | 0, 23 | Hour (24-hour clock) with a minimum width |
| `M` | 0, 59 | Minute with a minimum width |
| `S` | 0, 59 | Second with a minimum width |
| `s` | 000, 500 | Millisecond with a minimum width of 3 |
| `e` | Mon, Tue | Abbreviated days of the week |
| `E` | Monday | Full day of week name |
The number of sequential code characters indicate the width of the code. A format of
`yyyy-mm` specifies that the code `y` should have a width of four while `m` a width of two.
Codes that yield numeric digits have an associated mode: fixed-width or minimum-width.
The fixed-width mode left-pads the value with zeros when it is shorter than the specified
width and truncates the value when longer. Minimum-width mode works the same as fixed-width
except that it does not truncate values longer than the width.
When creating a `format` you can use any non-code characters as a separator. For example to
generate the string "1996-01-15T00:00:00" you could use `format`: "yyyy-mm-ddTHH:MM:SS".
Note that if you need to use a code character as a literal you can use the escape character
backslash. The string "1996y01m" can be produced with the format "yyyy\\ymm\\m".
"""
function format(dt::TimeType, f::AbstractString; locale::Locale=ENGLISH)
format(dt, DateFormat(f, locale))
end
# show
function Base.show(io::IO, dt::DateTime)
if millisecond(dt) == 0
format(io, dt, dateformat"YYYY-mm-dd\THH:MM:SS")
else
format(io, dt, dateformat"YYYY-mm-dd\THH:MM:SS.s")
end
end
function Base.show(io::IO, dt::Date)
format(io, dt, dateformat"YYYY-mm-dd")
end
function Base.string(dt::DateTime)
if millisecond(dt) == 0
format(dt, dateformat"YYYY-mm-dd\THH:MM:SS", 24)
else
format(dt, dateformat"YYYY-mm-dd\THH:MM:SS.s", 26)
end
end
function Base.string(dt::Date)
# don't use format - bypassing IOBuffer creation
# saves a bit of time here.
y,m,d = yearmonthday(value(dt))
yy = y < 0 ? @sprintf("%05i", y) : lpad(y, 4, "0")
mm = lpad(m, 2, "0")
dd = lpad(d, 2, "0")
return "$yy-$mm-$dd"
end