feat: expand types for MarkdownConverter

Author: G-Rath

markdownify/__init__.pyi

@@ -1,4 +1,5 @@
 from _typeshed import Incomplete
+from typing import TypedDict, Unpack
 
 ATX: str
 ATX_CLOSED: str
@@ -13,29 +14,38 @@ RSTRIP: str
 STRIP: str
 STRIP_ONE: str
 
-def markdownify(
-  html: str,
-  strip: list[str] = ...,
-  convert: list[str] = ...,
-  autolinks: bool = ...,
-  bullets: str = ...,  # An iterable of bullet types.
-  code_language: str = ...,
-  code_language_callback: Incomplete = ...,
-  default_title: bool = ...,
-  escape_asterisks: bool = ...,
-  escape_underscores: bool = ...,
-  escape_misc: bool = ...,
-  heading_style: str = ...,
-  keep_inline_images_in: list[str] = ...,
-  newline_style: str = ...,
-  strip_document: str | None = ...,
-  strong_em_symbol: str = ...,
-  sub_symbol: str = ...,
-  sup_symbol: str = ...,
-  table_infer_header: bool = ...,
-  wrap: bool = ...,
-  wrap_width: int = ...,
-) -> str: ...
+
+class Options(TypedDict, total=False):
+  autolinks: bool
+  bs4_options: str
+  bullets: str  # An iterable of bullet types.
+  code_language: str
+  code_language_callback: Incomplete | None
+  convert: list[str] | None
+  default_title: bool
+  escape_asterisks: bool
+  escape_underscores: bool
+  escape_misc: bool
+  heading_style: str
+  keep_inline_images_in: list[str]
+  newline_style: str
+  strip: list[str] | None
+  strip_document: str | None
+  strip_pre: str
+  strong_em_symbol: str
+  sub_symbol: str
+  sup_symbol: str
+  table_infer_header: bool
+  wrap: bool
+  wrap_width: int
+
+
+def markdownify(html: str, **kwargs: Unpack[Options]) -> str: ...
+
 
 class MarkdownConverter:
-  pass
+  def __init__(self, **kwargs: Unpack[Options]) -> None:
+    ...
+  
+  def convert(self, html: str) -> str:
+    ...

tests/types.py

@@ -1,7 +1,53 @@
-from markdownify import markdownify, LSTRIP, RSTRIP, STRIP
+from markdownify import markdownify, ASTERISK, ATX, BACKSLASH, LSTRIP, RSTRIP, SPACES, STRIP, UNDERLINED, UNDERSCORE, MarkdownConverter
 
 markdownify("<p>Hello</p>") == "Hello"  # test default of STRIP
 markdownify("<p>Hello</p>", strip_document=LSTRIP) == "Hello\n\n"
 markdownify("<p>Hello</p>", strip_document=RSTRIP) == "\n\nHello"
 markdownify("<p>Hello</p>", strip_document=STRIP) == "Hello"
 markdownify("<p>Hello</p>", strip_document=None) == "\n\nHello\n\n"
+
+# default options
+MarkdownConverter(
+    autolinks=True,
+    bs4_options='html.parser',
+    bullets='*+-',
+    code_language='',
+    code_language_callback=None,
+    convert=None,
+    default_title=False,
+    escape_asterisks=True,
+    escape_underscores=True,
+    escape_misc=False,
+    heading_style=UNDERLINED,
+    keep_inline_images_in=[],
+    newline_style=SPACES,
+    strip=None,
+    strip_document=STRIP,
+    strip_pre=STRIP,
+    strong_em_symbol=ASTERISK,
+    sub_symbol='',
+    sup_symbol='',
+    table_infer_header=False,
+    wrap=False,
+    wrap_width=80,
+).convert("")
+
+# custom options
+MarkdownConverter(
+    strip_document=None,
+    bullets="-",
+    escape_asterisks=True,
+    escape_underscores=True,
+    escape_misc=True,
+    autolinks=True,
+    default_title=True,
+    newline_style=BACKSLASH,
+    sup_symbol='^',
+    sub_symbol='^',
+    keep_inline_images_in=['h3'],
+    wrap=True,
+    wrap_width=80,
+    strong_em_symbol=UNDERSCORE,
+    code_language='python',
+    code_language_callback=None
+).convert("")