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

formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-25 19:28:04 -08:00
parent 155d421322
commit 3cfb3965bb
3 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/lib.md
View File

@ -7,7 +7,7 @@ JC lib module
<a id="jc.lib.parse"></a> <a id="jc.lib.parse"></a>
#### 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],
@ -73,7 +73,7 @@ Returns:
<a id="jc.lib.parser_mod_list"></a> <a id="jc.lib.parser_mod_list"></a>
#### parser\_mod\_list ### parser\_mod\_list
```python ```python
def parser_mod_list() -> List[str] def parser_mod_list() -> List[str]
@ -83,7 +83,7 @@ Returns a list of all available parser module names.
<a id="jc.lib.plugin_parser_mod_list"></a> <a id="jc.lib.plugin_parser_mod_list"></a>
#### plugin\_parser\_mod\_list ### plugin\_parser\_mod\_list
```python ```python
def plugin_parser_mod_list() -> List[str] def plugin_parser_mod_list() -> List[str]
@ -94,7 +94,7 @@ subset of `parser_mod_list()`.
<a id="jc.lib.parser_info"></a> <a id="jc.lib.parser_info"></a>
#### parser\_info ### parser\_info
```python ```python
def parser_info(parser_mod_name: str) -> Dict[str, Any] def parser_info(parser_mod_name: str) -> Dict[str, Any]
@ -107,7 +107,7 @@ variants of the module name string.
<a id="jc.lib.get_help"></a> <a id="jc.lib.get_help"></a>
#### get\_help ### get\_help
```python ```python
def get_help(parser_mod_name: str) -> None def get_help(parser_mod_name: str) -> None

4
docs/parsers/universal.md
View File

@ -6,7 +6,7 @@ jc - JSON CLI output utility universal Parsers
<a id="jc.parsers.universal.simple_table_parse"></a> <a id="jc.parsers.universal.simple_table_parse"></a>
#### simple\_table\_parse ### simple\_table\_parse
```python ```python
def simple_table_parse(data) def simple_table_parse(data)
@ -31,7 +31,7 @@ Returns:
<a id="jc.parsers.universal.sparse_table_parse"></a> <a id="jc.parsers.universal.sparse_table_parse"></a>
#### sparse\_table\_parse ### sparse\_table\_parse
```python ```python
def sparse_table_parse(data, delim='\u2063') def sparse_table_parse(data, delim='\u2063')

24
docs/utils.md
View File

@ -6,7 +6,7 @@ jc - JSON CLI output utility utils
<a id="jc.utils.warning_message"></a> <a id="jc.utils.warning_message"></a>
#### warning\_message ### warning\_message
```python ```python
def warning_message(message_lines) def warning_message(message_lines)
@ -26,7 +26,7 @@ Returns:
<a id="jc.utils.error_message"></a> <a id="jc.utils.error_message"></a>
#### error\_message ### error\_message
```python ```python
def error_message(message_lines) def error_message(message_lines)
@ -46,7 +46,7 @@ Returns:
<a id="jc.utils.compatibility"></a> <a id="jc.utils.compatibility"></a>
#### compatibility ### compatibility
```python ```python
def compatibility(mod_name, compatible, quiet=False) def compatibility(mod_name, compatible, quiet=False)
@ -71,7 +71,7 @@ Returns:
<a id="jc.utils.has_data"></a> <a id="jc.utils.has_data"></a>
#### has\_data ### has\_data
```python ```python
def has_data(data) def has_data(data)
@ -91,7 +91,7 @@ Returns:
<a id="jc.utils.convert_to_int"></a> <a id="jc.utils.convert_to_int"></a>
#### convert\_to\_int ### convert\_to\_int
```python ```python
def convert_to_int(value) def convert_to_int(value)
@ -110,7 +110,7 @@ Returns:
<a id="jc.utils.convert_to_float"></a> <a id="jc.utils.convert_to_float"></a>
#### convert\_to\_float ### convert\_to\_float
```python ```python
def convert_to_float(value) def convert_to_float(value)
@ -129,7 +129,7 @@ Returns:
<a id="jc.utils.convert_to_bool"></a> <a id="jc.utils.convert_to_bool"></a>
#### convert\_to\_bool ### convert\_to\_bool
```python ```python
def convert_to_bool(value) def convert_to_bool(value)
@ -149,7 +149,7 @@ Returns:
<a id="jc.utils.stream_success"></a> <a id="jc.utils.stream_success"></a>
#### stream\_success ### stream\_success
```python ```python
def stream_success(output_line, ignore_exceptions) def stream_success(output_line, ignore_exceptions)
@ -159,7 +159,7 @@ Add `_jc_meta` object to output line if `ignore_exceptions=True`
<a id="jc.utils.stream_error"></a> <a id="jc.utils.stream_error"></a>
#### stream\_error ### stream\_error
```python ```python
def stream_error(e, ignore_exceptions, line) def stream_error(e, ignore_exceptions, line)
@ -170,7 +170,7 @@ Reraise the stream exception with annotation or print an error
<a id="jc.utils.input_type_check"></a> <a id="jc.utils.input_type_check"></a>
#### input\_type\_check ### input\_type\_check
```python ```python
def input_type_check(data) def input_type_check(data)
@ -180,7 +180,7 @@ Ensure input data is a string
<a id="jc.utils.streaming_input_type_check"></a> <a id="jc.utils.streaming_input_type_check"></a>
#### streaming\_input\_type\_check ### streaming\_input\_type\_check
```python ```python
def streaming_input_type_check(data) def streaming_input_type_check(data)
@ -190,7 +190,7 @@ Ensure input data is an iterable, but not a string or bytes
<a id="jc.utils.streaming_line_input_type_check"></a> <a id="jc.utils.streaming_line_input_type_check"></a>
#### streaming\_line\_input\_type\_check ### streaming\_line\_input\_type\_check
```python ```python
def streaming_line_input_type_check(line) def streaming_line_input_type_check(line)