Skip to content

docs(corekit,const,vendor): seventh whole-repo pass over corekit, const and vendor (#1103) - #2264

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

JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-corekit-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/corekit, the vendor crawlers and templates, the hand-written const prose, and their API pages. Prose only.

  • AST guard:
    • 27 of 30 .py files are identical with docstrings stripped.
    • The other 3 are vendor templates whose emitted docstring text changed: vendor/ftp/command.py, vendor/http/method.py and vendor/reg/apptype/apptype.py.
    • Each template change is mirrored line for line into the generated const module.
  • corekit:
    • The FieldBase.unpack example and the _nested_types target are corrected.
    • EnumRegistry covers open enums only.
    • The parse_ip_address "nothing catches it" claim is narrowed to what holds.
    • Change-relative wording is restated.
  • vendor:
    • Method.get (the constructor finds hyphenated values before _missing_) and the _sanitize_identifier guard pointer are fixed.
    • Also corrected: TLSKeyLabel.process, AppType Record/svc, the mh flag process Returns, and L2TP process.
    • ipx RFC citations are by section name, and the PCAP-NG Hash Algorithms anchor is fixed.
  • const:
    • The index page says a value no band covers raises.
    • Band names come from each registry's source data.
    • Also fixed: the PCAP-NG anchor, the VLAN :class: role and the OSPF title underline.
  • Tests: tests/const/ 365 passed, tests/vendor/ 169, the tests/corekit nearest selection 375; docs, docstring-contract and convention tests pass.

…st and vendor (#1103)

Full read of pcapkit/corekit, the vendor crawlers and templates, the
hand-written const prose and their API pages.

- corekit: FieldBase.unpack example, _nested_types target, EnumRegistry
  covers open enums only, parse_ip_address claim narrowed, NoDefaultType
  and parse_ip_address change-relative wording.
- vendor: Method.get and _sanitize_identifier template text (mirrored into
  the generated const modules), TLSKeyLabel, AppType Record/svc, mh flag
  process Returns, L2TP process, ipx RFC sections by name, PCAP-NG Hash
  Algorithms anchor, ExtensionHeader/EtherType comments.
- const: index page raise bands and source data, PCAP-NG anchor, VLAN
  class role, OSPF title underline.
@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) const Regenerated IANA or vendor constant tables; members keep their numeric values 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 fe7dd611c (Sonnet).

  • AST guard:
    • 27 of 30 .py files are identical.
    • The 3 vendor templates change only text inside template strings, each identical to the hunk in its generated const module.
    • The two apptype Record edits sit in the crawler's own class, not the template.
  • Claims: each claim checked against the code and the RFC holds:
    • Method('BASELINE-CONTROL') resolves by value;
    • the closed enums sit outside EnumRegistry;
    • IPv4.read builds ToS with from_dict;
    • no try wraps a parse_ip_address/_make_* call;
    • RFC 1634 §4 is "Information Exchange Packet Formats";
    • the PCAP-NG …-optio anchor exists;
    • BlockType(11) raises;
    • PriorityLevel is a class.
  • Tests: const, vendor, docstring-contract, conventions, anchor and docs tests give 660 passed; tests/corekit 693 passed. No text pins.

@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
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, fe7dd611c, 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 fe7dd611c. Part of #1103, round 7: corekit, const and vendor.

  • 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.
  • Ordering: merged into main and run. const leg: 598 tests, 0 failures.
  • Conflicts: none against the current main (5fd197fad, whose vendor-doc commit touches no file in this PR).

@JarryShaw
JarryShaw merged commit 5753d03 into main Oct 26, 2026
66 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-r7-corekit-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

const Regenerated IANA or vendor constant tables; members keep their numeric values 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