Package: ping3
Ping3Ping3 is a pure python3 version of ICMP ping implementation using raw socket.(Note that on some platforms, ICMP messages can only be sent from processes running as root.)The Python2 version originally fromhere.This version maintained atthis github repo.CHANGELOGGet StartedIf you met "permission denied", you may need to run this as root. Alternatively seethisfor troubleshooting on linux.pipinstallping3# install ping>>>fromping3importping,verbose_ping>>>ping('example.com')# Returns delay in seconds.0.215697261510079666>>>verbose_ping('example.com')# Ping 4 times in a row.ping'example.com'...215msping'example.com'...216msping'example.com'...219msping'example.com'...217ms$ping3example.com# Verbose ping.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217msInstallationpipinstallping3# install ping3pipinstall--upgradeping3# upgrade ping3pipuninstallping3# uninstall ping3Functions>>>fromping3importping,verbose_ping>>>ping('example.com')# Returns delay in seconds.0.215697261510079666# `0.0` returned means the delay is lower than the precision of `time.time()`.>>>ping('not.exist.com')# If host unknown (cannot resolve), returns False.False>>>ping("224.0.0.0")# If timed out (no reply), returns None.None>>>ping('example.com',timeout=10)# Set timeout to 10 seconds. Default timeout is 4 for 4 seconds.0.215697261510079666>>>ping('example.com',unit='ms')# Returns delay in milliseconds. Default unit is 's' for seconds.215.9627876281738>>>ping('example.com',src_addr='192.168.1.15')# Set source ip address for multiple interfaces. Default src_addr is None for no binding.0.215697261510079666>>>ping('example.com',interface='eth0')# LINUX ONLY. Set source interface for multiple network interfaces. Default interface is None for no binding.0.215697261510079666>>>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.None>>>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.0.215697261510079666>>>verbose_ping('example.com')# Ping 4 times in a row.ping'example.com'...215msping'example.com'...216msping'example.com'...219msping'example.com'...217ms>>>verbose_ping('example.com',timeout=10)# Set timeout to 10 seconds. Default timeout is 4 for 4 seconds.ping'example.com'...215msping'example.com'...216msping'example.com'...219msping'example.com'...217ms>>>verbose_ping('example.com',count=6)# Ping 6 times. Default count is 4.ping'example.com'...215msping'example.com'...216msping'example.com'...219msping'example.com'...217msping'example.com'...215msping'example.com'...216ms>>>verbose_ping('example.com',count=0)# Ping endlessly (0 means infinite loops). Using `ctrl + c` to stop manully.ping'example.com'...215ms...>>>verbose_ping('example.com',src_addr='192.168.1.15')# Ping from source IP address for multiple interfaces. Default src_addr is None.ping'example.com'from'192.168.1.15'...215msping'example.com'from'192.168.1.15'...216msping'example.com'from'192.168.1.15'...219msping'example.com'from'192.168.1.15'...217ms>>>verbose_ping('example.com',interface='wifi0')# LINUX ONLY. Ping from network interface 'wifi0'. Default interface is None.ping'example.com'from'192.168.1.15'...215msping'example.com'from'192.168.1.15'...216msping'example.com'from'192.168.1.15'...219msping'example.com'from'192.168.1.15'...217ms>>>verbose_ping('example.com',unit='s')# Displays delay in seconds. Default unit is "ms" for milliseconds.ping'example.com'...1sping'example.com'...2sping'example.com'...1sping'example.com'...1s>>>verbose_ping('example.com',ttl=5)# Set TTL to 5. Default is 64.ping'example.com'...Timeoutping'example.com'...Timeoutping'example.com'...Timeoutping'example.com'...Timeout>>>verbose_ping('example.com',interval=5)# Wait 5 seconds between each packet. Default is 0.ping'example.com'...215ms# wait 5 secsping'example.com'...216ms# wait 5 secsping'example.com'...219ms# wait 5 secsping'example.com'...217ms>>>verbose_ping('example.com',size=56)# Set ICMP payload to 56 bytes. Default size is 56.ping'example.com'...215msping'example.com'...216msping'example.com'...219msping'example.com'...217msDEBUG modeShow more info for developers.>>>importping3>>>ping3.DEBUG=True# Default is False.>>>ping3.ping("example.com")# "ping()" prints received IP header and ICMP header.[DEBUG]IPHEADER:{'version':69,'tos':0,'len':14336,'id':8620,'flags':0,'ttl':51,'protocol':1,'checksum':*,'src_addr':*,'dest_addr':*}[DEBUG]ICMPHEADER:{'type':0,'code':0,'checksum':8890,'id':21952,'seq':0}0.215697261510079666>>>ping3.ping("example.com",timeout=0.0001)[DEBUG]RequesttimeoutforICMPpacket.(Timeout=0.0001s)None>>>ping3.ping("not.exist.com")[DEBUG]Cannotresolve:Unknownhost.(Host=not.exist.com)False>>>ping3.ping("example.com",ttl=1)[DEBUG]Timeexceeded:TimeToLiveexpired.NoneEXCEPTIONS modeRaise exceptions when there are errors instead of return None>>>importping3>>>ping3.EXCEPTIONS=True# Default is False.>>>ping3.ping("example.com",timeout=0.0001)[...Traceback...]ping3.errors.Timeout:RequesttimeoutforICMPpacket.(Timeout=0.0001s)>>>ping3.ping("not.exist.com")[...Traceback...]ping3.errors.HostUnknown:Cannotresolve:Unknownhost.(Host=not.exist.com)>>>ping3.ping("example.com",ttl=1)# Linux need root privilege to receive TTL expired. Windows cannot get TTL expired.[...Traceback...]ping3.errors.TimeToLiveExpired:Timeexceeded:TimeToLiveexpired.>>>try:>>>ping3.ping("example.com",ttl=1)>>>exceptping3.errors.TimeToLiveExpiredaserr:>>>print(err.ip_header["src_addr"])# TimeToLiveExpired, DestinationUnreachable and DestinationHostUnreachable have ip_header and icmp_header attached.1.2.3.4# IP address where the TTL happened.>>>help(ping3.errors)# More info about exceptions.importping3ping3.EXCEPTIONS=Truetry:ping3.ping("not.exist.com")exceptping3.errors.HostUnknown:# Specific error is catched.print("Host unknown error raised.")exceptping3.errors.PingError:# All ping3 errors are subclasses of `PingError`.print("A ping error raised.")Command Line ExecutionExecute ping3 from command-line.
Note: On some platforms,ping3needs root privilege to send/receive packets. You may want to usesudo ping3.$ping3--help# -h/--help. Command-line help message.$python-mping3--help# Same as `ping3`. `ping3` is an alias for `python -m ping3`.$ping3--version# -v/--version. Show ping3 version number.3.0.0

