Tree @e6b45107-458e-43a6-8bfd-7722f603ee7c/main (Download .tar.gz)

CHANGELOG.md @e6b45107-458e-43a6-8bfd-7722f603ee7c/main — view markup · raw · history · blame

All notable changes to this project will be documented in this file.

Make the SocketPermissionError more explicit when the OS does not allow instantiation of unprivileged sockets.
Delete unnecessary properties from exceptions.
Improve SEO on GitHub.

icmplib 3.0 is here! :rocket:

The library is now asynchronous!
Introduce new functions: async_ping, async_multiping and async_resolve.
Add a new AsyncSocket class to make an ICMP socket asynchronous.
Rewrite models:
All the properties of Host and Hop classes are now lazy.
Add new properties to the Host and Hop classes: you can retrieve the list of round-trip times and calculate the jitter.
Add the metaclass __str__ to visualize the results more easily.
Rewrite the ping, multiping and traceroute functions:
The identifier of ICMP requests is now handled automatically by the library.
Add the ability to set the address family if a hostname or an FQDN is specified.
A new implementation is used for the multiping function. It should be more reliable.
The multiping function is now in a dedicated module.
Rewrite the documentation to help you get started with icmplib.
Improve the resolve function to return all IP addresses found.
Add the is_hostname function to check if a string is a hostname or an FQDN.
Delete the experimental class BufferedSocket, replaced by AsyncSocket.
Performance and compatibility improvement.
Many other small changes and fixes.

Special thanks to @JonasKs and @bdraco for their suggestions, advice and feedback!

Python 3.7 or later is now required.

This version is the last of the 2.x branch. See you soon for the release of icmplib 3.0!

Add a family parameter to the resolve function to define the address family.
Improve the reliability of the results of the traceroute function.

Rename the default branch from master to main.
Add more details about the privileged parameter in the README file (part 2).
:bug: Fix a bug preventing the traceroute function to work with IPv6 addresses (part 2).

Handle EACCES errors at sockets level.
Add some details about the privileged parameter in the README file.
:bug: Fix a bug preventing the traceroute function to work with IPv6 addresses.

icmplib 2.0 is here! :rocket:

New library architecture.
Add a new multiping function. This function will be faster and more memory efficient.
Add the ability to use the library without root privileges.
Add the ability to set a source IP address for sending your ICMP packets.
Add a first_hop parameter to the traceroute function to set the initial time to live value (@scoulondre).
Add two new exceptions:
NameLookupError: raised when the requested name does not exist or cannot be resolved.
SocketAddressError: raised when the requested address cannot be assigned to the socket.
Add a new BufferedSocket class (experimental) to send several packets simultaneously without waiting for a response.
The receive method of sockets can receive all incoming packets.
Throw new exceptions when instantiating sockets, sending and receiving packets.
Improve the resolve function:
A NameLookupError is now raised if the requested name does not exist or cannot be resolved.
Improve compatibility with Linux, macOS and Windows.
Delete deprecated properties.
Update docstrings, examples and documentation.

Compatibility with existing programs is maintained.

:bug: Fix an issue in the traceroute function which gave the wrong value for the avg_rtt property (@patrickfnielsen).

Add the ability to modify the traffic class of ICMP packets.
Add new optional parameters to the traceroute function.
Add a new exception SocketUnavailableError when an action is performed while a socket is closed.
Add a warning message on deprecated properties.
Explicit closure of sockets on built-in functions.
:bug: Fix a bug when ICMP responses are not correctly formatted (part 2).

Add support for odd size payloads.
Normalize the names of variables and properties:
ICMPReply class: the received_bytes property is deprecated. Use bytes_received instead.
Host and Hop classes: the transmitted_packets property is deprecated. Use packets_sent instead.
Host and Hop classes: the received_packets property is deprecated. Use packets_received instead.
Normalize docstrings.
Optimizations.

Add the is_closed property to the ICMPSocket class.
Round round-trip time values by default.
Add an index for examples.
:bug: Fix a bug in the multiping function where the id parameter was ignored.
:bug: Fix a bug in the ICMPSocket class when instantiated without root privileges.

Add the ability to customize the payload.
Improve the ping and multiping functions:
You can pass arguments to the ICMPRequest object using keywords arguments **kwargs.
Update some docstrings.
Add new examples.