sphinxcontrib-screenshot 0.1.4__py3-none-any.whl → 0.2.0__py3-none-any.whl

sphinxcontrib/screenshot.py

@@ -24,7 +24,7 @@ from urllib.parse import urlparse
 
 from docutils import nodes
 from docutils.parsers.rst import directives
-from docutils.statemachine import ViewList
+from docutils.parsers.rst.directives.images import Figure
 from playwright._impl._helper import ColorScheme
 from playwright.sync_api import Browser, BrowserContext
 from playwright.sync_api import TimeoutError as PlaywrightTimeoutError
@@ -41,7 +41,7 @@ Meta = typing.TypedDict('Meta', {
 })
 
 
-class ScreenshotDirective(SphinxDirective):
+class ScreenshotDirective(SphinxDirective, Figure):
   """Sphinx Screenshot Dirctive.
 
   This directive embeds a screenshot of a webpage.
@@ -54,20 +54,13 @@ class ScreenshotDirective(SphinxDirective):
   .. screenshot:: http://www.example.com
   ```
 
-  You can also specify the screen size for the screenshot with `width` and
-  `height` parameters in pixel.
+  You can also specify the screen size for the screenshot with
+  `viewport-width` and `viewport-height` parameters in pixel.
 
   ```rst
   .. screenshot:: http://www.example.com
-    :width: 1280
-    :height: 960
-  ```
-
-  You can include a caption for the screenshot's `figure` directive.
-
-  ```rst
-  .. screenshot:: http://www.example.com
-    :caption: This is a screenshot for www.example.com
+    :viewport-width: 1280
+    :viewport-height: 960
   ```
 
   You can describe the interaction that you want to have with the webpage
@@ -79,13 +72,6 @@ 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.
 
@@ -96,13 +82,12 @@ class ScreenshotDirective(SphinxDirective):
   """
 
   required_arguments = 1  # URL
-  has_content = True
   option_spec = {
+      **Figure.option_spec,
       'browser': str,
-      'height': directives.positive_int,
-      'width': directives.positive_int,
-      'caption': directives.unchanged,
-      'figclass': directives.unchanged,
+      'viewport-height': directives.positive_int,
+      'viewport-width': directives.positive_int,
+      'interactions': str,
       'pdf': directives.flag,
       'color-scheme': str,
       'full-page': directives.flag,
@@ -113,8 +98,8 @@ class ScreenshotDirective(SphinxDirective):
 
   @staticmethod
   def take_screenshot(
-      url: str, browser_name: str, width: int, height: int, filepath: str,
-      init_script: str, interactions: str, generate_pdf: bool,
+      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]],
@@ -123,8 +108,8 @@ class ScreenshotDirective(SphinxDirective):
 
     Args:
       url (str): The HTTP/HTTPS URL of the webpage to screenshot.
-      width (int): The width of the screenshot in pixels.
-      height (int): The height of the screenshot in pixels.
+      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.
       init_script (str): JavaScript code to be evaluated after the document
         was created but before any of its scripts were run. See more details at
@@ -150,7 +135,10 @@ class ScreenshotDirective(SphinxDirective):
 
       page = context.new_page()
       page.set_default_timeout(10000)
-      page.set_viewport_size({'width': width, 'height': height})
+      page.set_viewport_size({
+          'width': viewport_width,
+          'height': viewport_height
+      })
 
       try:
         if init_script:
@@ -170,7 +158,10 @@ class ScreenshotDirective(SphinxDirective):
       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.pdf(
+            width=f'{viewport_width}px',
+            height=f'{viewport_height}px',
+            path=root + '.pdf')
       page.close()
       browser.close()
 
@@ -180,7 +171,7 @@ class ScreenshotDirective(SphinxDirective):
       text = text.replace(f"|{key}|", value.astext())
     return text
 
-  def run(self) -> typing.List[nodes.Node]:
+  def run(self) -> typing.Sequence[nodes.Node]:
     screenshot_init_script: str = self.env.config.screenshot_init_script or ''
 
     # Ensure the screenshots directory exists
@@ -190,20 +181,19 @@ class ScreenshotDirective(SphinxDirective):
     # Parse parameters
     raw_url = self.arguments[0]
     url = self.evaluate_substitutions(raw_url)
+    interactions = self.options.get('interactions', '')
     browser = self.options.get('browser',
                                self.env.config.screenshot_default_browser)
