File tree Expand file tree Collapse file tree 3 files changed +14
-5
lines changed Expand file tree Collapse file tree 3 files changed +14
-5
lines changed Original file line number Diff line number Diff line change @@ -3,4 +3,4 @@ Add optional uvloop support for improved async performance.
3
3
When uvloop is available, Zarr will automatically use it as the event loop implementation
4
4
for better I/O performance. This can be controlled via the ``async.use_uvloop `` configuration
5
5
setting or the ``ZARR_ASYNC__USE_UVLOOP `` environment variable. uvloop can be installed
6
- with ``pip install 'zarr[uvloop ]' ``.
6
+ with ``pip install 'zarr[optional ]' `` (Unix/Linux/macOS only) .
Original file line number Diff line number Diff line change @@ -289,12 +289,17 @@ Installation
289
289
290
290
To enable uvloop support, install it as an optional dependency::
291
291
292
- pip install 'zarr[uvloop ]'
292
+ pip install 'zarr[optional ]'
293
293
294
- Or install uvloop directly::
294
+ Or install uvloop directly (Unix/Linux/macOS only) ::
295
295
296
296
pip install uvloop
297
297
298
+ .. note ::
299
+ uvloop is automatically included in the ``optional `` dependency group, but only
300
+ installed on supported platforms (Unix/Linux/macOS). On Windows, the installation
301
+ will succeed but uvloop will be skipped.
302
+
298
303
Configuration
299
304
~~~~~~~~~~~~~
300
305
Original file line number Diff line number Diff line change @@ -91,7 +91,11 @@ remote_tests = [
91
91
" moto[s3,server]" ,
92
92
" requests" ,
93
93
]
94
- optional = [" rich" , " universal-pathlib" , " uvloop" ]
94
+ optional = [
95
+ " rich" ,
96
+ " universal-pathlib" ,
97
+ " uvloop; sys_platform != 'win32'"
98
+ ]
95
99
docs = [
96
100
# Doc building
97
101
' sphinx==8.1.3' ,
@@ -229,7 +233,7 @@ dependencies = [
229
233
' typing_extensions==4.9.*' ,
230
234
' donfig==0.8.*' ,
231
235
' obstore==0.5.*' ,
232
- ' uvloop==0.20.0' ,
236
+ ' uvloop==0.20.0; sys_platform != "win32" ' ,
233
237
# test deps
234
238
' zarr[test]' ,
235
239
' zarr[remote_tests]' ,
You can’t perform that action at this time.
0 commit comments