rename util to utils

Author: AnonymousRand

src/markdown_environments/captioned_figure.py

@@ -4,7 +4,7 @@
 from markdown.blockprocessors import BlockProcessor
 from markdown.extensions import Extension
 
-from . import util
+from . import utils
 
 
 class CaptionedFigureProcessor(BlockProcessor):
@@ -157,10 +157,12 @@ def __init__(self, **kwargs):
                 "HTML `class` attribute to add to captioned figure's caption (default: `\"\"`)."
             ]
         }
-        util.init_extension_with_configs(self, **kwargs)
+        utils.init_extension_with_configs(self, **kwargs)
 
     def extendMarkdown(self, md):
-        md.parser.blockprocessors.register(CaptionedFigureProcessor(md.parser, **self.getConfigs()), "captioned_figure", 105)
+        md.parser.blockprocessors.register(
+            CaptionedFigureProcessor(md.parser, **self.getConfigs()), "captioned_figure", 105
+        )
 
 
 def makeExtension(**kwargs):

src/markdown_environments/cited_blockquote.py

@@ -4,7 +4,7 @@
 from markdown.blockprocessors import BlockProcessor
 from markdown.extensions import Extension
 
-from . import util
+from . import utils
 
 
 class CitedBlockquoteProcessor(BlockProcessor):
@@ -155,10 +155,12 @@ def __init__(self, **kwargs):
                 "HTML `class` attribute to add to cited blockquote's citation. Defaults to `\"\"`."
             ]
         }
-        util.init_extension_with_configs(self, **kwargs)
+        utils.init_extension_with_configs(self, **kwargs)
 
     def extendMarkdown(self, md):
-        md.parser.blockprocessors.register(CitedBlockquoteProcessor(md.parser, **self.getConfigs()), "cited_blockquote", 105)
+        md.parser.blockprocessors.register(
+            CitedBlockquoteProcessor(md.parser, **self.getConfigs()), "cited_blockquote", 105
+        )
 
 
 def makeExtension(**kwargs):

src/markdown_environments/div.py

@@ -4,7 +4,7 @@
 from markdown.blockprocessors import BlockProcessor
 from markdown.extensions import Extension
 
-from . import util
+from . import utils
 
 
 class DivProcessor(BlockProcessor):
@@ -13,12 +13,12 @@ def __init__(self, *args, types: dict, html_class: str, is_thm: bool, **kwargs):
         super().__init__(*args, **kwargs)
         self.html_class = html_class
         self.is_thm = is_thm
-        self.types, self.start_pattern_choices, self.end_pattern_choices = util.init_env_types(types, self.is_thm)
+        self.types, self.start_pattern_choices, self.end_pattern_choices = utils.init_env_types(types, self.is_thm)
         self.start_pattern = None
         self.end_pattern = None
 
     def test(self, parent, block):
-        typ = util.test_for_env_types(self.start_pattern_choices, parent, block)
+        typ = utils.test_for_env_types(self.start_pattern_choices, parent, block)
         if typ is None:
             return False
         self.type_opts = self.types[typ]
@@ -31,7 +31,7 @@ def run(self, parent, blocks):
         # generate default thm heading if applicable
         thm_heading_md = ""
         if self.is_thm:
-            thm_heading_md = util.gen_thm_heading_md(self.type_opts, self.start_pattern, blocks[0])
+            thm_heading_md = utils.gen_thm_heading_md(self.type_opts, self.start_pattern, blocks[0])
         # remove starting delim (after generating thm heading from it, if applicable)
         blocks[0] = self.start_pattern.sub("", blocks[0])
 
@@ -52,7 +52,7 @@ def run(self, parent, blocks):
                 for _ in range(0, i + 1):
                     blocks.pop(0)
                 # add thm heading if applicable
-                util.prepend_thm_heading_md(self.type_opts, elem, thm_heading_md)
+                utils.prepend_thm_heading_md(self.type_opts, elem, thm_heading_md)
                 break
         # if no ending delim, restore and do nothing
         if not delim_found:
@@ -126,7 +126,7 @@ def __init__(self, **kwargs):
                 )
             ]
         }
-        util.init_extension_with_configs(self, **kwargs)
+        utils.init_extension_with_configs(self, **kwargs)
 
         # set default options for individual types
         for type, opts in self.getConfig("types").items():

src/markdown_environments/dropdown.py

