socket_request
socket_request is build and parses HTTP requests with unix domain sockets.
Installing socket_request
socket_request is available on PyPI:
pip3 install socket-request
Officially supports Python 3.7+.
Examples:
import socket_request
docker = socket_request.DockerSock(unix_socket="/var/run/docker.sock")
docker.get_docker_images()
import socket_request
control_chain = socket_request.ControlChain(unix_socket="./cli.sock")
control_chain.stop()
control_chain.start()
CLI:
$ control_chain --help
╋╋╋╋╋╋╋╋╋┏┓╋╋╋╋╋┏┓╋╋╋╋┏┓
╋╋╋╋╋╋╋╋┏┛┗┓╋╋╋╋┃┃╋╋╋╋┃┃
┏━━┳━━┳━╋┓┏╋━┳━━┫┃╋┏━━┫┗━┳━━┳┳━┓
┃┏━┫┏┓┃┏┓┫┃┃┏┫┏┓┃┃╋┃┏━┫┏┓┃┏┓┣┫┏┓┓
┃┗━┫┗┛┃┃┃┃┗┫┃┃┗┛┃┗┓┃┗━┫┃┃┃┏┓┃┃┃┃┃
┗━━┻━━┻┛┗┻━┻┛┗━━┻━┛┗━━┻┛┗┻┛┗┻┻┛┗┛
version : 1.0.11
base_dir: /app/icon2-node
usage: control_chain [-h] [-s unixsocket] [-d] [-t timeout] [-w wait_state]
[-r retry] [-ws] [-ap auto_prepare] [-p payload_file]
[-f] [-i] [--seedAddress SEEDADDRESS] [-b BASE_DIR]
[-pd payload dict]
{start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}
Command Line Interface for control_chain
positional arguments:
{start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}
optional arguments:
-h, --help show this help message and exit
-s unixsocket, --unixsocket unixsocket
unix domain socket path (default:
/app/icon2-node/data/cli.socket)
-d, --debug debug mode. (default: False)
-t timeout, --timeout timeout
timeout (default: 60)
-w wait_state, --wait-state wait_state
wait_state (default: True)
-r retry, --retry retry
wait_state (default: True)
-ws, --wait-socket wait for unix domain socket
-ap auto_prepare, --auto_prepare auto_prepare
auto_prepare (default: True)
-p payload_file, --payload payload_file
payload file
-f, --forever retry forever
-i, --inspect inspect for view chain
--seedAddress SEEDADDRESS
seed list string
-b BASE_DIR, --base-dir BASE_DIR
base dir for goloop
-pd payload dict, --payload-dict payload dict
payload dict
-bh BLOCKHEIGHT, --blockheight BLOCKHEIGHT
BlockHeight for pruning
-rn RESTORE_NAME, --restore-name RESTORE_NAME
Restore filename for restore
ConnectSock
- ConnectSock class
- request(self, method="GET", url=None, headers={}, payload={}, files={}, return_dict=False) method
ControlChain
Parent class is ConnectSock class
- ControlChain class
- start() method
- stop() method
- reset() method
- leave() method
- backup() method
- backup_list() method
- restore(name="name") method
- join(seed_list=["127.0.0.1:7100"], role=3) method
- view_chain(detail=False, inspect=False) method
- chain_config(payload={"key": "autoStart", "value": "true"}) method
- view_system_config() method
- system_config(payload={"key": "rpcIncludeDebug", "value": "true"}) method
DockerSock
Parent class is ConnectSock class
- DockerSock class
Metadata
Release files for socket-request 1.1.27
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| socket_request-1.1.27-py3-none-any.whl | Python 3 | none | any | Details |
Release files / socket_request-1.1.27-py3-none-any.whl
| Download URL | socket_request-1.1.27-py3-none-any.whl |
|---|---|
| Size | 29.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b83ed768e789bc4dde2c8361b0ee1d646e1465f8283260c1c2d9fe4d0603f517
|
|
BLAKE2b-256 checksum How to use checksums |
03e9349a0e665374ea5cc3edc418525758c526ea7a28349fed26cf40c6b4eea0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.13
|