python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

allow parser module as parse() argument

Browse Source
This commit is contained in:
Kelly Brazil
2022-10-14 14:05:16 -07:00
parent 38c41cfaf4
commit 38fb0a6828
3 changed files with 35 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/lib.md
View File

@ -21,7 +21,7 @@ jc - JSON Convert lib module
### parse ### parse
```python ```python
def parse(parser_mod_name: str, def parse(parser_mod_name: Union[str, ModuleType],
data: Union[str, bytes, Iterable[str]], data: Union[str, bytes, Iterable[str]],
quiet: bool = False, quiet: bool = False,
raw: bool = False, raw: bool = False,
@ -29,7 +29,7 @@ def parse(parser_mod_name: str,
**kwargs) -> Union[Dict, List[Dict], Iterator[Dict]] **kwargs) -> Union[Dict, List[Dict], Iterator[Dict]]
``` ```
Parse the string data using the supplied parser module. Parse the string or bytes data using the supplied parser module.
This function provides a high-level API to simplify parser use. This This function provides a high-level API to simplify parser use. This
function will call built-in parsers and custom plugin parsers. function will call built-in parsers and custom plugin parsers.
@ -53,6 +53,14 @@ Example (streaming parsers):
To get a list of available parser module names, use `parser_mod_list()`. To get a list of available parser module names, use `parser_mod_list()`.
Alternatively, a parser module object can be supplied:
>>> import jc
>>> import jc.parsers.date as jc_date
>>> date_obj = jc.parse(jc_date, 'Tue Jan 18 10:23:07 PST 2022')
>>> print(f'The year is: {date_obj["year"]}')
The year is: 2022
You can also use the lower-level parser modules directly: You can also use the lower-level parser modules directly:
>>> import jc.parsers.date >>> import jc.parsers.date
@ -73,11 +81,14 @@ parsers without this API:
Parameters: Parameters:
parser_mod_name: (string) name of the parser module. This parser_mod_name: (string or) name of the parser module. This
function will accept module_name, Module) function will accept module_name,
cli-name, and --argument-name cli-name, and --argument-name
variants of the module name. variants of the module name.
A Module object can also be passed
directly or via _get_parser()
data: (string or data to parse (string or bytes for data: (string or data to parse (string or bytes for
bytes or standard parsers, iterable of bytes or standard parsers, iterable of
iterable) strings for streaming parsers) iterable) strings for streaming parsers)

24
jc/lib.py
View File

@ -260,7 +260,7 @@ def _parser_is_deprecated(parser: ModuleType) -> bool:
return False return False
def parse( def parse(
parser_mod_name: str, parser_mod_name: Union[str, ModuleType],
data: Union[str, bytes, Iterable[str]], data: Union[str, bytes, Iterable[str]],
quiet: bool = False, quiet: bool = False,
raw: bool = False, raw: bool = False,
@ -268,7 +268,7 @@ def parse(
**kwargs **kwargs
) -> Union[Dict, List[Dict], Iterator[Dict]]: ) -> Union[Dict, List[Dict], Iterator[Dict]]:
""" """
Parse the string data using the supplied parser module. Parse the string or bytes data using the supplied parser module.
This function provides a high-level API to simplify parser use. This This function provides a high-level API to simplify parser use. This
function will call built-in parsers and custom plugin parsers. function will call built-in parsers and custom plugin parsers.
@ -292,6 +292,14 @@ def parse(
To get a list of available parser module names, use `parser_mod_list()`. To get a list of available parser module names, use `parser_mod_list()`.
Alternatively, a parser module object can be supplied:
>>> import jc
>>> import jc.parsers.date as jc_date
>>> date_obj = jc.parse(jc_date, 'Tue Jan 18 10:23:07 PST 2022')
>>> print(f'The year is: {date_obj["year"]}')
The year is: 2022
You can also use the lower-level parser modules directly: You can also use the lower-level parser modules directly:
>>> import jc.parsers.date >>> import jc.parsers.date
@ -312,11 +320,14 @@ def parse(
Parameters: Parameters:
parser_mod_name: (string) name of the parser module. This parser_mod_name: (string or) name of the parser module. This
function will accept module_name, Module) function will accept module_name,
cli-name, and --argument-name cli-name, and --argument-name
variants of the module name. variants of the module name.
A Module object can also be passed
directly or via _get_parser()
data: (string or data to parse (string or bytes for data: (string or data to parse (string or bytes for
bytes or standard parsers, iterable of bytes or standard parsers, iterable of
iterable) strings for streaming parsers) iterable) strings for streaming parsers)
@ -333,7 +344,10 @@ def parse(
Standard Parsers: Dictionary or List of Dictionaries Standard Parsers: Dictionary or List of Dictionaries
Streaming Parsers: Generator Object containing Dictionaries Streaming Parsers: Generator Object containing Dictionaries
""" """
jc_parser = _get_parser(parser_mod_name) if isinstance(parser_mod_name, ModuleType):
jc_parser = parser_mod_name
else:
jc_parser = _get_parser(parser_mod_name)
if ignore_exceptions is not None: if ignore_exceptions is not None:
return jc_parser.parse(data, quiet=quiet, raw=raw, return jc_parser.parse(data, quiet=quiet, raw=raw,

2
man/jc.1
View File

@ -1,4 +1,4 @@
.TH jc 1 2022-10-10 1.22.1 "JSON Convert" .TH jc 1 2022-10-14 1.22.1 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings
.SH SYNOPSIS .SH SYNOPSIS