Re-organise functions

Author: AA-Turner

sphinxext/opengraph/__init__.py

@@ -53,10 +53,23 @@
 }
 
 
-def make_tag(property: str, content: str, type_: str = 'property') -> str:
-    # Parse quotation, so they won't break html tags if smart quotes are disabled
-    content = content.replace('"', '"')
-    return f'<meta {type_}="{property}" content="{content}" />'
+def html_page_context(
+    app: Sphinx,
+    pagename: str,
+    templatename: str,
+    context: dict[str, Any],
+    doctree: nodes.document,
+) -> None:
+    if doctree:
+        context['metatags'] += get_tags(
+            context,
+            doctree,
+            srcdir=app.srcdir,
+            outdir=app.outdir,
+            config=app.config,
+            builder=app.builder,
+            env=app.env,
+        )
 
 
 def get_tags(
@@ -302,23 +315,10 @@ def social_card_for_page(
     return posixpath.join(ogp_site_url, image_path.as_posix())
 
 
-def html_page_context(
-    app: Sphinx,
-    pagename: str,
-    templatename: str,
-    context: dict[str, Any],
-    doctree: nodes.document,
-) -> None:
-    if doctree:
-        context['metatags'] += get_tags(
-            context,
-            doctree,
-            srcdir=app.srcdir,
-            outdir=app.outdir,
-            config=app.config,
-            builder=app.builder,
-            env=app.env,
-        )
+def make_tag(property: str, content: str, type_: str = 'property') -> str:
+    # Parse quotation, so they won't break html tags if smart quotes are disabled
+    content = content.replace('"', '&quot;')
+    return f'<meta {type_}="{property}" content="{content}" />'
 
 
 def setup(app: Sphinx) -> ExtensionMetadata:

sphinxext/opengraph/_description_parser.py

@@ -9,6 +9,18 @@
     from collections.abc import Set
 
 
+def get_description(
+    doctree: nodes.document,
+    description_length: int,
+    known_titles: Set[str] = frozenset(),
+) -> str:
+    mcv = DescriptionParser(
+        doctree, desc_len=description_length, known_titles=known_titles
+    )
+    doctree.walkabout(mcv)
+    return mcv.description
+
+
 class DescriptionParser(nodes.NodeVisitor):
     """Finds the title and creates a description from a doctree."""
 
@@ -95,15 +107,3 @@ def dispatch_departure(self, node: nodes.Element) -> None:
                 self.description = self.description[:-3] + '...'
 
             self.stop = True
-
-
-def get_description(
-    doctree: nodes.document,
-    description_length: int,
-    known_titles: Set[str] = frozenset(),
-) -> str:
-    mcv = DescriptionParser(
-        doctree, desc_len=description_length, known_titles=known_titles
-    )
-    doctree.walkabout(mcv)
-    return mcv.description

sphinxext/opengraph/_meta_parser.py

@@ -3,6 +3,14 @@
 from html.parser import HTMLParser
 
 
+def get_meta_description(meta_tags: str) -> bool:
+    htp = HTMLTextParser()
+    htp.feed(meta_tags)
+    htp.close()
+
+    return htp.meta_description
+
+
 class HTMLTextParser(HTMLParser):
     """Parse HTML into text."""
 
@@ -19,11 +27,3 @@ def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None
                 if name == 'content':
                     self.meta_description = value
                     break
-
-
-def get_meta_description(meta_tags: str) -> bool:
-    htp = HTMLTextParser()
-    htp.feed(meta_tags)
-    htp.close()
-
-    return htp.meta_description

sphinxext/opengraph/_social_cards.py

@@ -45,18 +45,6 @@
 }
 
 
-# These functions are used when creating social card objects to set MPL values.
-# They must be defined here otherwise Sphinx errors when trying to pickle them.
-# They are dependent on the `multiple` variable defined when the figure is created.
-# Because they are depending on the figure size and renderer used to generate them.
-def _set_page_title_line_width() -> int:
-    return 825
-
-
-def _set_description_line_width() -> int:
-    return 1000
-
-
 def create_social_card(
     config_social: dict[str, bool | str],
     site_name: str,
@@ -318,3 +306,15 @@ def create_social_card_objects(
     for ax in fig.axes:
         ax.set_axis_off()
     return fig, txt_site, txt_page, txt_description, txt_url
+
+
+# These functions are used when creating social card objects to set MPL values.
+# They must be defined here otherwise Sphinx errors when trying to pickle them.
+# They are dependent on the `multiple` variable defined when the figure is created.
+# Because they are depending on the figure size and renderer used to generate them.
+def _set_page_title_line_width() -> int:
+    return 825
+
+
+def _set_description_line_width() -> int:
+    return 1000

sphinxext/opengraph/_title_parser.py

@@ -3,6 +3,14 @@
 from html.parser import HTMLParser
 
 
+def get_title(title: str) -> tuple[str, str]:
+    htp = HTMLTextParser()
+    htp.feed(title)
+    htp.close()
+
+    return htp.text, htp.text_outside_tags
+
+
 class HTMLTextParser(HTMLParser):
     """Parse HTML into text."""
 
@@ -24,11 +32,3 @@ def handle_data(self, data: str) -> None:
         self.text += data
         if self.level == 0:
             self.text_outside_tags += data
-
-
-def get_title(title: str) -> tuple[str, str]:
-    htp = HTMLTextParser()
-    htp.feed(title)
-    htp.close()
-
-    return htp.text, htp.text_outside_tags