1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/hosts.md

120 lines
1.6 KiB
Markdown
Raw Normal View History

[Home](https://kellyjonbrazil.github.io/jc/)
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.hosts"></a>
2020-07-30 16:20:24 -07:00
2019-11-14 21:59:06 -08:00
# jc.parsers.hosts
2022-01-25 17:07:47 -08:00
2020-08-05 16:51:58 -07:00
jc - JSON CLI output utility `/etc/hosts` file parser
2019-11-14 21:59:06 -08:00
2020-08-05 13:32:59 -07:00
Usage (cli):
2019-12-12 09:47:14 -08:00
2022-01-25 17:07:47 -08:00
$ cat /etc/hosts | jc --hosts
2019-11-14 21:59:06 -08:00
2020-08-05 13:32:59 -07:00
Usage (module):
2022-01-25 17:07:47 -08:00
import jc
result = jc.parse('hosts', hosts_file_output)
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
or
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
import jc.parsers.hosts
result = jc.parsers.hosts.parse(hosts_file_output)
2020-08-05 13:32:59 -07:00
2021-04-08 12:42:01 -07:00
Schema:
2022-01-25 17:07:47 -08:00
[
{
"ip": string,
"hostname": [
string
]
}
]
**Examples**:
$ cat /etc/hosts | jc --hosts -p
[
{
- `"ip"` - "127.0.0.1",
- `"hostname"` - [
"localhost"
]
},
{
- `"ip"` - "127.0.1.1",
- `"hostname"` - [
"root-ubuntu"
]
},
{
- `"ip"` - "::1",
- `"hostname"` - [
"ip6-localhost",
"ip6-loopback"
]
},
{
- `"ip"` - "fe00::0",
- `"hostname"` - [
"ip6-localnet"
]
},
{
- `"ip"` - "ff00::0",
- `"hostname"` - [
"ip6-mcastprefix"
]
},
{
- `"ip"` - "ff02::1",
- `"hostname"` - [
"ip6-allnodes"
]
},
{
- `"ip"` - "ff02::2",
- `"hostname"` - [
"ip6-allrouters"
]
}
]
<a id="jc.parsers.hosts.info"></a>
## info Objects
2019-12-14 23:35:42 -08:00
```python
2022-01-25 17:07:47 -08:00
class info()
2019-12-14 23:35:42 -08:00
```
2022-01-25 17:07:47 -08:00
2021-04-08 12:42:01 -07:00
Provides parser metadata (version, author, etc.)
2020-07-30 16:20:24 -07:00
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.hosts.parse"></a>
#### parse
2019-11-14 21:59:06 -08:00
```python
2022-01-25 17:07:47 -08:00
def parse(data, raw=False, quiet=False)
2019-11-14 21:59:06 -08:00
```
Main text parsing function
2022-01-25 17:07:47 -08:00
**Arguments**:
2019-11-14 21:59:06 -08:00
2022-01-25 17:07:47 -08:00
- `data` - (string) text data to parse
- `raw` - (boolean) unprocessed output if True
- `quiet` - (boolean) suppress warning messages if True
2019-11-14 21:59:06 -08:00
2022-01-25 17:07:47 -08:00
**Returns**:
2019-11-14 21:59:06 -08:00
2022-01-25 17:07:47 -08:00
List of Dictionaries. Raw or processed structured data.
2019-11-14 21:59:06 -08:00
## Parser Information
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
2021-12-01 16:12:51 -08:00
Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)