From 5c749fe26f30716f6e9e3723dd00a0095c009b1d Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 28 Apr 2022 13:30:11 -0700 Subject: [PATCH] simplify docs --- docs/parsers/csv_s.md | 8 ++------ docs/parsers/iostat_s.md | 8 ++------ docs/parsers/ls_s.md | 8 ++------ docs/parsers/mpstat_s.md | 18 ++++++------------ docs/parsers/pidstat_s.md | 18 ++++++------------ docs/parsers/ping_s.md | 8 ++------ docs/parsers/rsync_s.md | 18 ++++++------------ docs/parsers/stat_s.md | 8 ++------ docs/parsers/vmstat_s.md | 8 ++------ jc/parsers/csv_s.py | 8 ++------ jc/parsers/foo_s.py | 11 ++++------- jc/parsers/iostat_s.py | 8 ++------ jc/parsers/ls_s.py | 8 ++------ jc/parsers/mpstat_s.py | 12 ++++-------- jc/parsers/pidstat_s.py | 12 ++++-------- jc/parsers/ping_s.py | 8 ++------ jc/parsers/rsync_s.py | 12 ++++-------- jc/parsers/stat_s.py | 8 ++------ jc/parsers/vmstat_s.py | 8 ++------ man/jc.1 | 2 +- 20 files changed, 59 insertions(+), 140 deletions(-) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 6b096ee2..be0244e2 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -68,7 +68,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -79,13 +79,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux, darwin, cygwin, win32, aix, freebsd diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index 698d15d8..711ec686 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -112,7 +112,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -123,13 +123,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 02097f98..ee66fae6 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -81,7 +81,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -92,13 +92,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux, darwin, cygwin, aix, freebsd diff --git a/docs/parsers/mpstat_s.md b/docs/parsers/mpstat_s.md index 51aceb14..21f17bdf 100644 --- a/docs/parsers/mpstat_s.md +++ b/docs/parsers/mpstat_s.md @@ -101,15 +101,13 @@ Examples: ```python @add_jc_meta -def parse( - data: Iterable[str], - raw: bool = False, - quiet: bool = False, - ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple] +def parse(data: Iterable[str], + raw: bool = False, + quiet: bool = False, + ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple] ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -120,13 +118,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux diff --git a/docs/parsers/pidstat_s.md b/docs/parsers/pidstat_s.md index e8fc7872..826a7a3a 100644 --- a/docs/parsers/pidstat_s.md +++ b/docs/parsers/pidstat_s.md @@ -83,15 +83,13 @@ Examples: ```python @add_jc_meta -def parse( - data: Iterable[str], - raw: bool = False, - quiet: bool = False, - ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple] +def parse(data: Iterable[str], + raw: bool = False, + quiet: bool = False, + ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple] ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -102,13 +100,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 86f22ba4..5b3ab153 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -88,7 +88,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -99,13 +99,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux, darwin, freebsd diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index d78ad24c..dca88721 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -90,15 +90,13 @@ Examples: ```python @add_jc_meta -def parse( - data: Iterable[str], - raw: bool = False, - quiet: bool = False, - ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple] +def parse(data: Iterable[str], + raw: bool = False, + quiet: bool = False, + ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple] ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -109,13 +107,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux, darwin, freebsd diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 2ea8e03f..53daf93d 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -86,7 +86,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -97,13 +97,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux, darwin, freebsd diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index b92bd283..96ab3861 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -105,7 +105,7 @@ Examples: def parse(data, raw=False, quiet=False, ignore_exceptions=False) ``` -Main text parsing generator function. Returns an iterator object. +Main text parsing generator function. Returns an iterable object. Parameters: @@ -116,13 +116,9 @@ Parameters: quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True -Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries ### Parser Information Compatibility: linux diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index 8434389d..604d2e88 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -95,7 +95,7 @@ def _process(proc_data): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -106,13 +106,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py index 496cd005..d26f5b9f 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -40,7 +40,7 @@ Examples: {example output} ... """ -from typing import Dict, Iterable, Generator, Union +from typing import Dict, Iterable, Union import jc.utils from jc.streaming import ( add_jc_meta, streaming_input_type_check, streaming_line_input_type_check, raise_or_yield @@ -90,9 +90,9 @@ def parse( raw: bool = False, quiet: bool = False, ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple]: +) -> Union[Iterable[Dict], tuple]: """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -103,13 +103,10 @@ def parse( quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/iostat_s.py b/jc/parsers/iostat_s.py index 9df7e14c..e76fdcd9 100644 --- a/jc/parsers/iostat_s.py +++ b/jc/parsers/iostat_s.py @@ -163,7 +163,7 @@ def _create_obj_list(section_list, section_name): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -174,13 +174,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index 003383b0..256b8069 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -118,7 +118,7 @@ def _process(proc_data): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -129,13 +129,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/mpstat_s.py b/jc/parsers/mpstat_s.py index e06f91b6..8d9a9a02 100644 --- a/jc/parsers/mpstat_s.py +++ b/jc/parsers/mpstat_s.py @@ -90,7 +90,7 @@ Examples: {"cpu":"all","intr_s":"37.61","type":"interrupts","time":"03:15:06 PM"} ... """ -from typing import Dict, Iterable, Generator, Union +from typing import Dict, Iterable, Union import jc.utils from jc.parsers.universal import simple_table_parse from jc.streaming import ( @@ -145,9 +145,9 @@ def parse( raw: bool = False, quiet: bool = False, ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple]: +) -> Union[Iterable[Dict], tuple]: """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -158,13 +158,9 @@ def parse( quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/pidstat_s.py b/jc/parsers/pidstat_s.py index d9b688bd..2972900b 100644 --- a/jc/parsers/pidstat_s.py +++ b/jc/parsers/pidstat_s.py @@ -72,7 +72,7 @@ Examples: {"time":"1646859134","uid":"0","pid":"9","percent_usr":"0.00","perc...} ... """ -from typing import Dict, Iterable, Generator, Union +from typing import Dict, Iterable, Union import jc.utils from jc.streaming import ( add_jc_meta, streaming_input_type_check, streaming_line_input_type_check, raise_or_yield @@ -126,9 +126,9 @@ def parse( raw: bool = False, quiet: bool = False, ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple]: +) -> Union[Iterable[Dict], tuple]: """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -139,13 +139,9 @@ def parse( quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 2acea940..64423959 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -465,7 +465,7 @@ def _linux_parse(line, s): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -476,13 +476,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/rsync_s.py b/jc/parsers/rsync_s.py index f6ecddd6..8bd94236 100644 --- a/jc/parsers/rsync_s.py +++ b/jc/parsers/rsync_s.py @@ -80,7 +80,7 @@ Examples: ... """ import re -from typing import Dict, Iterable, Generator, Union +from typing import Dict, Iterable, Union import jc.utils from jc.streaming import ( add_jc_meta, streaming_input_type_check, streaming_line_input_type_check, raise_or_yield @@ -139,9 +139,9 @@ def parse( raw: bool = False, quiet: bool = False, ignore_exceptions: bool = False -) -> Union[Generator[Dict, None, None], tuple]: +) -> Union[Iterable[Dict], tuple]: """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -152,13 +152,9 @@ def parse( quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/stat_s.py b/jc/parsers/stat_s.py index 3c3f9271..5594e647 100644 --- a/jc/parsers/stat_s.py +++ b/jc/parsers/stat_s.py @@ -127,7 +127,7 @@ def _process(proc_data): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -138,13 +138,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index cdb53c4a..5cbf4178 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -147,7 +147,7 @@ def _process(proc_data): @add_jc_meta def parse(data, raw=False, quiet=False, ignore_exceptions=False): """ - Main text parsing generator function. Returns an iterator object. + Main text parsing generator function. Returns an iterable object. Parameters: @@ -158,13 +158,9 @@ def parse(data, raw=False, quiet=False, ignore_exceptions=False): quiet: (boolean) suppress warning messages if True ignore_exceptions: (boolean) ignore parsing exceptions if True - Yields: - - Dictionary. Raw or processed structured data. - Returns: - Iterator object (generator) + Iterable of Dictionaries """ jc.utils.compatibility(__name__, info.compatible, quiet) streaming_input_type_check(data) diff --git a/man/jc.1 b/man/jc.1 index 0054dccd..74713009 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-04-27 1.18.8 "JSON Convert" +.TH jc 1 2022-04-28 1.18.8 "JSON Convert" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS