1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00

try new pydoc-markdown formatting options

This commit is contained in:
Kelly Brazil
2022-01-26 11:50:25 -08:00
parent 7cc147fe2d
commit 590728f9c1
91 changed files with 506 additions and 17 deletions

View File

@ -1,22 +1,40 @@
#!/bin/bash #!/bin/bash
# Generate docs.md # Generate docs.md
# requires pydoc-markdown 4.5.0 # requires pydoc-markdown 4.5.0
config=$(cat <<'EOF'
{
"processors": [
{
"type": "filter",
"expression":"not name ==\"info\" and default()"
},
{
"type": "pydocmd"
}
],
"renderer": {
"type": "markdown",
"render_toc": true
}
}
EOF
)
cd jc cd jc
echo Building docs for: package echo Building docs for: package
pydoc-markdown -m jc '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/readme.md pydoc-markdown -m jc "${config}" > ../docs/readme.md
sed -i "" 's/^#### /### /g' ../docs/readme.md sed -i "" 's/^#### /### /g' ../docs/readme.md
echo Building docs for: lib echo Building docs for: lib
pydoc-markdown -m jc.lib '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/lib.md pydoc-markdown -m jc.lib "${config}" > ../docs/lib.md
sed -i "" 's/^#### /### /g' ../docs/lib.md sed -i "" 's/^#### /### /g' ../docs/lib.md
echo Building docs for: utils echo Building docs for: utils
pydoc-markdown -m jc.utils '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/utils.md pydoc-markdown -m jc.utils "${config}" > ../docs/utils.md
sed -i "" 's/^#### /### /g' ../docs/utils.md sed -i "" 's/^#### /### /g' ../docs/utils.md
echo Building docs for: universal parser echo Building docs for: universal parser
pydoc-markdown -m jc.parsers.universal '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/parsers/universal.md pydoc-markdown -m jc.parsers.universal "${config}" > ../docs/parsers/universal.md
sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md
# a bit of inception here... jc is being used to help # a bit of inception here... jc is being used to help
@ -40,7 +58,7 @@ do
echo "Building docs for: ${parser_name}" echo "Building docs for: ${parser_name}"
echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md
pydoc-markdown -m jc.parsers."${parser_name}" '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' >> ../docs/parsers/"${parser_name}".md pydoc-markdown -m jc.parsers."${parser_name}" "${config}" >> ../docs/parsers/"${parser_name}".md
echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md
echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md
echo >> ../docs/parsers/"${parser_name}".md echo >> ../docs/parsers/"${parser_name}".md

View File

