- Saved searches
- Use saved searches to filter your results more quickly
- License
- alessandromaggio/pythonping
- Name already in use
- Sign In Required
- Launching GitHub Desktop
- Launching GitHub Desktop
- Launching Xcode
- Launching Visual Studio Code
- Latest commit
- Git stats
- Files
- README.md
- About
- Python Ping
- Ping Server in Python Using the subprocess.call() Method
- Ping Server in Python Using the os.system() Method
- Ping Server in Python Using the ping3.ping() Function
- Related Article — Python Network
Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
A simple way to ping in Python
License
alessandromaggio/pythonping
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
* fix(icmp.py): ICMP header format string All values in the struct should be unsigned. * pylint issues resolved Fixed a bunch of pylint issues * First Readme push headers updated. * Update README.md * Update README.md * UMLs created. * UMLs created. * Folder Structure Created. * backticks added. * Supporting words added. * Grammer fix * Code Styles section finished. * Fix made * Fix made * Readme fixed. * Readme fixed. * Ready for pull request. * Finally ready for pull request. * Testcase added, * feat: integrate #89, #92, and #93 Allow count greater than 16-bit, fix pylint issues, update and expand readme Co-authored-by: David A. Bell Co-authored-by: Mark Mayo Co-authored-by: Aleksa Zatezalo Co-authored-by: Aleksa Zatezalo
Git stats
Files
Failed to load latest commit information.
README.md
PythonPing is simple way to ping in Python. With it, you can send ICMP Probes to remote devices like you would do from the terminal. PythonPing is modular, so that you can run it in a script as a standalone function, or integrate its components in a fully-fledged application.
The simplest usage of PythonPing is in a script. You can use the ping function to ping a target. If you want to see the output immediately, emulating what happens on the terminal, use the verbose flag as below.
from pythonping import ping ping('127.0.0.1', verbose=True)
This will yeld the following result.
Reply from 127.0.0.1, 9 bytes in 0.17ms Reply from 127.0.0.1, 9 bytes in 0.14ms Reply from 127.0.0.1, 9 bytes in 0.12ms Reply from 127.0.0.1, 9 bytes in 0.12ms
Regardless of the verbose mode, the ping function will always return a ResponseList object. This is a special iterable object, containing a list of Response items. In each response, you can find the packet received and some meta information, like the time it took to receive the response and any error message.
You can also tune your ping by using some of its additional parameters:
- size is an integer that allows you to specify the size of the ICMP payload you desire
- timeout is the number of seconds you wish to wait for a response, before assuming the target is unreachable
- payload allows you to use a specific payload (bytes)
- count specify allows you to define how many ICMP packets to send
- interval the time to wait between pings, in seconds
- sweep_start and sweep_end allows you to perform a ping sweep, starting from payload size defined in sweep_start and growing up to size defined in sweep_end . Here, we repeat the payload you provided to match the desired size, or we generate a random one if no payload was provided. Note that if you defined size , these two fields will be ignored
- df is a flag that, if set to True, will enable the Don’t Fragment flag in the IP header
- verbose enables the verbose mode, printing output to a stream (see out )
- out is the target stream of verbose mode. If you enable the verbose mode and do not provide out , verbose output will be send to the sys.stdout stream. You may want to use a file here.
- match is a flag that, if set to True, will enable payload matching between a ping request and reply (default behaviour follows that of Windows which counts a successful reply by a matched packet identifier only; Linux behaviour counts a non equivalent payload with a matched packet identifier in reply as fail, such as when pinging 8.8.8.8 with 1000 bytes and the reply is truncated to only the first 74 of request payload with a matching packet identifier)
Do I need privileged mode or root?
Yes, you need to be root to use pythonping.
Why do I need to be root to use pythonping?
All operating systems allow programs to create TCP or UDP sockets without requiring particular permissions. However, ping runs in ICMP (which is neither TCP or UDP). This means we have to create raw IP packets, and sniff the traffic on the network card. Operating systems are designed to require root for such operations. This is because having unrestricted access to the NIC can expose the user to risks if the application running has bad intentions. This is not the case with pythonping of course, but nonetheless we need this capability to create custom IP packets. Unfortunately, there is simply no other way to create ICMP packets.
If you wish to extend PythonPing, or integrate it in your application, we recommend to use the classes that are part of Python Ping instead of the ping function. executor.Communicator handles the communication with the target device, it takes care of sending ICMP requests and processing responses (note that for it to be thread safe you must then handle making a unique seed ID for each thread instance, see ping._init_ for an example of this). It ultimately produces the executor.ResponseList object. The Communicator needs to know a target and which payloads to send to the remote device. For that, we have several classes in the payload_provider module. You may want to create your own provider by extending payload_provider.PayloadProvider . If you are interested in that, you should check the documentation of both executor and payload_provider module.
Top Level Directory Layout
Our project directory structure contains all src files in the pythonping folder, test cases in another folder, and helping documentation in on the top level directory.
. ├── pythonping # Source files ├── test # Automated Testcases for the package ├── CODE_OF_CONDUCT # An md file containing code of conduct ├── CONTRIBUTING # Contributing Guidlins ├── LICENSE # MIT License ├── README.md # An md file └── setup.py # Instalation
A UML Diagram of the code structure is below:
As per the uml diagram above five distinct classes outside of init exist in this package: Executor, Icmp, Payload Provider, and Utils. Each of them rely on attributes which have been listed as sub-classes for brevities sake. An overview of each class is as follows.
Simply generates random text. See function random_text.
Opens a socket to send and recive data. See functions send, recv, and del.
Generates ICMP Payloads with no Headers. It’s functionaly a interface. It has three functions init, iter, and next, which are all implmented by subclasses List, Repeat, and Sweep which store payloads in diffrent lists.
Generates the ICMP heaser through subclass ICMPType, and various helper functions.
Has various subclasses including Message, Response, Success, and Communicator used for sending icmp packets and collecting data.
Uses network, executor, payload_provider and utils.random_text to construct and send ICMP packets to ping a network.
A test package exists under the folder test, and contains a serise of unit tests. Before commiting changes make sure to run the test bench and make sure all corrisponding cases pass. For new functionality new test cases must be added and documented.
To run testcases we can simply use the unitest discover utility by running the following command:
python -m unittest discover
To run the test cases in a specific file FILE we must run the following command:
python -m unittest discover -s -p FILE
Another option is to run the following from the top level directory:
To test for coverage simply run:
coverage run -m pytest test
Before contributing read through the contribution guidlines found the CONTRIBUTING file.
A few key points when contributing to this repo are as follows:
- Use tabs over spaces.
- Format doc strings as such:
DESCRIPTION :param X: DESCRIPTION :type X: Type :param Y: DESCRIPTION :type Y: Type
About
A simple way to ping in Python
Python Ping
- Ping Server in Python Using the subprocess.call() Method
- Ping Server in Python Using the os.system() Method
- Ping Server in Python Using the ping3.ping() Function
This tutorial will explain various methods to ping a server using Internet Control Message Protocol (ICMP) in Python. Ping is used to check if a particular server is available or not on an Internet Protocol. It measures the time it takes for a message to reach the destination (server) and for a server response to reach the source.
Ping Server in Python Using the subprocess.call() Method
The subprocess.call(command) method takes command as input and executes it. It returns 0 if the command executes successfully.
The command to ping a server will be ping -c 1 host_address for Unix and ping -n 1 host_address for Windows, where 1 is the number of packets and host_address is the server address we want to ping.
We can use the platform.system() method first to check the OS of the machine and then run the command accordingly. The below example code demonstrates how to use the subprocess.call() method to execute the command to ping a server in Python.
import platform import subprocess def myping(host): parameter = '-n' if platform.system().lower()=='windows' else '-c' command = ['ping', parameter, '1', host] response = subprocess.call(command) if response == 0: return True else: return False print(myping("www.google.com"))
Ping Server in Python Using the os.system() Method
The os.system(command) method takes the command (a string) as input and executes it in a subshell. The method returns 0 if the command executes without any error.
We can use the os.system() method in the following way to execute the ping server command:
import os def myping(host): response = os.system("ping -c 1 " + host) if response == 0: return True else: return False print(myping("www.google.com"))
Ping Server in Python Using the ping3.ping() Function
The ping(addr) function of the ping3 module takes server address as input and returns the ping time as output if the server is available and returns False if it is not available.
We can install the ping3 module with the root privileges.
We can pass the server address to the ping() method to ping the server.
from ping3 import ping def myping(host): resp = ping(host) if resp == False: return False else: return True print(myping("www.google.com"))