File: README.md

package info (click to toggle)
libdatetime-format-strptime-perl 1.7200-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,200 kB
  • ctags: 41
  • sloc: perl: 1,419; makefile: 2
file content (397 lines) | stat: -rw-r--r-- 10,843 bytes parent folder | download
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
# NAME

DateTime::Format::Strptime - Parse and format strp and strf time patterns

# VERSION

version 1.72

# SYNOPSIS

    use DateTime::Format::Strptime;

    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
    );

    my $dt = $strp->parse_datetime('23:16:42');

    $strp->format_datetime($dt);

    # 23:16:42

    # Croak when things go wrong:
    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
        on_error  => 'croak',
    );

    # Do something else when things go wrong:
    my $strp = DateTime::Format::Strptime->new(
        pattern   => '%T',
        locale    => 'en_AU',
        time_zone => 'Australia/Melbourne',
        on_error  => \&phone_police,
    );

# DESCRIPTION

This module implements most of `strptime(3)`, the POSIX function that is the
reverse of `strftime(3)`, for `DateTime`. While `strftime` takes a
`DateTime` and a pattern and returns a string, `strptime` takes a string and
a pattern and returns the `DateTime` object associated.

# METHODS

This class offers the following methods.

## DateTime::Format::Strptime->new(%args)

This methods creates a new object. It accepts the following arguments:

- pattern

    This is the pattern to use for parsing. This is required.

- strict

    This is a boolean which disables or enables strict matching mode.

    By default, this module turns your pattern into a regex that will match
    anywhere in a string. So given the pattern `%Y%m%d%H%M%S` it will match a
    string like `20161214233712Z`. However, this also means that a this pattern
    will match **any** string that contains 14 or more numbers! This behavior can
    be very surprising.

    If you enable strict mode, then the generated regex is wrapped in boundary
    checks of the form `/(?:\A|\b)...(?:\b|\z_/)`. These checks ensure that the
    pattern will only match when at the beginning or end of a string, or when it
    is separated by other text with a word boundary (`\w` versus `\W`).

    By default, strict mode is off. This is done for backwards
    compatibility. Future releases may turn it on by default, as it produces less
    surprising behavior in many cases.

    Because the default may change in the future, **you are strongly encouraged
    to explicitly set this when constructing all `DateTime::Format::Strptime`
    objects**.

- time\_zone

    The default time zone to use for objects returned from parsing.

- zone\_map

    Some time zone abbreviations are ambiguous (e.g. PST, EST, EDT). By default,
    the parser will die when it parses an ambiguous abbreviation. You may specify
    a `zone_map` parameter as a hashref to map zone abbreviations however you like:

        zone_map => { PST => '-0800', EST => '-0600' }

    Note that you can also override non-ambiguous mappings if you want to as well.

- locale

    The locale to use for objects returned from parsing.

- on\_error

    This can be one of `'undef'` (the string, not an `undef`), 'croak', or a
    subroutine reference.

    - 'undef'

        This is the default behavior. The module will return `undef` on errors. The
        error can be accessed using the `$object->errmsg` method. This is the
        ideal behaviour for interactive use where a user might provide an illegal
        pattern or a date that doesn't match the pattern.

    - 'croak'

        The module will croak with an error message on errors.

    - sub{...} or \\&subname

        When given a code ref, the module will call that sub on errors. The sub
        receives two parameters: the object and the error message.

        If your sub does not die, then the formatter will continue on as if
        `on_error` was `'undef'`.

## $strptime->parse\_datetime($string)

Given a string in the pattern specified in the constructor, this method
will return a new `DateTime` object.

If given a string that doesn't match the pattern, the formatter will croak or
return undef, depending on the setting of `on_error` in the constructor.

## $strptime->format\_datetime($datetime)

Given a `DateTime` object, this methods returns a string formatted in the
object's format. This method is synonymous with `DateTime`'s strftime method.

## $strptime->locale

This method returns the locale passed to the object's constructor.

## $strptime->pattern

This method returns the pattern passed to the object's constructor.

## $strptime->time\_zone

This method returns the time zone passed to the object's constructor.

## $strptime->errmsg

If the on\_error behavior of the object is 'undef', you can retrieve error
messages with this method so you can work out why things went wrong.

# EXPORTS

These subs are available as optional exports.

## strptime( $strptime\_pattern, $string )

Given a pattern and a string this function will return a new `DateTime`
object.

## strftime( $strftime\_pattern, $datetime )

Given a pattern and a `DateTime` object this function will return a
formatted string.

# STRPTIME PATTERN TOKENS

The following tokens are allowed in the pattern string for strptime
(parse\_datetime):

- %%

    The % character.

- %a or %A

    The weekday name according to the given locale, in abbreviated form or
    the full name.

- %b or %B or %h

    The month name according to the given locale, in abbreviated form or
    the full name.

- %c

    The datetime format according to the given locale.

- %C

    The century number (0-99).

- %d or %e

    The day of month (01-31). This will parse single digit numbers as well.

