This release is a pre-release and may not be stable for production use.
PyPCAPKit - Comprehensive Network Packet Analysis Library
For any technical and/or maintenance information, please kindly refer to the Official Documentation.
The PyPCAPKit project is an open source Python program focus on network packet parsing and analysis, which works as a comprehensive PCAP file extraction, construction and analysis library.
The whole project supports Python 3.6 or later; CI covers 3.10 to 3.14, and 3.15 as an allowed-to-fail leg.
About
PyPCAPKit is a comprehensive Python-native network packet analysis library, with DictDumper as its formatted output dumper.
Unlike popular PCAP file extractors, such as Scapy, DPKT, PyShark, and etc, pcapkit is designed to be much more comprehensive, which means it is able to provide more detailed information about the packet, as well as a more Pythonic interface for users to interact with.
Module Structure
In pcapkit, all files can be described as following eight parts.
Interface (pcapkit.interface)
User interface for the pcapkit library, which standardises and simplifies the usage of this library.
Foundation (pcapkit.foundation)
Synthesises file I/O and protocol analysis, coordinates information exchange in all network layers, as well as provides the foundamental functions for pcapkit.
Protocols (pcapkit.protocols)
Collection of all protocol family, with detailed implementation and methods.
Utilities (pcapkit.utilities)
Auxiliary functions and tools for pcapkit.
CoreKit (pcapkit.corekit)
Core utilities for pcapkit implementation, mainly for internal data structure and processing.
ToolKit (pcapkit.toolkit)
Auxiliary tools for pcapkit to support the multiple extraction engines with a unified interface.
DumpKit (pcapkit.dumpkit)
File output formatters for pcapkit.
Constants (pcapkit.const)
Constant enumerations used in pcapkit for protocol family extraction and representation.
Engine Comparison
Due to the general overhead of pcapkit, its extraction procedure takes around 0.2 milliseconds per packet, which is already impressive but not enough comparing to other popular extraction engines available on the market, given the fact that pcapkit is a comprehensive packet processing module.
Additionally, pcapkit introduced alternative extraction engines to accelerate this procedure. By now pcapkit supports Scapy, DPKT, PyShark, PyPCAP, pcap-ct and PyPCAPFile, selected through engine='scapy', 'dpkt', 'pyshark', 'pypcap', 'pcap_ct' and 'pypcapfile' respectively; engine='default' (also spelled 'pcapkit') is pcapkit’s own parser and the only one with no third-party requirement.
PyPCAP and pcap-ct are two independent distributions of the same libpcap(3) interface, and both install a top-level pcap module, so they are two engines rather than one. Upstream PyPCAP stops at Python 3.11; pcap-ct covers 3.10 and newer. Install exactly one of them – with both present, pcap-ct wins the import and the other becomes unselectable, which each engine detects and reports.
Speed is not free. Every third-party engine supports less than the default one, and the newest ones support markedly less:
PyPCAP performs no protocol dissection at all, so it offers neither reassembly nor flow tracing, and reads PCAP savefiles from disk only.
pcap-ct reads the same interface, so it has exactly the same gaps.
PyPCAPFile has no IPv6 decoder, so IPv6 reassembly is unavailable; IPv4 and TCP reassembly still work, and it too is PCAP-only.
PyShark performs no reassembly.
Each gap is announced with a warning or an exception rather than silently returning nothing. The engine support documentation tabulates them.
Every engine also answers a preflight check before it is used – unsupported_reason() – so asking for one that cannot run in the current environment produces a single warning naming the actual cause (a Python version, a missing tshark, a missing libpcap, the wrong pcap distribution) and a clean fall back to pcapkit’s own parser, rather than an error from inside the third-party package.
Engine support by Python version
Which engines can run at all, by interpreter. Verified by installing each engine and extracting a capture on 3.10 through 3.14; 3.15 remains inferred.
Engine |
3.10 |
3.11 |
3.12 |
3.13 |
3.14 |
3.15 |
|---|---|---|---|---|---|---|
pcapkit |
yes |
yes |
yes |
yes |
yes |
yes* |
dpkt |
yes |
yes |
yes |
yes |
yes |
yes* |
scapy |
yes |
yes |
yes |
yes |
yes |
yes* |
pcap_ct |
yes |
yes |
yes |
yes |
yes |
yes* |
pypcap |
yes |
yes |
no |
no |
no |
no |
pypcapfile |
yes |
yes |
no |
no |
no |
no |
pyshark |
yes† |
yes† |
yes† |
yes† |
no |
no |
* inferred, not measured – no 3.15 interpreter was available.
† also needs Wireshark’s tshark, which was absent, so only the interpreter half was verified for pyshark.
pypcap and pypcapfile stop at 3.11, and pyshark at 3.13, for the reasons under Engine prerequisites. Python 3.11 is the last version on which every engine can run – and even there pypcap and pcap_ct are mutually exclusive, since both provide the pcap module, so no single environment ever has all seven at once.
Test Environment
Operating System |
macOS 26.6.2 |
Chip |
Apple M2 Pro |
Memory |
16 GB |
Test Results
Measured with examples/legacy_smoke/test_time.py: 1,000 timed extractions of examples/captures/in.pcap per engine and Python version. The first extraction is discarded as a warm-up. Values are milliseconds per packet.
Engine |
3.10 |
3.11 |
3.12 |
3.13 |
3.14 |
|---|---|---|---|---|---|
pypcapfile [2] |
0.0133 |
0.0093 |
– |
– |
– |
dpkt |
0.0163 |
0.0113 |
0.0118 |
0.0117 |
0.0125 |
pypcap [3] |
0.0289 |
0.0212 |
– |
– |
– |
pcap_ct [4] |
0.0364 |
0.0320 |
0.0366 |
0.0322 |
0.0396 |
scapy |
0.1082 |
0.0822 |
0.0877 |
0.0832 |
0.0967 |
pcapkit |
0.2342 |
0.1906 |
0.1985 |
0.1920 |
0.2392 |
pyshark [1] |
18.8158 |
18.7852 |
19.2694 |
20.3751 |
– |
The unavailable cells were attempted. They are not zeroes and must not be compared with a measured row.
Installation
Simply run the following to install the current version from PyPI:
pip install pypcapkitOr install the latest version from the gi repository:
git clone https://github.com/JarryShaw/PyPCAPKit.git
cd pypcapkit
pip install -e .
# and to update at any time
git pullFor local development with pipenv, the repository already includes a Pipfile and Makefile targets that keep both the virtualenv and the package caches inside the project directory:
make setupThis resolves two common local setup issues on macOS/Homebrew installations: pipenv cache permission errors under ~/Library/Caches and lxml builds failing to locate Homebrew’s libxml2/libxslt headers.
If you prefer to run pipenv directly, use the same local cache layout and skip any stale, user-local Pipfile.lock:
PIPENV_VENV_IN_PROJECT=1 \
PIPENV_CACHE_DIR=$PWD/.pipenv-cache \
PIP_CACHE_DIR=$PWD/.pip-cache \
pipenv install --skip-lock --devAnd since pcapkit supports various extraction engines, and extensive plug-in functions, you may want to install the optional ones:
# for DPKT only
pip install pypcapkit[DPKT]
# for Scapy only
pip install pypcapkit[Scapy]
# for PyShark only
pip install pypcapkit[PyShark]
# for PyPCAPFile only
pip install pypcapkit[PyPCAPFile]
# for PyPCAP only -- see the note below, this one builds from source
pip install pypcapkit[PyPCAP]
# for pcap-ct only -- the pure-Python alternative to PyPCAP, and the one that
# works on Python 3.12+; do not install it alongside PyPCAP
pip install pypcapkit[PCAP_CT]
# for ESP payload decryption
pip install pypcapkit[crypto]
# and to install the optional packages -- note this excludes PyPCAP and pcap-ct
pip install pypcapkit[all]
# or to do this explicitly
pip install pypcapkit dpkt scapy pyshark pypcapfileInstallation Notes
The all extra deliberately excludes both pypcap and pcap-ct, for different reasons. Everything else in all is a pure-Python wheel, whereas pypcap compiles a C extension; pulling it into all would demand a working compiler and the libpcap development files from everyone installing pypcapkit[all]. pcap-ct needs no compiler, but it and its libpcap dependency are published only as pre-releases (1.3.0b3 and 1.11.0b29), and all should not be how somebody ends up with a beta they did not ask for. Install either explicitly: pip install pypcapkit[PyPCAP] or pip install pypcapkit[PCAP_CT].
Install only one of them. Both distributions own the top-level pcap module, and pip will install both without complaint. With both present the pcap-ct package wins the import and pypcap’s extension module is shadowed and unreachable, so engine='pypcap' stops working. pcapkit detects that state and warns, naming both distributions and which one won, but it cannot undo it.
Engine prerequisites
Four of the engines need something beyond a pip install. Each constraint is also enforced in code – the engine’s unsupported_reason() is consulted before anything is imported – so hitting one produces a warning naming the cause and a fall back to pcapkit’s own parser, not an error from inside the third-party package.
- pyshark
Two requirements, and neither is visible to an import: the package imports cleanly and then fails when used.
Drives Wireshark’s tshark binary. It need not be on PATH: pyshark looks at tshark_path in its config.ini first, then PATH on POSIX, both Program Files directories on Windows, and /Applications/Wireshark.app on macOS. Install Wireshark (or just tshark) from your platform’s package manager.
Requires Python 3.13 or older. pyshark 0.6 builds its event loop with asyncio.get_event_loop_policy().get_event_loop(), and from Python 3.14 asyncio.get_event_loop() raises RuntimeError when there is no current event loop instead of quietly creating one. Measured: a loop is returned silently on 3.10 and 3.11, returned with a DeprecationWarning on 3.12, and refused on 3.14. (3.13 was not available to test and is expected to work, being on the deprecated-but-functional side of that change.)
- pypcap
Ships no wheels – only an sdist – so pip compiles it, and the build needs both libpcap’s headers (pcap.h) and its shared or static library:
# Debian/Ubuntu sudo apt-get install libpcap-dev # RHEL/Fedora/Amazon Linux sudo dnf install libpcap-devel # macOS brew install libpcapTwo caveats, both upstream problems rather than pcapkit ones:
pypcap 1.3.0 ships a pre-generated pcap.c produced by Cython 0.29.x, which does not compile against the Python 3.12+ C API. Having libpcap installed is therefore necessary but not sufficient: on 3.12 or newer the build fails whatever else is present. Use Python 3.11 or older for this engine, or regenerate pcap.c with Cython 3 yourself.
Its setup.py does not consult CFLAGS/LDFLAGS or pkg-config. It searches a fixed list of prefixes – /usr, sys.prefix, /opt/libpcap*, ../libpcap*, ../wpdpack* and the macOS SDKs – so a libpcap installed anywhere else, notably Homebrew’s keg-only prefix on Apple Silicon (/opt/homebrew/opt/libpcap), is not found even though it is installed. Installing into sys.prefix, or into /opt/libpcap, is what that search will pick up.
- pcap_ct
The way to drive the same libpcap interface on Python 3.12 and newer, where pypcap cannot be built. Nothing to compile and no pcap.h needed: pcap-ct is a ctypes reimplementation, and both it and its libpcap dependency ship py3-none-any wheels. Verified reading a capture on Python 3.10 and 3.14.
Two caveats:
A system ``libpcap`` is still required at run time. The libpcap distribution ships a vendored libpcap.so and, as published, does not use it: its libpcap.cfg says LIBPCAP = None, which sends its loader to ctypes.util.find_library('pcap'). So the library actually loaded is the host’s libpcap.so.1, and with none present import pcap raises OSError rather than ImportError. Set LIBPCAP = tcpdump in libpcap.cfg to use the vendored copy instead.
Both distributions are pre-releases, and pcap-ct documents itself as tracking the pypcap 1.2.3 interface. Every attribute the engine uses was measured behaving identically to pypcap 1.3.0, but that is a statement about the versions tested.
- pypcapfile
Version 0.12.0 imports the imp module, which was removed in Python 3.12, so pcapfile.savefile – the module needed to read a capture – cannot be imported at all on 3.12 or newer. Upstream master has fixed this but no release carries the fix yet, so this engine also requires Python 3.11 or older until 0.12.1 is published.
Note – pcapkit itself, and its default, dpkt and scapy engines, work fine on current Python versions – dpkt 1.9.8 and scapy 2.7.0 were both measured reading a capture on Python 3.14. Only the four engines above carry extra constraints, and asking for an engine that cannot run in the current environment emits a warning naming the reason and falls back to pcapkit’s own parser rather than failing outright.
For CLI usage, you will need to install the optional packages:
pip install pypcapkit[cli]
# or explicitly...
pip install pypcapkit emojiTesting
The unit tests need nothing beyond the package itself and the sample captures tracked in the repository:
make testThe runtime, regression and integration tests additionally read sample captures that are not tracked (see .gitignore); examples/generators/make_samples.py reconstructs them into examples/captures/, and make test-all regenerates them before running the whole suite:
make samples # write examples/captures/*.pcap and *.pcapng
make test-all # regenerate the fixtures, then run every testThe same fixtures back the demonstration scripts in examples/legacy_smoke/, which read them as ../captures/….
One of the generators works differently from the rest and is worth knowing about. examples/generators/options.py does not describe packets it wants; it asks the library which option, chunk, parameter, message, frame and block codes it registers, and then constructs one of each through the public construction API, parses it back, and constructs it again from what was parsed. The options-*.pcap captures are the cases that survive that round trip, so they record what this version of pcapkit builds rather than what a third-party tool builds. tests/protocols/test_option_roundtrip_unit.py runs the same cases without needing a fixture at all, and carries a table of the ones that do not yet close the cycle, each named against the defect that stops it.
Continuous integration runs the make test selection, since the fixtures are not in the repository. tshark is only required to exercise the PyShark engine, and is not needed by the test suite.
1 maintainer
Release files for pypcapkit 1.5.0b4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pypcapkit-1.5.0b4.tar.gz | 1.6 MB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pypcapkit-1.5.0b4-pp311-none-any.whl | PyPy 3.11 | none | any | Details |
| pypcapkit-1.5.0b4-pp310-none-any.whl | PyPy 3.10 | none | any | Details |
| pypcapkit-1.5.0b4-cp314-none-any.whl | CPython 3.14 | none | any | Details |
| pypcapkit-1.5.0b4-cp313-none-any.whl | CPython 3.13 | none | any | Details |
| pypcapkit-1.5.0b4-cp312-none-any.whl | CPython 3.12 | none | any | Details |
| pypcapkit-1.5.0b4-cp311-none-any.whl | CPython 3.11 | none | any | Details |
| pypcapkit-1.5.0b4-cp310-none-any.whl | CPython 3.10 | none | any | Details |
Total release size: 10.7 MB
Release files / pypcapkit-1.5.0b4.tar.gz
| Download URL | pypcapkit-1.5.0b4.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f4f72b8e84ea79586d9304e84331b471a8eba35a0c0ef73818cd9b2e05c7447c
|
|
BLAKE2b-256 checksum How to use checksums |
9b7d744110b25cc6b2331b2cff4bd849fd24b834537aa25b7a5d08dda3edf30a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-pp311-none-any.whl
| Download URL | pypcapkit-1.5.0b4-pp311-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | PyPy 3.11 |
|
SHA-256 checksum How to use checksums |
6956d7e04465553b6ed6566a3c8c4d69ac76d5eb94657e99f350a10e34e09ec9
|
|
BLAKE2b-256 checksum How to use checksums |
0bca4e6fad967d024a91c6cc4ec967695c288fe13ffc52d807b131f0607a4bd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-pp310-none-any.whl
| Download URL | pypcapkit-1.5.0b4-pp310-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | PyPy 3.10 |
|
SHA-256 checksum How to use checksums |
da63cfa1c65f221e72615557f098edbab2b159c462a90f5a4acf7db3aeb1dd98
|
|
BLAKE2b-256 checksum How to use checksums |
2e353947aad6748701be898f7271baff70e2e5f92367f0cc53f72416106119bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-cp314-none-any.whl
| Download URL | pypcapkit-1.5.0b4-cp314-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.14 |
|
SHA-256 checksum How to use checksums |
50ea5bdc8015e3b87141dcdfc7879b37339e10cec33213018ca429b67d301a00
|
|
BLAKE2b-256 checksum How to use checksums |
52f508363b5e75e318cc1a095d6a230a1120984142b08ecf21d205f67edd4a0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-cp313-none-any.whl
| Download URL | pypcapkit-1.5.0b4-cp313-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.13 |
|
SHA-256 checksum How to use checksums |
2a3744120c18820b95fd9c8353b3dee8b1dc313cd1f43bf3e07435987321f3e3
|
|
BLAKE2b-256 checksum How to use checksums |
2143315887b35c2a1c5de1f22d7a2aa15a8d2da30caeff248cac3bb02db737ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-cp312-none-any.whl
| Download URL | pypcapkit-1.5.0b4-cp312-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.12 |
|
SHA-256 checksum How to use checksums |
4e26c256d19a173ba3e21f55b1cab6d49f2fd9bbc498c49a658a0826ea8930e7
|
|
BLAKE2b-256 checksum How to use checksums |
3eeefeecf75404e4fa94b9be7f7a3f99276166d62dc397c71aa2831bba0837b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-cp311-none-any.whl
| Download URL | pypcapkit-1.5.0b4-cp311-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.11 |
|
SHA-256 checksum How to use checksums |
14db01775ae74a5170fbda6e22de25476ecbac0401085a85196998e5f9b1a325
|
|
BLAKE2b-256 checksum How to use checksums |
ffb6afc9371f09e3d1723fcff5274a3f20eab2355173f4e175c586df821b79a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pypcapkit-1.5.0b4-cp310-none-any.whl
| Download URL | pypcapkit-1.5.0b4-cp310-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.10 |
|
SHA-256 checksum How to use checksums |
4b80fcac303b3815ab16ff5984ba5297fe04b3558aa0690e1436abe9fbe03a89
|
|
BLAKE2b-256 checksum How to use checksums |
a81397a7cf0c81063309dec0a58fb32ae90f967abf73c25e6e5575485adf8fcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
