Skip to content

Commit 3e5fbb2

Browse files
committed
refactor(protocols)!: move NoPayload into misc/no_payload.py (#2529)
- `pcapkit.protocols.misc.null` and its `schema.misc.null` and `data.misc.null` modules move to `misc/no_payload.py`, so the module takes its class's name; the class keeps the name `NoPayload`, and nothing is re-exported at the old paths. - Every import, `:class:`/`:mod:` role, `.. module::` target, toctree entry, `ext.rst` row and class-hierarchy click target follows the move; the module and its docs page record `versionadded`/`versionremoved:: 1.6.0`. - protocol-family-grouping.rst leaves nothing pending under #2529. - Tests: `test_no_payload_path_2529_unit.py` pins `ModuleNotFoundError` on the old paths and the new homes; the #1744 ledger gains `MOVED_MODULES`, which pins the `versionremoved` notes; the existing tests import the new paths.
1 parent 18544c3 commit 3e5fbb2

79 files changed

Lines changed: 311 additions & 163 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/source/contributing/conventions/protocol-family-grouping.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,5 +363,4 @@ holds :class:`~pcapkit.protocols.link.linux_sll1.LinuxSLL1`. **The** ``schema/``
363363
``data/`` **modules follow the same layout**: the top-level class takes the module's
364364
name, and sub-structure classes such as
365365
:class:`~pcapkit.protocols.schema.internet.igmpv3.Query` share its module. Ruled on
366-
:issue:`2529`, where the class that does not match yet is pending:
367-
:class:`null.NoPayload <pcapkit.protocols.misc.null.NoPayload>`.
366+
:issue:`2529`.

‎docs/source/ext.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ The protocol classes :mod:`pcapkit` ships:
130130
+ +----------------+-----------------------+-------------------------------------------------------------+
131131
| | :class:`pcapkit.protocols.misc.raw.Raw` |
132132
+ +----------------+-----------------------+-------------------------------------------------------------+
133-
| | :class:`pcapkit.protocols.misc.null.NoPayload` |
133+
| | :class:`pcapkit.protocols.misc.no_payload.NoPayload` |
134134
+------------------------------------------------------------------+----------------+-----------------------+-------------------------------------------------------------+
135135

136136
.. _ext-new-protocol:

‎docs/source/pcapkit/protocols/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ from given information. The class hierarchy of :mod:`pcapkit.protocols`:
190190
click DTLS "application/dtls.html#pcapkit.protocols.application.dtls.DTLS"
191191

192192
click Raw "misc/raw.html#pcapkit.protocols.misc.raw.Raw"
193-
click NoPayload "misc/null.html#pcapkit.protocols.misc.null.NoPayload"
193+
click NoPayload "misc/no_payload.html#pcapkit.protocols.misc.no_payload.NoPayload"
194194
click PCAPNG "misc/pcapng.html#pcapkit.protocols.misc.pcapng.PCAPNG"
195195
click Header "misc/pcap.html#pcapkit.protocols.misc.pcap.header.Header"
196196
click Frame "misc/pcap.html#pcapkit.protocols.misc.pcap.frame.Frame"

‎docs/source/pcapkit/protocols/link/radiotap.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Decoding every optional field radiotap.org defines is tracked on
4747
:attr:`~pcapkit.protocols.data.link.radiotap.Radiotap.fields`.
4848
* **Hands** everything from ``it_len`` on, the 802.11 MAC frame, to
4949
:class:`~pcapkit.protocols.link.ieee802_11.IEEE802_11`
50-
(:class:`~pcapkit.protocols.misc.null.NoPayload` when nothing follows).
50+
(:class:`~pcapkit.protocols.misc.no_payload.NoPayload` when nothing follows).
5151
The header names no next protocol, since an 802.11 frame always follows it,
5252
so the frame is looked up in
5353
:attr:`Radiotap.__proto__ <pcapkit.protocols.link.radiotap.Radiotap.__proto__>`

‎docs/source/pcapkit/protocols/misc/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Auxiliary Protocols
99
These include the PCAP header classes, the PCAP-NG
1010
:class:`~pcapkit.protocols.misc.pcapng.PCAPNG` class, the
1111
:class:`~pcapkit.protocols.misc.raw.Raw` class for not-supported protocols, and
12-
the :class:`~pcapkit.protocols.misc.null.NoPayload` class for indication of
12+
the :class:`~pcapkit.protocols.misc.no_payload.NoPayload` class for indication of
1313
empty payload.
1414

1515
.. toctree::
@@ -18,5 +18,5 @@ empty payload.
1818
pcap
1919
pcapng
2020
raw
21-
null
21+
no_payload
2222
checksum
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
No-Payload Packet
2+
=================
3+
4+
.. module:: pcapkit.protocols.misc.no_payload
5+
6+
:mod:`pcapkit.protocols.misc.no_payload` contains
7+
:class:`~pcapkit.protocols.misc.no_payload.NoPayload` only, which
8+
implements a :class:`~pcapkit.protocols.protocol.Protocol` like
9+
object whose payload is recursively
10+
:class:`~pcapkit.protocols.misc.no_payload.NoPayload` itself.
11+
12+
.. versionadded:: 1.6.0
13+
14+
Moved here from ``pcapkit.protocols.misc.null``, with its data model and
15+
header schema, since a protocol class is named after its module
16+
(:issue:`2529`).
17+
18+
.. versionremoved:: 1.6.0
19+
20+
``pcapkit.protocols.misc.null``, ``pcapkit.protocols.data.misc.null`` and
21+
``pcapkit.protocols.schema.misc.null``, with no alias (:issue:`2529`).
22+
23+
.. autoclass:: pcapkit.protocols.misc.no_payload.NoPayload
24+
:no-members:
25+
:show-inheritance:
26+
27+
.. autoproperty:: name
28+
.. autoproperty:: length
29+
.. autoproperty:: protocol
30+
31+
.. automethod:: read
32+
.. automethod:: make
33+
34+
.. automethod:: __post_init__
35+
.. automethod:: __index__
36+
37+
Header Schemas
38+
--------------
39+
40+
.. module:: pcapkit.protocols.schema.misc.no_payload
41+
42+
.. autoclass:: pcapkit.protocols.schema.misc.no_payload.NoPayload
43+
:members:
44+
:show-inheritance:
45+
46+
Data Models
47+
-----------
48+
49+
.. module:: pcapkit.protocols.data.misc.no_payload
50+
51+
.. autoclass:: pcapkit.protocols.data.misc.no_payload.NoPayload
52+
:members:
53+
:show-inheritance:

‎docs/source/pcapkit/protocols/misc/null.rst‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎pcapkit/corekit/decorators.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def beholder(
108108
This decorator calls the decorated function. Should any exception be
109109
raised, it re-parses the current layer's payload as
110110
:class:`~pcapkit.protocols.misc.raw.Raw` -- or as
111-
:class:`~pcapkit.protocols.misc.null.NoPayload`, if the error is an
111+
:class:`~pcapkit.protocols.misc.no_payload.NoPayload`, if the error is an
112112
end-of-file :exc:`~pcapkit.utilities.exceptions.StructError` -- whose
113113
``error`` is the exception's message.
114114
@@ -185,7 +185,7 @@ def behold(*args: 'P.args', **kwargs: 'P.kwargs') -> 'R_beholder':
185185
beholding.reset(token)
186186
except Exception as exc:
187187
if isinstance(exc, StructError) and exc.eof: # pylint: disable=no-member
188-
from pcapkit.protocols.misc.null import NoPayload as protocol # isort: skip # pylint: disable=import-outside-toplevel
188+
from pcapkit.protocols.misc.no_payload import NoPayload as protocol # isort: skip # pylint: disable=import-outside-toplevel
189189
else:
190190
from pcapkit.protocols.misc.raw import Raw as protocol # type: ignore[assignment] # isort: skip # pylint: disable=import-outside-toplevel
191191
# error = traceback.format_exc(limit=1).strip().rsplit(os.linesep, maxsplit=1)[-1]

‎pcapkit/protocols/application/application.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
from typing import TYPE_CHECKING, Generic, overload
2424

2525
from pcapkit.corekit.protochain import ProtoChain
26-
from pcapkit.protocols.misc.null import NoPayload
26+
from pcapkit.protocols.misc.no_payload import NoPayload
2727
from pcapkit.protocols.protocol import _PT, _ST, ProtocolBase
2828
from pcapkit.protocols.schema.schema import keep_short_read, replay_short_read
2929
from pcapkit.utilities.exceptions import IntError, UnsupportedCall
@@ -49,7 +49,7 @@ class Application(ProtocolBase[_PT, _ST], Generic[_PT, _ST]): # pylint: disable
4949
:class:`~pcapkit.protocols.application.sslv2.SSLv2` and
5050
:class:`~pcapkit.protocols.application.dtls.DTLS` do for a further record and
5151
:class:`~pcapkit.protocols.application.httpv2.HTTPv2` for a further frame --
52-
or to :class:`~pcapkit.protocols.misc.null.NoPayload` when nothing remains.
52+
or to :class:`~pcapkit.protocols.misc.no_payload.NoPayload` when nothing remains.
5353
5454
"""
5555

@@ -124,7 +124,7 @@ def __post_init__(self, file: 'Optional[IO[bytes] | bytes]' = None,
124124
# ``_decode_next_layer``, which already set the payload and the chain
125125
# (basis included); only a protocol that did not gets the empty default
126126
if getattr(self, '_next', None) is None:
127-
#: pcapkit.protocols.misc.null.NoPayload: Payload of current instance.
127+
#: pcapkit.protocols.misc.no_payload.NoPayload: Payload of current instance.
128128
self._next = NoPayload()
129129
#: pcapkit.corekit.protochain.ProtoChain: Protocol chain of current instance.
130130
self._protos = ProtoChain(self.__class__, self.alias)
@@ -179,7 +179,7 @@ def _import_next_layer(self, proto: 'int', length: 'Optional[int]' = None, *, #
179179
180180
Returns:
181181
Instance of :class:`~pcapkit.protocols.misc.raw.Raw`, or of
182-
:class:`~pcapkit.protocols.misc.null.NoPayload` when nothing remains.
182+
:class:`~pcapkit.protocols.misc.no_payload.NoPayload` when nothing remains.
183183
184184
Raises:
185185
UnsupportedCall: If ``proto`` is anything but ``-1``, i.e. a real

‎pcapkit/protocols/application/http.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
from pcapkit.corekit.protochain import ProtoChain
3636
from pcapkit.protocols.application.application import Application
3737
from pcapkit.protocols.data.data import Data
38-
from pcapkit.protocols.misc.null import NoPayload
38+
from pcapkit.protocols.misc.no_payload import NoPayload
3939
from pcapkit.protocols.protocol import _PT, _ST
4040
from pcapkit.utilities.exceptions import ProtocolError
4141

0 commit comments

Comments
 (0)