xvfbwrapper 0.2.24__tar.gz → 0.2.26__tar.gz

{xvfbwrapper-0.2.24/xvfbwrapper.egg-info → xvfbwrapper-0.2.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.24
+Version: 0.2.26
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -44,6 +44,11 @@ Dynamic: license-file
 - Releases: [PyPI][pypi-home]
 - License: [MIT][mit-license]
 
+The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
+an Xvfb server.
+
+See the [module API documentation][api-docs] for more information.
+
 ----
 
 ## Status
@@ -253,9 +258,6 @@ import unittest
 from selenium import webdriver
 from xvfbwrapper import Xvfb
 
-# force X11 in case we are running on a Wayland system
-os.environ["XDG_SESSION_TYPE"] = "x11"
-
 
 class TestPage(unittest.TestCase):
 
@@ -311,3 +313,4 @@ if __name__ == "__main__":
 [github-repo]: https://github.com/cgoldberg/xvfbwrapper
 [pypi-home]: https://pypi.org/project/xvfbwrapper
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/xvfbwrapper/refs/heads/master/LICENSE
+[api-docs]: https://coreygoldberg.com/xvfbwrapper

{xvfbwrapper-0.2.24 → xvfbwrapper-0.2.26}/README.md

@@ -13,6 +13,11 @@
 - Releases: [PyPI][pypi-home]
 - License: [MIT][mit-license]
 
+The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
+an Xvfb server.
+
+See the [module API documentation][api-docs] for more information.
+
 ----
 
 ## Status
@@ -222,9 +227,6 @@ import unittest
 from selenium import webdriver
 from xvfbwrapper import Xvfb
 
-# force X11 in case we are running on a Wayland system
-os.environ["XDG_SESSION_TYPE"] = "x11"
-
 
 class TestPage(unittest.TestCase):
 
@@ -280,3 +282,4 @@ if __name__ == "__main__":
 [github-repo]: https://github.com/cgoldberg/xvfbwrapper
 [pypi-home]: https://pypi.org/project/xvfbwrapper
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/xvfbwrapper/refs/heads/master/LICENSE
+[api-docs]: https://coreygoldberg.com/xvfbwrapper

{xvfbwrapper-0.2.24 → xvfbwrapper-0.2.26}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xvfbwrapper"
-version = "0.2.24"
+version = "0.2.26"
 description = "Manage headless displays with Xvfb (X virtual framebuffer)"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -70,7 +70,7 @@ target-version = "py310"
 
 [tool.ruff.lint]
 select = ["ALL"]
-extend-ignore = [
+ignore = [
     "ANN", "COM812", "D", "EM101", "EM102", "FBT", "PERF203",
     "PLR", "PT", "PYI034", "SLF001", "S101", "S108", "S311",
     "S603", "TRY003", "TRY400"

{xvfbwrapper-0.2.24 → xvfbwrapper-0.2.26/xvfbwrapper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xvfbwrapper
-Version: 0.2.24
+Version: 0.2.26
 Summary: Manage headless displays with Xvfb (X virtual framebuffer)
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -44,6 +44,11 @@ Dynamic: license-file
 - Releases: [PyPI][pypi-home]
 - License: [MIT][mit-license]
 
+The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
+an Xvfb server.
+
+See the [module API documentation][api-docs] for more information.
+
 ----
 
 ## Status
@@ -253,9 +258,6 @@ import unittest
 from selenium import webdriver
 from xvfbwrapper import Xvfb
 
-# force X11 in case we are running on a Wayland system
-os.environ["XDG_SESSION_TYPE"] = "x11"
-
 
 class TestPage(unittest.TestCase):
 
@@ -311,3 +313,4 @@ if __name__ == "__main__":
 [github-repo]: https://github.com/cgoldberg/xvfbwrapper
 [pypi-home]: https://pypi.org/project/xvfbwrapper
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/xvfbwrapper/refs/heads/master/LICENSE
+[api-docs]: https://coreygoldberg.com/xvfbwrapper

{xvfbwrapper-0.2.24 → xvfbwrapper-0.2.26}/xvfbwrapper.py

@@ -14,6 +14,8 @@ from collections.abc import MutableMapping, Sequence
 from contextlib import suppress
 from pathlib import Path
 from random import randint
+from types import TracebackType
+from typing import TextIO
 
 try:
     import fcntl
@@ -25,7 +27,7 @@ except ImportError as e:
 class Xvfb:
     # Maximum value to use for a display. 32-bit maxint is the
     # highest Xvfb currently supports
-    MAX_DISPLAY = 2147483647
+    MAX_DISPLAY: int = 2147483647
 
     def __init__(
         self,
@@ -37,14 +39,14 @@ class Xvfb:
         set_xdg_session_type: bool = False,
         environ: MutableMapping[str, str] | None = None,
         extra_args: Sequence[str] | None = None,
-        timeout: int = 10,
-        **kwargs,
-    ):
+        timeout: float = 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: int = timeout
+        self._timeout: float = timeout
         self.new_display: int | None = display
         self.environ: MutableMapping[str, str] = environ or os.environ
 
@@ -78,12 +80,18 @@ class Xvfb:
             self.orig_display_var = None
 
         self.proc: subprocess.Popen[bytes] | None = None
+        self._lock_display_file: TextIO | None = None
 
     def __enter__(self) -> "Xvfb":
         self.start()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
         self.stop()
 
     def start(self) -> None:
@@ -125,11 +133,12 @@ class Xvfb:
                 self.environ.pop("DISPLAY", None)
             else:
                 self._set_display(self.orig_display_var)
-            if self.proc is not None:
-                with suppress(OSError):
-                    self.proc.terminate()
-                    self.proc.wait(self._timeout)
-                self.proc = None
+
+            with suppress(OSError):
+                self.proc.terminate()
+                self.proc.wait(self._timeout)
+
+            self.proc = None
         finally:
             self._cleanup_lock_file()
 
@@ -137,7 +146,7 @@ class Xvfb:
         """Check that Xvfb is available on PATH and is executable."""
         return shutil.which("Xvfb") is not None
 
-    def _cleanup_lock_file(self):
+    def _cleanup_lock_file(self) -> None:
         """Delete lock files when stopping.
 
         This gets called if the process exits safely with Xvfb.stop(),
@@ -148,11 +157,14 @@ class Xvfb:
         Xvfb.stop() in a finally block, or use Xvfb as a context manager
         to ensure lock files are purged.
         """
+        if self._lock_display_file is None:
+            return
+
         self._lock_display_file.close()
         with suppress(OSError):
             Path(self._lock_display_file.name).unlink()
 
-    def _get_lock_for_display(self, display) -> bool:
+    def _get_lock_for_display(self, display: int) -> bool:
         """Attempt to acquire an exclusive lock for a display.
 
         In order to ensure multi-process safety, this method attempts
@@ -183,12 +195,12 @@ class Xvfb:
             if self._get_lock_for_display(rand):
                 return rand
 
-    def _local_display_exists(self, display) -> bool:
+    def _local_display_exists(self, display: int) -> bool:
         tempdir = "/tmp"
         # We need read access to the real system temp directory
         if not os.access(tempdir, os.R_OK):
             raise RuntimeError(f"Could not access {tempdir} directory: {self._tempdir}")
         return Path(tempdir, ".X11-unix", f"X{display}").exists()
 
-    def _set_display(self, display_var):
+    def _set_display(self, display_var: str) -> None:
         self.environ["DISPLAY"] = display_var