👌 IMPROVE: Add more typing (#106)

Co-authored-by: Chris Sewell <[email protected]>

Author: hukkinj1

markdown_it/common/normalize_url.py

@@ -113,7 +113,7 @@ def normalizeLink(url):
     # return quote(urlunparse(parsed))
 
 
-def unescape_unquote(x):
+def unescape_unquote(x: str) -> str:
     return unquote(unescape_string(x))
 
 

markdown_it/main.py

@@ -42,8 +42,8 @@ def __init__(
         self.renderer = renderer_cls(self)
 
         self.utils = utils
-        self.helpers = helpers
-        self.options: Dict[str, Any] = {}
+        self.helpers: Any = helpers
+        self.options = AttrDict()
         self.configure(config)
 
         self.linkify = linkify_it.LinkifyIt() if linkify_it else None
@@ -59,7 +59,7 @@ def __getitem__(self, name):
             "renderer": self.renderer,
         }[name]
 
-    def set(self, options):
+    def set(self, options: AttrDict) -> None:
         """Set parser options (in the same format as in constructor).
         Probably, you will never need it, but you can change options after constructor call.
 

markdown_it/ruler.py

@@ -15,12 +15,25 @@ class Ruler
 rules control use [[MarkdownIt.disable]], [[MarkdownIt.enable]] and
 [[MarkdownIt.use]].
 """
-from typing import Callable, Dict, Iterable, List, Optional, Union
+from typing import (
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    TYPE_CHECKING,
+    Union,
+)
 import attr
 
+from markdown_it.utils import AttrDict
+
+if TYPE_CHECKING:
+    from markdown_it import MarkdownIt
+
 
 class StateBase:
-    def __init__(self, src: str, md, env):
+    def __init__(self, src: str, md: "MarkdownIt", env: AttrDict):
         self.srcCharCode: List[int] = []
         self.src = src
         self.env = env

markdown_it/rules_core/inline.py

@@ -5,4 +5,6 @@ def inline(state: StateCore) -> None:
     """Parse inlines"""
     for token in state.tokens:
         if token.type == "inline":
+            if token.children is None:
+                token.children = []
             state.md.inline.parse(token.content, state.md, state.env, token.children)

markdown_it/rules_core/state_core.py

@@ -1,11 +1,21 @@
-from typing import List
+from typing import List, Optional, TYPE_CHECKING
 
+from ..utils import AttrDict
 from ..token import Token
 from ..ruler import StateBase
 
+if TYPE_CHECKING:
+    from markdown_it import MarkdownIt
+
 
 class StateCore(StateBase):
-    def __init__(self, src: str, md, env, tokens=None):
+    def __init__(
+        self,
+        src: str,
+        md: "MarkdownIt",
+        env: AttrDict,
+        tokens: Optional[List[Token]] = None,
+    ):
         self.src = src
         self.md = md  # link to parser instance
         self.env = env

markdown_it/rules_inline/state_inline.py

@@ -1,12 +1,16 @@
 from collections import namedtuple
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, TYPE_CHECKING
 
 import attr
 
+from ..utils import AttrDict
 from ..token import Token
 from ..ruler import StateBase
 from ..common.utils import isWhiteSpace, isPunctChar, isMdAsciiPunct
 
+if TYPE_CHECKING:
+    from markdown_it import MarkdownIt
+
 
 @attr.s(slots=True)
 class Delimiter:
@@ -43,7 +47,9 @@ class Delimiter:
 
 
 class StateInline(StateBase):
-    def __init__(self, src: str, md, env, outTokens: List[Token]):
+    def __init__(
+        self, src: str, md: "MarkdownIt", env: AttrDict, outTokens: List[Token]
+    ):
         self.src = src
         self.env = env
         self.md = md

markdown_it/token.py

@@ -81,7 +81,7 @@ def attrJoin(self, name, value):
         else:
             self.attrs[idx][1] = self.attrs[idx][1] + " " + value
 
-    def copy(self):
+    def copy(self) -> "Token":
         """Return a shallow copy of the instance."""
         return attr.evolve(self)
 

markdown_it/utils.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, List, Union
 
 
 if TYPE_CHECKING:
@@ -17,7 +17,7 @@ def __init__(self, *args, **kwargs):
                     self[key] = AttrDict(item)
 
 
-def read_fixture_file(path):
+def read_fixture_file(path: Union[str, Path]) -> List[list]:
     text = Path(path).read_text(encoding="utf-8")
     tests = []
     section = 0