by msabramo

Use requests to talk HTTP via a UNIX domain socket

134 Stars 16 Forks Last release: Not found Apache License 2.0 97 Commits 6 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


.. image:: :target: :alt: Latest Version on PyPI

.. image:: :target:


_ to talk HTTP via a UNIX domain socket


Explicit ++++++++

You can use it by instantiating a special


.. code-block:: python

import json

import requests_unixsocket

session = requests_unixsocket.Session()

r = session.get('http+unix://%2Fvar%2Frun%2Fdocker.sock/info') registry_config = r.json()['RegistryConfig'] print(json.dumps(registry_config, indent=4))

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

object and call the
method on that object. Calling
(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


r = requests.get('http+unix://%2Fvar%2Frun%2Fdocker.sock/info') 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(): r = requests.get('http+unix://%2Fvar%2Frun%2Fdocker.sock/info') assert r.status_code == 200

Abstract namespace sockets ++++++++++++++++++++++++++

To connect to an

abstract namespace
_ (Linux only), prefix the name with a NULL byte (i.e.:
) - e.g.:

.. code-block:: python

import requests_unixsocket

session = requests_unixsocket.Session() res = session.get('http+unix://\0test_socket/get') print(res.text)

For an example program that illustrates this, see

in the git repo. Since abstract namespace sockets are specific to Linux, the program will only work on Linux.

See also

  • - a plugin for
    _ that allows you to interact with UNIX domain sockets

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.