Skip to content

Commit

Permalink
Add type hints where missing
Browse files Browse the repository at this point in the history
  • Loading branch information
jace committed Apr 22, 2024
1 parent 925dc6e commit 6009a02
Show file tree
Hide file tree
Showing 10 changed files with 58 additions and 50 deletions.
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/block_code_ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

from __future__ import annotations

from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence
from typing import Any

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['block_code_extend_plugin']

Expand All @@ -18,7 +18,7 @@ def fence(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
output = RendererHTML.fence(renderer, tokens, idx, options, env)
output = output.replace('<pre><code>', '<pre><code class="language-none">')
Expand All @@ -30,7 +30,7 @@ def code_block(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
output = RendererHTML.code_block(renderer, tokens, idx, options, env)
output = output.replace('<pre><code>', '<pre><code class="language-none">')
Expand Down
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/del_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

from __future__ import annotations

from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['del_plugin']

Expand All @@ -17,7 +17,7 @@ def del_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '<del>'

Expand All @@ -27,7 +27,7 @@ def del_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '</del>'

Expand Down
6 changes: 3 additions & 3 deletions funnel/utils/markdown/mdit_plugins/embeds.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
from __future__ import annotations

import re
from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence
from math import floor

from markdown_it import MarkdownIt
from markdown_it.common.utils import charCodeAt
from markdown_it.renderer import RendererHTML
from markdown_it.rules_block import StateBlock
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['embeds_plugin']

Expand All @@ -43,7 +43,7 @@ def render(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
token = tokens[idx]
content = md.utils.escapeHtml(token.content)
Expand Down
6 changes: 3 additions & 3 deletions funnel/utils/markdown/mdit_plugins/footnote_ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

from __future__ import annotations

from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence
from typing import Any

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict
from mdit_py_plugins.footnote.index import render_footnote_caption

__all__ = ['footnote_extend_plugin']
Expand All @@ -19,7 +19,7 @@ def caption(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
output = render_footnote_caption(renderer, tokens, idx, options, env)
return output.replace('[', '').replace(']', '')
Expand Down
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/ins_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

from __future__ import annotations

from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.rules_inline import StateInline
from markdown_it.rules_inline.state_inline import Delimiter
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['ins_plugin']

Expand Down Expand Up @@ -124,7 +124,7 @@ def ins_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '<ins>'

Expand All @@ -134,7 +134,7 @@ def ins_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '</ins>'

Expand Down
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/mark_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

from __future__ import annotations

from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.rules_inline import StateInline
from markdown_it.rules_inline.state_inline import Delimiter
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['mark_plugin']

Expand Down Expand Up @@ -141,7 +141,7 @@ def mark_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '<mark>'

Expand All @@ -151,7 +151,7 @@ def mark_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '</mark>'

Expand Down
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/sub_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
from __future__ import annotations

import re
from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.rules_inline import StateInline
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['sub_plugin']

Expand Down Expand Up @@ -82,7 +82,7 @@ def sub_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '<sub>'

Expand All @@ -92,7 +92,7 @@ def sub_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '</sub>'

Expand Down
8 changes: 4 additions & 4 deletions funnel/utils/markdown/mdit_plugins/sup_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
from __future__ import annotations

import re
from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence

from markdown_it import MarkdownIt
from markdown_it.renderer import RendererHTML
from markdown_it.rules_inline import StateInline
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

__all__ = ['sup_plugin']

Expand Down Expand Up @@ -82,7 +82,7 @@ def sup_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '<sup>'

Expand All @@ -92,7 +92,7 @@ def sup_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
env: EnvType,
) -> str:
return '</sup>'

Expand Down
18 changes: 9 additions & 9 deletions funnel/utils/markdown/mdit_plugins/toc.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from __future__ import annotations

import re
from collections.abc import MutableMapping, Sequence
from collections.abc import Sequence
from functools import reduce
from typing import Any, TypedDict

Expand All @@ -22,7 +22,7 @@
from markdown_it.rules_core import StateCore
from markdown_it.rules_inline import StateInline
from markdown_it.token import Token
from markdown_it.utils import OptionsDict
from markdown_it.utils import EnvType, OptionsDict

from coaster.utils import make_name

Expand Down Expand Up @@ -229,8 +229,8 @@ def toc_open(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
):
env: EnvType,
) -> str:
open_html = f'<div class="{opts["container_class"]}">'
if opts['container_header_html'] is not None:
open_html = open_html + opts['container_header_html']
Expand All @@ -241,8 +241,8 @@ def toc_close(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
):
env: EnvType,
) -> str:
footer = ''
if opts['container_footer_html']:
footer = opts['container_footer_html']
Expand All @@ -253,14 +253,14 @@ def toc_body(
tokens: Sequence[Token],
idx: int,
options: OptionsDict,
env: MutableMapping,
):
env: EnvType,
) -> str:
items = find_elements(opts['include_level'], env['gstate'].tokens, opts)
toc = items_to_tree(items)
html = toc_item_to_html(toc, opts, md)
return html

def grab_state(state: StateCore):
def grab_state(state: StateCore) -> None:
state.env['gstate'] = state

md.core.ruler.push('grab_state', grab_state)
Expand Down
Loading

0 comments on commit 6009a02

Please sign in to comment.