App::DateUtils - An assortment of date-/time-related CLI utilities
This document describes version 0.127 of App::DateUtils (from Perl distribution App-DateUtils), released on 2021-09-06.
This distribution provides the following command-line utilities related to date/time:
dateconv
datediff
durconv
parse-date
parse-date-using-df-alami-en
parse-date-using-df-alami-id
parse-date-using-df-flexible
parse-date-using-df-natural
parse-duration
parse-duration-using-df-alami-en
parse-duration-using-df-alami-id
parse-duration-using-df-natural
parse-duration-using-td-parse
strftime
strftimeq
Usage:
dateconv(%args) -> any
Convert date from one format to another.
Examples:
Convert "today" to epoch:
dateconv(date => "today"); # -> 1630886400
Convert epoch to ymd:
dateconv(date => 1463702400, to => "ymd"); # -> "2016-05-20"
Convert epoch to iso8601:
dateconv(date => 1580446441, to => "iso8601"); # -> "2020-01-31T04:54:01Z"
Convert iso8601 to epoch:
dateconv(date => "2020-01-31T04:54:01Z", to => "epoch"); # -> 1580446441
Show all possible conversions:
dateconv(date => "now", to => "ALL");
Result:
{ epoch => 1630934937, iso8601 => "2021-09-06T13:28:57Z", ymd => "2021-09-06", }
This function is not exported.
Arguments ('*' denotes required arguments):
date* => date
to => str (default: "epoch")
Return value: (any)
datediff(%args) -> any
Diff (subtract) two dates, show as ISO8601 duration.
Example #1:
datediff(date1 => "2019-06-18T20:08:42", date2 => "2019-06-19T06:02:03"); # -> "PT9H53M21S"
Example #2:
datediff( date1 => "2019-06-18T20:08:42", date2 => "2019-06-19T06:02:03", as => "hms" );
"09:53:21"
Example #3:
datediff( date1 => "2019-06-18T20:08:42", date2 => "2019-06-22T06:02:03", as => "concise_hms" );
"3d 09:53:21"
Example #4:
datediff( date1 => "2019-06-18T20:08:42", date2 => "2019-06-19T06:02:03", as => "seconds" );
35601
as => str (default: "iso8601")
date1* => date
date2* => date
durconv(%args) -> any
Convert duration from one format to another.
Convert "3h2m" to number of seconds:
durconv(duration => "3h2m"); # -> 10920
Convert "3h2m" to iso8601:
durconv(duration => "3h2m", to => "iso8601"); # -> "PT3H2M"
durconv(duration => "3h2m", to => "ALL");
{ hash => { hours => 3, minutes => 2 }, iso8601 => "PT3H2M", secs => 10920, }
duration* => duration
to => str (default: "secs")
parse_date(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse date string(s) using one of several modules.
parse_date(dates => ["23 sep 2015", "tomorrow", "foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Flexible", original => "23 sep 2015", is_parseable => 1, as_epoch => 1442966400, as_datetime_obj => "2015-09-23T00:00:00", as_datetime_obj_tz_local => "2015-09-23T00:00:00+07:00", as_datetime_obj_tz_utc => "2015-09-22T17:00:00Z", }, { module => "DateTime::Format::Flexible", original => "tomorrow", is_parseable => 1, as_epoch => 1630972800, as_datetime_obj => "2021-09-07T00:00:00", as_datetime_obj_tz_local => "2021-09-07T00:00:00+07:00", as_datetime_obj_tz_utc => "2021-09-06T17:00:00Z", }, { module => "DateTime::Format::Flexible", original => "foo", is_parseable => 0, error_msg => "Invalid date format: foo at /home/u1/perl5/perlbrew/perls/perl-5.34.0/lib/site_perl/5.34.0/Perinci/Access.pm line 81. ", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
all_modules => bool
Parse using all installed modules and return all the result at once.
dates* => array[str]
module => str (default: "DateTime::Format::Flexible")
time_zone => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
parse_date_using_df_alami_en(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse date string(s) using DateTime::Format::Alami::EN.
parse_date_using_df_alami_en(dates => ["23 May"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::EN", original => "23 May", is_parseable => 1, as_epoch => 1621728000, as_datetime_obj => "2021-05-23T00:00:00", as_datetime_obj_tz_local => "2021-05-23T07:00:00+07:00", as_datetime_obj_tz_utc => "2021-05-23T00:00:00Z", pattern => "p_dateymd", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_alami_en(dates => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::EN", original => "foo", is_parseable => 0, }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_alami_id(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse date string(s) using DateTime::Format::Alami::ID.
parse_date_using_df_alami_id(dates => ["23 Mei"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::ID", original => "23 Mei", is_parseable => 1, as_epoch => 1621728000, as_datetime_obj => "2021-05-23T00:00:00", as_datetime_obj_tz_local => "2021-05-23T07:00:00+07:00", as_datetime_obj_tz_utc => "2021-05-23T00:00:00Z", pattern => "p_dateymd", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_alami_id(dates => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::ID", original => "foo", is_parseable => 0, }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_flexible(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse date string(s) using DateTime::Format::Flexible.
parse_date_using_df_flexible(dates => ["23rd Jun"]);
[ 200, "OK", [ { module => "DateTime::Format::Flexible", original => "23rd Jun", is_parseable => 1, as_epoch => 1624406400, as_datetime_obj => "2021-06-23T00:00:00", as_datetime_obj_tz_local => "2021-06-23T00:00:00+07:00", as_datetime_obj_tz_utc => "2021-06-22T17:00:00Z", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_flexible(dates => ["23 Dez"], lang => "de");
[ 200, "OK", [ { module => "DateTime::Format::Flexible(de)", original => "23 Dez", is_parseable => 1, as_epoch => 1640217600, as_datetime_obj => "2021-12-23T00:00:00", as_datetime_obj_tz_local => "2021-12-23T00:00:00+07:00", as_datetime_obj_tz_utc => "2021-12-22T17:00:00Z", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_flexible(dates => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Flexible", original => "foo", is_parseable => 0, error_msg => "Invalid date format: foo at /home/u1/perl5/perlbrew/perls/perl-5.34.0/lib/site_perl/5.34.0/Perinci/Access.pm line 81. ", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
lang => str (default: "en")
parse_date_using_df_natural(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse date string(s) using DateTime::Format::Natural.
parse_date_using_df_natural(dates => ["23rd Jun"]);
[ 200, "OK", [ { module => "DateTime::Format::Natural", original => "23rd Jun", is_parseable => 1, as_epoch => 1624406400, as_datetime_obj => "2021-06-23T00:00:00", as_datetime_obj_tz_local => "2021-06-23T00:00:00+07:00", as_datetime_obj_tz_utc => "2021-06-22T17:00:00Z", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_date_using_df_natural(dates => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Natural", original => "foo", is_parseable => 0, error_msg => "'foo' does not parse (perhaps you have some garbage?)", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_epoch", "as_datetime_obj", "as_datetime_obj_tz_local", "as_datetime_obj_tz_utc", "error_msg", ], }, ]
parse_duration(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse duration string(s) using one of several modules.
durations* => array[str]
module => str (default: "Time::Duration::Parse")
parse_duration_using_df_alami_en(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse duration string(s) using DateTime::Format::Alami::EN.
parse_duration_using_df_alami_en(durations => ["2h, 3mins"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::EN", original => "2h, 3mins", is_parseable => 1, as_secs => 7380, as_dtdur_obj => "PT2H3M", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_alami_en(durations => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::EN", original => "foo", is_parseable => 0, }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_alami_id(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse duration string(s) using DateTime::Format::Alami::ID.
parse_duration_using_df_alami_id(durations => ["2j, 3mnt"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::ID", original => "2j, 3mnt", is_parseable => 1, as_secs => 7380, as_dtdur_obj => "PT2H3M", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_alami_id(durations => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Alami::ID", original => "foo", is_parseable => 0, }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_natural(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse duration string(s) using DateTime::Format::Natural.
parse_duration_using_df_natural(durations => ["for 2 weeks"]);
[ 200, "OK", [ { module => "DateTime::Format::Natural", original => "for 2 weeks", is_parseable => 1, as_secs => 1209600, as_dtdur_obj => "P14D", date1 => "2021-09-06T13:28:57", date2 => "2021-09-20T13:28:57", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_natural(durations => ["from 23 Jun to 29 Jun"]);
[ 200, "OK", [ { module => "DateTime::Format::Natural", original => "from 23 Jun to 29 Jun", is_parseable => 1, as_secs => 5912937, as_dtdur_obj => "P2M7DT13H28M57S", date1 => "2021-09-06T13:28:57", date2 => "2021-06-29T00:00:00", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_df_natural(durations => ["foo"]);
[ 200, "OK", [ { module => "DateTime::Format::Natural", original => "foo", is_parseable => 0, error_msg => "'foo' does not parse (perhaps you have some garbage?)", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_td_parse(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse duration string(s) using Time::Duration::Parse.
parse_duration_using_td_parse(durations => ["2 days 13 hours"]);
[ 200, "OK", [ { module => "Time::Duration::Parse", original => "2 days 13 hours", is_parseable => 1, as_secs => 219600, }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
parse_duration_using_td_parse(durations => ["foo"]);
[ 200, "OK", [ { module => "Time::Duration::Parse", original => "foo", is_parseable => 0, error_msg => "Unknown timespec: foo at lib/App/DateUtils.pm line 385. ", }, ], { "table.fields" => [ "module", "original", "is_parseable", "as_secs", "as_dtdur_obj", "error_msg", ], }, ]
strftime(%args) -> any
Format date using strftime().
Format current time as yyyy-mm-dd:
strftime(format => "%Y-%m-%d"); # -> "2021-09-06"
Format a specific time as yyyy-mm-dd:
strftime(format => "%Y-%m-%d", date => "tomorrow"); # -> "2021-09-07"
date => date
format* => str
strftimeq(%args) -> any
Format date using strftimeq().
Format current time as yyyy-mm-dd but add "Sun" when the date is Sunday:
strftimeq(format => "%Y-%m-%d%( require Date::DayOfWeek; Date::DayOfWeek::dayofweek(\$_[3], \$_[4]+1, \$_[5]+1900) == 0 ? \"sun\":\"\" )q");
"2021-09-06"
strftimeq() is like POSIX's strftime(), but allows an extra conversion %(...)q to insert Perl code, for flexibility in customizing format. For more details, read Date::strftimeq.
%(...)q
Please visit the project's homepage at https://metacpan.org/release/App-DateUtils.
Source repository is at https://github.com/perlancar/perl-App-DateUtils.
dateparse. Perinci::To::POD=HASH(0x556ac4fbeaf8).
App::datecalc
App::TimeZoneUtils
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2021, 2020, 2019, 2017, 2016, 2015 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-DateUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
To install App::DateUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::DateUtils
CPAN shell
perl -MCPAN -e shell install App::DateUtils
For more information on module installation, please visit the detailed CPAN module installation guide.