aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/deprecated/python/subprocess32/README.md
diff options
context:
space:
mode:
authornkozlovskiy <nmk@ydb.tech>2023-10-02 18:57:38 +0300
committernkozlovskiy <nmk@ydb.tech>2023-10-02 19:39:06 +0300
commit6295ef4d23465c11296e898b9dc4524ad9592b5d (patch)
treefc0c852877b2c52f365a1f6ed0710955844338c2 /contrib/deprecated/python/subprocess32/README.md
parentde63c80b75948ecc13894854514d147840ff8430 (diff)
downloadydb-6295ef4d23465c11296e898b9dc4524ad9592b5d.tar.gz
oss ydb: fix dstool building and test run
Diffstat (limited to 'contrib/deprecated/python/subprocess32/README.md')
-rw-r--r--contrib/deprecated/python/subprocess32/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/contrib/deprecated/python/subprocess32/README.md b/contrib/deprecated/python/subprocess32/README.md
new file mode 100644
index 0000000000..919e0929ed
--- /dev/null
+++ b/contrib/deprecated/python/subprocess32/README.md
@@ -0,0 +1,50 @@
+subprocess32
+------------
+[![PyPI version](https://badge.fury.io/py/subprocess32.svg)](https://badge.fury.io/py/subprocess32)
+[![POSIX Build Status](https://travis-ci.org/google/python-subprocess32.svg?branch=master)](https://travis-ci.org/google/python-subprocess32)
+[![Windows Build Status](https://ci.appveyor.com/api/projects/status/53apbb2jk1uslj0m?svg=true
+)](https://ci.appveyor.com/project/gpshead/python-subprocess32)
+
+This is a backport of the Python 3 subprocess module for use on Python 2.
+This code has not been tested on Windows or other non-POSIX platforms.
+
+subprocess32 includes many important reliability bug fixes relevant on
+POSIX platforms. The most important of which is a C extension module
+used internally to handle the code path between fork() and exec().
+This module is reliable when an application is using threads.
+
+Refer to the
+[Python 3.5 subprocess documentation](https://docs.python.org/3.5/library/subprocess.html)
+for usage information.
+
+* Timeout support backported from Python 3.3 is included.
+* The run() API from Python 3.5 was backported in subprocess32 3.5.0.
+* Otherwise features are frozen at the 3.2 level.
+
+Usage
+-----
+
+The recommend pattern for cross platform code is to use the following:
+
+```python
+if os.name == 'posix' and sys.version_info[0] < 3:
+ import subprocess32 as subprocess
+else:
+ import subprocess
+```
+
+Or if you fully control your POSIX Python 2.7 installation, this can serve
+as a replacement for its subprocess module. Users will thank you by not
+filing concurrency bugs.
+
+Got Bugs?
+---------
+
+Try to reproduce them on the latest Python 3.x itself and file bug
+reports on [bugs.python.org](https://bugs.python.org/).
+Add gregory.p.smith to the Nosy list.
+
+If you have reason to believe the issue is specifically with this backport
+and not a problem in Python 3 itself, use the github issue tracker.
+
+-- Gregory P. Smith _greg@krypto.org_