@@ -4,7 +4,7 @@
 from markdown.blockprocessors import BlockProcessor
 from markdown.extensions import Extension
 
-from . import util
+from . import utils
 
 
 class DropdownProcessor(BlockProcessor):
@@ -21,12 +21,12 @@ def __init__(
         self.summary_html_class = summary_html_class
         self.content_html_class = content_html_class
         self.is_thm = is_thm
-        self.types, self.start_pattern_choices, self.end_pattern_choices = util.init_env_types(types, self.is_thm)
+        self.types, self.start_pattern_choices, self.end_pattern_choices = utils.init_env_types(types, self.is_thm)
         self.start_pattern = None
         self.end_pattern = None
 
     def test(self, parent, block):
-        typ = util.test_for_env_types(self.start_pattern_choices, parent, block)
+        typ = utils.test_for_env_types(self.start_pattern_choices, parent, block)
         if typ is None:
             return False
         self.type_opts = self.types[typ]
@@ -55,7 +55,7 @@ def run(self, parent, blocks):
         # also first generate theorem heading from it to use as default summary if applicable
         thm_heading_md = ""
         if self.is_thm:
-            thm_heading_md = util.gen_thm_heading_md(self.type_opts, self.start_pattern, blocks[0])
+            thm_heading_md = utils.gen_thm_heading_md(self.type_opts, self.start_pattern, blocks[0])
         blocks[0] = self.start_pattern.sub("", blocks[0])
 
         # find and remove summary ending delim if summary starting delim was present, and extract element
@@ -87,7 +87,7 @@ def run(self, parent, blocks):
             blocks.extend(org_blocks)
             return False
         # prepend thm heading (including default summary) to summary if applicable, again outside loop
-        util.prepend_thm_heading_md(self.type_opts, summary_elem, thm_heading_md)
+        utils.prepend_thm_heading_md(self.type_opts, summary_elem, thm_heading_md)
 
         # find and remove dropdown ending delim, and extract element
         delim_found = False
@@ -208,7 +208,7 @@ def __init__(self, **kwargs):
                 "Whether to use theorem logic (e.g. heading); used only by `ThmExtension`. Defaults to `False`."
             ]
         }
-        util.init_extension_with_configs(self, **kwargs)
+        utils.init_extension_with_configs(self, **kwargs)
 
         # set default options for individual types
         for type, opts in self.getConfig("types").items():

src/markdown_environments/thms.py

@@ -6,7 +6,7 @@
 from markdown.postprocessors import Postprocessor
 from markdown.treeprocessors import Treeprocessor
 
-from . import util
+from . import utils
 
 
 # the only reason this is a `Treeprocessor` and not a `Preprocessor`, `InlineProcessor`, or `Postprocessor`, all of
@@ -379,7 +379,7 @@ def __init__(self, **kwargs):
                 "Config for theorem heading"
             ]
         }
-        util.init_extension_with_configs(self, **kwargs)
+        utils.init_extension_with_configs(self, **kwargs)
 
         # set default configs for each extension, since we no longer have the top-level `self.config` functionality
         # to set defaults for us

src/markdown_environments/util.py src/markdown_environments/utils.pysrc/markdown_environments/util.py renamed to src/markdown_environments/utils.py

@@ -1,7 +1,7 @@
 import pytest
 
 from markdown_environments import CaptionedFigureExtension
-from ..tests_util import run_extension_test
+from ..tests_utils import run_extension_test
 
 
 @pytest.mark.parametrize(

tests/captioned_figure/test_captioned_figure.py

@@ -1,7 +1,7 @@
 import pytest
 
 from markdown_environments import CitedBlockquoteExtension
-from ..tests_util import run_extension_test
+from ..tests_utils import run_extension_test
 
 
 @pytest.mark.parametrize(

tests/cited_blockquote/test_cited_blockquote.py

@@ -1,4 +1,4 @@
 def pytest_collection_modifyitems(session, config, items):
-    # don't interpret `test_for_env_types()` from actual package's `util.py` as a test!
+    # don't interpret `test_for_env_types()` from actual package's `utils.py` as a test!
     # otherwise it screams about fixture not found or something
     items[:] = [item for item in items if item.name != "test_for_env_types"]

tests/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 
 from markdown_environments import DivExtension
-from ..tests_util import run_extension_test
+from ..tests_utils import run_extension_test
 
 
 TYPES = {