From 8aee4517bb4c2eebdd9873f7eb0827cd33b85519 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 10 Mar 2022 13:02:50 -0800 Subject: [PATCH] doc formatting --- docs/parsers/pidstat_s.md | 19 ++++++------------- jc/parsers/pidstat_s.py | 19 ++++++------------- 2 files changed, 12 insertions(+), 26 deletions(-) diff --git a/docs/parsers/pidstat_s.md b/docs/parsers/pidstat_s.md index 49a52d1e..5d185262 100644 --- a/docs/parsers/pidstat_s.md +++ b/docs/parsers/pidstat_s.md @@ -5,7 +5,8 @@ jc - JSON Convert `pidstat` command output streaming parser -> This streaming parser outputs JSON Lines +> This streaming parser outputs JSON Lines (cli) or returns a Generator +iterator of Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. @@ -17,19 +18,11 @@ Usage (cli): Usage (module): import jc - # result is an iterable object (generator) + result = jc.parse('pidstat_s', pidstat_command_output.splitlines()) for item in result: # do something - or - - import jc.parsers.pidstat_s - # result is an iterable object (generator) - result = jc.parsers.pidstat_s.parse(pidstat_command_output.splitlines()) - for item in result: - # do something - Schema: { @@ -66,9 +59,9 @@ Schema: Examples: $ pidstat -hl | jc --pidstat-s - {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_system...} - {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_system...} - {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_system...} + {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...} + {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...} + {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...} ... $ pidstat -hl | jc --pidstat-s -r diff --git a/jc/parsers/pidstat_s.py b/jc/parsers/pidstat_s.py index 8cbd6470..19977598 100644 --- a/jc/parsers/pidstat_s.py +++ b/jc/parsers/pidstat_s.py @@ -1,6 +1,7 @@ """jc - JSON Convert `pidstat` command output streaming parser -> This streaming parser outputs JSON Lines +> This streaming parser outputs JSON Lines (cli) or returns a Generator +iterator of Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. @@ -12,19 +13,11 @@ Usage (cli): Usage (module): import jc - # result is an iterable object (generator) + result = jc.parse('pidstat_s', pidstat_command_output.splitlines()) for item in result: # do something - or - - import jc.parsers.pidstat_s - # result is an iterable object (generator) - result = jc.parsers.pidstat_s.parse(pidstat_command_output.splitlines()) - for item in result: - # do something - Schema: { @@ -61,9 +54,9 @@ Schema: Examples: $ pidstat -hl | jc --pidstat-s - {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_system...} - {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_system...} - {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_system...} + {"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...} + {"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...} + {"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...} ... $ pidstat -hl | jc --pidstat-s -r