Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature request: option to use "Z" tz label in format_ISO8601() output #941

Closed
francisbarton opened this issue Dec 18, 2020 · 9 comments · Fixed by #1022
Closed

Feature request: option to use "Z" tz label in format_ISO8601() output #941

francisbarton opened this issue Dec 18, 2020 · 9 comments · Fixed by #1022

Comments

@francisbarton
Copy link

francisbarton commented Dec 18, 2020 •
edited
Loading

This suggestion references @billdenney 's comment in #629, with the addition of a specific use case.

Bill wrote:

I didn't do the additional formatting for adding Z instead of -0000 for UTC because that would have added a notable amount more code. I can do it, but the longer-term maintenance didn't seem like it was worthwhile. If you'd like Z, I can make that update.

Example use case

The Twitter API v2 (example) currently only accepts YYYY-MM-DDTHH:mm:ssZ format for the start_time and end_time query parameters. Passing in YYYY-MM-DDTHH:mm:ss+0000 format results in a HTTP 400 Bad Request error. This makes it incompatible with lubridate::format_ISO8601()'s output.

lubridate::format_ISO8601(
  lubridate::make_datetime(2019),
  usetz = TRUE)
#> [1] "2019-01-01T00:00:00+0000"

It's not difficult for me to construct the "Z" format locally within my script and use that, but it would be great if this could be made part of lubridate's capability. Something like:

# pseudocode
lubridate::format_ISO8601(
  lubridate::make_datetime(2019),
  use_z_format = TRUE)
#> [1] "2019-01-01T00:00:00Z"

This option obviously is only appropriate when the tz is UTC, or more realistically, where no timezone is stipulated. Would require some thought as to how it would work in cases when a date with a timezone is passed in. Just return an error, I suppose.

I'm happy to work on a PR to try to provide this feature, but I haven't looked into the code yet.

PS I'm adding the inverse feature suggestion on Twitter's API feedback forum - that they should accept all valid ISO8601 datetime formats, but we don't have much control over what they do!
@billdenney
Copy link
Contributor

If this were implemented, I would suggest having the use_z_format argument cause the datetime to be converted to UTC if it has a time zone or assume UTC if it does not have a time zone. This can be done using with_tz() or force_tz().

@francisbarton
Copy link
Author

francisbarton commented Dec 18, 2020 •
edited
Loading

Fully agree - thank you. This is better behaviour than returning an error.

Did you already have some prior work on this saved somewhere, Bill?

@billdenney
Copy link
Contributor

I don't. Everything that I have is in the current version of lubridate.

@alexpghayes
Copy link

Just ran into this as well, want to say that I think this would be a nice feature to have, and that even if it doesn't get implemented, it would be nice to add a comment about Z vs zero offset to the documentation.

@billdenney
Copy link
Contributor

I decided to work on this one. PR coming shortly...

@francisbarton
Copy link
Author

That's fantastic, Bill, thanks. I wanted to do this but i don't think i ever would have got round to it!

@billdenney
Copy link
Contributor

@francisbarton , I'm procrastinating by making this PR. :)

@billdenney billdenney mentioned this issue Feb 24, 2022
Merged
@billdenney
Copy link
Contributor

@francisbarton , Please take a look and let me know if it does what you'd expect/want.

@francisbarton
Copy link
Author

@billdenney I'm sorry, I'm in the process of moving between employers at the moment and I haven't got easy access to R and my usual set-up for a while. I will get back to this as soon as I can.

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Jun 5, 2023
(time/R-lubridate) Updated 1.7.10 to 1.9.2
763a01d 
Version 1.9.2
=============

### BUG FIXES

