From 29f1a1d4251c3d2258a5ef6934eea0311e433c74 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 30 Jan 2024 10:59:39 -0800 Subject: [PATCH] fix proc doc - output is dict or list of dicts --- docs/parsers/proc.md | 6 ++++-- jc/parsers/proc.py | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/parsers/proc.md b/docs/parsers/proc.md index f31b61ae..dcc2bc8d 100644 --- a/docs/parsers/proc.md +++ b/docs/parsers/proc.md @@ -127,7 +127,9 @@ Examples: ### parse ```python -def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] +def parse(data: str, + raw: bool = False, + quiet: bool = False) -> Union[List[Dict], Dict] ``` Main text parsing function @@ -140,7 +142,7 @@ Parameters: Returns: - List of Dictionaries. Raw or processed structured data. + Dictionary or List of Dictionaries. Raw or processed structured data. ### Parser Information Compatibility: linux diff --git a/jc/parsers/proc.py b/jc/parsers/proc.py index 630fffa5..e22e7d12 100644 --- a/jc/parsers/proc.py +++ b/jc/parsers/proc.py @@ -119,7 +119,7 @@ Examples: """ import re import importlib -from typing import List, Dict +from typing import List, Dict, Union import jc.utils from jc.exceptions import ParseError @@ -141,7 +141,7 @@ def parse( data: str, raw: bool = False, quiet: bool = False -) -> List[Dict]: +) -> Union[List[Dict], Dict]: """ Main text parsing function @@ -153,7 +153,7 @@ def parse( Returns: - List of Dictionaries. Raw or processed structured data. + Dictionary or List of Dictionaries. Raw or processed structured data. """ jc.utils.input_type_check(data)