https://github.com/msabramo/requests-unixsocket

Use requests to talk HTTP via a UNIX domain socket
https://github.com/msabramo/requests-unixsocket

http python requests unix-domain-socket

Last synced: 26 days ago
JSON representation

Use requests to talk HTTP via a UNIX domain socket

• Host: GitHub
• URL: https://github.com/msabramo/requests-unixsocket
• Owner: msabramo
• License: apache-2.0
• Created: 2014-11-25T16:06:59.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2025-05-04T23:28:20.000Z (about 1 month ago)
• Last Synced: 2025-05-13T16:24:59.741Z (26 days ago)
• Topics: http, python, requests, unix-domain-socket
• Language: Python
• Size: 122 KB
• Stars: 209
• Watchers: 9
• Forks: 29
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
requests-unixsocket

===================

.. image:: https://badge.fury.io/py/requests-unixsocket.svg

    :target: https://badge.fury.io/py/requests-unixsocket

    :alt: Latest Version on PyPI

.. image:: https://github.com/msabramo/requests-unixsocket/actions/workflows/ci-cd.yml/badge.svg?event=push

    :target: https://github.com/msabramo/requests-unixsocket/actions/workflows/ci-cd.yml

Use `requests `_ to talk HTTP via a UNIX domain socket

Usage

-----

Explicit

++++++++

You can use it by instantiating a special ``Session`` object:

.. 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 ``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()

    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

socket `_

(Linux only), prefix the name with a NULL byte (i.e.: `\0`) - 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

``examples/abstract_namespace.py`` in the git repo. Since abstract namespace

sockets are specific to Linux, the program will only work on Linux.

See also

--------

- https://github.com/httpie/httpie-unixsocket - a plugin for `HTTPie `_ that allows you to interact with UNIX domain sockets