python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

replace parse_datetime_to_timestamp with timestamp class

Browse Source
This commit is contained in:
Kelly Brazil
2021-04-01 20:13:40 -07:00
parent 5c0142dd19
commit eb83c9b86d
1 changed files with 8 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/utils.md
View File

@ -69,32 +69,19 @@ Returns:
Boolean True if input string (data) contains non-whitespace characters, otherwise False Boolean True if input string (data) contains non-whitespace characters, otherwise False
## parse_datetime_to_timestamp ## timestamp
```python ```python
parse_datetime_to_timestamp(data) timestamp(datetime_string)
``` ```
Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC
Parameters: Parameters:
datetime_string: (str) a string representation of a date-time in several supported formats
data: (string) a string representation of a date-time in several supported formats Attributes:
string (str) the input datetime string
Returns: format (int) the format rule that was used to decode the datetime string
naive (int) timestamp based on locally configured timezone. None if conversion fails
Dictionary A Dictionary of the following format: utc (int) aware timestamp only if UTC timezone detected in datetime string. None if conversion fails
{
"format": integer, # for debugging purposes. None if conversion fails
"timestamp_naive": integer, # timestamp based on locally configured timezone. None if conversion fails
"timestamp_utc": integer # aware timestamp only if UTC timezone detected. None if conversion fails
}
The format integer denotes which date_time format conversion succeeded.
The timestamp_naive integer is the converted date-time string to a naive epoch timestamp.
The timestamp_utc integer is the converted date-time string to an aware epoch timestamp
in the UTC timezone. If an aware conversion cannot be performed (e.g. the UTC timezone
is not found in the date-time string), then this field will be None.
If the conversion completely fails, all fields will be None.