Skip to main content

TCP port monitoring and discovery

Project description

https://img.shields.io/pypi/v/portend.svg https://img.shields.io/pypi/pyversions/portend.svg https://img.shields.io/travis/jaraco/portend/master.svg Code style: Black https://img.shields.io/appveyor/ci/jaraco/portend/master.svg https://readthedocs.org/projects/portend/badge/?version=latest

por·tend pôrˈtend/ verb

be a sign or warning that (something, especially something momentous or calamitous) is likely to happen.

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 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 PortNotFree exception.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portend-2.5.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

portend-2.5-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file portend-2.5.tar.gz.

File metadata

  • Download URL: portend-2.5.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for portend-2.5.tar.gz
Algorithm Hash digest
SHA256 19dc27bfb3c72471bd30a235a4d5fbefef8a7e31cab367744b5d87a205e7bfd9
MD5 0ab51a12b7462a5275946a3645a71e92
BLAKE2b-256 2c59948666fc2455ae471efd40cb2a9a990f5f6f2354a9a6b228e29b9fb4a307

See more details on using hashes here.

File details

Details for the file portend-2.5-py2.py3-none-any.whl.

File metadata

  • Download URL: portend-2.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for portend-2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2dca12e585ce29fc357b31ce424a27c16e2d485029252bbf8ddcc9696207976
MD5 ceb077a234bef1394163ab503da3152b
BLAKE2b-256 0af50e5fe0bba1450034f023519aed3ca326bc42981475a93e3645ab868f351c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page