pingparsing 0.2.5

pingparsing is a python library of parsing ping command output.

pingparsing

Table of contents

• Summary

• Installation

• Premise

• Recommended ping command execution

  • Linux

  • Windows

    • Reference

• Usage

  • Parsing ping command output

    • Example: Debian 8.2 w/ iputils-ping 20121221-5+b2

      • Input

      • Sample code

      • Output

    • Example: Windows 7 SP1

      • Input

      • Sample code

      • Output

  • Execute ping and parse

    • Sample code

    • Example execution result: Debian 8.2 w/ iputils-ping 20121221-5+b2

    • Example execution result: Windows 7 SP1

• Dependencies

  • Test dependencies

• Tested Environment

Summary

pingparsing is a python library of parsing ping command output.

Installation

pip install pingparsing

Premise

This library expects to output language of the ping command is in English. The ping command output in any other languages is may fail to parse. This is because the output of the ping command is changed depending on the language.

Recommended ping command execution

The following methods are recommended to execute ping command for parsing. These will change the language setting to English temporarily.

Linux

LC_ALL=C ping <host or IP address> -w <seconds> [option] > <output.file>

Windows

> chcp
Active code page: <XXX>    # get current code page

> chcp 437    # change code page to english
> ping <host or IP address> -n <ping count> > <output.file>
> chcp <XXX>    # restore code page

Reference

https://technet.microsoft.com/en-us/library/cc733037

Usage

Parsing ping command output

Example: Debian 8.2 w/ iputils-ping 20121221-5+b2

Input

# LC_ALL=C ping google.com -q -c 60 > ping.txt
# cat ping.txt
PING google.com (216.58.196.238) 56(84) bytes of data.

--- google.com ping statistics ---
60 packets transmitted, 60 received, 0% packet loss, time 59153ms
rtt min/avg/max/mdev = 61.425/99.731/212.597/27.566 ms

Sample code

parse_sample.py

import pingparsing

ping_parser = pingparsing.PingParsing()
with open("ping.txt") as f:
    ping_parser.parse(f.read())

print("packet_transmit:", ping_parser.packet_transmit)
print("packet_receive:", ping_parser.packet_receive)
print("packet_loss:", ping_parser.packet_loss)
print("rtt_min:", ping_parser.rtt_min)
print("rtt_avg:", ping_parser.rtt_avg)
print("rtt_max:", ping_parser.rtt_max)
print("rtt_mdev:", ping_parser.rtt_mdev)
print(ping_parser.as_dict())

Output

python parse_sample.py
packet_transmit: 60
packet_receive: 60
packet_loss: 0.0
rtt_min: 61.425
rtt_avg: 99.731
rtt_max: 212.597
rtt_mdev: 27.566
{'rtt_avg': 99.731, 'packet_loss': 0.0, 'packet_transmit': 60, 'rtt_max': 212.597, 'rtt_min': 61.425, 'rtt_mdev': 27.566, 'packet_receive': 60}

Example: Windows 7 SP1

Input

>ping google.com -n 10 > ping_win7.txt

>type ping_win7.txt

Pinging google.com [216.58.196.238] with 32 bytes of data:
Reply from 216.58.196.238: bytes=32 time=87ms TTL=51
Reply from 216.58.196.238: bytes=32 time=97ms TTL=51
Reply from 216.58.196.238: bytes=32 time=56ms TTL=51
Reply from 216.58.196.238: bytes=32 time=95ms TTL=51
Reply from 216.58.196.238: bytes=32 time=194ms TTL=51
Reply from 216.58.196.238: bytes=32 time=98ms TTL=51
Reply from 216.58.196.238: bytes=32 time=93ms TTL=51
Reply from 216.58.196.238: bytes=32 time=96ms TTL=51
Reply from 216.58.196.238: bytes=32 time=96ms TTL=51
Reply from 216.58.196.238: bytes=32 time=165ms TTL=51

Ping statistics for 216.58.196.238:
    Packets: Sent = 10, Received = 10, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
    Minimum = 56ms, Maximum = 194ms, Average = 107ms

Sample code

parse_sample.py

import pingparsing

ping_parser = pingparsing.PingParsing()
with open("ping_win7.txt") as f:
    ping_parser.parse(f.read())

print(ping_parser.as_dict())

Output

>python parse_sample.py
{'packet_loss': 0.0, 'packet_receive': 10, 'packet_transmit': 10, 'rtt_min': 56.0, 'rtt_max': 194.0, 'rtt_mdev': None, '
rtt_avg': 107.0}

Execute ping and parse

PingTransmitter class can execute ping command and obtain the ping output as a string.

Sample code

ping_sample.py

import pingparsing

transmitter = pingparsing.PingTransmitter()
transmitter.destination_host = "192.168.0.1"
transmitter.waittime = 60
result = transmitter.ping()

ping_parser = pingparsing.PingParsing()
ping_parser.parse(result)

print(ping_parser.as_dict())

Example execution result: Debian 8.2 w/ iputils-ping 20121221-5+b2

# python ping_sample.py
{'packet_loss': 0.0, 'packet_receive': 60, 'packet_transmit': 60, 'rtt_min': 0.814, 'rtt_max': 27.958, 'rtt_mdev': 3.574, 'rtt_avg': 2.004}

Example execution result: Windows 7 SP1

>python ping_sample.py
{'packet_loss': 0.0, 'packet_receive': 60, 'packet_transmit': 60, 'rtt_min': 0.0
, 'rtt_max': 56.0, 'rtt_mdev': None, 'rtt_avg': 2.0}

Dependencies

Python 2.5+ or 3.3+

• DataPropery

• pyparsing

Test dependencies

• pytest

• pytest-runner

• tox

Tested Environment

OS	ping version
Debian 8.2	iputils-ping 20121221-5+b2
Debian 5.0.10	iputils-ping 20071127-1+lenny1
Windows 7 SP1	-
Windows 8.1	-