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

{sphinxcontrib_screenshot-0.2.0/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.0
+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.0 → sphinxcontrib_screenshot-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sphinxcontrib-screenshot"
-version = "0.2.0"
+version = "0.2.2"
 description = "A Sphinx extension to embed webpage screenshots."
 readme = "README.md"
 license = { text = "Apache-2.0" }
@@ -69,6 +69,7 @@ include-package-data = true
 
 [tool.yapf]
 based_on_style = "yapf"
+column_limit = 79
 
 [tool.flake8]
 indent-size = 2

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

@@ -40,6 +40,9 @@ Meta = typing.TypedDict('Meta', {
     'parallel_write_safe': bool
 })
 
+ContextBuilder = typing.Optional[typing.Callable[[Browser, str, str],
+                                                 BrowserContext]]
+
 
 class ScreenshotDirective(SphinxDirective, Figure):
   """Sphinx Screenshot Dirctive.
@@ -79,6 +82,24 @@ class ScreenshotDirective(SphinxDirective, Figure):
   .. screenshot:: http://www.example.com
     :pdf:
   ```
+
+  You can take a screenshot of a local file using a root-relative path.
+
+  ```rst
+  .. screenshot:: /static/example.html
+  ```
+
+  Or you can use a document-relative path.
+
+  ```rst
+  .. screenshot:: ./example.html
+  ```
+
+  The `file://` protocol is also supported.
+
+  ```rst
+   .. screenshot:: file:///path/to/your/file.html
+   ```
   """
 
   required_arguments = 1  # URL
@@ -93,21 +114,25 @@ class ScreenshotDirective(SphinxDirective, Figure):
       'full-page': directives.flag,
       'context': str,
       'headers': directives.unchanged,
+      'locale': str,
+      'timezone': str,
+      'device-scale-factor': directives.positive_int,
   }
   pool = ThreadPoolExecutor()
 
   @staticmethod
-  def take_screenshot(
-      url: str, browser_name: str, viewport_width: int, viewport_height: int,
-      filepath: str, init_script: str, interactions: str, generate_pdf: bool,
-      color_scheme: ColorScheme, full_page: bool,
-      context_builder: typing.Optional[typing.Callable[[Browser, str, str],
-                                                       BrowserContext]],
-      headers: dict):
+  def take_screenshot(url: str, browser_name: str, viewport_width: int,
+                      viewport_height: int, filepath: str, init_script: str,
+                      interactions: str, generate_pdf: bool,
+                      color_scheme: ColorScheme, full_page: bool,
+                      context_builder: ContextBuilder, headers: dict,
+                      device_scale_factor: int, locale: typing.Optional[str],
+                      timezone: typing.Optional[str]):
     """Takes a screenshot with Playwright's Chromium browser.
 
     Args:
       url (str): The HTTP/HTTPS URL of the webpage to screenshot.
+      browser_name (str): Browser to use ('chromium', 'firefox' or 'webkit').
       viewport_width (int): The width of the screenshot in pixels.
       viewport_height (int): The height of the screenshot in pixels.
       filepath (str): The path to save the screenshot to.
@@ -118,10 +143,16 @@ class ScreenshotDirective(SphinxDirective, Figure):
         after the page was loaded.
       generate_pdf (bool): Generate a PDF file along with the screenshot.
       color_scheme (str): The preferred color scheme. Can be 'light' or 'dark'.
+      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.
     """
     with sync_playwright() as playwright:
-      browser = getattr(playwright, browser_name).launch()
+      browser: Browser = getattr(playwright, browser_name).launch()
 
       if context_builder:
         try:
@@ -131,7 +162,11 @@ class ScreenshotDirective(SphinxDirective, Figure):
               'Timeout error occured at %s in executing py init script %s' %
               (url, context_builder.__name__))
       else:
-        context = browser.new_context(color_scheme=color_scheme)
+        context = browser.new_context(
+            color_scheme=color_scheme,
+            locale=locale,
+            timezone_id=timezone,
+            device_scale_factor=device_scale_factor)
 
       page = context.new_page()
       page.set_default_timeout(10000)
@@ -173,14 +208,33 @@ class ScreenshotDirective(SphinxDirective, Figure):
 
   def run(self) -> typing.Sequence[nodes.Node]:
     screenshot_init_script: str = self.env.config.screenshot_init_script or ''
+    docdir = os.path.dirname(self.env.doc2path(self.env.docname))
 
     # Ensure the screenshots directory exists
     ss_dirpath = os.path.join(self.env.app.outdir, '_static', 'screenshots')
     os.makedirs(ss_dirpath, exist_ok=True)
 
     # Parse parameters
-    raw_url = self.arguments[0]
-    url = self.evaluate_substitutions(raw_url)
+    raw_path = self.arguments[0]
+    url_or_filepath = self.evaluate_substitutions(raw_path)
+
+    # Check if the path is a local file path.
+    if urlparse(url_or_filepath).scheme == '':
+      # root-relative path
+      if url_or_filepath.startswith('/'):
+        url_or_filepath = os.path.join(self.env.srcdir,
+                                       url_or_filepath.lstrip('/'))
+      # document-relative path
+      else:
+        url_or_filepath = os.path.join(docdir, url_or_filepath)
+      url_or_filepath = "file://" + os.path.normpath(url_or_filepath)
+
+    if urlparse(url_or_filepath).scheme not in {'http', 'https', 'file'}:
+      raise RuntimeError(
+          f'Invalid URL: {url_or_filepath}. ' +
+          'Only HTTP/HTTPS/FILE URLs or root/document-relative file paths ' +
+          'are supported.')
+
     interactions = self.options.get('interactions', '')
     browser = self.options.get('browser',
                                self.env.config.screenshot_default_browser)
