xvfbwrapper 0.2.31__tar.gz → 0.2.33__tar.gz

{xvfbwrapper-0.2.31/xvfbwrapper.egg-info → xvfbwrapper-0.2.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.31
+Version: 0.2.33
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -39,9 +39,8 @@ Dynamic: license-file
 
 `xvfbwrapper` is a Python library for managing X11 virtual displays with
 [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
-a virtual X server that runs without a physical display. It provides the
-[`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
-program.
+a virtual X server that runs without a physical display. It provides the `Xvfb` class,
+a Python interface for configuring and controlling the Xvfb program.
 
 See the [module API documentation][api-docs] for more information.
 
@@ -245,10 +244,10 @@ finally:
     xvfb2.stop()
 ```
 
-#### Example: headless browser tests:
+#### Headless browser tests:
 
 This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
-on Chrome with a headless display.
+on Chrome inside a headless display.
 
 [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
 

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33}/README.md

@@ -8,9 +8,8 @@
 
 `xvfbwrapper` is a Python library for managing X11 virtual displays with
 [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
-a virtual X server that runs without a physical display. It provides the
-[`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
-program.
+a virtual X server that runs without a physical display. It provides the `Xvfb` class,
+a Python interface for configuring and controlling the Xvfb program.
 
 See the [module API documentation][api-docs] for more information.
 
@@ -214,10 +213,10 @@ finally:
     xvfb2.stop()
 ```
 
-#### Example: headless browser tests:
+#### Headless browser tests:
 
 This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
-on Chrome with a headless display.
+on Chrome inside a headless display.
 
 [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
 

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xvfbwrapper"
-version = "0.2.31"
+version = "0.2.33"
 description = "Manage headless displays with Xvfb (X virtual framebuffer)"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -40,6 +40,9 @@ download = "https://pypi.org/project/xvfbwrapper"
 dev = [
     "tox",
 ]
+docs = [
+    "pdoc",
+]
 lint = [
     "ruff",
 ]

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33}/test_xvfb.py

@@ -5,6 +5,7 @@
 """Tests for xvfbwrapper."""
 
 import os
+import re
 import sys
 import tempfile
 import unittest
@@ -167,17 +168,6 @@ class TestXvfb(XvfbCleanTestCase):
         self.assertEqual(orig_display, os.environ["DISPLAY"])
         self.assertIsNone(xvfb.proc)
 
-    def test_start_multiple_times(self):
-        xvfb = Xvfb()
-        xvfb.start()
-        self.addCleanup(xvfb.stop)
-        pid1 = xvfb.proc.pid
-        xvfb.stop()
-        xvfb.start()
-        pid2 = xvfb.proc.pid
-        self.assertIsNotNone(xvfb.proc)
-        self.assertNotEqual(pid1, pid2)
-
     def test_stop_if_not_running_doesnt_raise_error(self):
         xvfb = Xvfb()
         xvfb.stop()
@@ -269,7 +259,7 @@ class TestXvfb(XvfbCleanTestCase):
         self.assertIsNotNone(xvfb.proc)
         with self.assertRaisesRegex(
             RuntimeError,
-            f"Could not lock display :{display_num}",
+            f"Could not lock display: {display_num}",
         ):
             xvfb2.start()
 
@@ -319,6 +309,28 @@ class TestXvfb(XvfbCleanTestCase):
             xvfb.start()
         self.assertIsNone(xvfb.proc)
 
+    def test_start_already_running(self):
+        xvfb = Xvfb()
+        self.addCleanup(xvfb.stop)
+        xvfb.start()
+        with self.assertRaisesRegex(
+            RuntimeError,
+            re.escape(f"Xvfb is already running (PID: {xvfb.proc.pid})"),
+        ):
+            xvfb.start()
+        self.assertIsNotNone(xvfb.proc)
+
+    def test_multiple_lifecycles(self):
+        xvfb = Xvfb()
+        self.addCleanup(xvfb.stop)
+        xvfb.start()
+        pid1 = xvfb.proc.pid
+        xvfb.stop()
+        xvfb.start()
+        pid2 = xvfb.proc.pid
+        self.assertIsNotNone(xvfb.proc)
+        self.assertNotEqual(pid1, pid2)
+
     def test_get_next_unused_display_does_not_reuse_lock(self):
         xvfb = Xvfb()
         xvfb2 = Xvfb()

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33}/tox.ini

@@ -57,3 +57,22 @@ dependency_groups =
 skip_install = true
 commands =
     mypy --install-types --non-interactive {posargs:.}
+
+
+[testenv:docs]
+description = build docs
+platform = .*
+allowlist_externals =
+    echo
+dependency_groups =
+    docs
+commands =
+    echo "Cleaning {tox_root}/build/"
+    {envpython} -c "import shutil; shutil.rmtree('build', ignore_errors=True)"
+    echo "Building docs..."
+    {envpython} -m pdoc xvfbwrapper \
+        --output-dir build/docs \
+        --template-directory docs/pdoc \
+        --no-search \
+        --docformat markdown
+    echo "Docs successfully built: {tox_root}/build/docs/index.html"

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33/xvfbwrapper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.31
+Version: 0.2.33
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -39,9 +39,8 @@ Dynamic: license-file
 
 `xvfbwrapper` is a Python library for managing X11 virtual displays with
 [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
-a virtual X server that runs without a physical display. It provides the
-[`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
-program.
+a virtual X server that runs without a physical display. It provides the `Xvfb` class,
+a Python interface for configuring and controlling the Xvfb program.
 
 See the [module API documentation][api-docs] for more information.
 
@@ -245,10 +244,10 @@ finally:
     xvfb2.stop()
 ```
 
-#### Example: headless browser tests:
+#### Headless browser tests:
 
 This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
-on Chrome with a headless display.
+on Chrome inside a headless display.
 
 [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
 

{xvfbwrapper-0.2.31 → xvfbwrapper-0.2.33}/xvfbwrapper.py

@@ -1,7 +1,6 @@
 # Copyright (c) 2012-2026 Corey Goldberg
 # SPDX-License-Identifier: MIT
 
-
 """Manage headless displays with Xvfb (X virtual framebuffer)
 
 This module provides a wrapper around Xvfb (X Virtual Framebuffer) for managing
@@ -102,13 +101,17 @@ class Xvfb:
     def start(self) -> None:
         """Start Xvfb."""
 
+        if self.proc is not None:
+            raise RuntimeError(
+                f"Xvfb is already running (PID: {self.proc.pid})",
+            )
         if not os.access(self._tempdir, os.W_OK):
             raise RuntimeError(
                 f"Could not access writable temp directory: {self._tempdir}"
             )
         if self.new_display is not None:
             if not self._get_lock_for_display(self.new_display):
-                raise RuntimeError(f"Could not lock display :{self.new_display}")
+                raise RuntimeError(f"Could not lock display: {self.new_display}")
         else:
             self.new_display = self._get_next_unused_display()
         display_var = f":{self.new_display}"
@@ -143,10 +146,6 @@ class Xvfb:
         and, if necessary, an additional duration of the same length after killing the
         process. If `self._timeout` is `None`, wait indefinitely for the process to
         exit and be reaped.
-
-        This is a one-way lifecycle transition: once called, this object is considered
-        stopped and cannot be reused, regardless of whether the process exits
-        successfully.
         """
         if self.proc is None:
             return