Skip to main content
https://img.shields.io/pypi/v/portend.svg https://img.shields.io/pypi/pyversions/portend.svg tests Code style: Black https://readthedocs.org/projects/portend/badge/?version=latest https://img.shields.io/badge/skeleton-2021-informational

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.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

portend-3.1.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: portend-3.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for portend-3.1.0.tar.gz
Algorithm Hash digest
SHA256 239e3116045ea823f6df87d6168107ad75ccc0590e37242af0cc1e98c5d224e4
MD5 c37d676837505a6fc8dd33185c6d62a7
BLAKE2b-256 6e0a42bcc9c97744958ce72d33f526e972379b9e90adede8a151f338818c41d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: portend-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for portend-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e735cee3a5c1961f09e3f3ba6dc498198c2d70b473d98d0d1504b8d1e7a3d61
MD5 50637ee3f7ea9d201e96e35ddacb54cd
BLAKE2b-256 5ed555f51adaa23038c8533cde602c79e314edd6525d1f7f6a15a1995abec91e

See more details on using hashes here.

Release history Release notifications | RSS feed

3.2.1

2 files

3.2.0

2 files

This release

3.1.0 This release

2 files

3.0.0

2 files

2.7.2

2 files

2.7.1

2 files

2.7.0

2 files

2.6

2 files

2.5

2 files

2.4

2 files

2.3

2 files

2.2

2 files

2.1.2

2 files

2.1.1

2 files

2.1

2 files

1.8

2 files

1.7.1

2 files

1.7

2 files

1.6.1

2 files

1.6

2 files

1.5.1

2 files

1.4

2 files

1.3

1 file

1.2

1 file

1.1.3

1 file

1.1.1

1 file

1.1

1 file

1.0.2

1 file

1.0.1

1 file

1.0

1 file

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page