TCP port monitoring utilities
Project description
.. image:: https://img.shields.io/pypi/v/portend.svg
:target: https://pypi-hypernode.com/project/portend
.. image:: https://img.shields.io/pypi/pyversions/portend.svg
.. image:: https://img.shields.io/pypi/dm/portend.svg
.. image:: https://img.shields.io/travis/jaraco/portend/master.svg
:target: http://travis-ci.org/jaraco/portend
por·tend
pôrˈtend/
verb
be a sign or warning that (something, especially something momentous or calamitous) is likely to happen.
License
=======
License is indicated in the project metadata (typically one or more
of the Trove classifiers). For more details, see `this explanation
<https://github.com/jaraco/skeleton/issues/1>`_.
Usage
=====
Use portend to monitor TCP ports for bound or unbound states.
For example, to wait for a port to be occupied, timing out after 3 seconds::
portend.occupied('www.google.com', 80, timeout=3)
Or to wait for a port to be free, timing out after 5 seconds::
portend.free('::1', 80, timeout=5)
The portend may also be executed directly. If the function succeeds, it
returns nothing and exits with a status of 0. If it fails, it prints a
message and exits with a status of 1. For example::
python -m portend localhost:31923 free
(exits immediately)
python -m portend -t 1 localhost:31923 occupied
(one second passes)
Port 31923 not bound on localhost.
Portend also exposes a ``find_available_local_port`` for identifying
a suitable port for binding locally::
port = portend.find_available_local_port()
print(port, "is available for binding")
Portend additionally exposes the lower-level port checking functionality
in the :class:`Checker` class, which currently exposes only one public
method, ``assert_free``.
portend.Checker().assert_free('localhost', 31923)
If assert_free is passed a host/port combination that is occupied by
a bound listener (i.e. a TCP connection is established to that host/port),
assert_free will raise a :class:`PortNotFree` exception.
:target: https://pypi-hypernode.com/project/portend
.. image:: https://img.shields.io/pypi/pyversions/portend.svg
.. image:: https://img.shields.io/pypi/dm/portend.svg
.. image:: https://img.shields.io/travis/jaraco/portend/master.svg
:target: http://travis-ci.org/jaraco/portend
por·tend
pôrˈtend/
verb
be a sign or warning that (something, especially something momentous or calamitous) is likely to happen.
License
=======
License is indicated in the project metadata (typically one or more
of the Trove classifiers). For more details, see `this explanation
<https://github.com/jaraco/skeleton/issues/1>`_.
Usage
=====
Use portend to monitor TCP ports for bound or unbound states.
For example, to wait for a port to be occupied, timing out after 3 seconds::
portend.occupied('www.google.com', 80, timeout=3)
Or to wait for a port to be free, timing out after 5 seconds::
portend.free('::1', 80, timeout=5)
The portend may also be executed directly. If the function succeeds, it
returns nothing and exits with a status of 0. If it fails, it prints a
message and exits with a status of 1. For example::
python -m portend localhost:31923 free
(exits immediately)
python -m portend -t 1 localhost:31923 occupied
(one second passes)
Port 31923 not bound on localhost.
Portend also exposes a ``find_available_local_port`` for identifying
a suitable port for binding locally::
port = portend.find_available_local_port()
print(port, "is available for binding")
Portend additionally exposes the lower-level port checking functionality
in the :class:`Checker` class, which currently exposes only one public
method, ``assert_free``.
portend.Checker().assert_free('localhost', 31923)
If assert_free is passed a host/port combination that is occupied by
a bound listener (i.e. a TCP connection is established to that host/port),
assert_free will raise a :class:`PortNotFree` exception.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
portend-1.7.1.tar.gz
(7.3 kB
view hashes)
Built Distribution
Close
Hashes for portend-1.7.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e2124690565923434c2e4b2a4c27685a7cc27db5163e50f260070fc65b5756f4 |
|
| MD5 | 2d0246f522773092f0e65aa62cbe520f |
|
| BLAKE2b-256 | 9b5cf8742e07db353eed049b403c73c98285868ee74de21dfa94127a38b5ab44 |
