Skip to main content
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.

Release files for portend 2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for portend 2.5
File Size Uploaded
portend-2.5.tar.gz 12.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for portend 2.5
File Interpreter ABI Platform
portend-2.5-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 17.3 kB

Release files / portend-2.5.tar.gz

Download URL portend-2.5.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
19dc27bfb3c72471bd30a235a4d5fbefef8a7e31cab367744b5d87a205e7bfd9
BLAKE2b-256 checksum
How to use checksums
2c59948666fc2455ae471efd40cb2a9a990f5f6f2354a9a6b228e29b9fb4a307
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / portend-2.5-py2.py3-none-any.whl

Download URL portend-2.5-py2.py3-none-any.whl
Size 5.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d2dca12e585ce29fc357b31ce424a27c16e2d485029252bbf8ddcc9696207976
BLAKE2b-256 checksum
How to use checksums
0af50e5fe0bba1450034f023519aed3ca326bc42981475a93e3645ab868f351c
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

3.2.1

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.7.2

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6

2 release files

This release

2.5 This release

2 release files

2.4

2 release files

2.3

2 release files

2.2

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1

2 release files

1.8

2 release files

1.7.1

2 release files

1.7

2 release files

1.6.1

2 release files

1.6

2 release files

1.5.1

2 release files

1.4

2 release files

1.3

1 release file

1.2

1 release file

1.1.3

1 release file

1.1.1

1 release file

1.1

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0

1 release file

0.0.0

2 release 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