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 tests Ruff https://readthedocs.org/projects/portend/badge/?version=latest https://img.shields.io/badge/skeleton-2025-informational https://tidelift.com/badges/package/pypi/portend

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.

For Enterprise

Available as part of the Tidelift Subscription.

This project and the maintainers of thousands of other packages are working with Tidelift to deliver one enterprise subscription that covers all of the open source you use.

Learn more.

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-3.2.1.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

portend-3.2.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: portend-3.2.1.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for portend-3.2.1.tar.gz
Algorithm Hash digest
SHA256 aa9d40ab1f9e14bdb7d401f42210df35d017c9b97991baeb18568cedfb8c6489
MD5 c52510e0488592005243209246b1d4f9
BLAKE2b-256 b757be90f42996fc4f57d5742ef2c95f7f7bb8e9183af2cc11bff8e7df338888

See more details on using hashes here.

File details

Details for the file portend-3.2.1-py3-none-any.whl.

File metadata

  • Download URL: portend-3.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for portend-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd2bb1cd8585e32f1f986c1b8eae2950c8622c648db163b711a2fc2ef8d8d492
MD5 82db2d96717e488720462e0a1aad9715
BLAKE2b-256 4911b0b19077f80cb8972b44c96af983e8cfcdb1506090bacef137ed8b448af8

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