* [#1104](tidyverse/lubridate#1104) Fix
  incorrect parsing of months when %a format is present.

### OTHER

* Adapt to internal name changes in R-devel

Version 1.9.1
=============

### NEW FEATURES

* `as_datetime()` accepts multiple formats in format argument, just like `as_date()` does.

### BUG FIXES

* [#1091](tidyverse/lubridate#1091) Fix
  formatting of numeric inputs to parse_date_time.

* [#1092](tidyverse/lubridate#1092) Fix
  regression in `ymd_hm` on locales where `p` format is not defined.

* [#1097](tidyverse/lubridate#1097) Fix
  `as_date("character")` to work correctly with formats that include
  extra characters.

* [#1098](tidyverse/lubridate#1098) Roll
  over the month boundary in `make_dateime()` when units exceed their
  maximal values.

* [#1090](tidyverse/lubridate#1090)
  timechange has been moved from Depends to Imports.

Version 1.9.0
=============

### NEW FEATURES

* `roll` argument to updating and time-zone manipulation functions is
  deprecated in favor of a new `roll_dst` parameter.

* [#1042](tidyverse/lubridate#1042)
  `as_date` with character inputs accepts multiple formats in `format`
  argument. When `format` is supplied, the input string is parsed with
  `parse_date_time` instead of the old `strptime`.

* [#1055](tidyverse/lubridate#1055)
  Implement `as.integer` method for Duration, Period and Interval
  classes.

* [#1061](tidyverse/lubridate#1061) Make
  `year<-`, `month<-` etc. accessors truly generic. In order to make
  them work with arbitrary class XYZ, it's enough to define a
  `reclass_date.XYZ` method.

* [#1061](tidyverse/lubridate#1061) Add
  support for `year<-`, `month<-` etc. accessors for `data.table`'s
  IDate and ITime objects.

* [#1017](tidyverse/lubridate#1017)
  `week_start` argument in all lubridate functions now accepts full
  and abbreviated names of the days of the week.

* The assignment value `wday<-` can be a string either in English or
  as provided by the current locale.

* Date rounding functions accept a date-time `unit` argument for
  rounding to a vector of date-times.

* [#1005](tidyverse/lubridate#1005)
  `as.duration` now allows for full roundtrip `duration ->
  as.character -> as.duration`

* [#911](tidyverse/lubridate#911) C parsers
  treat multiple spaces as one (just like strptime does)

* `stamp` gained new argument `exact=FALSE` to indicate whether
  `orders` argument is an exact strptime formats string or not.

* [#1001](tidyverse/lubridate#1001) Add
  `%within` method with signature (Interval, list), which was
  documented but not implemented.

* [#941](tidyverse/lubridate#941)
  `format_ISO8601()` gained a new option `usetz="Z"` to format time
  zones with a "Z" and convert the time to the UTC time zone.

* [#931](tidyverse/lubridate#931) Usage of
  `Period` objects in rounding functions is explicitly documented.

### BUG FIXES

* [#1036](tidyverse/lubridate#1036)
  `%within%` now correctly works with flipped intervals

* [#1085](tidyverse/lubridate#1085)
  `as_datetime()` now preserves the time zone of the POSIXt input.

* [#1072](tidyverse/lubridate#1072) Names
  are now handled correctly when combining multiple Period or Interval
  objects.

* [#1003](tidyverse/lubridate#1003)
  Correctly handle r and R formats in locales which have no p format

* [#1074](tidyverse/lubridate#1074) Fix
  concatination of named Period, Interval and Duration vectors.

* [#1044](tidyverse/lubridate#1044) POSIXlt
  results returned by `fast_strptime()` and `parse_date_time2()` now
  have a recycled `isdst` field.

* [#1069](tidyverse/lubridate#1069) Internal
  code handling the addition of period months and years no longer
  generates partially recycled POSIXlt objects.

* Fix rounding of POSIXlt objects

* [#1007](tidyverse/lubridate#1007) Internal
  lubridate formats are no longer propagated to stamp formater.

* `train` argument in `parse_date_time` now takes effect. It was
  previously ignored.

* [#1004](tidyverse/lubridate#1004) Fix
  `c.POSIXct` and `c.Date` on empty single POSIXct and Date vectors.

* [#1013](tidyverse/lubridate#1013) Fix
  c(`POSIXct`,`POSIXlt`) heterogeneous concatenation.

* [#1002](tidyverse/lubridate#1002) Parsing
  only with format `j` now works on numeric inputs.

* `stamp()` now correctly errors when no formats could be guessed.

* Updating a date with timezone (e.g. `tzs = "UTC"`) now returns a POSIXct.

### INTERNALS

* `lubridate` is now relying on `timechange` package for update and
  time-zone computation. Google's CCTZ code is no longer part of the
  package.

* `lubridate`'s updating logic is now built on top of `timechange`
  package.

* Change implementation of `c.Period`, `c.Duration` and `c.Interval`
  from S4 to S3.

Version 1.8.0
=============

### NEW FEATURES

* [#960](tidyverse/lubridate#960)
  `c.POSIXct` and `c.Date` can deal with heterogeneous object types
  (e.g `c(date, datetime)` works as expected)

### BUG FIXES

* [#994](tidyverse/lubridate#994)
  Subtracting two duration or two period objects no longer results in
  an ambiguous dispatch note.

* `c.Date` and `c.POSIXct` correctly deal with empty vectors.

* `as_datetime(date, tz=XYZ)` returns the date-time object with HMS
  set to 00:00:00 in the corresponding `tz`

### CHANGES

* [#966](tidyverse/lubridate#966) Lubridate is
  now built with cpp11 (contribution of @DavisVaughan)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

use_z_format argument added to format_ISO8601() billdenney/lubridate
3 participants
@francisbarton @billdenney @alexpghayes