1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2026-04-24 20:56:11 +02:00

pydoc formatting fixes

This commit is contained in:
Kelly Brazil
2022-03-05 12:15:14 -08:00
parent 128c3c170a
commit 29c263f878
93 changed files with 115 additions and 115 deletions
+8 -8
View File
@@ -19,7 +19,7 @@ JC lib module
<a id="jc.lib.parse"></a>
#### parse
### parse
```python
def parse(parser_mod_name: str,
@@ -86,7 +86,7 @@ Returns:
<a id="jc.lib.parser_mod_list"></a>
#### parser\_mod\_list
### parser\_mod\_list
```python
def parser_mod_list() -> List[str]
@@ -96,7 +96,7 @@ Returns a list of all available parser module names.
<a id="jc.lib.plugin_parser_mod_list"></a>
#### plugin\_parser\_mod\_list
### plugin\_parser\_mod\_list
```python
def plugin_parser_mod_list() -> List[str]
@@ -107,7 +107,7 @@ subset of `parser_mod_list()`.
<a id="jc.lib.standard_parser_mod_list"></a>
#### standard\_parser\_mod\_list
### standard\_parser\_mod\_list
```python
def standard_parser_mod_list() -> List[str]
@@ -119,7 +119,7 @@ parsers.
<a id="jc.lib.streaming_parser_mod_list"></a>
#### streaming\_parser\_mod\_list
### streaming\_parser\_mod\_list
```python
def streaming_parser_mod_list() -> List[str]
@@ -130,7 +130,7 @@ subset of `parser_mod_list()`.
<a id="jc.lib.parser_info"></a>
#### parser\_info
### parser\_info
```python
def parser_info(parser_mod_name: str) -> Dict
@@ -143,7 +143,7 @@ This function will accept **module_name**, **cli-name**, and
<a id="jc.lib.all_parser_info"></a>
#### all\_parser\_info
### all\_parser\_info
```python
def all_parser_info() -> List[Dict]
@@ -153,7 +153,7 @@ Returns a list of dictionaries that includes metadata for all modules.
<a id="jc.lib.get_help"></a>
#### get\_help
### get\_help
```python
def get_help(parser_mod_name: str) -> None
+1 -1
View File
@@ -234,7 +234,7 @@ Examples:
<a id="jc.parsers.acpi.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -87,7 +87,7 @@ Examples:
<a id="jc.parsers.airport.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -115,7 +115,7 @@ Examples:
<a id="jc.parsers.airport_s.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -124,7 +124,7 @@ Examples:
<a id="jc.parsers.arp.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -127,7 +127,7 @@ Examples:
<a id="jc.parsers.blkid.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -61,7 +61,7 @@ Examples:
<a id="jc.parsers.cksum.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -180,7 +180,7 @@ Examples:
<a id="jc.parsers.crontab.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -177,7 +177,7 @@ Examples:
<a id="jc.parsers.crontab_u.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -84,7 +84,7 @@ Examples:
<a id="jc.parsers.csv.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -70,7 +70,7 @@ Examples:
<a id="jc.parsers.csv_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -84,7 +84,7 @@ Examples:
<a id="jc.parsers.date.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -104,7 +104,7 @@ Examples:
<a id="jc.parsers.df.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -329,7 +329,7 @@ Examples:
<a id="jc.parsers.dig.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -127,7 +127,7 @@ Examples:
<a id="jc.parsers.dir.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -132,7 +132,7 @@ Examples:
<a id="jc.parsers.dmidecode.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -138,7 +138,7 @@ Examples:
<a id="jc.parsers.dpkg_l.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -94,7 +94,7 @@ Examples:
<a id="jc.parsers.du.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -79,7 +79,7 @@ Examples:
<a id="jc.parsers.env.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -69,7 +69,7 @@ Examples:
<a id="jc.parsers.file.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -97,7 +97,7 @@ Examples:
<a id="jc.parsers.finger.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -79,7 +79,7 @@ Examples:
<a id="jc.parsers.free.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -92,7 +92,7 @@ Examples:
<a id="jc.parsers.fstab.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -116,7 +116,7 @@ Examples:
<a id="jc.parsers.group.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -84,7 +84,7 @@ Examples:
<a id="jc.parsers.gshadow.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -44,7 +44,7 @@ Examples:
<a id="jc.parsers.hash.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -75,7 +75,7 @@ Examples:
<a id="jc.parsers.hashsum.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -324,7 +324,7 @@ Examples:
<a id="jc.parsers.hciconfig.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -70,7 +70,7 @@ Examples:
<a id="jc.parsers.history.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -81,7 +81,7 @@ Examples:
<a id="jc.parsers.hosts.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -112,7 +112,7 @@ Examples:
<a id="jc.parsers.id.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -193,7 +193,7 @@ Examples:
<a id="jc.parsers.ifconfig.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -73,7 +73,7 @@ Examples:
<a id="jc.parsers.ini.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -166,7 +166,7 @@ Examples:
<a id="jc.parsers.iostat.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -107,7 +107,7 @@ Examples:
<a id="jc.parsers.iostat_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -170,7 +170,7 @@ Examples:
<a id="jc.parsers.iptables.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -128,7 +128,7 @@ Examples:
<a id="jc.parsers.iw_scan.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -84,7 +84,7 @@ Examples:
<a id="jc.parsers.jar_manifest.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -100,7 +100,7 @@ Example:
<a id="jc.parsers.jobs.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -60,7 +60,7 @@ Examples:
<a id="jc.parsers.kv.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -111,7 +111,7 @@ Examples:
<a id="jc.parsers.last.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -123,7 +123,7 @@ Examples:
<a id="jc.parsers.ls.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -84,7 +84,7 @@ Examples:
<a id="jc.parsers.ls_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -281,7 +281,7 @@ Examples:
<a id="jc.parsers.lsblk.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -132,7 +132,7 @@ Examples:
<a id="jc.parsers.lsmod.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -126,7 +126,7 @@ Examples:
<a id="jc.parsers.lsof.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -268,7 +268,7 @@ Examples:
<a id="jc.parsers.lsusb.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -82,7 +82,7 @@ Example:
<a id="jc.parsers.mount.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -362,7 +362,7 @@ Examples:
<a id="jc.parsers.netstat.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -152,7 +152,7 @@ Examples:
<a id="jc.parsers.nmcli.parse"></a>
#### parse
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+1 -1
View File
@@ -213,7 +213,7 @@ Examples:
<a id="jc.parsers.ntpq.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -101,7 +101,7 @@ Examples:
<a id="jc.parsers.passwd.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -169,7 +169,7 @@ Examples:
<a id="jc.parsers.ping.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -90,7 +90,7 @@ Examples:
<a id="jc.parsers.ping_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -54,7 +54,7 @@ Examples:
<a id="jc.parsers.pip_list.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -72,7 +72,7 @@ Examples:
<a id="jc.parsers.pip_show.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -213,7 +213,7 @@ Examples:
<a id="jc.parsers.ps.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -115,7 +115,7 @@ Examples:
<a id="jc.parsers.route.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -168,7 +168,7 @@ Examples:
<a id="jc.parsers.rpm_qi.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -141,7 +141,7 @@ Examples:
<a id="jc.parsers.rsync.parse"></a>
#### parse
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+1 -1
View File
@@ -95,7 +95,7 @@ Examples:
<a id="jc.parsers.rsync_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -209,7 +209,7 @@ Examples:
<a id="jc.parsers.sfdisk.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -108,7 +108,7 @@ Examples:
<a id="jc.parsers.shadow.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -287,7 +287,7 @@ Examples:
<a id="jc.parsers.ss.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -177,7 +177,7 @@ Examples:
<a id="jc.parsers.stat.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -88,7 +88,7 @@ Examples:
<a id="jc.parsers.stat_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -64,7 +64,7 @@ Examples:
<a id="jc.parsers.sysctl.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -65,7 +65,7 @@ Examples:
<a id="jc.parsers.systemctl.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -82,7 +82,7 @@ Examples:
<a id="jc.parsers.systemctl_lj.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -58,7 +58,7 @@ Examples:
<a id="jc.parsers.systemctl_ls.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -54,7 +54,7 @@ Examples:
<a id="jc.parsers.systemctl_luf.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -218,7 +218,7 @@ Examples:
<a id="jc.parsers.systeminfo.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -139,7 +139,7 @@ Examples:
<a id="jc.parsers.time.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -71,7 +71,7 @@ Examples:
<a id="jc.parsers.timedatectl.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -138,7 +138,7 @@ Examples:
<a id="jc.parsers.tracepath.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -127,7 +127,7 @@ Examples:
<a id="jc.parsers.traceroute.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -207,7 +207,7 @@ Examples:
<a id="jc.parsers.ufw.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -145,7 +145,7 @@ Examples:
<a id="jc.parsers.ufw_appinfo.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -54,7 +54,7 @@ Example:
<a id="jc.parsers.uname.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+2 -2
View File
@@ -12,7 +12,7 @@ jc - JSON Convert universal parsers
<a id="jc.parsers.universal.simple_table_parse"></a>
#### simple\_table\_parse
### simple\_table\_parse
```python
def simple_table_parse(data: List[str]) -> List[Dict]
@@ -37,7 +37,7 @@ Returns:
<a id="jc.parsers.universal.sparse_table_parse"></a>
#### sparse\_table\_parse
### sparse\_table\_parse
```python
def sparse_table_parse(data: List[str], delim: str = '\u2063') -> List[Dict]
+1 -1
View File
@@ -205,7 +205,7 @@ Examples:
<a id="jc.parsers.upower.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -72,7 +72,7 @@ Example:
<a id="jc.parsers.uptime.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -133,7 +133,7 @@ Examples:
<a id="jc.parsers.vmstat.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -107,7 +107,7 @@ Examples:
<a id="jc.parsers.vmstat_s.parse"></a>
#### parse
### parse
```python
@add_jc_meta
+1 -1
View File
@@ -110,7 +110,7 @@ Examples:
<a id="jc.parsers.w.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -61,7 +61,7 @@ Examples:
<a id="jc.parsers.wc.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -142,7 +142,7 @@ Examples:
<a id="jc.parsers.who.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -77,7 +77,7 @@ Examples:
<a id="jc.parsers.xml.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -144,7 +144,7 @@ Examples:
<a id="jc.parsers.xrandr.parse"></a>
#### parse
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict
+1 -1
View File
@@ -91,7 +91,7 @@ Examples:
<a id="jc.parsers.yaml.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+1 -1
View File
@@ -86,7 +86,7 @@ Examples:
<a id="jc.parsers.zipinfo.parse"></a>
#### parse
### parse
```python
def parse(data, raw=False, quiet=False)
+6 -6
View File
@@ -16,7 +16,7 @@ jc - JSON Convert streaming utils
<a id="jc.streaming.streaming_input_type_check"></a>
#### streaming\_input\_type\_check
### streaming\_input\_type\_check
```python
def streaming_input_type_check(data: Iterable) -> None
@@ -27,7 +27,7 @@ Ensure input data is an iterable, but not a string or bytes. Raises
<a id="jc.streaming.streaming_line_input_type_check"></a>
#### streaming\_line\_input\_type\_check
### streaming\_line\_input\_type\_check
```python
def streaming_line_input_type_check(line: str) -> None
@@ -37,7 +37,7 @@ Ensure each line is a string. Raises `TypeError` if not.
<a id="jc.streaming.stream_success"></a>
#### stream\_success
### stream\_success
```python
def stream_success(output_line: Dict, ignore_exceptions: bool) -> Dict
@@ -47,7 +47,7 @@ Add `_jc_meta` object to output line if `ignore_exceptions=True`
<a id="jc.streaming.stream_error"></a>
#### stream\_error
### stream\_error
```python
def stream_error(e: BaseException, line: str) -> Dict
@@ -57,7 +57,7 @@ Return an error `_jc_meta` field.
<a id="jc.streaming.add_jc_meta"></a>
#### add\_jc\_meta
### add\_jc\_meta
```python
def add_jc_meta(func)
@@ -102,7 +102,7 @@ In all cases above:
<a id="jc.streaming.raise_or_yield"></a>
#### raise\_or\_yield
### raise\_or\_yield
```python
def raise_or_yield(ignore_exceptions: bool, e: BaseException,
+10 -10
View File
@@ -20,7 +20,7 @@ jc - JSON Convert utils
<a id="jc.utils.warning_message"></a>
#### warning\_message
### warning\_message
```python
def warning_message(message_lines: List[str]) -> None
@@ -40,7 +40,7 @@ Returns:
<a id="jc.utils.error_message"></a>
#### error\_message
### error\_message
```python
def error_message(message_lines: List[str]) -> None
@@ -60,7 +60,7 @@ Returns:
<a id="jc.utils.compatibility"></a>
#### compatibility
### compatibility
```python
def compatibility(mod_name: str,
@@ -87,7 +87,7 @@ Returns:
<a id="jc.utils.has_data"></a>
#### has\_data
### has\_data
```python
def has_data(data: str) -> bool
@@ -107,7 +107,7 @@ Returns:
<a id="jc.utils.convert_to_int"></a>
#### convert\_to\_int
### convert\_to\_int
```python
def convert_to_int(value: Union[str, float]) -> Optional[int]
@@ -126,7 +126,7 @@ Returns:
<a id="jc.utils.convert_to_float"></a>
#### convert\_to\_float
### convert\_to\_float
```python
def convert_to_float(value: Union[str, int]) -> Optional[float]
@@ -145,7 +145,7 @@ Returns:
<a id="jc.utils.convert_to_bool"></a>
#### convert\_to\_bool
### convert\_to\_bool
```python
def convert_to_bool(value: Union[str, int, float]) -> bool
@@ -165,7 +165,7 @@ Returns:
<a id="jc.utils.input_type_check"></a>
#### input\_type\_check
### input\_type\_check
```python
def input_type_check(data: str) -> None
@@ -175,7 +175,7 @@ Ensure input data is a string. Raises `TypeError` if not.
<a id="jc.utils.timestamp"></a>
## timestamp Objects
### timestamp Objects
```python
class timestamp()
@@ -183,7 +183,7 @@ class timestamp()
<a id="jc.utils.timestamp.__init__"></a>
#### \_\_init\_\_
### \_\_init\_\_
```python
def __init__(datetime_string: str,