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

doc updates

Browse Source
This commit is contained in:
Kelly Brazil
2021-03-24 12:47:57 -07:00
parent 0701e65e97
commit c762de29c6
2 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/utils.md
View File

@ -68,3 +68,33 @@ Returns:
Boolean True if input string (data) contains non-whitespace characters, otherwise False
## parse_datetime_to_timestamp
```python
parse_datetime_to_timestamp(data)
```
Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC
Parameters:
data: (string) a string representation of a date-time in several supported formats
Returns:
Dict/None A Dictionary of the following format:
{
"format": integer, # for debugging purposes
"timestamp_naive": integer, # timestamp based on locally configured timezone
"timestamp_utc": integer # aware timestamp only if UTC timezone detected
}
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, None is returned instead of a Dictionary

4
jc/utils.py
View File

@ -100,8 +100,8 @@ def parse_datetime_to_timestamp(data):
Dict/None A Dictionary of the following format:
{
"format": integer,
"timestamp_naive": integer,
"format": integer, # for debugging purposes
"timestamp_naive": integer, # timestamp based on locally configured timezone
"timestamp_utc": integer # aware timestamp only if UTC timezone detected
}