Repository navigation
docs(corekit): second-round pass over corekit, dumpkit, toolkit, utilities and interface prose (#719) - #1089
Merged
Merged
Conversation
JarryShaw
marked this pull request as draft
October 6, 2026 17:27
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
JarryShaw
force-pushed
the
docs/719-r2-corekit
branch
from
October 6, 2026 17:38
8b4a0f8 to
0e1f486
Compare
…ities and interface prose (#719) Docstrings and comments only; every touched file's syntax tree matches origin/main once bare string statements are stripped. - Cut leftover timed context ("used to", "now", "no longer", "since #nnn", PR-by-PR history) across 26 files, restating the rationale it carried as the present-tense hazard it guards against. - Correct claims the code contradicts: NullType's copy hooks are not what keeps copy/deepcopy identity (the __new__ guard is); the sentinel re-exports are one import line, not three; Info is a Mapping, not a dict subclass; ProtoChain.__str__ returns colon-joined aliases; Method.get builds an unregistered member rather than minting; the NO_DEFAULT reload probe raises EnumKeyError; PayloadField's registry seed is at pcapkit/protocols/__init__.py:76; the CLI's emoji dependency is optional; beholder re-parses the payload, not self._file; OSPF/RARP/DRARP are application-layer in all.py; DPKT/PyShark adapters take their own packet types; PyShark tcp_traceflow returns trace data, not a tuple. - Drop a duplicated paragraph in the PyShark filter-name table notes, and fix typos and a broken role.
JarryShaw
force-pushed
the
docs/719-r2-corekit
branch
from
October 6, 2026 17:38
0e1f486 to
bb89dd2
Compare
JarryShaw
marked this pull request as ready for review
October 6, 2026 17:39
Owner
Author
|
Cross-review verdict on
Nit: in the UNVERIFIED: no Sphinx run by the reviewer (the worker reports 17 fewer warnings than |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeAdded a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Second-round #719 pass over all 43 files in
pcapkit/corekit/,dumpkit/,toolkit/,utilities/,interface/and the three top-level modules, every file read in full; 26 changed. Docstrings and comments only.NullType's copy/deepcopy identity comes from the__new__guard, not its copy hooks; the sentinel re-exports are one line, not three;Infois aMapping, not adictsubclass;ProtoChain.__str__returns colon-joined aliases;Method.getbuilds an unregistered member rather than minting; theNO_DEFAULTreload probe raisesEnumKeyError; the__proto__seed is atprotocols/__init__.py:76;emojiis optional for the CLI;beholderre-parses the payload, notself._file; OSPF/RARP/DRARP are application-layer inall.py; PySharktcp_traceflowreturns trace data, not a tuple.make test. Run: the modules undertests/{corekit,dumpkit,interface,toolkit,utilities,cli,project},tests/test_docstring_contract.py, andtests/protocols/test_protocol_base_unit.py, one per process, all green. Sphinx-non fresh output: no new warnings for these files, 17 fewer.utilities/compat.py, the werkzeug-basedcorekit/multidict.py) are untouched; their non-vendored prose was read and needs nothing.AST guard (docstrings and bare-string statements stripped, compared to the merge base
62a79897c):pcapkit/__init__.pypcapkit/__main__.pypcapkit/all.pypcapkit/corekit/enum.pypcapkit/corekit/fields/collections.pypcapkit/corekit/fields/field.pypcapkit/corekit/fields/ipaddress.pypcapkit/corekit/fields/misc.pypcapkit/corekit/fields/numbers.pypcapkit/corekit/fields/strings.pypcapkit/corekit/infoclass.pypcapkit/corekit/io.pypcapkit/corekit/module.pypcapkit/corekit/protochain.pypcapkit/corekit/sentinels.pypcapkit/dumpkit/common.pypcapkit/dumpkit/pcap.pypcapkit/interface/misc.pypcapkit/toolkit/dpkt.pypcapkit/toolkit/pcapng.pypcapkit/toolkit/pypcapfile.pypcapkit/toolkit/pyshark.pypcapkit/toolkit/scapy.pypcapkit/utilities/__init__.pypcapkit/utilities/decorators.pypcapkit/utilities/exceptions.pyPart of #719.