@@ -193,25 +247,28 @@ class ScreenshotDirective(SphinxDirective, Figure):
     pdf = 'pdf' in self.options
     full_page = ('full-page' in self.options or
                  self.env.config.screenshot_default_full_page)
+    locale = self.options.get('locale',
+                              self.env.config.screenshot_default_locale)
+    timezone = self.options.get('timezone',
+                                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"):
         name, value = header.split(" ", 1)
         request_headers[name] = value
 
-    if urlparse(url).scheme not in {'http', 'https'}:
-      raise RuntimeError(
-          f'Invalid URL: {url}. Only HTTP/HTTPS URLs are supported.')
-
     # Generate filename based on hash of parameters
     hash_input = "_".join([
-        raw_url, browser,
+        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)
@@ -224,15 +281,15 @@ class ScreenshotDirective(SphinxDirective, Figure):
 
     # Check if the file already exists. If not, take a screenshot
     if not os.path.exists(filepath):
-      fut = self.pool.submit(ScreenshotDirective.take_screenshot, url, browser,
-                             viewport_width, viewport_height, filepath,
-                             screenshot_init_script, interactions, pdf,
-                             color_scheme, full_page, context_builder,
-                             request_headers)
+      fut = self.pool.submit(ScreenshotDirective.take_screenshot,
+                             url_or_filepath, browser, viewport_width,
+                             viewport_height, filepath, screenshot_init_script,
+                             interactions, pdf, color_scheme, full_page,
+                             context_builder, request_headers,
+                             device_scale_factor, locale, timezone)
       fut.result()
 
     # Create image and figure nodes
-    docdir = os.path.dirname(self.env.doc2path(self.env.docname))
     rel_ss_dirpath = os.path.relpath(ss_dirpath, start=docdir)
     rel_filepath = os.path.join(rel_ss_dirpath, filename).replace(os.sep, '/')
 
@@ -311,6 +368,22 @@ 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,
+      'env',
+      description="The default locale in requests")
+  app.add_config_value(
+      'screenshot_default_timezone',
+      None,
+      'env',
+      description="The default timezone in requests")
   app.add_config_value(
       'screenshot_apps', {},
       'env',

{sphinxcontrib_screenshot-0.2.0 → 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.0
+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.0 → sphinxcontrib_screenshot-0.2.2}/sphinxcontrib_screenshot.egg-info/SOURCES.txt

@@ -12,6 +12,8 @@ tests/test_color_scheme.py
 tests/test_contexts.py
 tests/test_full_page.py
 tests/test_headers.py
+tests/test_locale.py
 tests/test_pdf.py
 tests/test_root.py
+tests/test_timezone.py
 tests/test_wsgi_apps.py

sphinxcontrib_screenshot-0.2.2/tests/test_locale.py

@@ -0,0 +1,48 @@
+# Copyright 2025 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 sphinx.testing.util import SphinxTestApp
+
+
+@pytest.mark.sphinx('html', testroot="locale")
+def test_locale(app: SphinxTestApp, status: StringIO, warning: StringIO,
+                image_regression) -> None:
+  app.build()
+  out_html = app.outdir / "index.html"
+
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+  imgs = soup.find_all('img')
+
+  img_path = app.outdir / imgs[0]['src']
+  with open(img_path, "rb") as fd:
+    # Tolerance of 0.5%
+    image_regression.check(fd.read(), diff_threshold=0.5)
+
+
+@pytest.mark.sphinx('html', testroot="default-locale")
+def test_default_locale(app: SphinxTestApp, status: StringIO,
+                        warning: StringIO, image_regression) -> None:
+  app.build()
+  out_html = app.outdir / "index.html"
+
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+  imgs = soup.find_all('img')
+
+  img_path = app.outdir / imgs[0]['src']
+  with open(img_path, "rb") as fd:
+    # Tolerance of 0.5%
+    image_regression.check(fd.read(), diff_threshold=0.5)

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.2/tests/test_timezone.py

@@ -0,0 +1,48 @@
+# Copyright 2025 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 sphinx.testing.util import SphinxTestApp
+
+
+@pytest.mark.sphinx('html', testroot="timezone")
+def test_timezone(app: SphinxTestApp, status: StringIO, warning: StringIO,
+                  image_regression) -> None:
+  app.build()
+  out_html = app.outdir / "index.html"
+
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+  imgs = soup.find_all('img')
+
+  img_path = app.outdir / imgs[0]['src']
+  with open(img_path, "rb") as fd:
+    # Tolerance of 0.5%
+    image_regression.check(fd.read(), diff_threshold=0.5)
+
+
+@pytest.mark.sphinx('html', testroot="default-timezone")
+def test_default_timezone(app: SphinxTestApp, status: StringIO,
+                          warning: StringIO, image_regression) -> None:
+  app.build()
+  out_html = app.outdir / "index.html"
+
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+  imgs = soup.find_all('img')
+
+  img_path = app.outdir / imgs[0]['src']
+  with open(img_path, "rb") as fd:
+    # Tolerance of 0.5%
+    image_regression.check(fd.read(), diff_threshold=0.5)

sphinxcontrib_screenshot-0.2.0/tests/test_root.py

@@ -1,61 +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()
-  out_html = app.outdir / "index.html"
-  soup = BeautifulSoup(out_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())
-
-
-@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