mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-06-19 00:17:51 +02:00
136 lines
3.3 KiB
Markdown
136 lines
3.3 KiB
Markdown
[Home](https://kellyjonbrazil.github.io/jc/)
|
|
|
|
# jc.parsers.ls
|
|
jc - JSON CLI output utility `ls` and `vdir` command output parser
|
|
|
|
Options supported:
|
|
- `lbaR1`
|
|
- `--time-style=full-iso`
|
|
- `-h`: File sizes will be available in text form with `-r` but larger file sizes with human readable suffixes will be converted to `Null` in the default view since the parser attempts to convert this field to an integer.
|
|
|
|
Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly parse filenames that include newline characters. Since `ls` does not encode newlines in filenames when outputting to a pipe it will cause `jc` to see multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. Alternatively, `vdir` can be used, which is the same as running `ls -lb`.
|
|
|
|
The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)
|
|
|
|
The `epoch_utc` calculated timestamp field is timezone-aware and is only available if the timezone field is UTC.
|
|
|
|
Usage (cli):
|
|
|
|
$ ls | jc --ls
|
|
|
|
or
|
|
|
|
$ jc ls
|
|
|
|
Usage (module):
|
|
|
|
import jc.parsers.ls
|
|
result = jc.parsers.ls.parse(ls_command_output)
|
|
|
|
Schema:
|
|
|
|
[
|
|
{
|
|
"filename": string,
|
|
"flags": string,
|
|
"links": integer,
|
|
"parent": string,
|
|
"owner": string,
|
|
"group": string,
|
|
"size": integer,
|
|
"date": string,
|
|
"epoch": integer, # naive timestamp if date field exists and can be converted
|
|
"epoch_utc": integer # timezone aware timestamp if date field is in UTC and can be converted
|
|
}
|
|
]
|
|
|
|
Examples:
|
|
|
|
$ ls /usr/bin | jc --ls -p
|
|
[
|
|
{
|
|
"filename": "apropos"
|
|
},
|
|
{
|
|
"filename": "arch"
|
|
},
|
|
...
|
|
]
|
|
|
|
$ ls -l /usr/bin | jc --ls -p
|
|
[
|
|
{
|
|
"filename": "apropos",
|
|
"link_to": "whatis",
|
|
"flags": "lrwxrwxrwx.",
|
|
"links": 1,
|
|
"owner": "root",
|
|
"group": "root",
|
|
"size": 6,
|
|
"date": "Aug 15 10:53"
|
|
},
|
|
{
|
|
"filename": "ar",
|
|
"flags": "-rwxr-xr-x.",
|
|
"links": 1,
|
|
"owner": "root",
|
|
"group": "root",
|
|
"size": 62744,
|
|
"date": "Aug 8 16:14"
|
|
},
|
|
...
|
|
]
|
|
|
|
$ ls -l /usr/bin | jc --ls -p -r
|
|
[
|
|
{
|
|
"filename": "apropos",
|
|
"link_to": "whatis",
|
|
"flags": "lrwxrwxrwx.",
|
|
"links": "1",
|
|
"owner": "root",
|
|
"group": "root",
|
|
"size": "6",
|
|
"date": "Aug 15 10:53"
|
|
},
|
|
{
|
|
"filename": "arch",
|
|
"flags": "-rwxr-xr-x.",
|
|
"links": "1",
|
|
"owner": "root",
|
|
"group": "root",
|
|
"size": "33080",
|
|
"date": "Aug 19 23:25"
|
|
},
|
|
...
|
|
]
|
|
|
|
|
|
## info
|
|
```python
|
|
info()
|
|
```
|
|
Provides parser metadata (version, author, etc.)
|
|
|
|
## parse
|
|
```python
|
|
parse(data, raw=False, quiet=False)
|
|
```
|
|
|
|
Main text parsing function
|
|
|
|
Parameters:
|
|
|
|
data: (string) text data to parse
|
|
raw: (boolean) output preprocessed JSON if True
|
|
quiet: (boolean) suppress warning messages if True
|
|
|
|
Returns:
|
|
|
|
List of Dictionaries. Raw or processed structured data.
|
|
|
|
## Parser Information
|
|
Compatibility: linux, darwin, cygwin, aix, freebsd
|
|
|
|
Version 1.8 by Kelly Brazil (kellyjonbrazil@gmail.com)
|