$ping3example.com# Verbose ping.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms

$ping3example.com8.8.8.8# Verbose ping all the addresses.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms
ping'8.8.8.8'...5ms
ping'8.8.8.8'...2ms
ping'8.8.8.8'...6ms
ping'8.8.8.8'...5ms

$ping3--count1example.com# -c/--count. How many pings should be sent. Default is 4.ping'example.com'...215ms

$ping3--count0example.com# Ping endlessly (0 means infinite loops). Using `ctrl + c` to stop manully.ping'example.com'...215ms
...

$ping3--timeout10example.com# -t/--timeout. Set timeout to 10 seconds. Default is 4.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms

$ping3--ttl5example.com# -T/--ttl. # Set TTL to 5. Default is 64.ping'example.com'...Timeout
ping'example.com'...Timeout
ping'example.com'...Timeout
ping'example.com'...Timeout

$ping3--size56example.com# -s/--size. Set ICMP packet payload to 56 bytes. Default is 56.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms

$ping3--interval5example.com# -i/--interval. Wait 5 seconds between each packet. Default is 0.ping'example.com'...215ms# wait 5 secsping'example.com'...216ms# wait 5 secsping'example.com'...219ms# wait 5 secsping'example.com'...217ms

$ping3--interfaceeth0example.com# -I/--interface. LINUX ONLY. The gateway network interface to ping from. Default is None.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms

$ping3--src192.168.1.15example.com# -S/--src. Ping from source IP address for multiple network interfaces. Default is None.ping'example.com'...215ms
ping'example.com'...216ms
ping'example.com'...219ms
ping'example.com'...217ms

$ping3--exceptions--timeout0.001example.com# -E/--exceptions. EXCPETIONS mode is on when this shows up.[...Traceback...]ping3.errors.Timeout:RequesttimeoutforICMPpacket.(Timeout=0.0001s)$ping3--debug--timeout0.001example.com# -D/--debug. DEBUG mode is on when this shows up.[DEBUG]RequesttimeoutforICMPpacket.(Timeout=0.001s)ping'example.com'...Timeout>0.001s[DEBUG]RequesttimeoutforICMPpacket.(Timeout=0.001s)ping'example.com'...Timeout>0.001s[DEBUG]RequesttimeoutforICMPpacket.(Timeout=0.001s)ping'example.com'...Timeout>0.001s[DEBUG]RequesttimeoutforICMPpacket.(Timeout=0.001s)ping'example.com'...Timeout>0.001s