xvfbwrapper 0.2.28__tar.gz → 0.2.30__tar.gz

{xvfbwrapper-0.2.28/xvfbwrapper.egg-info → xvfbwrapper-0.2.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.28
+Version: 0.2.30
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -164,7 +164,7 @@ xvfb.start()
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(display=23)
-xvfb.start() # Xvfb will start on display :23
+xvfb.start()  # Xvfb will start on display :23
 ```
 
 #### Setting XDG_SESSION_TYPE:
@@ -194,7 +194,7 @@ creating an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(nolisten="tcp")
-xvfb.start() # Xvfb will be called with the `-nolisten tcp` argument
+xvfb.start()  # Xvfb will be called with the `-nolisten tcp` argument
 ```
 
 However, there are other possible types of arguments:
@@ -212,7 +212,7 @@ an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(extra_args=("ttyxx", "-nocursor", "+extension", "RANDR"))
-xvfb.start() # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
+xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
 ```
 
 #### Multithreaded execution:
@@ -260,7 +260,6 @@ from xvfbwrapper import Xvfb
 
 
 class TestPage(unittest.TestCase):
-
     def setUp(self):
         xvfb = Xvfb(set_xdg_session_type=True)
         xvfb.start()

{xvfbwrapper-0.2.28 → xvfbwrapper-0.2.30}/README.md

@@ -133,7 +133,7 @@ xvfb.start()
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(display=23)
-xvfb.start() # Xvfb will start on display :23
+xvfb.start()  # Xvfb will start on display :23
 ```
 
 #### Setting XDG_SESSION_TYPE:
@@ -163,7 +163,7 @@ creating an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(nolisten="tcp")
-xvfb.start() # Xvfb will be called with the `-nolisten tcp` argument
+xvfb.start()  # Xvfb will be called with the `-nolisten tcp` argument
 ```
 
 However, there are other possible types of arguments:
@@ -181,7 +181,7 @@ an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(extra_args=("ttyxx", "-nocursor", "+extension", "RANDR"))
-xvfb.start() # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
+xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
 ```
 
 #### Multithreaded execution:
@@ -229,7 +229,6 @@ from xvfbwrapper import Xvfb
 
 
 class TestPage(unittest.TestCase):
-
     def setUp(self):
         xvfb = Xvfb(set_xdg_session_type=True)
         xvfb.start()

{xvfbwrapper-0.2.28 → xvfbwrapper-0.2.30}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xvfbwrapper"
-version = "0.2.28"
+version = "0.2.30"
 description = "Manage headless displays with Xvfb (X virtual framebuffer)"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -52,9 +52,7 @@ type = [
     "types-psutil",
 ]
 validate = [
-    "packaging",
-    "tomli",
-    "validate-pyproject",
+    "validate-pyproject[all]",
 ]
 
 [tool.setuptools]

{xvfbwrapper-0.2.28 → xvfbwrapper-0.2.30}/test_xvfb.py

@@ -21,9 +21,6 @@ class XvfbCleanTestCase(unittest.TestCase):
 
     - Records existing Xvfb processes at class start.
     - Kills newly spawned Xvfb processes at class end.
-
-    - Records existing Xvfb processes at test start.
-    - Kills newly spawned Xvfb processes at test end.
     """
 
     # ---------- Utility ----------
@@ -219,7 +216,8 @@ 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)
@@ -228,7 +226,8 @@ 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)
@@ -269,7 +268,8 @@ 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()
 
@@ -302,7 +302,7 @@ class TestXvfb(XvfbCleanTestCase):
         self.assertIsNotNone(xvfb.proc)
 
     def test_start_fails_with_unknown_kwargs(self):
-        xvfb = Xvfb(foo="bar", timeout=5)
+        xvfb = Xvfb(foo="bar", timeout=2)
         expected_cmd_args = [
             "Xvfb",
             r":\d",
@@ -313,7 +313,8 @@ 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)
@@ -348,15 +349,15 @@ class TestXvfb(XvfbCleanTestCase):
     def test_environ_keyword_isolates_environment_modification(self):
         # Check that start and stop methods modified the environ dict if
         # passed and does not modify os.environ
-        env_duped = os.environ.copy()
-        xvfb = Xvfb(environ=env_duped)
+        custom_env = os.environ.copy()
+        xvfb = Xvfb(environ=custom_env)
         xvfb.start()
         new_display = f":{xvfb.new_display}"
         self.assertEqual(":0", os.environ["DISPLAY"])
-        self.assertEqual(new_display, env_duped["DISPLAY"])
+        self.assertEqual(new_display, custom_env["DISPLAY"])
         xvfb.stop()
         self.assertEqual(":0", os.environ["DISPLAY"])
-        self.assertEqual(":0", env_duped["DISPLAY"])
+        self.assertEqual(":0", custom_env["DISPLAY"])
         self.assertIsNone(xvfb.proc)
 
     def test_environ_is_passed_to_xvfb_subprocess(self):
@@ -367,7 +368,10 @@ 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
@@ -388,7 +392,8 @@ 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.28 → xvfbwrapper-0.2.30}/tox.ini

@@ -14,9 +14,6 @@ envlist =
     lint
     type
     py310
-    py311
-    py312
-    py313
     py314
     pypy3
 skip_missing_interpreters = true

{xvfbwrapper-0.2.28 → xvfbwrapper-0.2.30/xvfbwrapper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.28
+Version: 0.2.30
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -164,7 +164,7 @@ xvfb.start()
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(display=23)
-xvfb.start() # Xvfb will start on display :23
+xvfb.start()  # Xvfb will start on display :23
 ```
 
 #### Setting XDG_SESSION_TYPE:
@@ -194,7 +194,7 @@ creating an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(nolisten="tcp")
-xvfb.start() # Xvfb will be called with the `-nolisten tcp` argument
+xvfb.start()  # Xvfb will be called with the `-nolisten tcp` argument
 ```
 
 However, there are other possible types of arguments:
@@ -212,7 +212,7 @@ an `xvfbwrapper.Xvfb` instance. For example:
 from xvfbwrapper import Xvfb
 
 xvfb = Xvfb(extra_args=("ttyxx", "-nocursor", "+extension", "RANDR"))
-xvfb.start() # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
+xvfb.start()  # Xvfb will be called with the `ttyxx -nocursor +extension RANDR` arguments
 ```
 
 #### Multithreaded execution:
@@ -260,7 +260,6 @@ from xvfbwrapper import Xvfb
 
 
 class TestPage(unittest.TestCase):
-
     def setUp(self):
         xvfb = Xvfb(set_xdg_session_type=True)
         xvfb.start()

{xvfbwrapper-0.2.28 → xvfbwrapper-0.2.30}/xvfbwrapper.py

@@ -39,46 +39,39 @@ class Xvfb:
         set_xdg_session_type: bool = False,
         environ: MutableMapping[str, str] | None = None,
         extra_args: Sequence[str] | None = None,
-        timeout: float = 10,
+        timeout: float | None = 10,
         **kwargs: str,
     ) -> None:
         self.width: int = width
         self.height: int = height
         self.colordepth: int = colordepth
         self._tempdir: Path | str = tempdir or tempfile.gettempdir()
-        self._timeout: float = timeout
+        self._timeout: float | None = timeout
         self.new_display: int | None = display
         self.environ: MutableMapping[str, str] = environ or os.environ
-
         if set_xdg_session_type:
             os.environ["XDG_SESSION_TYPE"] = "x11"
-
+            self.environ["XDG_SESSION_TYPE"] = "x11"
         if not self._xvfb_exists():
             raise FileNotFoundError(
                 "Could not find Xvfb. Please install it and try again"
             )
-
         self.xvfb_cmd: list[str] = []
-
         if not extra_args:
             extra_args = []
-
         self.extra_xvfb_args: list[str] = [
             "-screen",
             "0",
             f"{self.width}x{self.height}x{self.colordepth}",
             *extra_args,
         ]
-
         for key, value in kwargs.items():
             self.extra_xvfb_args += [f"-{key}", value]
-
         self.orig_display_var: str | None
         if "DISPLAY" in self.environ:
             self.orig_display_var = self.environ["DISPLAY"]
         else:
             self.orig_display_var = None
-
         self.proc: subprocess.Popen[bytes] | None = None
         self._lock_display_file: TextIO | None = None
 
@@ -95,6 +88,8 @@ class Xvfb:
         self.stop()
 
     def start(self) -> None:
+        """Start Xvfb."""
+
         if not os.access(self._tempdir, os.W_OK):
             raise RuntimeError(
                 f"Could not access writable temp directory: {self._tempdir}"
@@ -113,10 +108,11 @@ class Xvfb:
             close_fds=True,
             env=dict(self.environ),
         )
-        start = time.time()
+        start = time.monotonic()
         while not self._local_display_exists(self.new_display):
             time.sleep(1e-3)
-            if time.time() - start > self._timeout:
+            elapsed = time.monotonic() - start
+            if self._timeout is not None and elapsed > self._timeout:
                 self.stop()
                 raise RuntimeError(f"Xvfb display did not open: {self.xvfb_cmd}")
         ret_code = self.proc.poll()
@@ -127,6 +123,19 @@ class Xvfb:
             raise RuntimeError(f"Xvfb did not start ({ret_code}): {self.xvfb_cmd}")
 
     def stop(self) -> None:
+        """Stop Xvfb and clean up its resources.
+
+        Terminate the process, escalating to kill if it does not exit within the
+        timeout. If the process has already exited, termination is treated as
+        successful. If `self._timeout` is set, wait up to that duration for termination
+        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
         try:
@@ -134,13 +143,15 @@ class Xvfb:
                 self.environ.pop("DISPLAY", None)
             else:
                 self._set_display(self.orig_display_var)
-
-            with suppress(OSError):
+            with suppress(ProcessLookupError):
                 self.proc.terminate()
+            try:
+                self.proc.wait(self._timeout)
+            except subprocess.TimeoutExpired:
+                self.proc.kill()
                 self.proc.wait(self._timeout)
-
-            self.proc = None
         finally:
+            self.proc = None
             self._cleanup_lock_file()
 
     def _xvfb_exists(self) -> bool:
@@ -160,7 +171,6 @@ class Xvfb:
         """
         if self._lock_display_file is None:
             return
-
         self._lock_display_file.close()
         with suppress(OSError):
             Path(self._lock_display_file.name).unlink()