{"id":17477850,"url":"https://github.com/kyan001/ping3","last_synced_at":"2025-04-08T10:24:09.039Z","repository":{"id":26975850,"uuid":"111969722","full_name":"kyan001/ping3","owner":"kyan001","description":"Pure Python3 version of ICMP ping, shipped with command-line command.","archived":false,"fork":false,"pushed_at":"2024-04-10T16:56:03.000Z","size":127,"stargazers_count":326,"open_issues_count":10,"forks_count":58,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-01T08:44:41.686Z","etag":null,"topics":["command-line","icmp-ping","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kyan001.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-25T02:16:11.000Z","updated_at":"2025-03-28T09:47:50.000Z","dependencies_parsed_at":"2024-02-28T09:46:04.736Z","dependency_job_id":"2fb6f227-a876-4026-9abd-e2b786fd6fc1","html_url":"https://github.com/kyan001/ping3","commit_stats":{"total_commits":177,"total_committers":12,"mean_commits":14.75,"dds":0.1581920903954802,"last_synced_commit":"9fff91181ea605d1957643af381ee5fb7f3e558a"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyan001%2Fping3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyan001%2Fping3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyan001%2Fping3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyan001%2Fping3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kyan001","download_url":"https://codeload.github.com/kyan001/ping3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247821038,"owners_count":21001607,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","icmp-ping","python"],"created_at":"2024-10-18T20:09:53.459Z","updated_at":"2025-04-08T10:24:09.008Z","avatar_url":"https://github.com/kyan001.png","language":"Python","funding_links":[],"categories":["Python","📚 فهرست"],"sub_categories":["شبکه"],"readme":"# Ping3\n[![Build Status](https://travis-ci.org/kyan001/ping3.svg?branch=master)](https://travis-ci.org/kyan001/ping3)\n![GitHub release](https://img.shields.io/github/release/kyan001/ping3.svg)\n[![GitHub license](https://img.shields.io/github/license/kyan001/ping3.svg)](https://github.com/kyan001/ping3/blob/master/LICENSE)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/ping3.svg)\n\nPing3 is a pure python3 version of ICMP ping implementation using raw socket.\\\n(Note that on some platforms, ICMP messages can only be sent from processes running as root.)\n\n\u003e The Python2 version originally from [here](http://github.com/samuel/python-ping).\\\n\u003e This version maintained at [this github repo](https://github.com/kyan001/ping3).\n\n[CHANGELOG](CHANGELOG.md)\n\n## Get Started\n\n* If you met \"permission denied\", you may need to run this as root. Alternatively see [this](./TROUBLESHOOTING.md#permission-denied-on-linux) for troubleshooting on linux.\n\n```sh\npip install ping3  # install ping\n```\n\n```python\n\u003e\u003e\u003e from ping3 import ping, verbose_ping\n\u003e\u003e\u003e ping('example.com')  # Returns delay in seconds.\n0.215697261510079666\n\n\u003e\u003e\u003e verbose_ping('example.com')  # Ping 4 times in a row.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n```\n\n```sh\n$ ping3 example.com  # Verbose ping.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n```\n\n## Installation\n\n```sh\npip install ping3  # install ping3\npip install --upgrade ping3 # upgrade ping3\npip uninstall ping3  # uninstall ping3\n```\n\n## Functions\n\n```python\n\u003e\u003e\u003e from ping3 import ping, verbose_ping\n\n\u003e\u003e\u003e ping('example.com')  # Returns delay in seconds.\n0.215697261510079666  # `0.0` returned means the delay is lower than the precision of `time.time()`.\n\n\u003e\u003e\u003e ping('not.exist.com')  # If host unknown (cannot resolve), returns False.\nFalse\n\n\u003e\u003e\u003e ping(\"224.0.0.0\")  # If timed out (no reply), returns None.\nNone\n\n\u003e\u003e\u003e ping('example.com', timeout=10)  # Set timeout to 10 seconds. Default timeout is 4 for 4 seconds.\n0.215697261510079666\n\n\u003e\u003e\u003e ping('example.com', unit='ms')  # Returns delay in milliseconds. Default unit is 's' for seconds.\n215.9627876281738\n\n\u003e\u003e\u003e ping('example.com', src_addr='192.168.1.15')  # Set source ip address for multiple interfaces. Default src_addr is None for no binding.\n0.215697261510079666\n\n\u003e\u003e\u003e ping('example.com', interface='eth0')  # LINUX ONLY. Set source interface for multiple network interfaces. Default interface is None for no binding.\n0.215697261510079666\n\n\u003e\u003e\u003e ping('example.com', ttl=5)  # Set packet Time-To-Live to 5. The packet is discarded if it does not reach the target host after 5 jumps. Default ttl is 64.\nNone\n\n\u003e\u003e\u003e ping('example.com', size=56)  # Set ICMP packet payload to 56 bytes. The total ICMP packet size is 8 (header) + 56 (payload) = 64 bytes. Default size is 56.\n0.215697261510079666\n\n\u003e\u003e\u003e verbose_ping('example.com')  # Ping 4 times in a row.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n\u003e\u003e\u003e verbose_ping('example.com', timeout=10)  # Set timeout to 10 seconds. Default timeout is 4 for 4 seconds.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n\u003e\u003e\u003e verbose_ping('example.com', count=6)  # Ping 6 times. Default count is 4.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\n\n\u003e\u003e\u003e verbose_ping('example.com', count=0)  # Ping endlessly (0 means infinite loops). Using `ctrl + c` to stop manully.\nping 'example.com' ... 215ms\n...\n\n\u003e\u003e\u003e verbose_ping('example.com', src_addr='192.168.1.15')  # Ping from source IP address for multiple interfaces. Default src_addr is None.\nping 'example.com' from '192.168.1.15' ... 215ms\nping 'example.com' from '192.168.1.15' ... 216ms\nping 'example.com' from '192.168.1.15' ... 219ms\nping 'example.com' from '192.168.1.15' ... 217ms\n\n\u003e\u003e\u003e verbose_ping('example.com', interface='wifi0')  # LINUX ONLY. Ping from network interface 'wifi0'. Default interface is None.\nping 'example.com' from '192.168.1.15' ... 215ms\nping 'example.com' from '192.168.1.15' ... 216ms\nping 'example.com' from '192.168.1.15' ... 219ms\nping 'example.com' from '192.168.1.15' ... 217ms\n\n\u003e\u003e\u003e verbose_ping('example.com', unit='s')  # Displays delay in seconds. Default unit is \"ms\" for milliseconds.\nping 'example.com' ... 1s\nping 'example.com' ... 2s\nping 'example.com' ... 1s\nping 'example.com' ... 1s\n\n\u003e\u003e\u003e verbose_ping('example.com', ttl=5)  # Set TTL to 5. Default is 64.\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\n\n\u003e\u003e\u003e verbose_ping('example.com', interval=5)  # Wait 5 seconds between each packet. Default is 0.\nping 'example.com' ... 215ms  # wait 5 secs\nping 'example.com' ... 216ms  # wait 5 secs\nping 'example.com' ... 219ms  # wait 5 secs\nping 'example.com' ... 217ms\n\n\u003e\u003e\u003e verbose_ping('example.com', size=56)  # Set ICMP payload to 56 bytes. Default size is 56.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n```\n\n### DEBUG mode\n\nShow more info for developers.\n\n```python\n\u003e\u003e\u003e import ping3\n\u003e\u003e\u003e ping3.DEBUG = True  # Default is False.\n\n\u003e\u003e\u003e ping3.ping(\"example.com\")  # \"ping()\" prints received IP header and ICMP header.\n[DEBUG] IP HEADER: {'version': 69, 'tos': 0, 'len': 14336, 'id': 8620, 'flags': 0, 'ttl': 51, 'protocol': 1, 'checksum': *, 'src_addr': *, 'dest_addr': *}\n[DEBUG] ICMP HEADER: {'type': 0, 'code': 0, 'checksum': 8890, 'id': 21952, 'seq': 0}\n0.215697261510079666\n\n\u003e\u003e\u003e ping3.ping(\"example.com\", timeout=0.0001)\n[DEBUG] Request timeout for ICMP packet. (Timeout = 0.0001s)\nNone\n\n\u003e\u003e\u003e ping3.ping(\"not.exist.com\")\n[DEBUG] Cannot resolve: Unknown host. (Host = not.exist.com)\nFalse\n\n\u003e\u003e\u003e ping3.ping(\"example.com\", ttl=1)\n[DEBUG] Time exceeded: Time To Live expired.\nNone\n```\n\n### EXCEPTIONS mode\n\nRaise exceptions when there are errors instead of return None\n\n```python\n\u003e\u003e\u003e import ping3\n\u003e\u003e\u003e ping3.EXCEPTIONS = True  # Default is False.\n\n\u003e\u003e\u003e ping3.ping(\"example.com\", timeout=0.0001)\n[... Traceback ...]\nping3.errors.Timeout: Request timeout for ICMP packet. (Timeout = 0.0001s)\n\n\u003e\u003e\u003e ping3.ping(\"not.exist.com\")\n[... Traceback ...]\nping3.errors.HostUnknown: Cannot resolve: Unknown host. (Host = not.exist.com)\n\n\u003e\u003e\u003e ping3.ping(\"example.com\", ttl=1)  # Linux need root privilege to receive TTL expired. Windows cannot get TTL expired.\n[... Traceback ...]\nping3.errors.TimeToLiveExpired: Time exceeded: Time To Live expired.\n\n\u003e\u003e\u003e try:\n\u003e\u003e\u003e     ping3.ping(\"example.com\", ttl=1)\n\u003e\u003e\u003e except ping3.errors.TimeToLiveExpired as err:\n\u003e\u003e\u003e     print(err.ip_header[\"src_addr\"])  # TimeToLiveExpired, DestinationUnreachable and DestinationHostUnreachable have ip_header and icmp_header attached.\n1.2.3.4  # IP address where the TTL happened.\n\n\u003e\u003e\u003e help(ping3.errors)  # More info about exceptions.\n```\n\n```python\nimport ping3\nping3.EXCEPTIONS = True\n\ntry:\n    ping3.ping(\"not.exist.com\")\nexcept ping3.errors.HostUnknown:  # Specific error is catched.\n    print(\"Host unknown error raised.\")\nexcept ping3.errors.PingError:  # All ping3 errors are subclasses of `PingError`.\n    print(\"A ping error raised.\")\n```\n\n## Command Line Execution\n\nExecute ping3 from command-line.\nNote: On some platforms, `ping3` needs root privilege to send/receive packets. You may want to use `sudo ping3`.\n\n```sh\n$ ping3 --help  # -h/--help. Command-line help message.\n$ python -m ping3 --help  # Same as `ping3`. `ping3` is an alias for `python -m ping3`.\n\n$ ping3 --version  # -v/--version. Show ping3 version number.\n3.0.0\n\n$ ping3 example.com  # Verbose ping.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n$ ping3 example.com 8.8.8.8  # Verbose ping all the addresses.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\nping '8.8.8.8' ... 5ms\nping '8.8.8.8' ... 2ms\nping '8.8.8.8' ... 6ms\nping '8.8.8.8' ... 5ms\n\n$ ping3 --count 1 example.com  # -c/--count. How many pings should be sent. Default is 4.\nping 'example.com' ... 215ms\n\n$ ping3 --count 0 example.com  # Ping endlessly (0 means infinite loops). Using `ctrl + c` to stop manully.\nping 'example.com' ... 215ms\n...\n\n$ ping3 --timeout 10 example.com  # -t/--timeout. Set timeout to 10 seconds. Default is 4.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n$ ping3 --ttl 5 example.com  # -T/--ttl. # Set TTL to 5. Default is 64.\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\nping 'example.com' ... Timeout\n\n$ ping3 --size 56 example.com  # -s/--size. Set ICMP packet payload to 56 bytes. Default is 56.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n$ ping3 --interval 5 example.com  # -i/--interval. Wait 5 seconds between each packet. Default is 0.\nping 'example.com' ... 215ms  # wait 5 secs\nping 'example.com' ... 216ms  # wait 5 secs\nping 'example.com' ... 219ms  # wait 5 secs\nping 'example.com' ... 217ms\n\n$ ping3 --interface eth0 example.com  # -I/--interface. LINUX ONLY. The gateway network interface to ping from. Default is None.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n$ ping3 --src 192.168.1.15 example.com  # -S/--src. Ping from source IP address for multiple network interfaces. Default is None.\nping 'example.com' ... 215ms\nping 'example.com' ... 216ms\nping 'example.com' ... 219ms\nping 'example.com' ... 217ms\n\n$ ping3 --exceptions --timeout 0.001 example.com  # -E/--exceptions. EXCPETIONS mode is on when this shows up.\n[... Traceback ...]\nping3.errors.Timeout: Request timeout for ICMP packet. (Timeout = 0.0001s)\n\n$ ping3 --debug --timeout 0.001 example.com  # -D/--debug. DEBUG mode is on when this shows up.\n[DEBUG] Request timeout for ICMP packet. (Timeout = 0.001s)\nping 'example.com' ... Timeout \u003e 0.001s\n[DEBUG] Request timeout for ICMP packet. (Timeout = 0.001s)\nping 'example.com' ... Timeout \u003e 0.001s\n[DEBUG] Request timeout for ICMP packet. (Timeout = 0.001s)\nping 'example.com' ... Timeout \u003e 0.001s\n[DEBUG] Request timeout for ICMP packet. (Timeout = 0.001s)\nping 'example.com' ... Timeout \u003e 0.001s\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyan001%2Fping3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkyan001%2Fping3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyan001%2Fping3/lists"}