@ -1,3 +1,12 @@
# Table of Contents
* [jc.lib](#jc.lib)
* [parse](#jc.lib.parse)
* [parser\_mod\_list](#jc.lib.parser_mod_list)
* [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list)
* [parser\_info](#jc.lib.parser_info)
* [get\_help](#jc.lib.get_help)
<a id="jc.lib"></a> <a id="jc.lib"></a>
# jc.lib # jc.lib
@ -10,9 +19,7 @@ JC lib module
### parse ### parse
```python ```python
def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[Union[None, bool]] = None, **kwargs: Any, ,) -> Union[Dict[str, Any], def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[Union[None, bool]] = None, **kwargs: Any, ,) -> Union[Dict[str, Any], List[Dict[str, Any]], Iterator[Dict[str, Any]]]
List[Dict[str, Any]],
Iterator[Dict[str, Any]]]
``` ```
Parse the string data using the supplied parser module. Parse the string data using the supplied parser module.

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.acpi](#jc.parsers.acpi)
* [parse](#jc.parsers.acpi.parse)
<a id="jc.parsers.acpi"></a> <a id="jc.parsers.acpi"></a>
# jc.parsers.acpi # jc.parsers.acpi

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.airport](#jc.parsers.airport)
* [parse](#jc.parsers.airport.parse)
<a id="jc.parsers.airport"></a> <a id="jc.parsers.airport"></a>
# jc.parsers.airport # jc.parsers.airport

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.airport\_s](#jc.parsers.airport_s)
* [parse](#jc.parsers.airport_s.parse)
<a id="jc.parsers.airport_s"></a> <a id="jc.parsers.airport_s"></a>
# jc.parsers.airport\_s # jc.parsers.airport\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.arp](#jc.parsers.arp)
* [parse](#jc.parsers.arp.parse)
<a id="jc.parsers.arp"></a> <a id="jc.parsers.arp"></a>
# jc.parsers.arp # jc.parsers.arp

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.blkid](#jc.parsers.blkid)
* [parse](#jc.parsers.blkid.parse)
<a id="jc.parsers.blkid"></a> <a id="jc.parsers.blkid"></a>
# jc.parsers.blkid # jc.parsers.blkid

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.cksum](#jc.parsers.cksum)
* [parse](#jc.parsers.cksum.parse)
<a id="jc.parsers.cksum"></a> <a id="jc.parsers.cksum"></a>
# jc.parsers.cksum # jc.parsers.cksum

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.crontab](#jc.parsers.crontab)
* [parse](#jc.parsers.crontab.parse)
<a id="jc.parsers.crontab"></a> <a id="jc.parsers.crontab"></a>
# jc.parsers.crontab # jc.parsers.crontab

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.crontab\_u](#jc.parsers.crontab_u)
* [parse](#jc.parsers.crontab_u.parse)
<a id="jc.parsers.crontab_u"></a> <a id="jc.parsers.crontab_u"></a>
# jc.parsers.crontab\_u # jc.parsers.crontab\_u

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.csv](#jc.parsers.csv)
* [parse](#jc.parsers.csv.parse)
<a id="jc.parsers.csv"></a> <a id="jc.parsers.csv"></a>
# jc.parsers.csv # jc.parsers.csv

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.csv\_s](#jc.parsers.csv_s)
* [parse](#jc.parsers.csv_s.parse)
<a id="jc.parsers.csv_s"></a> <a id="jc.parsers.csv_s"></a>
# jc.parsers.csv\_s # jc.parsers.csv\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.date](#jc.parsers.date)
* [parse](#jc.parsers.date.parse)
<a id="jc.parsers.date"></a> <a id="jc.parsers.date"></a>
# jc.parsers.date # jc.parsers.date

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.df](#jc.parsers.df)
* [parse](#jc.parsers.df.parse)
<a id="jc.parsers.df"></a> <a id="jc.parsers.df"></a>
# jc.parsers.df # jc.parsers.df

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.dig](#jc.parsers.dig)
* [parse](#jc.parsers.dig.parse)
<a id="jc.parsers.dig"></a> <a id="jc.parsers.dig"></a>
# jc.parsers.dig # jc.parsers.dig

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.dir](#jc.parsers.dir)
* [parse](#jc.parsers.dir.parse)
<a id="jc.parsers.dir"></a> <a id="jc.parsers.dir"></a>
# jc.parsers.dir # jc.parsers.dir

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.dmidecode](#jc.parsers.dmidecode)
* [parse](#jc.parsers.dmidecode.parse)
<a id="jc.parsers.dmidecode"></a> <a id="jc.parsers.dmidecode"></a>
# jc.parsers.dmidecode # jc.parsers.dmidecode

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.dpkg\_l](#jc.parsers.dpkg_l)
* [parse](#jc.parsers.dpkg_l.parse)
<a id="jc.parsers.dpkg_l"></a> <a id="jc.parsers.dpkg_l"></a>
# jc.parsers.dpkg\_l # jc.parsers.dpkg\_l

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.du](#jc.parsers.du)
* [parse](#jc.parsers.du.parse)
<a id="jc.parsers.du"></a> <a id="jc.parsers.du"></a>
# jc.parsers.du # jc.parsers.du

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.env](#jc.parsers.env)
* [parse](#jc.parsers.env.parse)
<a id="jc.parsers.env"></a> <a id="jc.parsers.env"></a>
# jc.parsers.env # jc.parsers.env

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.file](#jc.parsers.file)
* [parse](#jc.parsers.file.parse)
<a id="jc.parsers.file"></a> <a id="jc.parsers.file"></a>
# jc.parsers.file # jc.parsers.file

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.finger](#jc.parsers.finger)
* [parse](#jc.parsers.finger.parse)
<a id="jc.parsers.finger"></a> <a id="jc.parsers.finger"></a>
# jc.parsers.finger # jc.parsers.finger

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.free](#jc.parsers.free)
* [parse](#jc.parsers.free.parse)
<a id="jc.parsers.free"></a> <a id="jc.parsers.free"></a>
# jc.parsers.free # jc.parsers.free

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.fstab](#jc.parsers.fstab)
* [parse](#jc.parsers.fstab.parse)
<a id="jc.parsers.fstab"></a> <a id="jc.parsers.fstab"></a>
# jc.parsers.fstab # jc.parsers.fstab

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.group](#jc.parsers.group)
* [parse](#jc.parsers.group.parse)
<a id="jc.parsers.group"></a> <a id="jc.parsers.group"></a>
# jc.parsers.group # jc.parsers.group

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.gshadow](#jc.parsers.gshadow)
* [parse](#jc.parsers.gshadow.parse)
<a id="jc.parsers.gshadow"></a> <a id="jc.parsers.gshadow"></a>
# jc.parsers.gshadow # jc.parsers.gshadow

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.hash](#jc.parsers.hash)
* [parse](#jc.parsers.hash.parse)
<a id="jc.parsers.hash"></a> <a id="jc.parsers.hash"></a>
# jc.parsers.hash # jc.parsers.hash

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.hashsum](#jc.parsers.hashsum)
* [parse](#jc.parsers.hashsum.parse)
<a id="jc.parsers.hashsum"></a> <a id="jc.parsers.hashsum"></a>
# jc.parsers.hashsum # jc.parsers.hashsum

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.hciconfig](#jc.parsers.hciconfig)
* [parse](#jc.parsers.hciconfig.parse)
<a id="jc.parsers.hciconfig"></a> <a id="jc.parsers.hciconfig"></a>
# jc.parsers.hciconfig # jc.parsers.hciconfig

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.history](#jc.parsers.history)
* [parse](#jc.parsers.history.parse)
<a id="jc.parsers.history"></a> <a id="jc.parsers.history"></a>
# jc.parsers.history # jc.parsers.history

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.hosts](#jc.parsers.hosts)
* [parse](#jc.parsers.hosts.parse)
<a id="jc.parsers.hosts"></a> <a id="jc.parsers.hosts"></a>
# jc.parsers.hosts # jc.parsers.hosts

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.id](#jc.parsers.id)
* [parse](#jc.parsers.id.parse)
<a id="jc.parsers.id"></a> <a id="jc.parsers.id"></a>
# jc.parsers.id # jc.parsers.id

View File

@ -1,4 +1,18 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ifconfig](#jc.parsers.ifconfig)
* [\_IfconfigParser](#jc.parsers.ifconfig._IfconfigParser)
* [\_\_init\_\_](#jc.parsers.ifconfig._IfconfigParser.__init__)
* [list\_interfaces](#jc.parsers.ifconfig._IfconfigParser.list_interfaces)
* [count\_interfaces](#jc.parsers.ifconfig._IfconfigParser.count_interfaces)
* [filter\_interfaces](#jc.parsers.ifconfig._IfconfigParser.filter_interfaces)
* [get\_interface](#jc.parsers.ifconfig._IfconfigParser.get_interface)
* [get\_interfaces](#jc.parsers.ifconfig._IfconfigParser.get_interfaces)
* [is\_available](#jc.parsers.ifconfig._IfconfigParser.is_available)
* [parser](#jc.parsers.ifconfig._IfconfigParser.parser)
* [parse](#jc.parsers.ifconfig.parse)
<a id="jc.parsers.ifconfig"></a> <a id="jc.parsers.ifconfig"></a>
# jc.parsers.ifconfig # jc.parsers.ifconfig

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ini](#jc.parsers.ini)
* [parse](#jc.parsers.ini.parse)
<a id="jc.parsers.ini"></a> <a id="jc.parsers.ini"></a>
# jc.parsers.ini # jc.parsers.ini

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.iostat](#jc.parsers.iostat)
* [parse](#jc.parsers.iostat.parse)
<a id="jc.parsers.iostat"></a> <a id="jc.parsers.iostat"></a>
# jc.parsers.iostat # jc.parsers.iostat

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.iostat\_s](#jc.parsers.iostat_s)
* [parse](#jc.parsers.iostat_s.parse)
<a id="jc.parsers.iostat_s"></a> <a id="jc.parsers.iostat_s"></a>
# jc.parsers.iostat\_s # jc.parsers.iostat\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.iptables](#jc.parsers.iptables)
* [parse](#jc.parsers.iptables.parse)
<a id="jc.parsers.iptables"></a> <a id="jc.parsers.iptables"></a>
# jc.parsers.iptables # jc.parsers.iptables

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.iw\_scan](#jc.parsers.iw_scan)
* [parse](#jc.parsers.iw_scan.parse)
<a id="jc.parsers.iw_scan"></a> <a id="jc.parsers.iw_scan"></a>
# jc.parsers.iw\_scan # jc.parsers.iw\_scan

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.jar\_manifest](#jc.parsers.jar_manifest)
* [parse](#jc.parsers.jar_manifest.parse)
<a id="jc.parsers.jar_manifest"></a> <a id="jc.parsers.jar_manifest"></a>
# jc.parsers.jar\_manifest # jc.parsers.jar\_manifest

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.jobs](#jc.parsers.jobs)
* [parse](#jc.parsers.jobs.parse)
<a id="jc.parsers.jobs"></a> <a id="jc.parsers.jobs"></a>
# jc.parsers.jobs # jc.parsers.jobs

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.kv](#jc.parsers.kv)
* [parse](#jc.parsers.kv.parse)
<a id="jc.parsers.kv"></a> <a id="jc.parsers.kv"></a>
# jc.parsers.kv # jc.parsers.kv

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.last](#jc.parsers.last)
* [parse](#jc.parsers.last.parse)
<a id="jc.parsers.last"></a> <a id="jc.parsers.last"></a>
# jc.parsers.last # jc.parsers.last

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ls](#jc.parsers.ls)
* [parse](#jc.parsers.ls.parse)
<a id="jc.parsers.ls"></a> <a id="jc.parsers.ls"></a>
# jc.parsers.ls # jc.parsers.ls

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ls\_s](#jc.parsers.ls_s)
* [parse](#jc.parsers.ls_s.parse)
<a id="jc.parsers.ls_s"></a> <a id="jc.parsers.ls_s"></a>
# jc.parsers.ls\_s # jc.parsers.ls\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.lsblk](#jc.parsers.lsblk)
* [parse](#jc.parsers.lsblk.parse)
<a id="jc.parsers.lsblk"></a> <a id="jc.parsers.lsblk"></a>
# jc.parsers.lsblk # jc.parsers.lsblk

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.lsmod](#jc.parsers.lsmod)
* [parse](#jc.parsers.lsmod.parse)
<a id="jc.parsers.lsmod"></a> <a id="jc.parsers.lsmod"></a>
# jc.parsers.lsmod # jc.parsers.lsmod

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.lsof](#jc.parsers.lsof)
* [parse](#jc.parsers.lsof.parse)
<a id="jc.parsers.lsof"></a> <a id="jc.parsers.lsof"></a>
# jc.parsers.lsof # jc.parsers.lsof

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.lsusb](#jc.parsers.lsusb)
* [parse](#jc.parsers.lsusb.parse)
<a id="jc.parsers.lsusb"></a> <a id="jc.parsers.lsusb"></a>
# jc.parsers.lsusb # jc.parsers.lsusb

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.mount](#jc.parsers.mount)
* [parse](#jc.parsers.mount.parse)
<a id="jc.parsers.mount"></a> <a id="jc.parsers.mount"></a>
# jc.parsers.mount # jc.parsers.mount

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.netstat](#jc.parsers.netstat)
* [parse](#jc.parsers.netstat.parse)
<a id="jc.parsers.netstat"></a> <a id="jc.parsers.netstat"></a>
# jc.parsers.netstat # jc.parsers.netstat

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ntpq](#jc.parsers.ntpq)
* [parse](#jc.parsers.ntpq.parse)
<a id="jc.parsers.ntpq"></a> <a id="jc.parsers.ntpq"></a>
# jc.parsers.ntpq # jc.parsers.ntpq

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.passwd](#jc.parsers.passwd)
* [parse](#jc.parsers.passwd.parse)
<a id="jc.parsers.passwd"></a> <a id="jc.parsers.passwd"></a>
# jc.parsers.passwd # jc.parsers.passwd

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ping](#jc.parsers.ping)
* [parse](#jc.parsers.ping.parse)
<a id="jc.parsers.ping"></a> <a id="jc.parsers.ping"></a>
# jc.parsers.ping # jc.parsers.ping

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ping\_s](#jc.parsers.ping_s)
* [parse](#jc.parsers.ping_s.parse)
<a id="jc.parsers.ping_s"></a> <a id="jc.parsers.ping_s"></a>
# jc.parsers.ping\_s # jc.parsers.ping\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.pip\_list](#jc.parsers.pip_list)
* [parse](#jc.parsers.pip_list.parse)
<a id="jc.parsers.pip_list"></a> <a id="jc.parsers.pip_list"></a>
# jc.parsers.pip\_list # jc.parsers.pip\_list

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.pip\_show](#jc.parsers.pip_show)
* [parse](#jc.parsers.pip_show.parse)
<a id="jc.parsers.pip_show"></a> <a id="jc.parsers.pip_show"></a>
# jc.parsers.pip\_show # jc.parsers.pip\_show

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ps](#jc.parsers.ps)
* [parse](#jc.parsers.ps.parse)
<a id="jc.parsers.ps"></a> <a id="jc.parsers.ps"></a>
# jc.parsers.ps # jc.parsers.ps

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.route](#jc.parsers.route)
* [parse](#jc.parsers.route.parse)
<a id="jc.parsers.route"></a> <a id="jc.parsers.route"></a>
# jc.parsers.route # jc.parsers.route

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.rpm\_qi](#jc.parsers.rpm_qi)
* [parse](#jc.parsers.rpm_qi.parse)
<a id="jc.parsers.rpm_qi"></a> <a id="jc.parsers.rpm_qi"></a>
# jc.parsers.rpm\_qi # jc.parsers.rpm\_qi

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.sfdisk](#jc.parsers.sfdisk)
* [parse](#jc.parsers.sfdisk.parse)
<a id="jc.parsers.sfdisk"></a> <a id="jc.parsers.sfdisk"></a>
# jc.parsers.sfdisk # jc.parsers.sfdisk

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.shadow](#jc.parsers.shadow)
* [parse](#jc.parsers.shadow.parse)
<a id="jc.parsers.shadow"></a> <a id="jc.parsers.shadow"></a>
# jc.parsers.shadow # jc.parsers.shadow

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ss](#jc.parsers.ss)
* [parse](#jc.parsers.ss.parse)
<a id="jc.parsers.ss"></a> <a id="jc.parsers.ss"></a>
# jc.parsers.ss # jc.parsers.ss

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.stat](#jc.parsers.stat)
* [parse](#jc.parsers.stat.parse)
<a id="jc.parsers.stat"></a> <a id="jc.parsers.stat"></a>
# jc.parsers.stat # jc.parsers.stat

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.stat\_s](#jc.parsers.stat_s)
* [parse](#jc.parsers.stat_s.parse)
<a id="jc.parsers.stat_s"></a> <a id="jc.parsers.stat_s"></a>
# jc.parsers.stat\_s # jc.parsers.stat\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.sysctl](#jc.parsers.sysctl)
* [parse](#jc.parsers.sysctl.parse)
<a id="jc.parsers.sysctl"></a> <a id="jc.parsers.sysctl"></a>
# jc.parsers.sysctl # jc.parsers.sysctl

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.systemctl](#jc.parsers.systemctl)
* [parse](#jc.parsers.systemctl.parse)
<a id="jc.parsers.systemctl"></a> <a id="jc.parsers.systemctl"></a>
# jc.parsers.systemctl # jc.parsers.systemctl

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.systemctl\_lj](#jc.parsers.systemctl_lj)
* [parse](#jc.parsers.systemctl_lj.parse)
<a id="jc.parsers.systemctl_lj"></a> <a id="jc.parsers.systemctl_lj"></a>
# jc.parsers.systemctl\_lj # jc.parsers.systemctl\_lj

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.systemctl\_ls](#jc.parsers.systemctl_ls)
* [parse](#jc.parsers.systemctl_ls.parse)
<a id="jc.parsers.systemctl_ls"></a> <a id="jc.parsers.systemctl_ls"></a>
# jc.parsers.systemctl\_ls # jc.parsers.systemctl\_ls

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.systemctl\_luf](#jc.parsers.systemctl_luf)
* [parse](#jc.parsers.systemctl_luf.parse)
<a id="jc.parsers.systemctl_luf"></a> <a id="jc.parsers.systemctl_luf"></a>
# jc.parsers.systemctl\_luf # jc.parsers.systemctl\_luf

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.systeminfo](#jc.parsers.systeminfo)
* [parse](#jc.parsers.systeminfo.parse)
<a id="jc.parsers.systeminfo"></a> <a id="jc.parsers.systeminfo"></a>
# jc.parsers.systeminfo # jc.parsers.systeminfo

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.time](#jc.parsers.time)
* [parse](#jc.parsers.time.parse)
<a id="jc.parsers.time"></a> <a id="jc.parsers.time"></a>
# jc.parsers.time # jc.parsers.time

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.timedatectl](#jc.parsers.timedatectl)
* [parse](#jc.parsers.timedatectl.parse)
<a id="jc.parsers.timedatectl"></a> <a id="jc.parsers.timedatectl"></a>
# jc.parsers.timedatectl # jc.parsers.timedatectl

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.tracepath](#jc.parsers.tracepath)
* [parse](#jc.parsers.tracepath.parse)
<a id="jc.parsers.tracepath"></a> <a id="jc.parsers.tracepath"></a>
# jc.parsers.tracepath # jc.parsers.tracepath

View File

@ -1,4 +1,12 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.traceroute](#jc.parsers.traceroute)
* [\_\_version\_\_](#jc.parsers.traceroute.__version__)
* [\_Hop](#jc.parsers.traceroute._Hop)
* [add\_probe](#jc.parsers.traceroute._Hop.add_probe)
* [parse](#jc.parsers.traceroute.parse)
<a id="jc.parsers.traceroute"></a> <a id="jc.parsers.traceroute"></a>
# jc.parsers.traceroute # jc.parsers.traceroute

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ufw](#jc.parsers.ufw)
* [parse](#jc.parsers.ufw.parse)
<a id="jc.parsers.ufw"></a> <a id="jc.parsers.ufw"></a>
# jc.parsers.ufw # jc.parsers.ufw

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.ufw\_appinfo](#jc.parsers.ufw_appinfo)
* [parse](#jc.parsers.ufw_appinfo.parse)
<a id="jc.parsers.ufw_appinfo"></a> <a id="jc.parsers.ufw_appinfo"></a>
# jc.parsers.ufw\_appinfo # jc.parsers.ufw\_appinfo

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.uname](#jc.parsers.uname)
* [parse](#jc.parsers.uname.parse)
<a id="jc.parsers.uname"></a> <a id="jc.parsers.uname"></a>
# jc.parsers.uname # jc.parsers.uname

View File

@ -1,3 +1,9 @@
# Table of Contents
* [jc.parsers.universal](#jc.parsers.universal)
* [simple\_table\_parse](#jc.parsers.universal.simple_table_parse)
* [sparse\_table\_parse](#jc.parsers.universal.sparse_table_parse)
<a id="jc.parsers.universal"></a> <a id="jc.parsers.universal"></a>
# jc.parsers.universal # jc.parsers.universal

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.upower](#jc.parsers.upower)
* [parse](#jc.parsers.upower.parse)
<a id="jc.parsers.upower"></a> <a id="jc.parsers.upower"></a>
# jc.parsers.upower # jc.parsers.upower

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.uptime](#jc.parsers.uptime)
* [parse](#jc.parsers.uptime.parse)
<a id="jc.parsers.uptime"></a> <a id="jc.parsers.uptime"></a>
# jc.parsers.uptime # jc.parsers.uptime

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.vmstat](#jc.parsers.vmstat)
* [parse](#jc.parsers.vmstat.parse)
<a id="jc.parsers.vmstat"></a> <a id="jc.parsers.vmstat"></a>
# jc.parsers.vmstat # jc.parsers.vmstat

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.vmstat\_s](#jc.parsers.vmstat_s)
* [parse](#jc.parsers.vmstat_s.parse)
<a id="jc.parsers.vmstat_s"></a> <a id="jc.parsers.vmstat_s"></a>
# jc.parsers.vmstat\_s # jc.parsers.vmstat\_s

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.w](#jc.parsers.w)
* [parse](#jc.parsers.w.parse)
<a id="jc.parsers.w"></a> <a id="jc.parsers.w"></a>
# jc.parsers.w # jc.parsers.w

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.wc](#jc.parsers.wc)
* [parse](#jc.parsers.wc.parse)
<a id="jc.parsers.wc"></a> <a id="jc.parsers.wc"></a>
# jc.parsers.wc # jc.parsers.wc

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.who](#jc.parsers.who)
* [parse](#jc.parsers.who.parse)
<a id="jc.parsers.who"></a> <a id="jc.parsers.who"></a>
# jc.parsers.who # jc.parsers.who

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.xml](#jc.parsers.xml)
* [parse](#jc.parsers.xml.parse)
<a id="jc.parsers.xml"></a> <a id="jc.parsers.xml"></a>
# jc.parsers.xml # jc.parsers.xml

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.yaml](#jc.parsers.yaml)
* [parse](#jc.parsers.yaml.parse)
<a id="jc.parsers.yaml"></a> <a id="jc.parsers.yaml"></a>
# jc.parsers.yaml # jc.parsers.yaml

View File

@ -1,4 +1,9 @@
[Home](https://kellyjonbrazil.github.io/jc/) [Home](https://kellyjonbrazil.github.io/jc/)
# Table of Contents
* [jc.parsers.zipinfo](#jc.parsers.zipinfo)
* [parse](#jc.parsers.zipinfo.parse)
<a id="jc.parsers.zipinfo"></a> <a id="jc.parsers.zipinfo"></a>
# jc.parsers.zipinfo # jc.parsers.zipinfo

View File

@ -1,3 +1,7 @@
# Table of Contents
* [jc](#jc)
<a id="jc"></a> <a id="jc"></a>
# jc # jc

View File

@ -1,3 +1,20 @@
# Table of Contents
* [jc.utils](#jc.utils)
* [warning\_message](#jc.utils.warning_message)
* [error\_message](#jc.utils.error_message)
* [compatibility](#jc.utils.compatibility)
* [has\_data](#jc.utils.has_data)
* [convert\_to\_int](#jc.utils.convert_to_int)
* [convert\_to\_float](#jc.utils.convert_to_float)
* [convert\_to\_bool](#jc.utils.convert_to_bool)
* [stream\_success](#jc.utils.stream_success)
* [stream\_error](#jc.utils.stream_error)
* [input\_type\_check](#jc.utils.input_type_check)
* [streaming\_input\_type\_check](#jc.utils.streaming_input_type_check)
* [streaming\_line\_input\_type\_check](#jc.utils.streaming_line_input_type_check)
* [timestamp](#jc.utils.timestamp)
<a id="jc.utils"></a> <a id="jc.utils"></a>
# jc.utils # jc.utils

View File

@ -140,15 +140,15 @@ def _get_parser(parser_mod_name):
modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.' modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.'
return importlib.import_module(f'{modpath}{parser_mod_name}') return importlib.import_module(f'{modpath}{parser_mod_name}')
def parse(parser_mod_name: str,
def parse(
parser_mod_name: str,
data: Union[str, Iterable[str]], data: Union[str, Iterable[str]],
quiet: Optional[bool] = False, quiet: Optional[bool] = False,
raw: Optional[bool] = False, raw: Optional[bool] = False,
ignore_exceptions: Optional[Union[None, bool]] = None, ignore_exceptions: Optional[Union[None, bool]] = None,
**kwargs: Any, **kwargs: Any,
) -> Union[Dict[str, Any], ) -> Union[Dict[str, Any], List[Dict[str, Any]], Iterator[Dict[str, Any]]]:
List[Dict[str, Any]],
Iterator[Dict[str, Any]]]:
""" """
Parse the string data using the supplied parser module. Parse the string data using the supplied parser module.