xvfbwrapper 0.2.32__tar.gz → 0.2.34__tar.gz

{xvfbwrapper-0.2.32/xvfbwrapper.egg-info → xvfbwrapper-0.2.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.32
+Version: 0.2.34
 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.
 
@@ -64,13 +63,21 @@ See the [module API documentation][api-docs] for more information.
     </td>
   </tr>
   <tr>
-    <td>Build/Tests (CI)</td>
+    <td>Tests (CI)</td>
     <td>
       <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml">
         <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml/badge.svg">
       </a>
     </td>
   </tr>
+  <tr>
+    <td>API Docs (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml">
+        <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
   <tr>
     <td>Supported Python Versions</td>
     <td>
@@ -218,12 +225,10 @@ xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR`
 
 #### Multithreaded execution:
 
-To run several Xvfb displays at the same time, you can use the `environ`
-keyword when starting the `Xvfb` instances. This provides isolation between
-processes or threads. Be sure to use the environment dictionary you initialize
-`Xvfb` with in your subsequent calls. Also, if you wish to inherit your current
-environment, you must use the copy method of `os.environ` and not simply
-assign a new variable to `os.environ`:
+To run several Xvfb displays at the same time, you can use the `environ` keyword
+when starting the `Xvfb` instances. This provides isolation between processes or
+threads. If you wish to inherit your current environment, you must use the copy
+method of `os.environ` and not simply assign a new variable to `os.environ`:
 
 ```python
 import os
@@ -286,8 +291,6 @@ if __name__ == "__main__":
 
 ## Development
 
-- Git: [github.com/cgoldberg/xvfbwrapper.git][github-repo]
-
 - Create a virtual env and install required testing packages:
 
     ```

{xvfbwrapper-0.2.32 → xvfbwrapper-0.2.34}/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.
 
@@ -33,13 +32,21 @@ See the [module API documentation][api-docs] for more information.
     </td>
   </tr>
   <tr>
-    <td>Build/Tests (CI)</td>
+    <td>Tests (CI)</td>
     <td>
       <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml">
         <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml/badge.svg">
       </a>
     </td>
   </tr>
+  <tr>
+    <td>API Docs (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml">
+        <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
   <tr>
     <td>Supported Python Versions</td>
     <td>
@@ -187,12 +194,10 @@ xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR`
 
 #### Multithreaded execution:
 
-To run several Xvfb displays at the same time, you can use the `environ`
-keyword when starting the `Xvfb` instances. This provides isolation between
-processes or threads. Be sure to use the environment dictionary you initialize
-`Xvfb` with in your subsequent calls. Also, if you wish to inherit your current
-environment, you must use the copy method of `os.environ` and not simply
-assign a new variable to `os.environ`:
+To run several Xvfb displays at the same time, you can use the `environ` keyword
+when starting the `Xvfb` instances. This provides isolation between processes or
+threads. If you wish to inherit your current environment, you must use the copy
+method of `os.environ` and not simply assign a new variable to `os.environ`:
 
 ```python
 import os
@@ -255,8 +260,6 @@ if __name__ == "__main__":
 
 ## Development
 
-- Git: [github.com/cgoldberg/xvfbwrapper.git][github-repo]
-
 - Create a virtual env and install required testing packages:
 
     ```

{xvfbwrapper-0.2.32 → xvfbwrapper-0.2.34}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xvfbwrapper"
-version = "0.2.32"
+version = "0.2.34"
 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",
 ]
@@ -60,6 +63,7 @@ py-modules = ["xvfbwrapper"]
 
 [tool.pytest]
 addopts = ["-v"]
+filterwarnings = ["default"]
 
 [tool.ruff]
 line-length = 88

{xvfbwrapper-0.2.32 → xvfbwrapper-0.2.34}/test_xvfb.py

@@ -5,7 +5,7 @@
 """Tests for xvfbwrapper."""
 
 import os
-import sys
+import re
 import tempfile
 import unittest
 from contextlib import suppress
@@ -167,17 +167,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()
@@ -216,8 +205,7 @@ class TestXvfb(XvfbCleanTestCase):
         unwriteable_dir = "/etc"
         xvfb = Xvfb(tempdir=unwriteable_dir)
         with self.assertRaisesRegex(
-            RuntimeError,
-            f"Could not access writable temp directory: {unwriteable_dir}",
+            RuntimeError, f"Could not access writable temp directory: {unwriteable_dir}"
         ):
             xvfb.start()
         self.assertIsNone(xvfb.proc)
@@ -226,8 +214,7 @@ class TestXvfb(XvfbCleanTestCase):
         unknown_dir = "/tmp/some_unknown_path"
         xvfb = Xvfb(tempdir=unknown_dir)
         with self.assertRaisesRegex(
-            RuntimeError,
-            f"Could not access writable temp directory: {unknown_dir}",
+            RuntimeError, f"Could not access writable temp directory: {unknown_dir}"
         ):
             xvfb.start()
         self.assertIsNone(xvfb.proc)
@@ -268,8 +255,7 @@ class TestXvfb(XvfbCleanTestCase):
         self.assertEqual(xvfb.new_display, display_num)
         self.assertIsNotNone(xvfb.proc)
         with self.assertRaisesRegex(
-            RuntimeError,
-            f"Could not lock display :{display_num}",
+            RuntimeError, f"Could not lock display: {display_num}"
         ):
             xvfb2.start()
 
@@ -313,12 +299,32 @@ class TestXvfb(XvfbCleanTestCase):
             "bar",
         ]
         with self.assertRaisesRegex(
-            RuntimeError,
-            f"Xvfb display did not open: {expected_cmd_args}",
+            RuntimeError, f"Xvfb display did not open: {expected_cmd_args}"
         ):
             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()
