python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-02-07 15:44:54 -08:00
parent d0387f5820
commit d392c7f901
12 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/parsers/date.md
View File

@ -105,4 +105,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux, darwin, freebsd Compatibility: linux, darwin, freebsd
Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 2.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/dig.md
View File

@ -350,4 +350,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux, aix, freebsd, darwin, win32, cygwin Compatibility: linux, aix, freebsd, darwin, win32, cygwin
Version 2.2 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 2.3 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/dir.md
View File

@ -148,4 +148,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: win32 Compatibility: win32
Version 1.4 by Rasheed Elsaleh (rasheed@rebelliondefense.com) Version 1.5 by Rasheed Elsaleh (rasheed@rebelliondefense.com)

2
docs/parsers/ls.md
View File

@ -144,4 +144,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux, darwin, cygwin, aix, freebsd Compatibility: linux, darwin, cygwin, aix, freebsd
Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/rpm_qi.md
View File

@ -189,4 +189,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux Compatibility: linux
Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/stat.md
View File

@ -198,4 +198,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux, darwin, freebsd Compatibility: linux, darwin, freebsd
Version 1.10 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.11 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/systeminfo.md
View File

@ -239,4 +239,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: win32 Compatibility: win32
Version 1.1 by Jon Smith (jon@rebelliondefense.com) Version 1.2 by Jon Smith (jon@rebelliondefense.com)

2
docs/parsers/timedatectl.md
View File

@ -92,4 +92,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux Compatibility: linux
Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/upower.md
View File

@ -226,4 +226,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux Compatibility: linux
Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/vmstat.md
View File

@ -154,4 +154,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux Compatibility: linux
Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

2
docs/parsers/who.md
View File

@ -163,4 +163,4 @@ Returns:
### Parser Information ### Parser Information
Compatibility: linux, darwin, cygwin, aix, freebsd Compatibility: linux, darwin, cygwin, aix, freebsd
Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com) Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)

11
docs/utils.md
View File

@ -184,10 +184,10 @@ class timestamp()
### \_\_init\_\_ ### \_\_init\_\_
```python ```python
def __init__(datetime_string: str) -> None def __init__(datetime_string: str, format_hint: Union[List, Tuple, None] = None) -> None
``` ```
Input a date-time text string of several formats and convert to a Input a datetime text string of several formats and convert to a
naive or timezone-aware epoch timestamp in UTC. naive or timezone-aware epoch timestamp in UTC.
Parameters: Parameters:
@ -195,6 +195,13 @@ Parameters:
datetime_string (str): a string representation of a datetime_string (str): a string representation of a
datetime in several supported formats datetime in several supported formats
format_hint (list | tuple): an optional list of format ID
integers to instruct the timestamp object to try those
formats first in the order given. Other formats will be
tried after the format hint list is exhausted. This can
speed up timestamp conversion so several different formats
don't have to be tried in brute-force fashion.
Returns a timestamp object with the following attributes: Returns a timestamp object with the following attributes:
string (str): the input datetime string string (str): the input datetime string