summaryrefslogtreecommitdiffstats
path: root/third_party/python/requests-unixsocket/README.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/python/requests-unixsocket/README.rst
parentInitial commit. (diff)
downloadfirefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz
firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/python/requests-unixsocket/README.rst')
-rw-r--r--third_party/python/requests-unixsocket/README.rst62
1 files changed, 62 insertions, 0 deletions
diff --git a/third_party/python/requests-unixsocket/README.rst b/third_party/python/requests-unixsocket/README.rst
new file mode 100644
index 0000000000..d582f4c059
--- /dev/null
+++ b/third_party/python/requests-unixsocket/README.rst
@@ -0,0 +1,62 @@
+requests-unixsocket
+===================
+
+.. image:: https://pypip.in/version/requests-unixsocket/badge.svg?style=flat
+ :target: https://pypi.python.org/pypi/requests-unixsocket/
+ :alt: Latest Version
+
+.. image:: https://travis-ci.org/msabramo/requests-unixsocket.svg?branch=master
+ :target: https://travis-ci.org/msabramo/requests-unixsocket
+
+Use `requests <http://docs.python-requests.org/>`_ to talk HTTP via a UNIX domain socket
+
+Usage
+-----
+
+Explicit
+++++++++
+
+You can use it by instantiating a special ``Session`` object:
+
+.. code-block:: python
+
+ import requests_unixsocket
+
+ session = requests_unixsocket.Session()
+
+ # Access /path/to/page from /tmp/profilesvc.sock
+ r = session.get('http+unix://%2Ftmp%2Fprofilesvc.sock/path/to/page')
+ assert r.status_code == 200
+
+Implicit (monkeypatching)
++++++++++++++++++++++++++
+
+Monkeypatching allows you to use the functionality in this module, while making
+minimal changes to your code. Note that in the above example we had to
+instantiate a special ``requests_unixsocket.Session`` object and call the
+``get`` method on that object. Calling ``requests.get(url)`` (the easiest way
+to use requests and probably very common), would not work. But we can make it
+work by doing monkeypatching.
+
+You can monkeypatch globally:
+
+.. code-block:: python
+
+ import requests_unixsocket
+
+ requests_unixsocket.monkeypatch()
+
+ # Access /path/to/page from /tmp/profilesvc.sock
+ r = requests.get('http+unix://%2Ftmp%2Fprofilesvc.sock/path/to/page')
+ assert r.status_code == 200
+
+or you can do it temporarily using a context manager:
+
+.. code-block:: python
+
+ import requests_unixsocket
+
+ with requests_unixsocket.monkeypatch():
+ # Access /path/to/page from /tmp/profilesvc.sock
+ r = requests.get('http+unix://%2Ftmp%2Fprofilesvc.sock/path/to/page')
+ assert r.status_code == 200