- %D

    Equivalent to %m/%d/%y. (This is the American style date, very confusing
    to non-Americans, especially since %d/%m/%y is widely used in Europe.
    The ISO 8601 standard pattern is %F.)

- %F

    Equivalent to %Y-%m-%d. (This is the ISO style date)

- %g

    The year corresponding to the ISO week number, but without the century
    (0-99).

- %G

    The 4-digit year corresponding to the ISO week number.

- %H

    The hour (00-23). This will parse single digit numbers as well.

- %I

    The hour on a 12-hour clock (1-12).

- %j

    The day number in the year (1-366).

- %m

    The month number (01-12). This will parse single digit numbers as well.

- %M

    The minute (00-59). This will parse single digit numbers as well.

- %n

    Arbitrary whitespace.

- %N

    Nanoseconds. For other sub-second values use `%[number]N`.

- %p or %P

    The equivalent of AM or PM according to the locale in use. See
    [DateTime::Locale](https://metacpan.org/pod/DateTime::Locale).

- %r

    Equivalent to %I:%M:%S %p.

- %R

    Equivalent to %H:%M.

- %s

    Number of seconds since the Epoch.

- %S

    The second (0-60; 60 may occur for leap seconds. See
    [DateTime::LeapSecond](https://metacpan.org/pod/DateTime::LeapSecond)).

- %t

    Arbitrary whitespace.

- %T

    Equivalent to %H:%M:%S.

- %U

    The week number with Sunday the first day of the week (0-53). The first
    Sunday of January is the first day of week 1.

- %u

    The weekday number (1-7) with Monday = 1. This is the `DateTime` standard.

- %w

    The weekday number (0-6) with Sunday = 0.

- %W

    The week number with Monday the first day of the week (0-53). The first
    Monday of January is the first day of week 1.

- %x

    The date format according to the given locale.

- %X

    The time format according to the given locale.

- %y

    The year within century (0-99). When a century is not otherwise specified
    (with a value for %C), values in the range 69-99 refer to years in the
    twentieth century (1969-1999); values in the range 00-68 refer to years in the
    twenty-first century (2000-2068).

- %Y

    A 4-digit year, including century (for example, 1991).

- %z

    An RFC-822/ISO 8601 standard time zone specification. (For example
    \+1100) \[See note below\]

- %Z

    The timezone name. (For example EST -- which is ambiguous) \[See note
    below\]

- %O

    This extended token allows the use of Olson Time Zone names to appear
    in parsed strings. **NOTE**: This pattern cannot be passed to `DateTime`'s
    `strftime()` method, but can be passed to `format_datetime()`.

# AUTHOR EMERITUS

This module was created by Rick Measham.

# SEE ALSO

`datetime@perl.org` mailing list.

http://datetime.perl.org/

[perl](https://metacpan.org/pod/perl), [DateTime](https://metacpan.org/pod/DateTime), [DateTime::TimeZone](https://metacpan.org/pod/DateTime::TimeZone), [DateTime::Locale](https://metacpan.org/pod/DateTime::Locale)

# BUGS

Please report any bugs or feature requests to
`bug-datetime-format-strptime@rt.cpan.org`, or through the web interface at
[http://rt.cpan.org](http://rt.cpan.org). I will be notified, and then you'll automatically be
notified of progress on your bug as I make changes.

Bugs may be submitted at [https://github.com/houseabsolute/DateTime-Format-Strptime/issues](https://github.com/houseabsolute/DateTime-Format-Strptime/issues).

There is a mailing list available for users of this distribution,
[mailto:datetime@perl.org](mailto:datetime@perl.org).

I am also usually active on IRC as 'autarch' on `irc://irc.perl.org`.

# SOURCE

The source code repository for DateTime-Format-Strptime can be found at [https://github.com/houseabsolute/DateTime-Format-Strptime](https://github.com/houseabsolute/DateTime-Format-Strptime).

# DONATIONS

If you'd like to thank me for the work I've done on this module, please
consider making a "donation" to me via PayPal. I spend a lot of free time
creating free software, and would appreciate any support you'd care to offer.

Please note that **I am not suggesting that you must do this** in order for me
to continue working on this particular software. I will continue to do so,
inasmuch as I have in the past, for as long as it interests me.

Similarly, a donation made in this way will probably not make me work on this
software much more, unless I get so many donations that I can consider working
on free software full time (let's all have a chuckle at that together).

To donate, log into PayPal and send money to autarch@urth.org, or use the
button at [http://www.urth.org/~autarch/fs-donation.html](http://www.urth.org/~autarch/fs-donation.html).

# AUTHORS

- Dave Rolsky <autarch@urth.org>
- Rick Measham <rickm@cpan.org>

# CONTRIBUTORS

- Christian Hansen <chansen@cpan.org>
- D. Ilmari Mannsåker <ilmari.mannsaker@net-a-porter.com>
- key-amb <yasutake.kiyoshi@gmail.com>

# COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 - 2017 by Dave Rolsky.

This is free software, licensed under:

    The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the
`LICENSE` file included with this distribution.