Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stellarbit/aioping
Python asyncio ping library
https://github.com/stellarbit/aioping
Last synced: 2 months ago
JSON representation
Python asyncio ping library
- Host: GitHub
- URL: https://github.com/stellarbit/aioping
- Owner: stellarbit
- License: gpl-2.0
- Created: 2017-02-14T05:06:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-21T22:51:21.000Z (about 1 year ago)
- Last Synced: 2024-10-04T04:12:26.416Z (4 months ago)
- Language: Python
- Size: 56.6 KB
- Stars: 82
- Watchers: 5
- Forks: 31
- Open Issues: 10
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-asyncio - aioping - Fast asyncio implementation of ICMP (ping) protocol. (Networking)
README
aioping is a fast asyncio implementation of ICMP (ping) protocol.
Installation
------------
aioping requires Python 3.5.
Use pip to install it from the PyPI::
$ pip install aioping
Or use the latest version from the master (if you are brave enough)::
$ pip install git+https://github.com/stellarbit/aioping
Using aioping
-------------
There are 2 ways to use the library.
First one is interactive, which sends results to standard Python logger:
.. code:: python
import asyncio
import aioping
import logging
logging.basicConfig(level=logging.INFO) # or logging.DEBUG
asyncio.run(aioping.verbose_ping("google.com"))
Alternatively, you can call a ping function, which returns a
ping delay in milliseconds or throws an exception in case of
error:
.. code:: python
import asyncio
import aioping
async def do_ping(host):
try:
delay = await aioping.ping(host) * 1000
print("Ping response in %s ms" % delay)
except TimeoutError:
print("Timed out")
asyncio.run(do_ping("google.com"))
Methods
-------
``ping(dest_addr, timeout=10, family=None)``
- ``dest_addr`` - destination address, IPv4, IPv6 or hostname
- ``timeout`` - timeout in seconds (default: ``10``)
- ``family`` - family of resolved address - ``socket.AddressFamily.AF_INET`` for IPv4, ``socket.AddressFamily.AF_INET6``
for IPv6 or ``None`` if it doesn't matter (default: ``None``)
``verbose_ping(dest_addr, timeout=2, count=3, family=None)``
- ``dest_addr`` - destination address, IPv4, IPv6 or hostname
- ``timeout`` - timeout in seconds (default: ``2``)
- ``count`` - count of packets to send (default: ``3``)
- ``family`` - family of resolved address - ``socket.AddressFamily.AF_INET`` for IPv4, ``socket.AddressFamily.AF_INET6``
for IPv6 or ``None`` if it doesn't matter (default: ``None``)
Credits
-------
- Original Version from Matthew Dixon Cowles:
ftp://ftp.visi.com/users/mdc/ping.py
- Rewrite by Jens Diemer:
http://www.python-forum.de/post-69122.html#69122
- Rewrite by Samuel Stauffer:
https://github.com/samuel/python-ping
- Rewrite by Anton Belousov / Stellarbit LLC
http://github.com/stellarbit/aioping
- Generous contributions from GitHub users:
- https://github.com/JackSlateur
- https://github.com/harriv
- https://github.com/asantoni
- https://github.com/eddebc
- https://github.com/wise0wl
- https://github.com/nARN
- https://github.com/hergla
- https://github.com/hanieljgoertz
- https://github.com/Crypto-Spartan
- https://github.com/liordot
- https://github.com/dkaplan1
- https://github.com/haron
- https://github.com/matteomartelli
License
-------
aioping is licensed under GPLv2.