Skip to content

docs(link,transport): seventh whole-repo pass over link and transport protocols (#1103) - #2263

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-linktrans-pr
Oct 26, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-linktrans-pr

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 7. A full read of pcapkit/protocols/link, transport and their models. Prose only: the AST guard is identical on all 7 .py files.

… protocols (#1103)

Full read of pcapkit/protocols/link, transport and their data/schema models.

- L2TP: the tunnel ID is the Session ID's lower half; L2TPv2.read's version
  check and Raises.
- ARP/Ethernet make: Raises name the address makers' exceptions.
- SCTP: padding clamp per RFC 9260 section 3.2, folded padding chunks, SACK
  a_rwnd, PPID member names.
- TCP: Flags has its own _missing_; FieldValueError in MPTCP Raises.
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 6dfb55d81 (Sonnet).

  • Prose only: the AST guard with docstrings stripped is identical on all 7 .py files.
  • Claims: each claim checked against the code or RFC holds:
    • L2TPv2's tunnel ID is the Session ID's lower half (run: 00025678… gives tunnelid=0x5678), and the version check raises ProtocolError;
    • the ARP.make and Ethernet.make Raises match runs of True, 5 and 'zz';
    • RFC 9260 §3.2 says MUST pad, and exactly six chunk schemas fold their padding;
    • the PPID 60/66 member names;
    • Flags._missing_ accepts 0–0xFFFF;
    • _make_mptcp_addaddr(addr=True) raises FieldValueError.
  • Tests: link, transport, docstring-contract, docs and convention tests give 475 passed. No text pins.
  • Follow-ups:

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, 6dfb55d81, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 3023 23 1044 25 98.82%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17437 218 4586 185 98.15%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at 6dfb55d81. Part of #1103, round 7: link and transport.

  • Review: Sonnet GOOD TO GO.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed. Sync Status is board sync, not CI.
  • KTLO: 12 legs, no warnings (the 3.9 leg re-run after an artifact-upload ECONNRESET).
  • Ordering: merged into main and run. protocols leg: 1942 tests, 0 failures.
  • Conflicts: none against the current main (5fd197fad, whose vendor-doc commit touches no file in this PR).

@JarryShaw
JarryShaw merged commit 054b62a into main Oct 26, 2026
101 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-r7-linktrans-pr branch October 26, 2026 20:24
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant