From f19c9c71bf4f592f55a5176458acd478b462fdbe Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Wed, 26 Jan 2022 18:39:14 -0800
Subject: [PATCH] add type hints

---
 jc/parsers/foo.py   |  9 +++++++--
 jc/parsers/foo_s.py | 10 ++++++++--
 2 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/jc/parsers/foo.py b/jc/parsers/foo.py
index 2743c05f..6d456f0b 100644
--- a/jc/parsers/foo.py
+++ b/jc/parsers/foo.py
@@ -39,6 +39,7 @@ Examples:
     []
 """
 import jc.utils
+from typing import Optional, List, Dict
 
 
 class info():
@@ -57,7 +58,7 @@ class info():
 __version__ = info.version
 
 
-def _process(proc_data):
+def _process(proc_data: List[Dict]) -> List[Dict]:
     """
     Final processing to conform to the schema.
 
@@ -78,7 +79,11 @@ def _process(proc_data):
     return proc_data
 
 
-def parse(data, raw=False, quiet=False):
+def parse(
+    data: str,
+    raw: Optional[bool] = False,
+    quiet: Optional[bool] = False
+) -> List[Dict]:
     """
     Main text parsing function
 
diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py
index 9b29e337..f4c648b8 100644
--- a/jc/parsers/foo_s.py
+++ b/jc/parsers/foo_s.py
@@ -49,6 +49,7 @@ Examples:
     {example output}
     ...
 """
+from typing import Optional, Dict, Iterable
 import jc.utils
 from jc.utils import stream_success, stream_error
 from jc.exceptions import ParseError
@@ -69,7 +70,7 @@ class info():
 __version__ = info.version
 
 
-def _process(proc_data):
+def _process(proc_data: Dict) -> Dict:
     """
     Final processing to conform to the schema.
 
@@ -90,7 +91,12 @@ def _process(proc_data):
     return proc_data
 
 
-def parse(data, raw=False, quiet=False, ignore_exceptions=False):
+def parse(
+    data: Iterable[str],
+    raw: Optional[bool] = False,
+    quiet: Optional[bool] = False,
+    ignore_exceptions: Optional[bool] = False
+) -> Iterable[Dict]:
     """
     Main text parsing generator function. Returns an iterator object.