Factor out social_card_for_page()

Author: AA-Turner

sphinxext/opengraph/__init__.py

@@ -15,6 +15,8 @@
     from typing import Any
 
     from sphinx.application import Sphinx
+    from sphinx.config import Config
+    from sphinx.environment import BuildEnvironment
     from sphinx.util.typing import ExtensionMetadata
 
 try:
@@ -165,34 +167,16 @@ def get_tags(
         and config_social.get("enable") is not False
         and create_social_card is not None
     ):
-        # Description
-        description_max_length = config_social.get(
-            "description_max_length", DEFAULT_DESCRIPTION_LENGTH_SOCIAL_CARDS - 3
-        )
-        if len(description) > description_max_length:
-            description = description[:description_max_length].strip() + "..."
-
-        # Page title
-        pagetitle = title
-        if len(pagetitle) > DEFAULT_PAGE_LENGTH_SOCIAL_CARDS:
-            pagetitle = pagetitle[:DEFAULT_PAGE_LENGTH_SOCIAL_CARDS] + "..."
-
-        # Site URL
-        site_url = config_social.get("site_url", True)
-        if site_url is True:
-            url_text = app.config.ogp_site_url.split("://")[-1]
-        elif isinstance(site_url, str):
-            url_text = site_url
-
-        # Plot an image with the given metadata to the output path
-        image_path = create_social_card(
-            app,
-            config_social,
-            site_name,
-            pagetitle,
-            description,
-            url_text,
-            context["pagename"],
+        image_url = social_card_for_page(
+            config_social=config_social,
+            site_name=site_name,
+            title=title,
+            description=description,
+            pagename=context["pagename"],
+            srcdir=app.srcdir,
+            outdir=app.outdir,
+            config=app.config,
+            env=app.env,
         )
         ogp_use_first_image = False
 
@@ -202,12 +186,6 @@ def get_tags(
         else:
             ogp_image_alt = description
 
-        # Link the image in our page metadata
-        # We use os.path.sep to standardize behavior acros *nix and Windows
-        url = app.config.ogp_site_url.strip("/")
-        image_path = str(image_path).replace(os.path.sep, "/").strip("/")
-        image_url = f"{url}/{image_path}"
-
         # If the social card objects have been added we add special metadata for them
         # These are the dimensions *in pixels* of the card
         # They were chosen by looking at the image pixel dimensions on disk
@@ -267,6 +245,59 @@ def get_tags(
     )
 
 
+def social_card_for_page(
+    config_social: dict[str, bool | str],
+    site_name: str,
+    title: str,
+    description: str,
+    pagename: str,
+    *,
+    srcdir: str | Path,
+    outdir: str | Path,
+    config: Config,
+    env: BuildEnvironment,
+):
+    # Description
+    description_max_length = config_social.get(
+        "description_max_length", DEFAULT_DESCRIPTION_LENGTH_SOCIAL_CARDS - 3
+    )
+    if len(description) > description_max_length:
+        description = description[:description_max_length].strip() + "..."
+
+    # Page title
+    pagetitle = title
+    if len(pagetitle) > DEFAULT_PAGE_LENGTH_SOCIAL_CARDS:
+        pagetitle = pagetitle[:DEFAULT_PAGE_LENGTH_SOCIAL_CARDS] + "..."
+
+    # Site URL
+    site_url = config_social.get("site_url", True)
+    if site_url is True:
+        url_text = config.ogp_site_url.split("://")[-1]
+    elif isinstance(site_url, str):
+        url_text = site_url
+
+    # Plot an image with the given metadata to the output path
+    image_path = create_social_card(
+        config_social,
+        site_name,
+        pagetitle,
+        description,
+        url_text,
+        pagename,
+        srcdir=srcdir,
+        outdir=outdir,
+        config=config,
+        env=env,
+    )
+
+    # Link the image in our page metadata
+    # We use os.path.sep to standardize behavior acros *nix and Windows
+    url = config.ogp_site_url.strip("/")
+    image_path = str(image_path).replace(os.path.sep, "/").strip("/")
+    image_url = f"{url}/{image_path}"
+    return image_url
+
+
 def html_page_context(
     app: Sphinx,
     pagename: str,

sphinxext/opengraph/socialcards.py

@@ -17,7 +17,8 @@
 
     from matplotlib.figure import Figure
     from matplotlib.text import Text
-    from sphinx.application import Sphinx
+    from sphinx.config import Config
+    from sphinx.environment import BuildEnvironment
 
     PltObjects: TypeAlias = tuple[Figure, Text, Text, Text, Text]
 
@@ -58,13 +59,17 @@ def _set_description_line_width() -> int:
 
 
 def create_social_card(
-    app: Sphinx,
     config_social: dict[str, bool | str],
     site_name: str,
     page_title: str,
     description: str,
     url_text: str,
     page_path: str,
+    *,
+    srcdir: str | Path,
+    outdir: str | Path,
+    config: Config,
+    env: BuildEnvironment,
 ) -> Path:
     """Create a social preview card according to page metadata.
 
@@ -84,7 +89,7 @@ def create_social_card(
     filename_image = f"summary_{page_path.replace('/', '_')}_{hash}.png"
 
     # Absolute path used to save the image
-    path_images_absolute = Path(app.builder.outdir) / path_images_relative
+    path_images_absolute = Path(outdir) / path_images_relative
     path_images_absolute.mkdir(exist_ok=True, parents=True)
     path_image = path_images_absolute / filename_image
 
@@ -99,13 +104,13 @@ def create_social_card(
 
     # Large image to the top right
     if cs_image := config_social.get("image"):
-        kwargs_fig["image"] = Path(app.builder.srcdir) / cs_image
-    elif app.config.html_logo:
-        kwargs_fig["image"] = Path(app.builder.srcdir) / app.config.html_logo
+        kwargs_fig["image"] = Path(srcdir) / cs_image
+    elif config.html_logo:
+        kwargs_fig["image"] = Path(srcdir) / config.html_logo
 
     # Mini image to the bottom right
     if cs_image_mini := config_social.get("image_mini"):
-        kwargs_fig["image_mini"] = Path(app.builder.srcdir) / cs_image_mini
+        kwargs_fig["image_mini"] = Path(srcdir) / cs_image_mini
     else:
         kwargs_fig["image_mini"] = (
             Path(__file__).parent / "_static/sphinx-logo-shadow.png"
@@ -135,7 +140,7 @@ def create_social_card(
 
     # Generate the image and store the matplotlib objects so that we can re-use them
     try:
-        plt_objects = app.env.ogp_social_card_plt_objects
+        plt_objects = env.ogp_social_card_plt_objects
     except AttributeError:
         # If objects is None it means this is the first time plotting.
         # Create the figure objects and return them so that we re-use them later.
@@ -148,7 +153,7 @@ def create_social_card(
         url_text,
         plt_objects,
     )
-    app.env.ogp_social_card_plt_objects = plt_objects
+    env.ogp_social_card_plt_objects = plt_objects
 
     # Path relative to build folder will be what we use for linking the URL
     path_relative_to_build = path_images_relative / filename_image