sphinxcontrib-screenshot 0.2.1__tar.gz → 0.2.2__tar.gz

{sphinxcontrib_screenshot-0.2.1/sphinxcontrib_screenshot.egg-info → sphinxcontrib_screenshot-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinxcontrib-screenshot
-Version: 0.2.1
+Version: 0.2.2
 Summary: A Sphinx extension to embed webpage screenshots.
 Author-email: Shuhei Iitsuka <tushuhei@gmail.com>
 License: Apache-2.0

{sphinxcontrib_screenshot-0.2.1 → sphinxcontrib_screenshot-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sphinxcontrib-screenshot"
-version = "0.2.1"
+version = "0.2.2"
 description = "A Sphinx extension to embed webpage screenshots."
 readme = "README.md"
 license = { text = "Apache-2.0" }

{sphinxcontrib_screenshot-0.2.1 → sphinxcontrib_screenshot-0.2.2}/sphinxcontrib/screenshot.py

@@ -116,6 +116,7 @@ class ScreenshotDirective(SphinxDirective, Figure):
       'headers': directives.unchanged,
       'locale': str,
       'timezone': str,
+      'device-scale-factor': directives.positive_int,
   }
   pool = ThreadPoolExecutor()
 
@@ -125,7 +126,7 @@ class ScreenshotDirective(SphinxDirective, Figure):
                       interactions: str, generate_pdf: bool,
                       color_scheme: ColorScheme, full_page: bool,
                       context_builder: ContextBuilder, headers: dict,
-                      locale: typing.Optional[str],
+                      device_scale_factor: int, locale: typing.Optional[str],
                       timezone: typing.Optional[str]):
     """Takes a screenshot with Playwright's Chromium browser.
 
@@ -145,6 +146,8 @@ class ScreenshotDirective(SphinxDirective, Figure):
       full_page (bool): Take a full page screenshot.
       context: A method to build the Playwright context.
       headers (dict): Custom request header.
+      device_scale_factor (int): The device scale factor for the screenshot.
+        This can be thought of as DPR (device pixel ratio).
       locale (str, optional): User locale for the request.
       timezone (str, optional): User timezone for the request.
     """
@@ -160,7 +163,10 @@ class ScreenshotDirective(SphinxDirective, Figure):
               (url, context_builder.__name__))
       else:
         context = browser.new_context(
-            color_scheme=color_scheme, locale=locale, timezone_id=timezone)
+            color_scheme=color_scheme,
+            locale=locale,
+            timezone_id=timezone,
+            device_scale_factor=device_scale_factor)
 
       page = context.new_page()
       page.set_default_timeout(10000)
@@ -247,7 +253,9 @@ class ScreenshotDirective(SphinxDirective, Figure):
                                 self.env.config.screenshot_default_timezone)
     context = self.options.get('context', '')
     headers = self.options.get('headers', '')
-
+    device_scale_factor = self.options.get(
+        'device-scale-factor',
+        self.env.config.screenshot_default_device_scale_factor)
     request_headers = {**self.env.config.screenshot_default_headers}
     if headers:
       for header in headers.strip().split("\n"):
@@ -259,7 +267,8 @@ class ScreenshotDirective(SphinxDirective, Figure):
         raw_path, browser,
         str(viewport_height),
         str(viewport_width), color_scheme, context, interactions,
-        str(full_page)
+        str(full_page),
+        str(device_scale_factor)
     ])
     filename = hashlib.md5(hash_input.encode()).hexdigest() + '.png'
     filepath = os.path.join(ss_dirpath, filename)
@@ -276,8 +285,8 @@ class ScreenshotDirective(SphinxDirective, Figure):
                              url_or_filepath, browser, viewport_width,
                              viewport_height, filepath, screenshot_init_script,
                              interactions, pdf, color_scheme, full_page,
-                             context_builder, request_headers, locale,
-                             timezone)
+                             context_builder, request_headers,
+                             device_scale_factor, locale, timezone)
       fut.result()
 
     # Create image and figure nodes
@@ -359,6 +368,12 @@ def setup(app: Sphinx) -> Meta:
       'screenshot_default_headers', {},
       'env',
       description="The default headers to pass in requests")
