From cba918851a3a825b7d7903149264f6b7137b5649 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Thu, 11 Jul 2013 15:56:31 -0700 Subject: [PATCH 01/22] Rewriting file back into a class for easier access. --- ping.py | 663 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 382 insertions(+), 281 deletions(-) diff --git a/ping.py b/ping.py index 0d69856..d0ac5b3 100755 --- a/ping.py +++ b/ping.py @@ -203,6 +203,7 @@ #=============================================================================# import os, sys, socket, struct, select, time, signal +from icmp_messages import * if sys.platform == "win32": # On Windows, the best timer is time.clock() @@ -218,24 +219,40 @@ ICMP_ECHO = 8 # Echo request (per RFC792) ICMP_ECHO_IPV6 = 128 # Echo request (per RFC4443) ICMP_ECHO_IPV6_REPLY = 129 # Echo request (per RFC4443) +ICMP_PORT = 1 +ICMP_PORT_IPV6 = 58 ICMP_MAX_RECV = 2048 # Max size of incoming buffer MAX_SLEEP = 1000 -class MyStats: - thisIP = "0.0.0.0" - pktsSent = 0 - pktsRcvd = 0 - minTime = 999999999 - maxTime = 0 - totTime = 0 - avrgTime = 0 - fracLoss = 1.0 - -myStats = MyStats # NOT Used globally anymore. +# class MyStats: + # destIP = "0.0.0.0" + # destHost = "0.0.0.0" + # pktsSent = 0 + # pktsRcvd = 0 + # minTime = 999999999 + # maxTime = 0 + # totTime = 0 + # avrgTime = 0 + # fracLoss = 1.0 +# +# myStats = MyStats # NOT Used globally anymore. +# +# + +class PingStats: + destination_ip = "0.0.0.0" + destination_host = "unknown" + destination_port = 0 + packets_sent = 0 + packets_received = 0 + min_time = 999999999 + max_time = 0 + total_time = 0 + average_time = 0 #=============================================================================# -def checksum(source_string): +def calculate_checksum(source_string): """ A port of the functionality of in_cksum() from ping.c Ideally this would act on the string as a series of 16-bit ints (host @@ -282,320 +299,404 @@ def checksum(source_string): return answer #=============================================================================# -def do_one(myStats, destIP, hostname, timeout, mySeqNumber, numDataBytes, quiet = False, ipv6=False): - """ - Returns either the delay (in ms) or None on timeout. - """ - delay = None - - if ipv6: - try: # One could use UDP here, but it's obscure - mySocket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) - except socket.error, e: - print("failed. (socket error: '%s')" % e.args[1]) - raise # raise the original error - else: - - try: # One could use UDP here, but it's obscure - mySocket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) - except socket.error, e: - print("failed. (socket error: '%s')" % e.args[1]) - raise # raise the original error - - my_ID = os.getpid() & 0xFFFF - - sentTime = send_one_ping(mySocket, destIP, my_ID, mySeqNumber, numDataBytes, ipv6) - if sentTime == None: - mySocket.close() - return delay - myStats.pktsSent += 1 - - recvTime, dataSize, iphSrcIP, icmpSeqNumber, iphTTL = receive_one_ping(mySocket, my_ID, timeout, ipv6) +class Ping(object): + def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet=False, ipv6=False): + self.stats = PingStats + # Statistics + self.stats.destination_ip = "0.0.0.0" + self.stats.destination_host = destination + self.stats.destination_port = ICMP_PORT + self.stats.packets_sent = 0 + self.stats.packets_received = 0 + self.stats.lost_rate = 100.0 + self.stats.min_time = 999999999 + self.stats.max_time = 0 + self.stats.total_time = 0 + self.stats.average_time = 0.0 + + # Parameters + self.ipv6 = ipv6 + self.timeout = timeout + self.packet_size = packet_size - 8 + self.sequence_number = 0 + self.unknown_host = False + + if own_id is None: + self.own_id = os.getpid() & 0xFFFF + else: + self.own_id = own_id - mySocket.close() + # Output Streams + if quiet: + devnull = open(os.devnull, 'w') + self._stdout = devnull + self._stderr = devnull + else: + self._stdout = sys.stdout + self._stderr = sys.stderr + + # Get IP from hostname + try: + if self.ipv6: + self.stats.destination_port = ICMP_PORT_IPV6 + info = socket.getaddrinfo(self.stats.destination_host, None)[0] + self.stats.destination_ip = info[4][0] + else: + self.stats.destination_ip = socket.gethostbyname(self.stats.destination_host) + except socket.error as e: + self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % (self.stats.destination_host, e.args[1])) + #sys.exit(2) + self.unknown_host = True + return + + # Print opening line + self._stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % (self.stats.destination_host, self.stats.destination_ip, self.packet_size)) - if recvTime: - delay = (recvTime-sentTime)*1000 - if not quiet: - if ipv6: - host_addr = hostname +#=============================================================================# + def do_one(self): + """ + Returns either the delay (in ms) or None on timeout. + """ + delay = None + + try: + # One could use UDP here, but it's obscure + if self.ipv6: + current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) else: - host_addr = socket.inet_ntop(socket.AF_INET, struct.pack("!I", iphSrcIP)) + current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) + except socket.error as e: +# if e.args[0] == 1: +# # Operation not permitted - Add more information to traceback +# etype, evalue, etb = sys.exc_info() +# evalue = etype( +# "%s - Note that ICMP messages can only be send from processes running as root." % evalue +# ) +# raise etype, evalue, etb + self._stderr.write("failed. (socket error: '%s')\n" % e.args[1]) + raise # raise the original error + + send_time = self.send_one_ping(current_socket) + if send_time == None: + current_socket.close() + return delay + self.stats.packets_sent += 1 + + receive_time, packet_size, ip_header, icmp_header = self.receive_one_ping(current_socket) + current_socket.close() + + icmp_seq_number = icmp_header["seq_number"] + icmp_type = icmp_header["type"] + icmp_code = icmp_header["code"] + + + if self.ipv6: + host_addr = self.stats.destination_host + else: + host_addr = self.stats.destination_ip + if host_addr == self.stats.destination_host: + from_info = host_addr + else: + if self.ipv6: + from_info = self.stats.destination_host + else: + from_info = "%s (%s)" % (self.stats.destination_host, host_addr) + + if receive_time: + + iph_src_ip = ip_header["src_ip"] + ip_header_ttl = ip_header["ttl"] + + delay = (receive_time-send_time) * 1000.0 + + self._stdout.write("%d bytes from %s: icmp_seq=%d ttl=%d time=%0.3f ms\n" % (packet_size, from_info, icmp_seq_number, ip_header_ttl, delay)) + + self.stats.packets_received += 1 + self.stats.total_time += delay + if self.stats.min_time > delay: + self.stats.min_time = delay + if self.stats.max_time < delay: + self.stats.max_time = delay + else: + imcp_message = ICMP_CONTROL_MESSAGE[icmp_type][icmp_code] + delay = None + self._stdout.write("From %s: icmp_seq=%d %s\n" % (self.stats.destination_ip, icmp_seq_number, imcp_message)) + #self._stdout.write("Request timed out.\n") + + return delay - print("%d bytes from %s: icmp_seq=%d ttl=%d time=%d ms" % ( - dataSize, host_addr, icmpSeqNumber, iphTTL, delay) +#=============================================================================# + def send_one_ping(self, current_socket): + """ + Send one ping to the given >destIP<. + """ + + # Header is type (8), code (8), checksum (16), id (16), sequence (16) + # (numDataBytes - 8) - Remove header size from packet size + checksum = 0 + + # Make a dummy heder with a 0 checksum. + if self.ipv6: + header = struct.pack( + "!BbHHh", ICMP_ECHO_IPV6, 0, checksum, self.own_id, self.sequence_number ) - myStats.pktsRcvd += 1 - myStats.totTime += delay - if myStats.minTime > delay: - myStats.minTime = delay - if myStats.maxTime < delay: - myStats.maxTime = delay - else: - delay = None - print("Request timed out.") - - return delay + else: + header = struct.pack( + "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.sequence_number + ) + + pad_bytes = [] + start_val = 0x42 + # 'cose of the string/byte changes in python 2/3 we have + # to build the data differnely for different version + # or it will make packets with unexpected size. + if sys.version[:1] == '2': + bytes = struct.calcsize("d") + data = ((self.packet_size) - bytes) * "Q" + data = struct.pack("d", default_timer()) + data + else: + for i in range(start_val, start_val + (self.packet_size)): + pad_bytes += [(i & 0xff)] # Keep chars in the 0-255 range + #data = bytes(pad_bytes) + data = bytearray(pad_bytes) + + + + # Calculate the checksum on the data and the dummy header. + checksum = calculate_checksum(header + data) # Checksum is in network order + + # Now that we have the right checksum, we put that in. It's just easier + # to make up a new header than to stuff it into the dummy. + if self.ipv6: + header = struct.pack( + "!BbHHh", ICMP_ECHO_IPV6, 0, checksum, self.own_id, self.sequence_number + ) + else: + header = struct.pack( + "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.sequence_number + ) + + packet = header + data + + send_time = default_timer() + + try: + if self.ipv6: + current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port, 0, 0)) + else: + current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port)) + except socket.error as e: + self._stderr.write("General failure (%s)\n" % (e.args[1])) + send_time = None + + return send_time #=============================================================================# -def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes, ipv6=False): - """ - Send one ping to the given >destIP<. - """ - #destIP = socket.gethostbyname(destIP) - - # Header is type (8), code (8), checksum (16), id (16), sequence (16) - # (numDataBytes - 8) - Remove header size from packet size - myChecksum = 0 - - # Make a dummy heder with a 0 checksum. - if ipv6: - header = struct.pack( - "!BbHHh", ICMP_ECHO_IPV6, 0, myChecksum, myID, mySeqNumber - ) - else: - header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber - ) - - padBytes = [] - startVal = 0x42 - # 'cose of the string/byte changes in python 2/3 we have - # to build the data differnely for different version - # or it will make packets with unexpected size. - if sys.version[:1] == '2': - bytes = struct.calcsize("d") - data = ((numDataBytes - 8) - bytes) * "Q" - data = struct.pack("d", default_timer()) + data - else: - for i in range(startVal, startVal + (numDataBytes-8)): - padBytes += [(i & 0xff)] # Keep chars in the 0-255 range - #data = bytes(padBytes) - data = bytearray(padBytes) - - - # Calculate the checksum on the data and the dummy header. - myChecksum = checksum(header + data) # Checksum is in network order - - # Now that we have the right checksum, we put that in. It's just easier - # to make up a new header than to stuff it into the dummy. - if ipv6: - header = struct.pack( - "!BbHHh", ICMP_ECHO_IPV6, 0, myChecksum, myID, mySeqNumber - ) - else: - header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber - ) - - packet = header + data - - sendTime = default_timer() - - try: - mySocket.sendto(packet, (destIP, 1)) # Port number is irrelevant for ICMP - except socket.error, e: - print("General failure (%s)" % (e.args[1])) - return - - return sendTime + def receive_one_ping(self, current_socket): + """ + Receive the ping from the socket. Timeout = in ms + """ + time_left = self.timeout / 1000.0 + + while True: # Loop while waiting for packet or timeout + select_start = default_timer() + what_ready = select.select([current_socket], [], [], time_left) + select_duration = (default_timer() - select_start) + + time_received = default_timer() + + packet_data, addr = current_socket.recvfrom(ICMP_MAX_RECV) + + if self.ipv6: + icmp_header_raw = packet_data[0:8] + else: + icmp_header_raw = packet_data[20:28] + + icmp_header = self.header2dict( + names=[ + "type", "code", "checksum", + "packet_id", "seq_number" + ], + struct_format="!BBHHH", + data=icmp_header_raw + ) + + ip_header = None + # TODO: Still need to work on IPv6 Headers + if icmp_header["packet_id"] == self.own_id: # Our packet + if self.ipv6: + ip_header = self.header2dict( + names=[ + "version", "type", "flow_label", + "payload_length", "protocol", "ttl", + "src_ip", "dest_ip" + ], + struct_format="!BBHHBBdd", + data=packet_data[:24] + # "src_ip_a", "src_ip_b", "dest_ip_a", "dest_ip_b" + #], + #struct_format="!BBHHBBQQQQ", + #data=packet_data[:40] + ) + #ip_header['src_ip'] = ip_header['src_ip_a'] + ip_header['src_ip_b'] + #ip_header['dest_ip'] = ip_header['dest_ip_a'] + ip_header['dest_ip_b'] + else: + ip_header = self.header2dict( + names=[ + "version", "type", "length", + "id", "flags", "ttl", "protocol", + "checksum", "src_ip", "dest_ip" + ], + struct_format="!BBHHHBBHII", + data=packet_data[:20] + ) + + if what_ready[0] == []: # Timeout + return None, 0, ip_header, icmp_header + + if icmp_header["packet_id"] == self.own_id: # Our packet + data_size = len(packet_data) - 28 + return time_received, (data_size+8), ip_header, icmp_header + + time_left = time_left - select_duration + if time_left <= 0: + return None, 0, ip_header, icmp_header #=============================================================================# -def receive_one_ping(mySocket, myID, timeout, ipv6=False): - """ - Receive the ping from the socket. Timeout = in ms - """ - timeLeft = timeout/1000 - - while True: # Loop while waiting for packet or timeout - startedSelect = default_timer() - whatReady = select.select([mySocket], [], [], timeLeft) - howLongInSelect = (default_timer() - startedSelect) - if whatReady[0] == []: # Timeout - return None, 0, 0, 0, 0 - - timeReceived = default_timer() - - recPacket, addr = mySocket.recvfrom(ICMP_MAX_RECV) - - ipHeader = recPacket[:20] - iphVersion, iphTypeOfSvc, iphLength, \ - iphID, iphFlags, iphTTL, iphProtocol, \ - iphChecksum, iphSrcIP, iphDestIP = struct.unpack( - "!BBHHHBBHII", ipHeader - ) - - if ipv6: - icmpHeader = recPacket[0:8] + + def calculate_packet_loss(self): + if self.stats.packets_sent: + lost_count = self.stats.packets_sent - self.stats.packets_received + self.stats.lost_rate = float(lost_count) / self.stats.packets_sent * 100.0 else: - icmpHeader = recPacket[20:28] - - icmpType, icmpCode, icmpChecksum, \ - icmpPacketID, icmpSeqNumber = struct.unpack( - "!BBHHH", icmpHeader - ) - - if icmpPacketID == myID: # Our packet - dataSize = len(recPacket) - 28 - #print (len(recPacket.encode())) - return timeReceived, (dataSize+8), iphSrcIP, icmpSeqNumber, iphTTL - - timeLeft = timeLeft - howLongInSelect - if timeLeft <= 0: - return None, 0, 0, 0, 0 - + self.stats.lost_rate = 100.0 + + def calculate_packet_average(self): + if self.stats.packets_received: + self.stats.average_time = self.stats.total_time / self.stats.packets_received + else: + self.stats.average_time = 0.0 + #=============================================================================# -def dump_stats(myStats): - """ - Show stats when pings are done - """ - print("\n----%s PYTHON PING Statistics----" % (myStats.thisIP)) - - if myStats.pktsSent > 0: - myStats.fracLoss = (myStats.pktsSent - myStats.pktsRcvd)/myStats.pktsSent + + def print_stats(self): + self._stdout.write("\n--- %s PYTHON PING statistics ---\n" % (self.stats.destination_host)) - print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( - myStats.pktsSent, myStats.pktsRcvd, 100.0 * myStats.fracLoss - )) + self.calculate_packet_loss() - if myStats.pktsRcvd > 0: - print("round-trip (ms) min/avg/max = %d/%0.1f/%d" % ( - myStats.minTime, myStats.totTime/myStats.pktsRcvd, myStats.maxTime + self._stdout.write("%d packets transmitted, %d received, %0.1f%% packet loss, time %dms\n" % ( + self.stats.packets_sent, self.stats.packets_received, self.stats.lost_rate, self.stats.total_time )) - print("") - return - + if self.stats.packets_received > 0: + self.calculate_packet_average() + self._stdout.write("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f\n" % ( + self.stats.min_time, self.stats.average_time, self.stats.max_time)) + #=============================================================================# -def signal_handler(signum, frame): - """ - Handle exit via signals - """ - dump_stats() - print("\n(Terminated with signal %d)\n" % (signum)) - sys.exit(0) + def header2dict(self, names, struct_format, data): + """ unpack the raw received IP and ICMP header informations to a dict """ + unpacked_data = struct.unpack(struct_format, data) + return dict(zip(names, unpacked_data)) + #=============================================================================# -def verbose_ping(hostname, timeout = 3000, count = 3, - numDataBytes = 64, path_finder = False, ipv6=False): - """ - Send >count< ping to >destIP< with the given >timeout< and display - the result. - """ - signal.signal(signal.SIGINT, signal_handler) # Handle Ctrl-C - if hasattr(signal, "SIGBREAK"): - # Handle Ctrl-Break e.g. under Windows - signal.signal(signal.SIGBREAK, signal_handler) - - myStats = MyStats() # Reset the stats - - mySeqNumber = 0 # Starting value - - try: - if ipv6: - info = socket.getaddrinfo(hostname, None)[0] - destIP = info[4][0] - else: - destIP = socket.gethostbyname(hostname) - print("\nPYTHON PING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) - except socket.gaierror, e: - print("\nPYTHON PING: Unknown host: %s (%s)" % (hostname, e.args[1])) - print() - return - - myStats.thisIP = destIP - for i in range(count): - delay = do_one(myStats, destIP, hostname, timeout, mySeqNumber, numDataBytes, ipv6=ipv6) - if delay == None: - delay = 0 - - mySeqNumber += 1 - - # Pause for the remainder of the MAX_SLEEP period (if applicable) - if (MAX_SLEEP > delay): - time.sleep((MAX_SLEEP - delay)/1000) - - dump_stats(myStats) - # 0 if we receive at least one packet - # 1 if we don't receive any packets - return not myStats.pktsRcvd + def signal_handler(self, signum, frame): + """ + Handle print_exit via signals + """ + self.calculate_packet_loss() + self.print_stats() + #self._stdout.write("\n(Terminated with signal %d)\n" % (signum)) + sys.exit(not self.stats.packets_received) + + def setup_signal_handler(self): + signal.signal(signal.SIGINT, self.signal_handler) # Handle Ctrl-C + if hasattr(signal, "SIGBREAK"): + # Handle Ctrl-Break e.g. under Windows + signal.signal(signal.SIGBREAK, self.signal_handler) #=============================================================================# -def quiet_ping(hostname, timeout = 3000, count = 3, - numDataBytes = 64, path_finder = False, ipv6=False): - """ - Same as verbose_ping, but the results are returned as tuple - """ - myStats = MyStats() # Reset the stats - mySeqNumber = 0 # Starting value - try: - if ipv6: - info = socket.getaddrinfo(hostname, None)[0] - destIP = info[4][0] - else: - destIP = socket.gethostbyname(hostname) - except socket.gaierror, e: - return False - - myStats.thisIP = destIP - - # This will send packet that we dont care about 0.5 seconds before it starts - # acrutally pinging. This is needed in big MAN/LAN networks where you sometimes - # loose the first packet. (while the switches find the way... :/ ) - if path_finder: - fakeStats = MyStats() - do_one(fakeStats, destIP, hostname, timeout, - mySeqNumber, numDataBytes, quiet=True, ipv6=ipv6) - time.sleep(0.5) + def run(self, count=None, deadline=None): + """ + send and receive pings in a loop. Stop if count or until deadline. + """ + self.setup_signal_handler() - for i in range(count): - delay = do_one(myStats, destIP, hostname, timeout, - mySeqNumber, numDataBytes, quiet=True, ipv6=ipv6) + while True: + if self.unknown_host: + return self.stats + + delay = self.do_one() - if delay == None: - delay = 0 + self.sequence_number += 1 + if count and self.sequence_number >= count: + break + if deadline and self.stats.total_time >= deadline: + break - mySeqNumber += 1 + if delay == None: + delay = 0 - # Pause for the remainder of the MAX_SLEEP period (if applicable) - if (MAX_SLEEP > delay): - time.sleep((MAX_SLEEP - delay)/1000) + # Pause for the remainder of the MAX_SLEEP period (if applicable) + if (MAX_SLEEP > delay): + time.sleep((MAX_SLEEP - delay) / 1000.0) - if myStats.pktsSent > 0: - myStats.fracLoss = (myStats.pktsSent - myStats.pktsRcvd)/myStats.pktsSent - if myStats.pktsRcvd > 0: - myStats.avrgTime = myStats.totTime / myStats.pktsRcvd - # return tuple(max_rtt, min_rtt, avrg_rtt, percent_lost) - return myStats.maxTime, myStats.minTime, myStats.avrgTime, myStats.fracLoss + self.calculate_packet_loss() + self.print_stats() + return self.stats + +#=============================================================================# + +def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False): + p = Ping(hostname, timeout, packet_size, own_id, quiet) + stats = p.run(count) + return(not stats.packets_received) + +def ping6(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False): + p = Ping(hostname, timeout, packet_size, own_id, quiet, True) + stats = p.run(count) + return(not stats.packets_received) + +#=============================================================================# +def usage(): + usage_message = """\ +Usage: %s hostname +""" % (sys.argv[0]) + sys.stderr.write(usage_message) + #=============================================================================# if __name__ == '__main__': # FIXME: Add a real CLI if len(sys.argv) == 1: # These should work: - verbose_ping("8.8.8.8") - verbose_ping("heise.de") - verbose_ping("google.com") + ping("8.8.8.8") + ping("heise.de") + ping("google.com") # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly # to the local host, but 2.7 tries to resolve to the local *gateway*) - verbose_ping("localhost") + ping("localhost") # Should fail with 'getaddrinfo failed': - verbose_ping("foobar_url.foobar") + ping("foobar_url.foobar") # Should fail (timeout), but it depends on the local network: - verbose_ping("192.168.255.254") + ping("192.168.255.254") # Should fails with 'The requested address is not valid in its context': - verbose_ping("0.0.0.0") + ping("0.0.0.0") + sys.exit(1) elif len(sys.argv) == 2: - retval = verbose_ping(sys.argv[1]) + retval = ping(sys.argv[1]) sys.exit(retval) else: - print "Error: call ./ping.py hostname" \ No newline at end of file + usage() + #sys.stderr.write("Error: call ./ping.py hostname\n") + sys.exit(1) From f2016076fc96015d422d557b2bf9641aa56af24d Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Fri, 12 Jul 2013 11:26:00 -0700 Subject: [PATCH 02/22] Changing exceptions to work with older versions of python (2.2 or newer) --- ping.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ping.py b/ping.py index d0ac5b3..5b0f105 100755 --- a/ping.py +++ b/ping.py @@ -344,7 +344,7 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet self.stats.destination_ip = info[4][0] else: self.stats.destination_ip = socket.gethostbyname(self.stats.destination_host) - except socket.error as e: + except socket.error, e: self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % (self.stats.destination_host, e.args[1])) #sys.exit(2) self.unknown_host = True @@ -366,7 +366,7 @@ def do_one(self): current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) else: current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) - except socket.error as e: + except socket.error, e: # if e.args[0] == 1: # # Operation not permitted - Add more information to traceback # etype, evalue, etb = sys.exc_info() @@ -486,7 +486,7 @@ def send_one_ping(self, current_socket): current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port, 0, 0)) else: current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port)) - except socket.error as e: + except socket.error, e: self._stderr.write("General failure (%s)\n" % (e.args[1])) send_time = None From fdfd19c149e15c6f9863637575fc5ba6cb2c4d90 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Mon, 15 Jul 2013 13:13:15 -0700 Subject: [PATCH 03/22] Adding a CLI using argparse (requires 2.7 or higher) --- ping.py | 80 +++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 50 insertions(+), 30 deletions(-) diff --git a/ping.py b/ping.py index 5b0f105..2cf6c84 100755 --- a/ping.py +++ b/ping.py @@ -652,13 +652,8 @@ def run(self, count=None, deadline=None): #=============================================================================# -def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False): - p = Ping(hostname, timeout, packet_size, own_id, quiet) - stats = p.run(count) - return(not stats.packets_received) - -def ping6(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False): - p = Ping(hostname, timeout, packet_size, own_id, quiet, True) +def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False, ipv6=False): + p = Ping(hostname, timeout, packet_size, own_id, quiet, ipv6) stats = p.run(count) return(not stats.packets_received) @@ -671,32 +666,57 @@ def usage(): sys.stderr.write(usage_message) #=============================================================================# -if __name__ == '__main__': - # FIXME: Add a real CLI - if len(sys.argv) == 1: +def run_tests(): + # These should work: + ping("8.8.8.8") + ping("heise.de") + ping("google.com") - # These should work: - ping("8.8.8.8") - ping("heise.de") - ping("google.com") + # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly + # to the local host, but 2.7 tries to resolve to the local *gateway*) + ping("localhost") - # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly - # to the local host, but 2.7 tries to resolve to the local *gateway*) - ping("localhost") + # Should fail with 'getaddrinfo failed': + ping("foobar_url.foobar") - # Should fail with 'getaddrinfo failed': - ping("foobar_url.foobar") + # Should fail (timeout), but it depends on the local network: + ping("192.168.255.254") - # Should fail (timeout), but it depends on the local network: - ping("192.168.255.254") + # Should fails with 'The requested address is not valid in its context': + ping("0.0.0.0") + + +#=============================================================================# +def main(arguments): + import argparse + + parser = argparse.ArgumentParser(description='Send ICMP ECHO_REQUEST to network hosts') + parser.add_argument('destination', type=str, + help='destination') + parser.add_argument('--test', action="store_true", help='Run a basic test suite') + parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output.') + parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') + parser.add_argument('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') + parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') + parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') + + args = parser.parse_args() - # Should fails with 'The requested address is not valid in its context': - ping("0.0.0.0") - sys.exit(1) - elif len(sys.argv) == 2: - retval = ping(sys.argv[1]) - sys.exit(retval) - else: - usage() - #sys.stderr.write("Error: call ./ping.py hostname\n") + if args.test: + run_tests() sys.exit(1) + + retval = ping(hostname=args.destination, + count=args.count, + timeout=args.timeout, + packet_size=args.packetsize, + own_id=None, + quiet=args.quiet, + ipv6=args.ipv6 + ) + sys.exit(retval) + + +#=============================================================================# +if __name__ == '__main__': + main(sys.argv) From c9f5cf9eefe5a827907e876c74ae726be03cf865 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Mon, 15 Jul 2013 13:16:17 -0700 Subject: [PATCH 04/22] Changing quiet functionality to match iputil/ping. Displays summary lines, even if quiet output. --- ping.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ping.py b/ping.py index 2cf6c84..a651715 100755 --- a/ping.py +++ b/ping.py @@ -351,7 +351,7 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet return # Print opening line - self._stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % (self.stats.destination_host, self.stats.destination_ip, self.packet_size)) + sys.stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % (self.stats.destination_host, self.stats.destination_ip, self.packet_size)) #=============================================================================# def do_one(self): @@ -581,17 +581,17 @@ def calculate_packet_average(self): #=============================================================================# def print_stats(self): - self._stdout.write("\n--- %s PYTHON PING statistics ---\n" % (self.stats.destination_host)) + sys.stdout.write("\n--- %s PYTHON PING statistics ---\n" % (self.stats.destination_host)) self.calculate_packet_loss() - self._stdout.write("%d packets transmitted, %d received, %0.1f%% packet loss, time %dms\n" % ( + sys.stdout.write("%d packets transmitted, %d received, %0.1f%% packet loss, time %dms\n" % ( self.stats.packets_sent, self.stats.packets_received, self.stats.lost_rate, self.stats.total_time )) if self.stats.packets_received > 0: self.calculate_packet_average() - self._stdout.write("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f\n" % ( + sys.stdout.write("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f\n" % ( self.stats.min_time, self.stats.average_time, self.stats.max_time)) #=============================================================================# @@ -694,7 +694,7 @@ def main(arguments): parser.add_argument('destination', type=str, help='destination') parser.add_argument('--test', action="store_true", help='Run a basic test suite') - parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output.') + parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') parser.add_argument('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') From 77f70d371e07a928c0175bb53d7abb20607d6f78 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 16 Jul 2013 13:31:33 -0700 Subject: [PATCH 05/22] Adding both OptionParser (depricated) and argparse for parsing the command line arguments. --- ping.py | 43 +++++++++++++++++++++++++++++++------------ 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/ping.py b/ping.py index a651715..fcada8a 100755 --- a/ping.py +++ b/ping.py @@ -688,19 +688,38 @@ def run_tests(): #=============================================================================# def main(arguments): - import argparse - - parser = argparse.ArgumentParser(description='Send ICMP ECHO_REQUEST to network hosts') - parser.add_argument('destination', type=str, - help='destination') - parser.add_argument('--test', action="store_true", help='Run a basic test suite') - parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') - parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') - parser.add_argument('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') - parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') - parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') - args = parser.parse_args() + # There is some duplication in trying to not break for older versions. + # OptionParser is still present in current versions, but it is deprecated, + # in favor of argparse. + try: + import argparse + + parser = argparse.ArgumentParser(description='Send ICMP ECHO_REQUEST to network hosts') + parser.add_argument('destination', type=str, help='destination') + parser.add_argument('--test', action="store_true", help='Run a basic test suite') + parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') + parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') + parser.add_argument('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') + parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') + parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') + + args = parser.parse_args() + except ImportError, evalue: + from optparse import OptionParser + + parser = OptionParser(description='Send ICMP ECHO_REQUEST to network hosts') + parser.add_option('--test', action="store_true", help='Run a basic test suite') + parser.add_option('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') + parser.add_option('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') + parser.add_option('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') + parser.add_option('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') + parser.add_option('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') + + (args, positional_args) = parser.parse_args() + + # Add the destination to this object to match argparse.parse_args() output + args.destination = positional_args[0] if args.test: run_tests() From 4e761ea99582ac1699c7965d149ce16e6b62f0ac Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 16 Jul 2013 13:35:11 -0700 Subject: [PATCH 06/22] Changing 'except' calls to work with 2.x and 3.x --- ping.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/ping.py b/ping.py index fcada8a..16dff4e 100755 --- a/ping.py +++ b/ping.py @@ -344,8 +344,9 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet self.stats.destination_ip = info[4][0] else: self.stats.destination_ip = socket.gethostbyname(self.stats.destination_host) - except socket.error, e: - self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % (self.stats.destination_host, e.args[1])) + except socket.error: + etype, evalue, etb = sys.exc_info() + self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % (self.stats.destination_host, evalue.args[1])) #sys.exit(2) self.unknown_host = True return @@ -366,7 +367,8 @@ def do_one(self): current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) else: current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) - except socket.error, e: + except socket.error: + etype, evalue, etb = sys.exc_info() # if e.args[0] == 1: # # Operation not permitted - Add more information to traceback # etype, evalue, etb = sys.exc_info() @@ -374,7 +376,7 @@ def do_one(self): # "%s - Note that ICMP messages can only be send from processes running as root." % evalue # ) # raise etype, evalue, etb - self._stderr.write("failed. (socket error: '%s')\n" % e.args[1]) + self._stderr.write("failed. (socket error: '%s')\n" % evalue.args[1]) raise # raise the original error send_time = self.send_one_ping(current_socket) @@ -486,8 +488,9 @@ def send_one_ping(self, current_socket): current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port, 0, 0)) else: current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port)) - except socket.error, e: - self._stderr.write("General failure (%s)\n" % (e.args[1])) + except socket.error: + etype, evalue, etb = sys.exc_info() + self._stderr.write("General failure (%s)\n" % (evalue.args[1])) send_time = None return send_time @@ -705,7 +708,7 @@ def main(arguments): parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') args = parser.parse_args() - except ImportError, evalue: + except ImportError: from optparse import OptionParser parser = OptionParser(description='Send ICMP ECHO_REQUEST to network hosts') From 5f03717ee83c764cafbe17148f0dbc7d4378c71d Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Fri, 9 Aug 2013 13:05:29 -0700 Subject: [PATCH 07/22] Making PEP8 compliant --- ping.py | 403 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 233 insertions(+), 170 deletions(-) diff --git a/ping.py b/ping.py index 16dff4e..1c52698 100755 --- a/ping.py +++ b/ping.py @@ -69,9 +69,9 @@ * Adding quiet_ping function - This way we'll be able to use this script as external lib. * Changing default timeout to 3s. (1second is not enought) - * Switching data syze to packet size. It's easyer for the user to ignore the - fact that the packet headr is 8b and the datasize 64 will make packet with - size 72. + * Switching data syze to packet size. It's easyer for the user to ignore + the fact that the packet headr is 8b and the datasize 64 will make + packet with size 72. October 12, 2011 -------------- @@ -202,7 +202,13 @@ """ #=============================================================================# -import os, sys, socket, struct, select, time, signal +import os +import sys +import socket +import struct +import select +import time +import signal from icmp_messages import * if sys.platform == "win32": @@ -215,13 +221,13 @@ #=============================================================================# # ICMP parameters -ICMP_ECHOREPLY = 0 # Echo reply (per RFC792) -ICMP_ECHO = 8 # Echo request (per RFC792) -ICMP_ECHO_IPV6 = 128 # Echo request (per RFC4443) -ICMP_ECHO_IPV6_REPLY = 129 # Echo request (per RFC4443) -ICMP_PORT = 1 -ICMP_PORT_IPV6 = 58 -ICMP_MAX_RECV = 2048 # Max size of incoming buffer +ICMP_ECHOREPLY = 0 # Echo reply (per RFC792) +ICMP_ECHO = 8 # Echo request (per RFC792) +ICMP_ECHO_IPV6 = 128 # Echo request (per RFC4443) +ICMP_ECHO_IPV6_REPLY = 129 # Echo request (per RFC4443) +ICMP_PORT = 1 +ICMP_PORT_IPV6 = 58 +ICMP_MAX_RECV = 2048 # Max size of incoming buffer MAX_SLEEP = 1000 @@ -235,23 +241,26 @@ # totTime = 0 # avrgTime = 0 # fracLoss = 1.0 -# +# # myStats = MyStats # NOT Used globally anymore. -# # +# + class PingStats: - destination_ip = "0.0.0.0" + destination_ip = "0.0.0.0" destination_host = "unknown" destination_port = 0 - packets_sent = 0 + packets_sent = 0 packets_received = 0 - min_time = 999999999 - max_time = 0 - total_time = 0 - average_time = 0 + min_time = 999999999 + max_time = 0 + total_time = 0 + average_time = 0 #=============================================================================# + + def calculate_checksum(source_string): """ A port of the functionality of in_cksum() from ping.c @@ -259,8 +268,8 @@ def calculate_checksum(source_string): packed), but this works. Network data is big-endian, hosts are typically little-endian """ - countTo = (int(len(source_string)/2))*2 - sum = 0 + countTo = (int(len(source_string) / 2)) * 2 + my_sum = 0 count = 0 # Handle bytes in pairs (decoding as short ints) @@ -274,54 +283,57 @@ def calculate_checksum(source_string): loByte = source_string[count + 1] hiByte = source_string[count] try: # For Python3 - sum = sum + (hiByte * 256 + loByte) + my_sum = my_sum + (hiByte * 256 + loByte) except: # For Python2 - sum = sum + (ord(hiByte) * 256 + ord(loByte)) + my_sum = my_sum + (ord(hiByte) * 256 + ord(loByte)) count += 2 # Handle last byte if applicable (odd-number of bytes) # Endianness should be irrelevant in this case - if countTo < len(source_string): # Check for odd length - loByte = source_string[len(source_string)-1] + if countTo < len(source_string): # Check for odd length + loByte = source_string[len(source_string) - 1] try: # For Python3 - sum += loByte + my_sum += loByte except: # For Python2 - sum += ord(loByte) + my_sum += ord(loByte) - sum &= 0xffffffff # Truncate sum to 32 bits (a variance from ping.c, which - # uses signed ints, but overflow is unlikely in ping) + my_sum &= 0xffffffff # Truncate sum to 32 bits (a variance from ping.c, + # which uses signed ints, but overflow is unlikely + # in ping) - sum = (sum >> 16) + (sum & 0xffff) # Add high 16 bits to low 16 bits - sum += (sum >> 16) # Add carry from above (if any) - answer = ~sum & 0xffff # Invert and truncate to 16 bits + my_sum = (my_sum >> 16) + (my_sum & 0xffff) # Add high 16 and low 16 bits + my_sum += (my_sum >> 16) # Add carry from above (if any) + answer = ~my_sum & 0xffff # Invert & truncate to 16 bits answer = socket.htons(answer) return answer #=============================================================================# + class Ping(object): - def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet=False, ipv6=False): + def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, + quiet=False, ipv6=False): self.stats = PingStats # Statistics - self.stats.destination_ip = "0.0.0.0" + self.stats.destination_ip = "0.0.0.0" self.stats.destination_host = destination self.stats.destination_port = ICMP_PORT - self.stats.packets_sent = 0 + self.stats.packets_sent = 0 self.stats.packets_received = 0 - self.stats.lost_rate = 100.0 - self.stats.min_time = 999999999 - self.stats.max_time = 0 - self.stats.total_time = 0 - self.stats.average_time = 0.0 - + self.stats.lost_rate = 100.0 + self.stats.min_time = 999999999 + self.stats.max_time = 0 + self.stats.total_time = 0 + self.stats.average_time = 0.0 + # Parameters - self.ipv6 = ipv6 - self.timeout = timeout - self.packet_size = packet_size - 8 - self.sequence_number = 0 - self.unknown_host = False - + self.ipv6 = ipv6 + self.timeout = timeout + self.packet_size = packet_size - 8 + self.sequence_number = 0 + self.unknown_host = False + if own_id is None: self.own_id = os.getpid() & 0xFFFF else: @@ -343,56 +355,60 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, quiet info = socket.getaddrinfo(self.stats.destination_host, None)[0] self.stats.destination_ip = info[4][0] else: - self.stats.destination_ip = socket.gethostbyname(self.stats.destination_host) + self.stats.destination_ip = \ + socket.gethostbyname(self.stats.destination_host) except socket.error: etype, evalue, etb = sys.exc_info() - self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % (self.stats.destination_host, evalue.args[1])) + self._stderr.write("\nPYTHON PING: Unknown host: %s (%s)\n" % + (self.stats.destination_host, evalue.args[1])) #sys.exit(2) self.unknown_host = True return - + # Print opening line - sys.stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % (self.stats.destination_host, self.stats.destination_ip, self.packet_size)) + sys.stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % + (self.stats.destination_host, + self.stats.destination_ip, + self.packet_size)) #=============================================================================# def do_one(self): """ Returns either the delay (in ms) or None on timeout. """ - delay = None - + delay = None + try: # One could use UDP here, but it's obscure if self.ipv6: - current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) + current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, + socket.getprotobyname("ipv6-icmp")) else: - current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) + current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, + socket.getprotobyname("icmp")) except socket.error: etype, evalue, etb = sys.exc_info() -# if e.args[0] == 1: -# # Operation not permitted - Add more information to traceback -# etype, evalue, etb = sys.exc_info() -# evalue = etype( -# "%s - Note that ICMP messages can only be send from processes running as root." % evalue -# ) -# raise etype, evalue, etb - self._stderr.write("failed. (socket error: '%s')\n" % evalue.args[1]) - raise # raise the original error - + evalue = etype(""" +%s - Note that ICMP messages can only be send from processes running as root. +""" % evalue + ) + raise etype, evalue, etb + send_time = self.send_one_ping(current_socket) - if send_time == None: + #if send_time == None: + if send_time is None: current_socket.close() return delay self.stats.packets_sent += 1 - - receive_time, packet_size, ip_header, icmp_header = self.receive_one_ping(current_socket) + + receive_time, packet_size, ip_header, icmp_header = \ + self.receive_one_ping(current_socket) current_socket.close() icmp_seq_number = icmp_header["seq_number"] - icmp_type = icmp_header["type"] - icmp_code = icmp_header["code"] - - + icmp_type = icmp_header["type"] + icmp_code = icmp_header["code"] + if self.ipv6: host_addr = self.stats.destination_host else: @@ -404,16 +420,17 @@ def do_one(self): from_info = self.stats.destination_host else: from_info = "%s (%s)" % (self.stats.destination_host, host_addr) - + if receive_time: - - iph_src_ip = ip_header["src_ip"] - ip_header_ttl = ip_header["ttl"] - - delay = (receive_time-send_time) * 1000.0 - - self._stdout.write("%d bytes from %s: icmp_seq=%d ttl=%d time=%0.3f ms\n" % (packet_size, from_info, icmp_seq_number, ip_header_ttl, delay)) - + ip_header_ttl = ip_header["ttl"] + + delay = (receive_time - send_time) * 1000.0 + + self._stdout.write( + "%d bytes from %s: icmp_seq=%d ttl=%d time=%0.3f ms\n" % + (packet_size, from_info, icmp_seq_number, + ip_header_ttl, delay)) + self.stats.packets_received += 1 self.stats.total_time += delay if self.stats.min_time > delay: @@ -423,9 +440,10 @@ def do_one(self): else: imcp_message = ICMP_CONTROL_MESSAGE[icmp_type][icmp_code] delay = None - self._stdout.write("From %s: icmp_seq=%d %s\n" % (self.stats.destination_ip, icmp_seq_number, imcp_message)) + self._stdout.write("From %s: icmp_seq=%d %s\n" % + (self.stats.destination_ip, icmp_seq_number, imcp_message)) #self._stdout.write("Request timed out.\n") - + return delay #=============================================================================# @@ -433,66 +451,70 @@ def send_one_ping(self, current_socket): """ Send one ping to the given >destIP<. """ - + # Header is type (8), code (8), checksum (16), id (16), sequence (16) # (numDataBytes - 8) - Remove header size from packet size checksum = 0 - + # Make a dummy heder with a 0 checksum. if self.ipv6: header = struct.pack( - "!BbHHh", ICMP_ECHO_IPV6, 0, checksum, self.own_id, self.sequence_number + "!BbHHh", ICMP_ECHO_IPV6, 0, checksum, + self.own_id, self.sequence_number ) else: header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.sequence_number + "!BBHHH", ICMP_ECHO, 0, checksum, + self.own_id, self.sequence_number ) - + pad_bytes = [] start_val = 0x42 # 'cose of the string/byte changes in python 2/3 we have # to build the data differnely for different version # or it will make packets with unexpected size. if sys.version[:1] == '2': - bytes = struct.calcsize("d") - data = ((self.packet_size) - bytes) * "Q" + byte = struct.calcsize("d") + data = ((self.packet_size) - byte) * "Q" data = struct.pack("d", default_timer()) + data else: for i in range(start_val, start_val + (self.packet_size)): pad_bytes += [(i & 0xff)] # Keep chars in the 0-255 range #data = bytes(pad_bytes) data = bytearray(pad_bytes) - - - + # Calculate the checksum on the data and the dummy header. - checksum = calculate_checksum(header + data) # Checksum is in network order - + # Checksum is in network order + checksum = calculate_checksum(header + data) + # Now that we have the right checksum, we put that in. It's just easier # to make up a new header than to stuff it into the dummy. if self.ipv6: - header = struct.pack( - "!BbHHh", ICMP_ECHO_IPV6, 0, checksum, self.own_id, self.sequence_number - ) + header = struct.pack("!BbHHh", ICMP_ECHO_IPV6, 0, checksum, + self.own_id, self.sequence_number + ) else: - header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.sequence_number - ) - + header = struct.pack("!BBHHH", ICMP_ECHO, 0, checksum, + self.own_id, self.sequence_number + ) + packet = header + data - + send_time = default_timer() - + try: if self.ipv6: - current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port, 0, 0)) + current_socket.sendto(packet, (self.stats.destination_ip, + self.stats.destination_port, + 0, 0)) else: - current_socket.sendto(packet, (self.stats.destination_ip, self.stats.destination_port)) + current_socket.sendto(packet, (self.stats.destination_ip, + self.stats.destination_port)) except socket.error: etype, evalue, etb = sys.exc_info() self._stderr.write("General failure (%s)\n" % (evalue.args[1])) send_time = None - + return send_time #=============================================================================# @@ -501,21 +523,21 @@ def receive_one_ping(self, current_socket): Receive the ping from the socket. Timeout = in ms """ time_left = self.timeout / 1000.0 - - while True: # Loop while waiting for packet or timeout + + while True: # Loop while waiting for packet or timeout select_start = default_timer() what_ready = select.select([current_socket], [], [], time_left) select_duration = (default_timer() - select_start) - + time_received = default_timer() - + packet_data, addr = current_socket.recvfrom(ICMP_MAX_RECV) - + if self.ipv6: icmp_header_raw = packet_data[0:8] else: icmp_header_raw = packet_data[20:28] - + icmp_header = self.header2dict( names=[ "type", "code", "checksum", @@ -524,10 +546,10 @@ def receive_one_ping(self, current_socket): struct_format="!BBHHH", data=icmp_header_raw ) - + ip_header = None # TODO: Still need to work on IPv6 Headers - if icmp_header["packet_id"] == self.own_id: # Our packet + if icmp_header["packet_id"] == self.own_id: # Our packet if self.ipv6: ip_header = self.header2dict( names=[ @@ -542,8 +564,8 @@ def receive_one_ping(self, current_socket): #struct_format="!BBHHBBQQQQ", #data=packet_data[:40] ) - #ip_header['src_ip'] = ip_header['src_ip_a'] + ip_header['src_ip_b'] - #ip_header['dest_ip'] = ip_header['dest_ip_a'] + ip_header['dest_ip_b'] +#ip_header['src_ip'] = ip_header['src_ip_a'] + ip_header['src_ip_b'] +#ip_header['dest_ip'] = ip_header['dest_ip_a'] + ip_header['dest_ip_b'] else: ip_header = self.header2dict( names=[ @@ -555,55 +577,64 @@ def receive_one_ping(self, current_socket): data=packet_data[:20] ) - if what_ready[0] == []: # Timeout + if what_ready[0] == []: # Timeout return None, 0, ip_header, icmp_header - if icmp_header["packet_id"] == self.own_id: # Our packet + if icmp_header["packet_id"] == self.own_id: # Our packet data_size = len(packet_data) - 28 - return time_received, (data_size+8), ip_header, icmp_header - + return time_received, (data_size + 8), ip_header, icmp_header + time_left = time_left - select_duration if time_left <= 0: return None, 0, ip_header, icmp_header #=============================================================================# - + def calculate_packet_loss(self): if self.stats.packets_sent: lost_count = self.stats.packets_sent - self.stats.packets_received - self.stats.lost_rate = float(lost_count) / self.stats.packets_sent * 100.0 + self.stats.lost_rate = \ + float(lost_count) / self.stats.packets_sent * 100.0 else: self.stats.lost_rate = 100.0 - + def calculate_packet_average(self): if self.stats.packets_received: - self.stats.average_time = self.stats.total_time / self.stats.packets_received + self.stats.average_time = \ + self.stats.total_time / self.stats.packets_received else: self.stats.average_time = 0.0 - + #=============================================================================# - + def print_stats(self): - sys.stdout.write("\n--- %s PYTHON PING statistics ---\n" % (self.stats.destination_host)) + sys.stdout.write("\n--- %s PYTHON PING statistics ---\n" % + (self.stats.destination_host)) self.calculate_packet_loss() - sys.stdout.write("%d packets transmitted, %d received, %0.1f%% packet loss, time %dms\n" % ( - self.stats.packets_sent, self.stats.packets_received, self.stats.lost_rate, self.stats.total_time + sys.stdout.write( +"%d packets transmitted, %d received, %0.1f%% packet loss, time %dms\n" % ( + self.stats.packets_sent, self.stats.packets_received, + self.stats.lost_rate, self.stats.total_time )) if self.stats.packets_received > 0: self.calculate_packet_average() - sys.stdout.write("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f\n" % ( - self.stats.min_time, self.stats.average_time, self.stats.max_time)) - + sys.stdout.write( + "round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f\n" % ( + self.stats.min_time, self.stats.average_time, + self.stats.max_time)) + #=============================================================================# def header2dict(self, names, struct_format, data): - """ unpack the raw received IP and ICMP header informations to a dict """ + """ + unpack the raw received IP and ICMP header informations to a dict + """ unpacked_data = struct.unpack(struct_format, data) - return dict(zip(names, unpacked_data)) - + return dict(list(zip(names, unpacked_data))) + #=============================================================================# def signal_handler(self, signum, frame): @@ -618,7 +649,7 @@ def signal_handler(self, signum, frame): def setup_signal_handler(self): signal.signal(signal.SIGINT, self.signal_handler) # Handle Ctrl-C if hasattr(signal, "SIGBREAK"): - # Handle Ctrl-Break e.g. under Windows + # Handle Ctrl-Break e.g. under Windows signal.signal(signal.SIGBREAK, self.signal_handler) #=============================================================================# @@ -632,7 +663,7 @@ def run(self, count=None, deadline=None): while True: if self.unknown_host: return self.stats - + delay = self.do_one() self.sequence_number += 1 @@ -641,34 +672,39 @@ def run(self, count=None, deadline=None): if deadline and self.stats.total_time >= deadline: break - if delay == None: + #if delay == None: + if delay is None: delay = 0 # Pause for the remainder of the MAX_SLEEP period (if applicable) if (MAX_SLEEP > delay): time.sleep((MAX_SLEEP - delay) / 1000.0) - self.calculate_packet_loss() self.print_stats() return self.stats - + #=============================================================================# - -def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, quiet=False, ipv6=False): + + +def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, + quiet=False, ipv6=False): p = Ping(hostname, timeout, packet_size, own_id, quiet, ipv6) stats = p.run(count) return(not stats.packets_received) - + #=============================================================================# + def usage(): usage_message = """\ Usage: %s hostname """ % (sys.argv[0]) sys.stderr.write(usage_message) - + #=============================================================================# + + def run_tests(): # These should work: ping("8.8.8.8") @@ -687,47 +723,74 @@ def run_tests(): # Should fails with 'The requested address is not valid in its context': ping("0.0.0.0") - - + + #=============================================================================# + + def main(arguments): - + # There is some duplication in trying to not break for older versions. # OptionParser is still present in current versions, but it is deprecated, # in favor of argparse. try: import argparse - parser = argparse.ArgumentParser(description='Send ICMP ECHO_REQUEST to network hosts') - parser.add_argument('destination', type=str, help='destination') - parser.add_argument('--test', action="store_true", help='Run a basic test suite') - parser.add_argument('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') - parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') - parser.add_argument('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') - parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') - parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') - + parser = argparse.ArgumentParser( + description='Send ICMP ECHO_REQUEST to network hosts') + parser.add_argument('destination', type=str, + help='destination') + parser.add_argument('--test', action="store_true", + help='Run a basic test suite') + parser.add_argument('-q', '--quiet', action="store_true", + help='Quiet output. Nothing is displayed except the summary lines ' + 'at startup time and when finished.') + parser.add_argument('--ipv6', action="store_true", + help='Run using IPv6, instead of the default (IPv4)') + parser.add_argument('-c', dest='count', metavar='count', type=int, + default=3, help='Stop after sending count ECHO_REQUEST packets.') + parser.add_argument('-s', dest='packetsize', metavar='packetsize', + type=int, default=64, + help='Specifies the number of data bytes to be sent. The default ' + 'is 56, which translates into 64 ICMP data bytes when' + 'combined with the 8 bytes of ICMP header data.') + parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, + default=3, + help='Time to wait for a response, in seconds.') + args = parser.parse_args() except ImportError: from optparse import OptionParser - - parser = OptionParser(description='Send ICMP ECHO_REQUEST to network hosts') - parser.add_option('--test', action="store_true", help='Run a basic test suite') - parser.add_option('-q', '--quiet', action="store_true", help='Quiet output. Nothing is displayed except the summary lines at startup time and when finished.') - parser.add_option('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') - parser.add_option('-c', dest='count', metavar='count', type=int, default=3, help='Stop after sending count ECHO_REQUEST packets.') - parser.add_option('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.') - parser.add_option('-W', dest='timeout', metavar='timeout', type=int, default=3, help='Time to wait for a response, in seconds.') - + + parser = OptionParser( + description='Send ICMP ECHO_REQUEST to network hosts') + parser.add_option('--test', action="store_true", + help='Run a basic test suite') + parser.add_option('-q', '--quiet', action="store_true", + help='Quiet output. Nothing is displayed except the summary lines ' + 'at startup time and when finished.') + parser.add_option('--ipv6', action="store_true", + help='Run using IPv6, instead of the default (IPv4)') + parser.add_option('-c', dest='count', metavar='count', type=int, + default=3, help='Stop after sending count ECHO_REQUEST packets.') + parser.add_option('-s', dest='packetsize', metavar='packetsize', + type=int, default=64, + help='Specifies the number of data bytes to be sent. The default ' + 'is 56, which translates into 64 ICMP data bytes when ' + 'combined with the 8 bytes of ICMP header data.') + parser.add_option('-W', dest='timeout', metavar='timeout', type=int, + default=3, + help='Time to wait for a response, in seconds.') + (args, positional_args) = parser.parse_args() - - # Add the destination to this object to match argparse.parse_args() output + + # Add destination to this object to match argparse.parse_args() output args.destination = positional_args[0] if args.test: run_tests() sys.exit(1) - + retval = ping(hostname=args.destination, count=args.count, timeout=args.timeout, @@ -738,7 +801,7 @@ def main(arguments): ) sys.exit(retval) - + #=============================================================================# if __name__ == '__main__': main(sys.argv) From 00a6c5f4f3a6df25062a2498d48a4cdfb9ef1b0e Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Fri, 9 Aug 2013 15:47:48 -0700 Subject: [PATCH 08/22] More pep8 updates (shortening line lengths) --- icmp_messages.py | 200 +++++++++++++++++++++++------------------------ ping.py | 19 +++-- setup.py | 23 +++--- tests.py | 7 +- 4 files changed, 128 insertions(+), 121 deletions(-) diff --git a/icmp_messages.py b/icmp_messages.py index e1acc26..cf4e46d 100755 --- a/icmp_messages.py +++ b/icmp_messages.py @@ -1,100 +1,100 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" - ICMP Control Messages - https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages - ICMP Types 0, 3, 4, 5, 8, 11, 12, 13, 14 from RFC792 - ICMP Types 9, 11 from RFC1256 -""" -ICMP_CONTROL_MESSAGE = \ - {0: {0: 'Echo reply', - }, - 3: {0: 'Destination network unreachable', - 1: 'Destination host unreachable', - 2: 'Destination protocol unreachable', - 3: 'Destination port unreachable', - 4: 'Fragmentation required, and DF flag set', - 5: 'Source route failed', - 6: 'Destination network unknown', - 7: 'Destination host unknown', - 8: 'Source host isolated', - 9: 'Network administratively prohibited', - 10: 'Host administratively prohibited', - 11: 'Network unreachable for TOS', - 12: 'Host unreachable for TOS', - 13: 'Communication administratively prohibited', - 14: 'Host Precedence Violation', - 15: 'Precedence cutoff in effect', - }, - 4: {0: 'Source quench', - }, - 5: {0: 'Redirect Datagram for the Network', - 1: 'Redirect Datagram for the Host', - 2: 'Redirect Datagram for the TOS & network', - 3: 'Redirect Datagram for the TOS & host', - }, - 8: {0: 'Echo request', - }, - 9: {0: 'Router Advertisement', - }, - 10:{0: 'Router discovery/selection/solicitation', - }, - 11:{0: 'TTL expired in transit', - 1: 'Fragment reassembly time exceeded', - }, - 12:{0: 'Pointer indicates the error', - 1: 'Missing a required option', - 2: 'Bad length', - }, - 13:{0: 'Timestamp', - }, - 14:{0: 'Timestamp reply', - }, - } - - -""" - ICMPv6 Control Messages - https://en.wikipedia.org/wiki/ICMPv6#Types_of_ICMPv6_messages - ICMPv6 Types 0-127 are Error Messages - ICMPv6 Types 128-255 are Informational Messages -""" -ICMPv6_CONTROL_MESSAGE = \ - {1: {0: 'no route to destination', - 1: 'communication with destination administratively prohibited', - 2: 'beyond scope of source address', - 3: 'address unreachable', - 4: 'port unreachable', - 5: 'source address failed ingress/egress policy', - 6: 'reject route to destination', - 7: 'Error in Source Routing Header', - }, - 2: {0: 'packet too big', - }, - 3: {0: 'hop limit exceeded in transit', - 1: 'fragment reassembly time exceeded', - }, - 4: {0: 'erroneous header field encountered', - 1: 'unrecognized Next Header type encountered', - 2: 'unrecognized IPv6 option encountered', - }, - } - -if __name__ == '__main__': - # Print all defined ICMP Control Messages - print("ICMP Control Messages") - print("Type\tCode:\tMessage") - for (type, codes) in ICMP_CONTROL_MESSAGE.iteritems(): - print("") - for (code, message) in codes.iteritems(): - print("[%d]\t[%d]:\t%s" % (type, code, message)) - print("") - - # Print all defined ICMPv6 Control Messages - print("ICMPv6 Control Messages") - print("Type\tCode:\tMessage") - for (type, codes) in ICMPv6_CONTROL_MESSAGE.iteritems(): - print("") - for (code, message) in codes.iteritems(): - print("[%d]\t[%d]:\t%s" % (type, code, message)) \ No newline at end of file +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +ICMP Control Messages +http://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages +ICMP Types 0, 3, 4, 5, 8, 11, 12, 13, 14 from RFC792 +ICMP Types 9, 11 from RFC1256 +""" +ICMP_CONTROL_MESSAGE = \ + {0: {0: 'Echo Reply', + }, + 3: {0: 'Net Unreachable', + 1: 'Host Unreachable', + 2: 'Destination protocol unreachable', + 3: 'Destination port unreachable', + 4: 'Fragmentation required, and DF flag set', + 5: 'Source route failed', + 6: 'Destination network unknown', + 7: 'Destination host unknown', + 8: 'Source host isolated', + 9: 'Network administratively prohibited', + 10: 'Host administratively prohibited', + 11: 'Network unreachable for TOS', + 12: 'Host unreachable for TOS', + 13: 'Communication administratively prohibited', + 14: 'Host Precedence Violation', + 15: 'Precedence cutoff in effect', + }, + 4: {0: 'Source quench', + }, + 5: {0: 'Redirect Datagram for the Network', + 1: 'Redirect Datagram for the Host', + 2: 'Redirect Datagram for the TOS & network', + 3: 'Redirect Datagram for the TOS & host', + }, + 8: {0: 'Echo request', + }, + 9: {0: 'Router Advertisement', + }, + 10: {0: 'Router discovery/selection/solicitation', + }, + 11: {0: 'TTL expired in transit', + 1: 'Fragment reassembly time exceeded', + }, + 12: {0: 'Pointer indicates the error', + 1: 'Missing a required option', + 2: 'Bad length', + }, + 13: {0: 'Timestamp', + }, + 14: {0: 'Timestamp reply', + }, + } + + +""" +ICMPv6 Control Messages +http://en.wikipedia.org/wiki/ICMPv6#Types_of_ICMPv6_messages +ICMPv6 Types 0-127 are Error Messages +ICMPv6 Types 128-255 are Informational Messages +""" +ICMPv6_CONTROL_MESSAGE = \ + {1: {0: 'no route to destination', + 1: 'communication with destination administratively prohibited', + 2: 'beyond scope of source address', + 3: 'address unreachable', + 4: 'port unreachable', + 5: 'source address failed ingress/egress policy', + 6: 'reject route to destination', + 7: 'Error in Source Routing Header', + }, + 2: {0: 'packet too big', + }, + 3: {0: 'hop limit exceeded in transit', + 1: 'fragment reassembly time exceeded', + }, + 4: {0: 'erroneous header field encountered', + 1: 'unrecognized Next Header type encountered', + 2: 'unrecognized IPv6 option encountered', + }, + } + +if __name__ == '__main__': + # Print all defined ICMP Control Messages + print("ICMP Control Messages") + print("Type\tCode:\tMessage") + for (type, codes) in list(ICMP_CONTROL_MESSAGE.items()): + print("") + for (code, message) in list(codes.items()): + print(("[%d]\t[%d]:\t%s" % (type, code, message))) + print("") + + # Print all defined ICMPv6 Control Messages + print("ICMPv6 Control Messages") + print("Type\tCode:\tMessage") + for (type, codes) in list(ICMPv6_CONTROL_MESSAGE.items()): + print("") + for (code, message) in list(codes.items()): + print(("[%d]\t[%d]:\t%s" % (type, code, message))) diff --git a/ping.py b/ping.py index 1c52698..f380136 100755 --- a/ping.py +++ b/ping.py @@ -302,7 +302,7 @@ def calculate_checksum(source_string): # in ping) my_sum = (my_sum >> 16) + (my_sum & 0xffff) # Add high 16 and low 16 bits - my_sum += (my_sum >> 16) # Add carry from above (if any) + my_sum += (my_sum >> 16) # Add carry from above, if any answer = ~my_sum & 0xffff # Invert & truncate to 16 bits answer = socket.htons(answer) @@ -381,10 +381,12 @@ def do_one(self): try: # One could use UDP here, but it's obscure if self.ipv6: - current_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, + current_socket = socket.socket(socket.AF_INET6, + socket.SOCK_RAW, socket.getprotobyname("ipv6-icmp")) else: - current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, + current_socket = socket.socket(socket.AF_INET, + socket.SOCK_RAW, socket.getprotobyname("icmp")) except socket.error: etype, evalue, etb = sys.exc_info() @@ -419,7 +421,8 @@ def do_one(self): if self.ipv6: from_info = self.stats.destination_host else: - from_info = "%s (%s)" % (self.stats.destination_host, host_addr) + from_info = "%s (%s)" % (self.stats.destination_host, + host_addr) if receive_time: ip_header_ttl = ip_header["ttl"] @@ -743,8 +746,8 @@ def main(arguments): parser.add_argument('--test', action="store_true", help='Run a basic test suite') parser.add_argument('-q', '--quiet', action="store_true", - help='Quiet output. Nothing is displayed except the summary lines ' - 'at startup time and when finished.') + help='Quiet output. Nothing is displayed except the summary ' + 'lines at startup time and when finished.') parser.add_argument('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') parser.add_argument('-c', dest='count', metavar='count', type=int, @@ -767,8 +770,8 @@ def main(arguments): parser.add_option('--test', action="store_true", help='Run a basic test suite') parser.add_option('-q', '--quiet', action="store_true", - help='Quiet output. Nothing is displayed except the summary lines ' - 'at startup time and when finished.') + help='Quiet output. Nothing is displayed except the summary ' + 'lines at startup time and when finished.') parser.add_option('--ipv6', action="store_true", help='Run using IPv6, instead of the default (IPv4)') parser.add_option('-c', dest='count', metavar='count', type=int, diff --git a/setup.py b/setup.py index a5ecc8c..e2bc6b4 100755 --- a/setup.py +++ b/setup.py @@ -24,11 +24,13 @@ #VERBOSE = True VERBOSE = False + def _error(msg): if VERBOSE: warnings.warn(msg) return "" + def get_version_from_git(): try: process = subprocess.Popen( @@ -37,7 +39,7 @@ def get_version_from_git(): shell=False, cwd=PACKAGE_ROOT, stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) - except Exception, err: + except Exception as err: return _error("Can't get git hash: %s" % err) process.wait() @@ -46,20 +48,20 @@ def get_version_from_git(): return _error( "Can't get git hash, returncode was: %r" " - git stdout: %r" - " - git stderr: %r" - % (returncode, process.stdout.readline(), process.stderr.readline()) + " - git stderr: %r" % + (returncode, process.stdout.readline(), process.stderr.readline()) ) output = process.stdout.readline().strip() try: raw_timestamp, hash = output.split("-", 1) timestamp = int(raw_timestamp) - except Exception, err: + except Exception as err: return _error("Error in git log output! Output was: %r" % output) try: timestamp_formatted = time.strftime("%Y.%m.%d", time.gmtime(timestamp)) - except Exception, err: + except Exception as err: return _error("can't convert %r to time string: %s" % (timestamp, err)) return "%s.%s" % (timestamp_formatted, hash) @@ -70,9 +72,12 @@ def get_version_from_git(): try: from creole.setup_utils import get_long_description except ImportError: - if "register" in sys.argv or "sdist" in sys.argv or "--long-description" in sys.argv: + if "register" in sys.argv \ + or "sdist" in sys.argv \ + or "--long-description" in sys.argv: etype, evalue, etb = sys.exc_info() - evalue = etype("%s - Please install python-creole >= v0.8 - e.g.: pip install python-creole" % evalue) + evalue = etype("%s - Please install python-creole >= v0.8 - " + "e.g.: pip install python-creole" % evalue) raise etype, evalue, etb long_description = None else: @@ -91,7 +96,7 @@ def get_authors(): authors.append(line.strip(" *\r\n")) f.close() authors.sort() - except Exception, err: + except Exception as err: authors = "[Error: %s]" % err return authors @@ -107,7 +112,7 @@ def get_authors(): url='https://github.com/jedie/python-ping/', keywords="ping icmp network latency", packages=find_packages(), - include_package_data=True, # include package data under svn source control + include_package_data=True, # include package data under svn source control zip_safe=False, scripts=["ping.py"], classifiers=[ diff --git a/tests.py b/tests.py index 74d6431..ba87d2a 100644 --- a/tests.py +++ b/tests.py @@ -4,12 +4,12 @@ """ python-ping unittests ~~~~~~~~~~~~~~~~~~~~~ - + Note that ICMP messages can only be send from processes running as root. So you must run this tests also as root, e.g.: - + .../python-ping$ sudo python tests.py - + :homepage: https://github.com/jedie/python-ping/ :copyleft: 1989-2011 by the python-ping team, see AUTHORS for more details. :license: GNU GPL v2, see LICENSE for more details. @@ -127,4 +127,3 @@ def test_run_failed_pings(self): if __name__ == '__main__': unittest.main() - From 26fb5993659bb94dfc5d36f26c9abb78fe434e74 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Fri, 9 Aug 2013 15:48:46 -0700 Subject: [PATCH 09/22] Making error a bit cleaner when not running as root --- ping.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/ping.py b/ping.py index f380136..d175d2d 100755 --- a/ping.py +++ b/ping.py @@ -390,11 +390,10 @@ def do_one(self): socket.getprotobyname("icmp")) except socket.error: etype, evalue, etb = sys.exc_info() - evalue = etype(""" -%s - Note that ICMP messages can only be send from processes running as root. -""" % evalue - ) - raise etype, evalue, etb + self._stderr.write("socket.error: %s\n" % evalue) + self._stderr.write("Note that ICMP messages can only be send " + "from processes running as root.\n") + sys.exit(3) send_time = self.send_one_ping(current_socket) #if send_time == None: From d9d1e3dbd143e1f82bab2a3e1c89e0e66f18e4aa Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Mon, 12 Aug 2013 13:56:08 -0700 Subject: [PATCH 10/22] Fixed test running syntax in parser. --- ping.py | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/ping.py b/ping.py index d175d2d..77d66dc 100755 --- a/ping.py +++ b/ping.py @@ -378,16 +378,17 @@ def do_one(self): """ delay = None + # One could use UDP here, but it's obscure + if self.ipv6: + sock_af = socket.AF_INET6 + sock_type = socket.SOCK_RAW + sock_protocol = socket.getprotobyname("ipv6-icmp") + else: + sock_af = socket.AF_INET + sock_type = socket.SOCK_RAW + sock_protocol = socket.getprotobyname("icmp") try: - # One could use UDP here, but it's obscure - if self.ipv6: - current_socket = socket.socket(socket.AF_INET6, - socket.SOCK_RAW, - socket.getprotobyname("ipv6-icmp")) - else: - current_socket = socket.socket(socket.AF_INET, - socket.SOCK_RAW, - socket.getprotobyname("icmp")) + current_socket = socket.socket(sock_af, sock_type, sock_protocol) except socket.error: etype, evalue, etb = sys.exc_info() self._stderr.write("socket.error: %s\n" % evalue) @@ -414,6 +415,7 @@ def do_one(self): host_addr = self.stats.destination_host else: host_addr = self.stats.destination_ip + if host_addr == self.stats.destination_host: from_info = host_addr else: @@ -699,9 +701,7 @@ def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, def usage(): - usage_message = """\ -Usage: %s hostname -""" % (sys.argv[0]) + usage_message = "Usage: %s hostname" % (sys.argv[0]) sys.stderr.write(usage_message) #=============================================================================# @@ -740,7 +740,7 @@ def main(arguments): parser = argparse.ArgumentParser( description='Send ICMP ECHO_REQUEST to network hosts') - parser.add_argument('destination', type=str, + parser.add_argument('destination', type=str, nargs='?', help='destination') parser.add_argument('--test', action="store_true", help='Run a basic test suite') @@ -787,12 +787,19 @@ def main(arguments): (args, positional_args) = parser.parse_args() # Add destination to this object to match argparse.parse_args() output - args.destination = positional_args[0] + if positional_args: + args.destination = positional_args[0] + else: + args.destination = False if args.test: run_tests() sys.exit(1) + if not args.destination: + parser.print_help() + sys.exit(1) + retval = ping(hostname=args.destination, count=args.count, timeout=args.timeout, From 09936f29da573f0b4c582fc54e0738ef84c6f856 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Mon, 12 Aug 2013 13:56:54 -0700 Subject: [PATCH 11/22] Adding ignore syntax for Ninja-IDE projects. --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 611e05b..a591243 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ /dist /build .pydevproject -/.settings \ No newline at end of file +/.settings +*.nja From 684379c71ef80e83490040f455bde2196b00aba9 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 08:47:46 -0700 Subject: [PATCH 12/22] Adding ICMPv6 control message --- ping.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ping.py b/ping.py index 77d66dc..667c4ce 100755 --- a/ping.py +++ b/ping.py @@ -209,7 +209,7 @@ import select import time import signal -from icmp_messages import * +from icmp_messages import ICMP_CONTROL_MESSAGE, ICMPv6_CONTROL_MESSAGE if sys.platform == "win32": # On Windows, the best timer is time.clock() @@ -442,7 +442,10 @@ def do_one(self): if self.stats.max_time < delay: self.stats.max_time = delay else: - imcp_message = ICMP_CONTROL_MESSAGE[icmp_type][icmp_code] + if self.ipv6: + imcp_message = ICMPv6_CONTROL_MESSAGE[icmp_type][icmp_code] + else: + imcp_message = ICMP_CONTROL_MESSAGE[icmp_type][icmp_code] delay = None self._stdout.write("From %s: icmp_seq=%d %s\n" % (self.stats.destination_ip, icmp_seq_number, imcp_message)) From 7e0fac7d2639012e07c8daad8c18616e8051d7ae Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 08:48:53 -0700 Subject: [PATCH 13/22] Adding 'silent' option (Slightly different than quiet). --- ping.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/ping.py b/ping.py index 667c4ce..69170d2 100755 --- a/ping.py +++ b/ping.py @@ -313,7 +313,7 @@ def calculate_checksum(source_string): class Ping(object): def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, - quiet=False, ipv6=False): + quiet=False, silent=False, ipv6=False): self.stats = PingStats # Statistics self.stats.destination_ip = "0.0.0.0" @@ -340,6 +340,11 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, self.own_id = own_id # Output Streams + if silent: + devnull = open(os.devnull, 'w') + sys.stdout = devnull + sys.stderr = devnull + if quiet: devnull = open(os.devnull, 'w') self._stdout = devnull @@ -695,8 +700,8 @@ def run(self, count=None, deadline=None): def ping(hostname, count=3, timeout=3000, packet_size=64, own_id=None, - quiet=False, ipv6=False): - p = Ping(hostname, timeout, packet_size, own_id, quiet, ipv6) + quiet=False, silent=False, ipv6=False): + p = Ping(hostname, timeout, packet_size, own_id, quiet, silent, ipv6) stats = p.run(count) return(not stats.packets_received) From 116c258f296100fc7b8181f82832dad760d0200d Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 08:51:08 -0700 Subject: [PATCH 14/22] Adding __init__.py --- __init__.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 __init__.py diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e69de29 From 84fd508c3814a7c5f0514e5fc6266ff30805ab09 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 09:01:53 -0700 Subject: [PATCH 15/22] Changing the way 'silent' is called --- ping.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/ping.py b/ping.py index 69170d2..efdb2dc 100755 --- a/ping.py +++ b/ping.py @@ -334,17 +334,14 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, self.sequence_number = 0 self.unknown_host = False + self.silent = silent + if own_id is None: self.own_id = os.getpid() & 0xFFFF else: self.own_id = own_id # Output Streams - if silent: - devnull = open(os.devnull, 'w') - sys.stdout = devnull - sys.stderr = devnull - if quiet: devnull = open(os.devnull, 'w') self._stdout = devnull @@ -371,10 +368,11 @@ def __init__(self, destination, timeout=3000, packet_size=64, own_id=None, return # Print opening line - sys.stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % - (self.stats.destination_host, - self.stats.destination_ip, - self.packet_size)) + if not self.silent: + sys.stdout.write("PYTHON PING %s (%s): %d bytes of data.\n" % + (self.stats.destination_host, + self.stats.destination_ip, + self.packet_size)) #=============================================================================# def do_one(self): @@ -620,6 +618,8 @@ def calculate_packet_average(self): #=============================================================================# def print_stats(self): + if self.silent: + return sys.stdout.write("\n--- %s PYTHON PING statistics ---\n" % (self.stats.destination_host)) From 5820268898ebe1ec1addd3566c7c45dc47165a4a Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 09:19:43 -0700 Subject: [PATCH 16/22] Adding relative import path. --- __init__.py | 1 + ping.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/__init__.py b/__init__.py index e69de29..40a96af 100644 --- a/__init__.py +++ b/__init__.py @@ -0,0 +1 @@ +# -*- coding: utf-8 -*- diff --git a/ping.py b/ping.py index efdb2dc..916d6ae 100755 --- a/ping.py +++ b/ping.py @@ -209,7 +209,7 @@ import select import time import signal -from icmp_messages import ICMP_CONTROL_MESSAGE, ICMPv6_CONTROL_MESSAGE +from .icmp_messages import ICMP_CONTROL_MESSAGE, ICMPv6_CONTROL_MESSAGE if sys.platform == "win32": # On Windows, the best timer is time.clock() From 5f54c61c20d30d84249fac77457ae8a0021bb7ff Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 10:06:02 -0700 Subject: [PATCH 17/22] Added conversion for timeout (sec->ms) --- ping.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 916d6ae..1a5e738 100755 --- a/ping.py +++ b/ping.py @@ -209,7 +209,7 @@ import select import time import signal -from .icmp_messages import ICMP_CONTROL_MESSAGE, ICMPv6_CONTROL_MESSAGE +from icmp_messages import ICMP_CONTROL_MESSAGE, ICMPv6_CONTROL_MESSAGE if sys.platform == "win32": # On Windows, the best timer is time.clock() @@ -808,6 +808,8 @@ def main(arguments): parser.print_help() sys.exit(1) + args.timeout = args.timeout * 1000 # Convert timeout from sec to ms + retval = ping(hostname=args.destination, count=args.count, timeout=args.timeout, From 9f6c2513c4506d6c761fc68bde052ba038d682a6 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 10:13:50 -0700 Subject: [PATCH 18/22] Fixing minor typo --- ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 1a5e738..94f50a6 100755 --- a/ping.py +++ b/ping.py @@ -762,7 +762,7 @@ def main(arguments): parser.add_argument('-s', dest='packetsize', metavar='packetsize', type=int, default=64, help='Specifies the number of data bytes to be sent. The default ' - 'is 56, which translates into 64 ICMP data bytes when' + 'is 56, which translates into 64 ICMP data bytes when ' 'combined with the 8 bytes of ICMP header data.') parser.add_argument('-W', dest='timeout', metavar='timeout', type=int, default=3, From bf467a3aaae3e248cda05df8ed5217b20b5c4d70 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 10:14:27 -0700 Subject: [PATCH 19/22] Updating AUTHORS and README files. --- AUTHORS | 1 + README.creole | 86 +++++++++++++++++++++++++++++++++++++++------------ 2 files changed, 67 insertions(+), 20 deletions(-) diff --git a/AUTHORS b/AUTHORS index 6d535a3..5e89c9e 100644 --- a/AUTHORS +++ b/AUTHORS @@ -4,6 +4,7 @@ AUTHORS / CONTRIBUTORS (alphabetic order): * Diemer, Jens -- http://www.jensdiemer.de * Esteban, Mendoza * Falatic, Martin -- http://www.falatic.com + * Ferate, Pat -- https://github.com/pferate * Hallman, Chris -- http://cdhallman.blogspot.com * incidence -- https://github.com/incidence * jcborras -- https://github.com/jcborras diff --git a/README.creole b/README.creole index 4f9c791..8b0ac77 100644 --- a/README.creole +++ b/README.creole @@ -5,49 +5,95 @@ Note that ICMP messages can only be sent from processes running as root Original Version from [[ftp://ftp.visi.com/users/mdc/ping.py|Matthew Dixon Cowles]] -* copyleft 1989-2011 by the python-ping team, see [[https://github.com/jedie/python-ping/blob/master/AUTHORS|AUTHORS]] for more details. -* license: GNU GPL v2, see [[https://github.com/jedie/python-ping/blob/master/LICENSE|LICENSE]] for more details. +* copyleft 1989-2013 by the python-ping team, see [[https://github.com/pferate/python-ping/blob/master/AUTHORS|AUTHORS]] for more details. +* license: GNU GPL v2, see [[https://github.com/pferate/python-ping/blob/master/LICENSE|LICENSE]] for more details. === usage === {{{ -~/python-ping$ sudo ./ping.py google.com +~/python-ping$ sudo ./ping.py +usage: ping.py [-h] [--test] [-q] [--ipv6] [-c count] [-s packetsize] + [-W timeout] + [destination] + +Send ICMP ECHO_REQUEST to network hosts + +positional arguments: + destination destination + +optional arguments: + -h, --help show this help message and exit + --test Run a basic test suite + -q, --quiet Quiet output. Nothing is displayed except the summary lines + at startup time and when finished. + --ipv6 Run using IPv6, instead of the default (IPv4) + -c count Stop after sending count ECHO_REQUEST packets. + -s packetsize Specifies the number of data bytes to be sent. The default is + 56, which translates into 64 ICMP data bytes when combined + with the 8 bytes of ICMP header data. + -W timeout Time to wait for a response, in seconds. -PYTHON-PING google.com (209.85.148.99): 55 data bytes -64 bytes from google.com (209.85.148.99): icmp_seq=0 ttl=54 time=56.2 ms -64 bytes from google.com (209.85.148.99): icmp_seq=1 ttl=54 time=55.7 ms -64 bytes from google.com (209.85.148.99): icmp_seq=2 ttl=54 time=55.5 ms +}}} -----google.com PYTHON PING Statistics---- -3 packets transmitted, 3 packets received, 0.0% packet loss -round-trip (ms) min/avg/max = 55.468/55.795/56.232 +{{{ +~/python-ping$ sudo ./ping.py google.com +PYTHON PING google.com (173.194.33.34): 56 bytes of data. +64 bytes from google.com (173.194.33.34): icmp_seq=0 ttl=57 time=11.353 ms +64 bytes from google.com (173.194.33.34): icmp_seq=1 ttl=57 time=11.085 ms +64 bytes from google.com (173.194.33.34): icmp_seq=2 ttl=57 time=10.786 ms + +--- google.com PYTHON PING statistics --- +3 packets transmitted, 3 received, 0.0% packet loss, time 33ms +round-trip (ms) min/avg/max = 10.786/11.075/11.353 +}}} + +{{{ +~/python-ping$ sudo ./ping.py 8.8.8.8 +PYTHON PING 8.8.8.8 (8.8.8.8): 56 bytes of data. +64 bytes from 8.8.8.8: icmp_seq=0 ttl=49 time=20.363 ms +64 bytes from 8.8.8.8: icmp_seq=1 ttl=49 time=17.155 ms +64 bytes from 8.8.8.8: icmp_seq=2 ttl=49 time=32.250 ms + +--- 8.8.8.8 PYTHON PING statistics --- +3 packets transmitted, 3 received, 0.0% packet loss, time 69ms +round-trip (ms) min/avg/max = 17.155/23.256/32.250 }}} == TODOs == -* refactor ping.py -* create a CLI interface -* add a "suprocess ping", with output parser +* Refactor ping.py +* Improve CLI interface +* Add a "suprocess ping", with output parser == contribute == -[[http://help.github.com/fork-a-repo/|Fork this repo]] on [[https://github.com/jedie/python-ping/|GitHub]] and [[http://help.github.com/send-pull-requests/|send pull requests]]. Thank you. +[[http://help.github.com/fork-a-repo/|Fork this repo]] on [[https://github.com/pferate/python-ping/|GitHub]] and [[http://help.github.com/send-pull-requests/|send pull requests]]. Thank you. == Revision history == -June 19, 2013 --------------- +==== Aug. 13, 2013 ==== +* Adding 'silent' option when running as imported module. 'quiet' prints just the summary, 'silent' suppresses all outputs. [pferate] + +==== Aug. 09, 2013 ==== +* Now pep8 compliant [pferate] + +==== Jul. 16, 2013 ==== +* Refactored codebase back to a class, retaining all other updates. [pferate] +* Added a better CLI (still more to add, but currently has more options available) [pferate] + +==== Jul. 09, 2013 ==== +* Added exit code [pferate] + +==== June 19, 2013 ==== * Added support for IPv6. Taken from implementation of Lars Strand. -March 19, 2013 --------------- +==== March 19, 2013 ==== * Fixing bug to prevent divide by 0 during run-time. -January 26, 2012 ----------------- +==== January 26, 2012 ==== * Fixing BUG #4 - competability with python 2.x [tested with 2.7] - Packet data building is different for 2.x and 3.x. 'cose of the string/bytes difference. From 8072009ebeed0c60f39b635df280720557174498 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 10:33:15 -0700 Subject: [PATCH 20/22] Adding lost_rate PingStats class as a default --- ping.py | 1 + 1 file changed, 1 insertion(+) diff --git a/ping.py b/ping.py index 94f50a6..e4fd0f5 100755 --- a/ping.py +++ b/ping.py @@ -253,6 +253,7 @@ class PingStats: destination_port = 0 packets_sent = 0 packets_received = 0 + lost_rate = 100.0 min_time = 999999999 max_time = 0 total_time = 0 From 8d8a4d805a1492cd547d8179665d21bf8d2ff204 Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 10:33:34 -0700 Subject: [PATCH 21/22] Updating README --- README.creole | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.creole b/README.creole index 8b0ac77..84a12e6 100644 --- a/README.creole +++ b/README.creole @@ -9,8 +9,7 @@ Original Version from [[ftp://ftp.visi.com/users/mdc/ping.py|Matthew Dixon Cowle * license: GNU GPL v2, see [[https://github.com/pferate/python-ping/blob/master/LICENSE|LICENSE]] for more details. -=== usage === - +=== CLI Usage === {{{ ~/python-ping$ sudo ./ping.py usage: ping.py [-h] [--test] [-q] [--ipv6] [-c count] [-s packetsize] @@ -60,6 +59,30 @@ PYTHON PING 8.8.8.8 (8.8.8.8): 56 bytes of data. round-trip (ms) min/avg/max = 17.155/23.256/32.250 }}} +=== Module Usage === +{{{ +#!/usr/bin/env python + +from python_ping import ping + +# host = Host you want to ping +p = ping.Ping(host, timeout=3000, quiet=True, silent=True, ipv6=False) +stats = p.run(1) # PingStats + +# class PingStats: +# destination_ip +# destination_host +# destination_port +# packets_sent +# packets_received +# lost_rate +# min_time +# max_time +# total_time +# average_time + +}}} + == TODOs == From 5c334b3de38fc8ec3cdf0a9204cf1063eaf68f9d Mon Sep 17 00:00:00 2001 From: Pat Ferate Date: Tue, 13 Aug 2013 11:06:28 -0700 Subject: [PATCH 22/22] Adding basic Doxygen config file --- Doxyfile | 1826 +++++++++++++++++++++++++++++++++++++++++++++++++ README.creole | 4 +- 2 files changed, 1829 insertions(+), 1 deletion(-) create mode 100644 Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..57107fa --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1826 @@ +# Doxyfile 1.8.1.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "Python Ping" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "A pure python ping implementation using raw sockets." + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# style sheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/README.creole b/README.creole index 84a12e6..1f87525 100644 --- a/README.creole +++ b/README.creole @@ -86,8 +86,10 @@ stats = p.run(1) # PingStats == TODOs == -* Refactor ping.py +* Fix unit tests +* Improve documentation * Improve CLI interface +* Refactor ping.py * Add a "suprocess ping", with output parser