xvfbwrapper 0.2.30__tar.gz → 0.2.32__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: xvfbwrapper
3
- Version: 0.2.30
3
+ Version: 0.2.32
4
4
  Summary: Manage headless displays with Xvfb (X virtual framebuffer)
5
5
  Author: Corey Goldberg
6
6
  Maintainer: Corey Goldberg
@@ -37,18 +37,19 @@ Dynamic: license-file
37
37
 
38
38
  ## About
39
39
 
40
- `xvfbwrapper` is a Python library for controlling X11 virtual displays with Xvfb.
40
+ `xvfbwrapper` is a Python library for managing X11 virtual displays with
41
+ [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
42
+ a virtual X server that runs without a physical display. It provides the
43
+ [`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
44
+ program.
45
+
46
+ See the [module API documentation][api-docs] for more information.
41
47
 
42
48
  - Copyright (c) 2012-2026 [Corey Goldberg][github-profile]
43
49
  - Development: [GitHub][github-repo]
44
50
  - Releases: [PyPI][pypi-home]
45
51
  - License: [MIT][mit-license]
46
52
 
47
- The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
48
- an Xvfb server.
49
-
50
- See the [module API documentation][api-docs] for more information.
51
-
52
53
  ----
53
54
 
54
55
  ## Status
@@ -116,7 +117,7 @@ pip install xvfbwrapper
116
117
  - Python 3.10+
117
118
  - X Window System
118
119
  - Xvfb (`sudo apt-get install xvfb`, `yum install xorg-x11-server-Xvfb`, etc)
119
- - Support for locking with `fcntl` system call (non-Windows systems)
120
+ - Support for file locking using `fcntl` (POSIX systems)
120
121
 
121
122
  ----
122
123
 
@@ -244,10 +245,10 @@ finally:
244
245
  xvfb2.stop()
245
246
  ```
246
247
 
247
- #### Usage in testing - headless Selenium WebDriver tests:
248
+ #### Headless browser tests:
248
249
 
249
- This is a test using `selenium` and `xvfbwrapper` to run tests
250
- on Chrome with a headless display. (see: [selenium docs][selenium-docs])
250
+ This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
251
+ on Chrome inside a headless display.
251
252
 
252
253
  [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
253
254
 
@@ -6,18 +6,19 @@
6
6
 
7
7
  ## About
8
8
 
9
- `xvfbwrapper` is a Python library for controlling X11 virtual displays with Xvfb.
9
+ `xvfbwrapper` is a Python library for managing X11 virtual displays with
10
+ [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
11
+ a virtual X server that runs without a physical display. It provides the
12
+ [`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
13
+ program.
14
+
15
+ See the [module API documentation][api-docs] for more information.
10
16
 
11
17
  - Copyright (c) 2012-2026 [Corey Goldberg][github-profile]
12
18
  - Development: [GitHub][github-repo]
13
19
  - Releases: [PyPI][pypi-home]
14
20
  - License: [MIT][mit-license]
15
21
 
16
- The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
17
- an Xvfb server.
18
-
19
- See the [module API documentation][api-docs] for more information.
20
-
21
22
  ----
22
23
 
23
24
  ## Status
@@ -85,7 +86,7 @@ pip install xvfbwrapper
85
86
  - Python 3.10+
86
87
  - X Window System
87
88
  - Xvfb (`sudo apt-get install xvfb`, `yum install xorg-x11-server-Xvfb`, etc)
88
- - Support for locking with `fcntl` system call (non-Windows systems)
89
+ - Support for file locking using `fcntl` (POSIX systems)
89
90
 
90
91
  ----
91
92
 
@@ -213,10 +214,10 @@ finally:
213
214
  xvfb2.stop()
214
215
  ```
215
216
 
216
- #### Usage in testing - headless Selenium WebDriver tests:
217
+ #### Headless browser tests:
217
218
 
218
- This is a test using `selenium` and `xvfbwrapper` to run tests
219
- on Chrome with a headless display. (see: [selenium docs][selenium-docs])
219
+ This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
220
+ on Chrome inside a headless display.
220
221
 
221
222
  [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
222
223
 
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "xvfbwrapper"
7
- version = "0.2.30"
7
+ version = "0.2.32"
8
8
  description = "Manage headless displays with Xvfb (X virtual framebuffer)"
9
9
  license = "MIT"
10
10
  license-files = ["LICENSE"]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: xvfbwrapper
3
- Version: 0.2.30
3
+ Version: 0.2.32
4
4
  Summary: Manage headless displays with Xvfb (X virtual framebuffer)
5
5
  Author: Corey Goldberg
6
6
  Maintainer: Corey Goldberg
@@ -37,18 +37,19 @@ Dynamic: license-file
37
37
 
38
38
  ## About
39
39
 
40
- `xvfbwrapper` is a Python library for controlling X11 virtual displays with Xvfb.
40
+ `xvfbwrapper` is a Python library for managing X11 virtual displays with
41
+ [Xvfb (X virtual framebuffer)](https://x.org/releases/X11R7.7/doc/man/man1/Xvfb.1.xhtml),
42
+ a virtual X server that runs without a physical display. It provides the
43
+ [`Xvfb`][api-docs] class, a Python interface for configuring and controlling the Xvfb
44
+ program.
45
+
46
+ See the [module API documentation][api-docs] for more information.
41
47
 
42
48
  - Copyright (c) 2012-2026 [Corey Goldberg][github-profile]
43
49
  - Development: [GitHub][github-repo]
44
50
  - Releases: [PyPI][pypi-home]
45
51
  - License: [MIT][mit-license]
46
52
 
47
- The package provides the `xvfvwrapper.Xvfb` class that is used to interact with
48
- an Xvfb server.
49
-
50
- See the [module API documentation][api-docs] for more information.
51
-
52
53
  ----
53
54
 
54
55
  ## Status
@@ -116,7 +117,7 @@ pip install xvfbwrapper
116
117
  - Python 3.10+
117
118
  - X Window System
118
119
  - Xvfb (`sudo apt-get install xvfb`, `yum install xorg-x11-server-Xvfb`, etc)
119
- - Support for locking with `fcntl` system call (non-Windows systems)
120
+ - Support for file locking using `fcntl` (POSIX systems)
120
121
 
121
122
  ----
122
123
 
@@ -244,10 +245,10 @@ finally:
244
245
  xvfb2.stop()
245
246
  ```
246
247
 
247
- #### Usage in testing - headless Selenium WebDriver tests:
248
+ #### Headless browser tests:
248
249
 
249
- This is a test using `selenium` and `xvfbwrapper` to run tests
250
- on Chrome with a headless display. (see: [selenium docs][selenium-docs])
250
+ This uses [`selenium`][selenium-docs] and `xvfbwrapper` to run a test
251
+ on Chrome inside a headless display.
251
252
 
252
253
  [selenium-docs]: https://www.selenium.dev/selenium/docs/api/py
253
254
 
@@ -2,7 +2,14 @@
2
2
  # SPDX-License-Identifier: MIT
3
3
 
4
4
 
5
- """Run a headless display inside X virtual framebuffer (Xvfb)."""
5
+ """Manage headless displays with Xvfb (X virtual framebuffer)
6
+
7
+ This module provides a wrapper around Xvfb (X Virtual Framebuffer) for managing
8
+ virtual X displays.
9
+
10
+ - Releases: https://pypi.org/project/xvfbwrapper
11
+ - Development: https://github.com/cgoldberg/xvfbwrapper
12
+ """
6
13
 
7
14
  import os
8
15
  import platform
@@ -25,6 +32,11 @@ except ImportError as e:
25
32
 
26
33
 
27
34
  class Xvfb:
35
+ """Manage an Xvfb (X Virtual Framebuffer) process.
36
+
37
+ Provides an interface for configuring and controlling a virtual X display.
38
+ """
39
+
28
40
  # Maximum value to use for a display. 32-bit maxint is the
29
41
  # highest Xvfb currently supports
30
42
  MAX_DISPLAY: int = 2147483647
@@ -131,10 +143,6 @@ class Xvfb:
131
143
  and, if necessary, an additional duration of the same length after killing the
132
144
  process. If `self._timeout` is `None`, wait indefinitely for the process to
133
145
  exit and be reaped.
134
-
135
- This is a one-way lifecycle transition: once called, this object is considered
136
- stopped and cannot be reused, regardless of whether the process exits
137
- successfully.
138
146
  """
139
147
  if self.proc is None:
140
148
  return
File without changes
File without changes
File without changes
File without changes
File without changes