Skip to content

docs(foundation): seventh whole-repo pass over foundation, utilities, interface, toolkit and dumpkit (#1103) - #2261

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

JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-foundation-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/foundation, utilities, interface, toolkit, dumpkit, the top-level package and their API pages. Prose only: the AST guard is identical on all 20 .py files.

  • extraction/engines/registry:
    • Extractor.run emits no EngineWarning of its own, since __init__ does.
    • The context engines are named correctly.
    • EngineBase.name works at class level.
    • register_apptype raises during the call.
    • magic_number gets an autoproperty, and the PyShark gap row lists trace_analyse.
  • reassembly/traceflow:
    • The RFC 791 pseudocode is re-nested to match the RFC, with two departures listed.
    • The user timeout and RST citations are RFC 9293 §3.10.8 and §3.5.3.
    • The expire, Datagram, Deferred and submit notes are corrected.
    • The name/protocol Notes now say the values are available at class level.
  • utilities/interface:
    • PCAPKit is not an __engine__ key.
    • TCP/IPv4 options have 8-bit lengths.
    • warn() reads VERBOSE; DEVMODE routes records.
    • Every truthy env-var value is listed, and a never-released "Moved from" path is dropped.
  • toolkit/dumpkit: the render_enum example (Flags(15)), tree's 40-character newline rule, and the dpkt reassembly notes, checked against dpkt 1.9.8.
  • Tests: tests/foundation/ 523 passed, tests/utilities/ 158, tests/interface/ 35, tests/toolkit/ 204, tests/dumpkit/ 77; docs, docstring-contract and convention tests pass.

@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 JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at f60021a88 (Sonnet).

  • Prose only: the AST guard with docstrings stripped is identical on all 20 .py files.
  • Claims: each claim checked against the code, the RFCs and installed upstream code holds:
    • Extractor.run doesn't warn again;
    • name/protocol work at class level for the engine, reassembly and traceflow bases;
    • register_apptype raises during the call and stores nothing;
    • the RFC 791 nesting and both departures;
    • RFC 9293 §3.10.8 and §3.5.3;
    • PCAPKit is not an __engine__ key;
    • warn() reads only VERBOSE, and the _read_flag truthy values;
    • Flags(15) is nameless while Flags(65536) raises;
    • dictdumper Tree wraps strings over 40 characters;
    • the dpkt 1.9.8 recompute rules.
  • Never-released path: the dropped "Moved from" path is in no v* tag (185 checked).
  • Tests: foundation, utilities, interface, toolkit, dumpkit, docstring-contract, docs and convention tests all pass, matching the body's counts.

@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
… interface, toolkit and dumpkit (#1103)

Full read of pcapkit/foundation, utilities, interface, toolkit, dumpkit, the
top-level package and their API pages.

- extraction/engines/registry: Extractor.run warns nothing itself; context
  engines; EngineBase.name works at class level; register_apptype Raises;
  magic_number documented; engine gap table; pcap-ct attributes.
- reassembly/traceflow: RFC 791 pseudocode nesting and departures; RFC 9293
  sections 3.10.8 and 3.5.3; expire, Datagram, Deferred and submit notes;
  name/protocol class-level Notes; typos.
- utilities/interface: engine constants, option length widths, DEVMODE vs
  VERBOSE, ConfigWarning, env var truthy values; never-released config path.
- toolkit/dumpkit: render_enum example, tree newline wrapping, PCAPIO note,
  dpkt reassembly notes checked against dpkt 1.9.8.
@JarryShaw
JarryShaw force-pushed the docs/1103-r7-foundation-pr branch from f60021a to 355a692 Compare October 26, 2026 19:46
@JarryShaw

Copy link
Copy Markdown
Owner Author

CI fix at 355a69248: Project tests failed on test_no_engine_agreement_prose_1708_unit. The new interface/core.py comment said Extractor "takes 'default' as the built-in engine", which matches the guard's "as the other engines" pattern. The comment now says Extractor "resolves" 'default' to its built-in engine. That guard and test_conventions_doc_claims give 38 passed. Comment-only; the AST guard is unchanged.

@JarryShaw
JarryShaw merged commit df42c24 into main Oct 26, 2026
59 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw
JarryShaw deleted the docs/1103-r7-foundation-pr branch October 26, 2026 20:25
@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