mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-06-17 00:07:37 +02:00
95 lines
1.7 KiB
Markdown
95 lines
1.7 KiB
Markdown
|
|
# jc.parsers.file
|
|
jc - JSON CLI output utility file command Parser
|
|
|
|
Usage:
|
|
|
|
specify --file as the first argument if the piped input is coming from file.
|
|
|
|
Compatibility:
|
|
|
|
'linux', 'aix', 'freebsd', 'darwin'
|
|
|
|
Examples:
|
|
|
|
$ file * | jc --file -p
|
|
[
|
|
{
|
|
"filename": "Applications",
|
|
"type": "directory"
|
|
},
|
|
{
|
|
"filename": "another file with spaces",
|
|
"type": "empty"
|
|
},
|
|
{
|
|
"filename": "argstest.py",
|
|
"type": "Python script text executable, ASCII text"
|
|
},
|
|
{
|
|
"filename": "blkid-p.out",
|
|
"type": "ASCII text"
|
|
},
|
|
{
|
|
"filename": "blkid-pi.out",
|
|
"type": "ASCII text, with very long lines"
|
|
},
|
|
{
|
|
"filename": "cd_catalog.xml",
|
|
"type": "XML 1.0 document text, ASCII text, with CRLF line terminators"
|
|
},
|
|
{
|
|
"filename": "centosserial.sh",
|
|
"type": "Bourne-Again shell script text executable, UTF-8 Unicode text"
|
|
},
|
|
...
|
|
]
|
|
|
|
|
|
## info
|
|
```python
|
|
info()
|
|
```
|
|
|
|
|
|
## process
|
|
```python
|
|
process(proc_data)
|
|
```
|
|
|
|
Final processing to conform to the schema.
|
|
|
|
Parameters:
|
|
|
|
proc_data: (dictionary) raw structured data to process
|
|
|
|
Returns:
|
|
|
|
List of dictionaries. Structured data with the following schema:
|
|
|
|
[
|
|
{
|
|
"filename": string,
|
|
"type ": string
|
|
}
|
|
]
|
|
|
|
|
|
## 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.
|
|
|