sphinxcontrib-screenshot 0.1.1__tar.gz → 0.1.3__tar.gz

{sphinxcontrib_screenshot-0.1.1 → sphinxcontrib_screenshot-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinxcontrib-screenshot
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Shpinx extension to embed webpage screenshots.
 Home-page: https://github.com/tushuhei/sphinxcontrib-screenshot/
 Author: Shuhei Iitsuka

{sphinxcontrib_screenshot-0.1.1 → sphinxcontrib_screenshot-0.1.3}/sphinxcontrib/screenshot.py

@@ -32,7 +32,7 @@ Meta = typing.TypedDict('Meta', {
     'parallel_write_safe': bool
 })
 
-__version__ = '0.1.1'
+__version__ = '0.1.3'
 
 
 class ScreenshotDirective(SphinxDirective):
@@ -72,6 +72,21 @@ class ScreenshotDirective(SphinxDirective):
 
     document.querySelector('button').click();
   ```
+
+  Use `figclass` option if you want to specify a class name to the image.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :figclass: foo
+  ```
+
+  It also generates a PDF file when `pdf` option is given, which might be
+  useful when you need scalable image assets.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :pdf:
+  ```
   """
 
   required_arguments = 1  # URL
@@ -80,12 +95,14 @@ class ScreenshotDirective(SphinxDirective):
       'height': directives.positive_int,
       'width': directives.positive_int,
       'caption': directives.unchanged,
+      'figclass': directives.unchanged,
+      'pdf': directives.flag,
   }
   pool = ThreadPoolExecutor()
 
   @staticmethod
   def take_screenshot(url: str, width: int, height: int, filepath: str,
-                      init_script: str, interactions: str):
+                      init_script: str, interactions: str, generate_pdf: bool):
     """Takes a screenshot with Playwright's Chromium browser.
 
     Args:
@@ -98,6 +115,7 @@ class ScreenshotDirective(SphinxDirective):
         https://playwright.dev/python/docs/api/class-page#page-add-init-script
       interactions (str): JavaScript code to run before taking the screenshot
         after the page was loaded.
+      generate_pdf (bool): Generate a PDF file along with the screenshot.
     """
     with sync_playwright() as playwright:
       browser = playwright.chromium.launch()
@@ -118,6 +136,10 @@ class ScreenshotDirective(SphinxDirective):
         raise RuntimeError('Timeout error occured at %s in executing\n%s' %
                            (url, interactions))
       page.screenshot(path=filepath)
+      if generate_pdf:
+        page.emulate_media(media='screen')
+        root, ext = os.path.splitext(filepath)
+        page.pdf(width=f'{width}px', height=f'{height}px', path=root + '.pdf')
       page.close()
       browser.close()
 
@@ -133,6 +155,8 @@ class ScreenshotDirective(SphinxDirective):
     height = self.options.get('height', 960)
     width = self.options.get('width', 1280)
     caption_text = self.options.get('caption', '')
+    figclass = self.options.get('figclass', '')
+    pdf = 'pdf' in self.options
     interactions = '\n'.join(self.content)
 
     if urlparse(url).scheme not in {'http', 'https'}:
@@ -148,7 +172,7 @@ class ScreenshotDirective(SphinxDirective):
     if not os.path.exists(filepath):
       fut = self.pool.submit(ScreenshotDirective.take_screenshot, url, width,
                              height, filepath, screenshot_init_script,
-                             interactions)
+                             interactions, pdf)
       fut.result()
 
     # Create image and figure nodes
@@ -158,6 +182,9 @@ class ScreenshotDirective(SphinxDirective):
     image_node = nodes.image(uri=rel_filepath)
     figure_node = nodes.figure('', image_node)
 
+    if figclass:
+      figure_node['classes'].append(figclass)
+
     if caption_text:
       parsed = nodes.Element()
       self.state.nested_parse(

{sphinxcontrib_screenshot-0.1.1 → sphinxcontrib_screenshot-0.1.3}/sphinxcontrib_screenshot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinxcontrib-screenshot
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Shpinx extension to embed webpage screenshots.
 Home-page: https://github.com/tushuhei/sphinxcontrib-screenshot/
 Author: Shuhei Iitsuka

{sphinxcontrib_screenshot-0.1.1 → sphinxcontrib_screenshot-0.1.3}/tests/test_it.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
 from io import StringIO
 
 import pytest
@@ -29,7 +30,7 @@ def test_default(app: SphinxTestApp, status: StringIO,
 
   # Every screenshot directive should become an image.
   imgs = soup.find_all('img')
-  assert len(list(imgs)) == 3
+  assert len(list(imgs)) == 5
 
   # The image size should be set as specified.
   img_obj = Image.open(app.outdir / imgs[0]['src'])
@@ -44,7 +45,7 @@ def test_default(app: SphinxTestApp, status: StringIO,
 
   # The images should be different after the specified user interaction.
   img_before_interaction = Image.open(app.outdir / imgs[0]['src'])
-  img_after_interaction = Image.open(app.outdir / imgs[-1]['src'])
+  img_after_interaction = Image.open(app.outdir / imgs[2]['src'])
   assert list(img_before_interaction.getdata()) != list(
       img_after_interaction.getdata())
 
@@ -52,3 +53,18 @@ def test_default(app: SphinxTestApp, status: StringIO,
   img_with_caption_a = imgs[0]
   img_with_caption_b = imgs[1]
   assert img_with_caption_a['src'] == img_with_caption_b['src']
+
+  # The figure node should have the class name specified.
+  assert 'round' in soup.find_all('figure')[3]['class']
+
+  # Should generate a PDF file if specified.
+  img_with_pdf = imgs[4]['src']
+  root, ext = os.path.splitext(os.path.basename(img_with_pdf))
+  pdf_filepath = app.outdir / '_static' / 'screenshots' / f'{root}.pdf'
+  assert os.path.exists(pdf_filepath)
+
+  # Should not generate a PDF file if not specified.
+  img_without_pdf = imgs[2]['src']
+  root, ext = os.path.splitext(os.path.basename(img_without_pdf))
+  pdf_filepath = app.outdir / '_static' / 'screenshots' / f'{root}.pdf'
+  assert not os.path.exists(pdf_filepath)