Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varlink/python
Python implementation of the Varlink protocol
https://github.com/varlink/python
ipc json python varlink
Last synced: about 2 months ago
JSON representation
Python implementation of the Varlink protocol
- Host: GitHub
- URL: https://github.com/varlink/python
- Owner: varlink
- License: apache-2.0
- Created: 2017-08-18T14:34:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T13:42:07.000Z (over 1 year ago)
- Last Synced: 2024-10-30T16:21:05.298Z (about 2 months ago)
- Topics: ipc, json, python, varlink
- Language: Python
- Homepage: https://varlink.org/python/
- Size: 1.32 MB
- Stars: 43
- Watchers: 8
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.varlink.org/Language-Bindings)
[](https://travis-ci.org/varlink/python)
[](https://coveralls.io/github/varlink/python?branch=master)
[](https://pypi.org/project/varlink/)
[](https://pypi.org/project/varlink/)
[](https://pypi.org/project/varlink/)
# python-varlink
A [varlink](http://varlink.org) implementation for Python.
* [GIT Repository](https://github.com/varlink/python)
* [API documentation](https://varlink.github.io/python/)
## python varlink installation
From pypi:
```bash
$ pip3 install --user varlink
```
With Fedora 28/rawhide:
```bash
$ sudo dnf install python3-varlink
```
## Examples
See the [tests](https://github.com/varlink/python-varlink/tree/master/varlink/tests) directory.
```bash
$ python3 -m varlink.tests.test_orgexamplemore --varlink="unix:/tmp/test" &
[1] 6434
$ python -m varlink.cli help unix:/tmp/test/org.example.more
# Example Varlink service
interface org.example.more
# Enum, returning either start, progress or end
# progress: [0-100]
type State (
start: ?bool,
progress: ?int,
end: ?bool
)
# Returns the same string
method Ping(ping: string) -> (pong: string)
# Dummy progress method
# n: number of progress steps
method TestMore(n: int) -> (state: State)
# Stop serving
method StopServing() -> ()
# Something failed in TestMore
error TestMoreError (reason: string)
$ python -m varlink.cli call unix:/tmp/test/org.example.more.Ping '{ "ping": "Ping"}'
{
"pong": "Ping"
}
$ fg
python3 -m varlink.tests.test_orgexamplemore --varlink="unix:/tmp/test"
^C
```
```bash
$ python3 -m varlink.tests.test_orgexamplemore --client -A 'python3 -m varlink.tests.test_orgexamplemore --varlink=$VARLINK_ADDRESS'
Connecting to unix:/tmp/tmppxrbqk9p/4927
Listening on /tmp/tmppxrbqk9p/4927
--- Start ---
Progress: 0
Progress: 10
Progress: 20
Progress: 30
Progress: 40
Progress: 50
Progress: 60
Ping: Test
Progress: 70
Ping: Test
Progress: 80
Ping: Test
Progress: 90
Ping: Test
Progress: 100
Ping: Test
--- End ---
```
```bash
$ PYTHONPATH=$(pwd) python3 ./varlink/tests/test_orgexamplemore.py
Connecting to unix:/tmp/tmp7n6zc67d/5257
Listening on /tmp/tmp7n6zc67d/5257
--- Start ---
Progress: 0
Progress: 10
Progress: 20
Progress: 30
Progress: 40
Progress: 50
Progress: 60
Ping: Test
Progress: 70
Ping: Test
Progress: 80
Ping: Test
Progress: 90
Ping: Test
Progress: 100
Ping: Test
--- End ---
```
```bash
$ python3 -m varlink.tests.test_orgexamplemore --varlink="unix:/tmp/test" &
Listening on /tmp/test
[1] 6434
python3 -m varlink.tests.test_orgexamplemore --client --varlink="unix:/tmp/test"
Connecting to unix:/tmp/test
Ping: Test
--- Start ---
Progress: 0
Progress: 10
Progress: 20
Progress: 30
Progress: 40
Progress: 50
Progress: 60
Ping: Test
Progress: 70
Ping: Test
Progress: 80
Ping: Test
Progress: 90
Ping: Test
Progress: 100
Ping: Test
--- End ---
$ python3 -m varlink.cli call --more unix:/tmp/test/org.example.more.TestMore '{ "n": 10 }'
{'state': {'start': True}}
{'state': {'progress': 0}}
{'state': {'progress': 10}}
{'state': {'progress': 20}}
{'state': {'progress': 30}}
{'state': {'progress': 40}}
{'state': {'progress': 50}}
{'state': {'progress': 60}}
{'state': {'progress': 70}}
{'state': {'progress': 80}}
{'state': {'progress': 90}}
{'state': {'progress': 100}}
{'state': {'end': True}}
$ fg
python3 -m varlink.tests.test_orgexamplemore --varlink="unix:/tmp/test"
^C
```
You can also start the clients and server with URLs following the [varlink URL standard](https://varlink.org/#address) with `unix:` and `tcp:`.
E.g.
- unix:@anonuds
- unix:/run/myserver/socketfile
- tcp:127.0.0.1:12345
- tcp:[::1]:12345
### Activation Mode
Activation mode starts the service to connect to and passes the socket via socket activation.
The ```VARLINK_ADDRESS``` environment variable contains the varlink address URI.
```bash
$ python3 -m varlink.cli --activate 'python3 -m varlink.tests.test_orgexamplemore --varlink=$VARLINK_ADDRESS' call org.example.more.Ping '{ "ping": "Ping"}'
Listening on @00352
{'pong': 'Ping'}
```
### Bridge Mode
Bridge mode allows to tunnel to a remote point via stdin/stdout and call a method.
Running ```varlink bridge``` allows to connect stdio to the host services via ```org.varlink.resolver``` interface resolving.
```bash
# python3 -m varlink.cli -b "ssh host.example.org varlink bridge" call com.redhat.machine.GetInfo '{}'
{
"hostname": "host.example.org",
"system": {
"id": "fedora",
"kernel_version": "4.18.0-0.rc5.git1.2.fc29.x86_64",
"name": "Fedora",
"version": "29"
},
"virtualization": {
"name": "none"
}
}
```
### Varlink Certification Server
```
$ python3 -m varlink.tests.test_certification --varlink=tcp:127.0.0.1:12345
```
### Varlink Certification Client
```
$ python3 -m varlink.tests.test_certification --varlink=tcp:127.0.0.1:12345 --client
```