-    height = self.options.get('height',
-                              self.env.config.screenshot_default_height)
-    width = self.options.get('width', self.env.config.screenshot_default_width)
+    viewport_height = self.options.get(
+        'viewport-height', self.env.config.screenshot_default_viewport_height)
+    viewport_width = self.options.get(
+        'viewport-width', self.env.config.screenshot_default_viewport_width)
     color_scheme = self.options.get(
         'color-scheme', self.env.config.screenshot_default_color_scheme)
-    caption_text = self.options.get('caption', '')
-    figclass = self.options.get('figclass', '')
     pdf = 'pdf' in self.options
     full_page = ('full-page' in self.options or
                  self.env.config.screenshot_default_full_page)
     context = self.options.get('context', '')
-    interactions = '\n'.join(self.content)
     headers = self.options.get('headers', '')
 
     request_headers = {**self.env.config.screenshot_default_headers}
@@ -219,8 +209,8 @@ class ScreenshotDirective(SphinxDirective):
     # Generate filename based on hash of parameters
     hash_input = "_".join([
         raw_url, browser,
-        str(height),
-        str(width), color_scheme, context, interactions,
+        str(viewport_height),
+        str(viewport_width), color_scheme, context, interactions,
         str(full_page)
     ])
     filename = hashlib.md5(hash_input.encode()).hexdigest() + '.png'
@@ -235,29 +225,19 @@ class ScreenshotDirective(SphinxDirective):
     # 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,
-                             width, height, filepath, screenshot_init_script,
-                             interactions, pdf, color_scheme, full_page,
-                             context_builder, request_headers)
+                             viewport_width, viewport_height, filepath,
+                             screenshot_init_script, interactions, pdf,
+                             color_scheme, full_page, context_builder,
+                             request_headers)
       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, '/')
-    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(
-          ViewList([caption_text], source=''), self.content_offset, parsed)
-      figure_node += nodes.caption(parsed[0].source or '', '',
-                                   *parsed[0].children)
 
-    return [figure_node]
+    self.arguments[0] = rel_filepath
+    return super().run()
 
 
 app_threads = {}
@@ -298,12 +278,12 @@ def setup(app: Sphinx) -> Meta:
   app.add_directive('screenshot', ScreenshotDirective)
   app.add_config_value('screenshot_init_script', '', 'env')
   app.add_config_value(
-      'screenshot_default_width',
+      'screenshot_default_viewport_width',
       1280,
       'env',
       description="The default width for screenshots")
   app.add_config_value(
-      'screenshot_default_height',
+      'screenshot_default_viewport_height',
       960,
       'env',
       description="The default height for screenshots")

{sphinxcontrib_screenshot-0.1.4.dist-info → sphinxcontrib_screenshot-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sphinxcontrib-screenshot
-Version: 0.1.4
+Version: 0.2.0
 Summary: A Sphinx extension to embed webpage screenshots.
 Author-email: Shuhei Iitsuka <tushuhei@gmail.com>
 License: Apache-2.0
@@ -53,8 +53,8 @@ A Sphinx extension to embed website screenshots.
 ```rst
 .. screenshot:: http://www.example.com
   :browser: chromium
-  :width: 1280
-  :height: 960
+  :viewport-width: 1280
+  :viewport-height: 960
   :color-scheme: dark
 ```
 

sphinxcontrib_screenshot-0.2.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinxcontrib/screenshot.py,sha256=03cVsF1d9zuWMsVBwtZU_EQ_GMMsYyPa2a3vBmzC4f8,11342
+sphinxcontrib_screenshot-0.2.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+sphinxcontrib_screenshot-0.2.0.dist-info/METADATA,sha256=pwaSBQlzvflzW2BSv7ByJ8GvbwDrYF0xn8bftw3dPC0,2868
+sphinxcontrib_screenshot-0.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+sphinxcontrib_screenshot-0.2.0.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sphinxcontrib_screenshot-0.2.0.dist-info/RECORD,,

sphinxcontrib_screenshot-0.1.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-sphinxcontrib/screenshot.py,sha256=eJEF1qfGGo1uwyTovYHXx4Ewz2fXmrxDSsQSdLJ0O-0,11863
-sphinxcontrib_screenshot-0.1.4.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-sphinxcontrib_screenshot-0.1.4.dist-info/METADATA,sha256=XpzmVDGTDfL-AxKUv7jIV3wQ_phEGc-OLxWU-wG7-o0,2850
-sphinxcontrib_screenshot-0.1.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-sphinxcontrib_screenshot-0.1.4.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sphinxcontrib_screenshot-0.1.4.dist-info/RECORD,,