+  app.add_config_value(
+      'screenshot_default_device_scale_factor',
+      1,
+      'env',
+      description="The default device scale factor " +
+      "a.k.a. DPR (device pixel ratio)")
   app.add_config_value(
       'screenshot_default_locale',
       None,

{sphinxcontrib_screenshot-0.2.1 → sphinxcontrib_screenshot-0.2.2/sphinxcontrib_screenshot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinxcontrib-screenshot
-Version: 0.2.1
+Version: 0.2.2
 Summary: A Sphinx extension to embed webpage screenshots.
 Author-email: Shuhei Iitsuka <tushuhei@gmail.com>
 License: Apache-2.0

sphinxcontrib_screenshot-0.2.2/tests/test_root.py

@@ -0,0 +1,92 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from io import StringIO
+
+import pytest
+from bs4 import BeautifulSoup
+from PIL import Image
+from sphinx.testing.util import SphinxTestApp
+
+
+@pytest.mark.sphinx('html', testroot='root')
+def test_default(app: SphinxTestApp) -> None:
+  app.build()
+
+  def test_index():
+    soup = BeautifulSoup((app.outdir / "index.html").read_text(),
+                         "html.parser")
+
+    # Every screenshot directive should become an image.
+    imgs = soup.find_all('img')
+    assert len(list(imgs)) == 4
+
+    # The image size should be set as specified.
+    img_obj = Image.open(app.outdir / imgs[0]['src'])
+    width, height = img_obj.size
+    assert width == 480
+    assert height == 320
+
+    # The images should be the same if the difference is only the caption.
+    img_with_caption_a = imgs[0]
+    img_with_caption_b = imgs[1]
+    assert img_with_caption_a['src'] == img_with_caption_b['src']
+
+    # The images should be different after the specified user interaction.
+    imgsrc_before_interaction = app.outdir / imgs[1]['src']
+    imgsrc_after_interaction = app.outdir / imgs[2]['src']
+    assert imgsrc_before_interaction != imgsrc_after_interaction
+    assert list(Image.open(imgsrc_before_interaction).getdata()) != list(
+        Image.open(imgsrc_after_interaction).getdata())
+
+    # High reso image should have a larger size.
+    imgsrc_standard = app.outdir / imgs[0]['src']
+    imgsrc_highreso = app.outdir / imgs[3]['src']
+    assert (Image.open(imgsrc_highreso).width ==
+            Image.open(imgsrc_standard).width * 2)
+
+  def test_sections_index():
+    soup = BeautifulSoup((app.outdir / "sections" / "index.html").read_text(),
+                         "html.parser")
+
+    # Every screenshot directive should become an image.
+    imgs = soup.find_all('img')
+    assert len(list(imgs)) == 2
+
+    # The images should be the same.
+    imgsrc_relative = app.outdir / "sections" / imgs[0]['src']
+    imgsrc_absolute = app.outdir / "sections" / imgs[1]['src']
+    assert imgsrc_relative != imgsrc_absolute
+    assert list(Image.open(imgsrc_relative).getdata()) == list(
+        Image.open(imgsrc_absolute).getdata())
+
+  test_index()
+  test_sections_index()
+
+
+@pytest.mark.sphinx('html', testroot="default-size")
+def test_default_size(app: SphinxTestApp, status: StringIO, warning: StringIO,
+                      image_regression) -> None:
+  """Test the 'screenshot_default_viewport_width' and
+  'screenshot_default_viewport_height' configuration parameters."""
+  app.build()
+  out_html = app.outdir / "index.html"
+
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+  imgs = soup.find_all('img')
+
+  img_obj = Image.open(app.outdir / imgs[0]['src'])
+  width, height = img_obj.size
+  assert width == 1920
+  assert height == 1200

sphinxcontrib_screenshot-0.2.1/tests/test_root.py

@@ -1,74 +0,0 @@
-# Copyright 2023 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from io import StringIO
-
-import pytest
-from bs4 import BeautifulSoup
-from PIL import Image
-from sphinx.testing.util import SphinxTestApp
-
-
-@pytest.mark.sphinx('html', testroot='root')
-def test_default(app: SphinxTestApp) -> None:
-  app.build()
-  soup = BeautifulSoup((app.outdir / "index.html").read_text(), "html.parser")
-
-  # Every screenshot directive should become an image.
-  imgs = soup.find_all('img')
-  assert len(list(imgs)) == 3
-
-  # The image size should be set as specified.
-  img_obj = Image.open(app.outdir / imgs[0]['src'])
-  width, height = img_obj.size
-  assert width == 480
-  assert height == 320
-
-  # The images should be different after the specified user interaction.
-  imgsrc_before_interaction = app.outdir / imgs[1]['src']
-  imgsrc_after_interaction = app.outdir / imgs[2]['src']
-  assert imgsrc_before_interaction != imgsrc_after_interaction
-  assert list(Image.open(imgsrc_before_interaction).getdata()) != list(
-      Image.open(imgsrc_after_interaction).getdata())
-
-  soup = BeautifulSoup((app.outdir / "sections" / "index.html").read_text(),
-                       "html.parser")
-
-  # Every screenshot directive should become an image.
-  imgs = soup.find_all('img')
-  assert len(list(imgs)) == 2
-
-  # The images should be the same.
-  imgsrc_relative = app.outdir / "sections" / imgs[0]['src']
-  imgsrc_absolute = app.outdir / "sections" / imgs[1]['src']
-  assert imgsrc_relative != imgsrc_absolute
-  assert list(Image.open(imgsrc_relative).getdata()) == list(
-      Image.open(imgsrc_absolute).getdata())
-
-
-@pytest.mark.sphinx('html', testroot="default-size")
-def test_default_size(app: SphinxTestApp, status: StringIO, warning: StringIO,
-                      image_regression) -> None:
-  """Test the 'screenshot_default_viewport_width' and
-  'screenshot_default_viewport_height' configuration parameters."""
-  app.build()
-  out_html = app.outdir / "index.html"
-
-  soup = BeautifulSoup(out_html.read_text(), "html.parser")
-  imgs = soup.find_all('img')
-
-  img_obj = Image.open(app.outdir / imgs[0]['src'])
-  width, height = img_obj.size
-  assert width == 1920
-  assert height == 1200