sphinxcontrib-screenshot 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

sphinxcontrib/screenshot.py

@@ -19,6 +19,8 @@ import typing
 from docutils import nodes
 from docutils.parsers.rst import directives
 from docutils.statemachine import ViewList
+from playwright.sync_api import Browser, Playwright
+from playwright.sync_api import TimeoutError as PlaywrightTimeoutError
 from playwright.sync_api import sync_playwright
 from sphinx.application import Sphinx
 from sphinx.util.docutils import SphinxDirective
@@ -29,8 +31,10 @@ Meta = typing.TypedDict('Meta', {
     'parallel_write_safe': bool
 })
 
-p = sync_playwright().start()
-browser = p.chromium.launch()
+p: typing.Optional[Playwright] = None
+browser: typing.Optional[Browser] = None
+
+__version__ = '0.0.4'
 
 
 class ScreenshotDirective(SphinxDirective):
@@ -107,23 +111,31 @@ class ScreenshotDirective(SphinxDirective):
     filename = hashlib.md5(hash_input.encode()).hexdigest() + '.png'
     filepath = os.path.join(ss_dirpath, filename)
 
+    if not browser:
+      raise RuntimeError('Browser has not been initiated.')
+
     # Check if the file already exists. If not, take a screenshot
     if not os.path.exists(filepath):
       page = browser.new_page()
+      page.set_default_timeout(10000)
       page.set_viewport_size({'width': width, 'height': height})
-      if screenshot_init_script:
-        page.add_init_script(screenshot_init_script)
-      if url_or_path.startswith(('http://', 'https://')):
-        page.goto(url_or_path)
-      elif os.path.isabs(url_or_path):
-        page.goto('file://' + url_or_path)
-      else:
-        page.goto('file://' + str(self.env.srcdir.joinpath(url_or_path)))
-      page.wait_for_load_state('networkidle')
-
-      # Execute interactions
-      if interactions:
-        exec(interactions)
+      try:
+        if screenshot_init_script:
+          page.add_init_script(screenshot_init_script)
+        if url_or_path.startswith(('http://', 'https://')):
+          page.goto(url_or_path)
+        elif os.path.isabs(url_or_path):
+          page.goto('file://' + url_or_path)
+        else:
+          page.goto('file://' + str(self.env.srcdir.joinpath(url_or_path)))
+        page.wait_for_load_state('networkidle')
+
+        # Execute interactions
+        if interactions:
+          exec(interactions)
+      except PlaywrightTimeoutError:
+        raise RuntimeError('Timeout error occured at %s in executing\n%s' %
+                           (url_or_path, interactions))
 
       page.screenshot(path=filepath)
       page.close()
@@ -145,17 +157,29 @@ class ScreenshotDirective(SphinxDirective):
     return [figure_node]
 
 
+def on_builder_inited(app: Sphinx):
+  global p
+  global browser
+  p = sync_playwright().start()
+  browser = p.chromium.launch()
+
+
 def on_build_finished(app: Sphinx, exception: Exception):
-  browser.close()
-  p.stop()
+  global p
+  global browser
+  if browser:
+    browser.close()
+  if p:
+    p.stop()
 
 
 def setup(app: Sphinx) -> Meta:
   app.add_directive('screenshot', ScreenshotDirective)
   app.connect('build-finished', on_build_finished)
+  app.connect('builder-inited', on_builder_inited)
   app.add_config_value('screenshot_init_script', '', 'env')
   return {
-      'version': '0.0.2',
+      'version': __version__,
       'parallel_read_safe': True,
       'parallel_write_safe': True,
   }

{sphinxcontrib_screenshot-0.0.2.dist-info → sphinxcontrib_screenshot-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinxcontrib-screenshot
-Version: 0.0.2
+Version: 0.0.4
 Summary: A Shpinx extension to embed webpage screenshots.
 Author: Shuhei Iitsuka
 Author-email: tushuhei@gmail.com

sphinxcontrib_screenshot-0.0.4.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinxcontrib/screenshot.py,sha256=tcT_d5r0pMFBNQq2MYx7knjuWEIEySox-_O-TqEPyJE,5642
+sphinxcontrib_screenshot-0.0.4.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+sphinxcontrib_screenshot-0.0.4.dist-info/METADATA,sha256=1u2FkF2ciErdKKVmwhPUhxEdaXUuND30QAilfvqWNMs,3208
+sphinxcontrib_screenshot-0.0.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+sphinxcontrib_screenshot-0.0.4.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sphinxcontrib_screenshot-0.0.4.dist-info/RECORD,,

sphinxcontrib_screenshot-0.0.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-sphinxcontrib/screenshot.py,sha256=qi351sBkCYZ5sIBr5XYtxTZnMaYOQJN_7XBSR9VFPDE,4915
-sphinxcontrib_screenshot-0.0.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-sphinxcontrib_screenshot-0.0.2.dist-info/METADATA,sha256=y7FWmuAFeqc_9P8Sl2krRFYyscYM6jqbogo3JxjbKwk,3208
-sphinxcontrib_screenshot-0.0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-sphinxcontrib_screenshot-0.0.2.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sphinxcontrib_screenshot-0.0.2.dist-info/RECORD,,