@@ -330,21 +336,10 @@ class TestXvfb(XvfbCleanTestCase):
         with patch("xvfbwrapper.randint", side_effect=side_effect) as mockrandint:
             self.assertEqual(xvfb._get_next_unused_display(), 11)
             self.assertEqual(mockrandint.call_count, 1)
-            if sys.implementation.name == "cpython":
-                # ResourceWarning is only raised on CPython because
-                # of an implementation detail in it's garbage collector.
-                # This does not occur on other Python implementations
-                # (like PyPy).
-                with self.assertWarns(ResourceWarning):
-                    self.assertEqual(xvfb2._get_next_unused_display(), 22)
-                    self.assertEqual(mockrandint.call_count, 3)
-                    self.assertEqual(xvfb3._get_next_unused_display(), 33)
-                    self.assertEqual(mockrandint.call_count, 10)
-            else:
-                self.assertEqual(xvfb2._get_next_unused_display(), 22)
-                self.assertEqual(mockrandint.call_count, 3)
-                self.assertEqual(xvfb3._get_next_unused_display(), 33)
-                self.assertEqual(mockrandint.call_count, 10)
+            self.assertEqual(xvfb2._get_next_unused_display(), 22)
+            self.assertEqual(mockrandint.call_count, 3)
+            self.assertEqual(xvfb3._get_next_unused_display(), 33)
+            self.assertEqual(mockrandint.call_count, 10)
 
     def test_environ_keyword_isolates_environment_modification(self):
         # Check that start and stop methods modified the environ dict if
@@ -368,10 +363,7 @@ class TestXvfb(XvfbCleanTestCase):
         self.addCleanup(xvfb.stop)
         xvfb.start()
         proc = psutil.Process(xvfb.proc.pid)
-        self.assertEqual(
-            proc.environ().get("XVFBWRAPPER_TEST_MARKER"),
-            marker_value,
-        )
+        self.assertEqual(proc.environ().get("XVFBWRAPPER_TEST_MARKER"), marker_value)
 
     def test_start_failure_without_initial_display_env(self):
         # Provide a custom env *without* DISPLAY so orig_display_var == None
@@ -392,8 +384,7 @@ class TestXvfb(XvfbCleanTestCase):
         with (
             patch.object(xvfb, "_local_display_exists", return_value=False),
             self.assertRaisesRegex(
-                RuntimeError,
-                f"Xvfb display did not open: {expected_cmd_args}",
+                RuntimeError, f"Xvfb display did not open: {expected_cmd_args}"
             ),
         ):
             xvfb.start()

{xvfbwrapper-0.2.32 → xvfbwrapper-0.2.34}/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.32 → xvfbwrapper-0.2.34/xvfbwrapper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.32
+Version: 0.2.34
 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.
 
@@ -64,13 +63,21 @@ See the [module API documentation][api-docs] for more information.
     </td>
   </tr>
   <tr>
-    <td>Build/Tests (CI)</td>
+    <td>Tests (CI)</td>
     <td>
       <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml">
         <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/test.yml/badge.svg">
       </a>
     </td>
   </tr>
+  <tr>
+    <td>API Docs (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml">
+        <img src="https://github.com/cgoldberg/xvfbwrapper/actions/workflows/docs.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
   <tr>
     <td>Supported Python Versions</td>
     <td>
@@ -218,12 +225,10 @@ xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR`
 
 #### Multithreaded execution:
 
-To run several Xvfb displays at the same time, you can use the `environ`
-keyword when starting the `Xvfb` instances. This provides isolation between
-processes or threads. Be sure to use the environment dictionary you initialize
-`Xvfb` with in your subsequent calls. Also, if you wish to inherit your current
-environment, you must use the copy method of `os.environ` and not simply
-assign a new variable to `os.environ`:
+To run several Xvfb displays at the same time, you can use the `environ` keyword
+when starting the `Xvfb` instances. This provides isolation between processes or
+threads. If you wish to inherit your current environment, you must use the copy
+method of `os.environ` and not simply assign a new variable to `os.environ`:
 
 ```python
 import os
@@ -286,8 +291,6 @@ if __name__ == "__main__":
 
 ## Development
 
-- Git: [github.com/cgoldberg/xvfbwrapper.git][github-repo]
-
 - Create a virtual env and install required testing packages:
 
     ```

{xvfbwrapper-0.2.32 → xvfbwrapper-0.2.34}/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}"
@@ -192,16 +195,17 @@ class Xvfb:
         """
         tempfile_path = Path(self._tempdir, f".X{display}-lock")
         try:
-            self._lock_display_file = tempfile_path.open("w")
+            lock_file = tempfile_path.open("w")
         except PermissionError:
             return False
+        try:
+            fcntl.flock(lock_file, fcntl.LOCK_EX | fcntl.LOCK_NB)
+        except BlockingIOError:
+            lock_file.close()
+            return False
         else:
-            try:
-                fcntl.flock(self._lock_display_file, fcntl.LOCK_EX | fcntl.LOCK_NB)
-            except BlockingIOError:
-                return False
-            else:
-                return True
+            self._lock_display_file = lock_file
+            return True
 
     def _get_next_unused_display(self) -> int:
         """Randomly choose a display number and try to acquire a lock for it.