Skip to content

refactor(protocols): reorder misc, schema and base class members to the member-order convention (#2490) #2539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JarryShaw merged 1 commit into from
Nov 1, 2026
+989 −989
Merged

refactor(protocols): reorder misc, schema and base class members to the member-order convention (#2490) #2539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 56 additions & 56 deletions pcapkit/protocols/misc/pcap/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,36 +521,6 @@ def __length_hint__(self) -> 'Literal[16]':
"""Return an estimated length for the object."""
return RECORD_HEADER_LEN # type: ignore[return-value]

def _check_record_floor(self, length: 'Optional[int]') -> 'None':
"""Refuse a tail too short to hold a record header.

Args:
length: Length of packet data, as the caller declared it, or
:obj:`None` to measure what is left in
:attr:`self._file <pcapkit.protocols.protocol.Protocol._file>`.

Raises:
StreamEOFError: If fewer than sixteen octets are left to read.

A PCAP record header is sixteen octets, which is what
:meth:`__length_hint__` reports. A shorter tail is not a record, so
parsing one would only invent fields from zero padding. Reporting the
end of the stream instead lets :meth:`Extractor.record_frames
<pcapkit.foundation.extraction.Extractor.record_frames>` stop with the
frames read so far, as the PCAP-NG reader does for a truncated block
(:issue:`678`). See :issue:`1265`.

"""
if length is None:
current = self._file.tell()
length = self._file.seek(0, io.SEEK_END) - current
self._file.seek(current, io.SEEK_SET)

if length < RECORD_HEADER_LEN:
raise StreamEOFError(f'PCAP: record truncated: {length} octet(s) left, '
f'fewer than the {RECORD_HEADER_LEN} a record header needs',
quiet=True)

# NOTE: This is a hack to make the ``__index__`` method work both as a
# class method and an instance method.
def __index__(self: 'Optional[Frame]' = None) -> 'int': # type: ignore[override]
Expand Down Expand Up @@ -601,38 +571,35 @@ def _make_data(cls, data: 'Data_Frame') -> 'dict[str, Any]': # type: ignore[ove
'packet': cls._make_payload(data),
}

def _make_timestamp(self, timestamp: 'Optional[float | Decimal | dt_type | int]' = None, ts_sec: 'Optional[int]' = None,
ts_usec: 'Optional[int]' = None, nanosecond: 'bool' = False) -> 'tuple[int, int]':
"""Make timestamp.
def _check_record_floor(self, length: 'Optional[int]') -> 'None':
"""Refuse a tail too short to hold a record header.

Args:
timestamp: UNIX-Epoch timestamp
ts_sec: timestamp seconds
ts_usec: timestamp microseconds
nanosecond: nanosecond-resolution file flag

Returns:
Second and microsecond/nanosecond value of timestamp.
length: Length of packet data, as the caller declared it, or
:obj:`None` to measure what is left in
:attr:`self._file <pcapkit.protocols.protocol.Protocol._file>`.

"""
with localcontext(prec=64):
if timestamp is None:
if nanosecond:
timestamp = decimal.Decimal(time.time_ns()) / 1_000_000_000
else:
timestamp = decimal.Decimal(time.time())
else:
if isinstance(timestamp, datetime.datetime):
timestamp = totimestamp(timestamp)
timestamp = decimal.Decimal(timestamp)
Raises:
StreamEOFError: If fewer than sixteen octets are left to read.

if ts_sec is None:
ts_sec = int(timestamp)
A PCAP record header is sixteen octets, which is what
:meth:`__length_hint__` reports. A shorter tail is not a record, so
parsing one would only invent fields from zero padding. Reporting the
end of the stream instead lets :meth:`Extractor.record_frames
<pcapkit.foundation.extraction.Extractor.record_frames>` stop with the
frames read so far, as the PCAP-NG reader does for a truncated block
(:issue:`678`). See :issue:`1265`.

if ts_usec is None:
ts_usec = int((timestamp - ts_sec) * RESOLUTION[bool(nanosecond)])
"""
if length is None:
current = self._file.tell()
length = self._file.seek(0, io.SEEK_END) - current
self._file.seek(current, io.SEEK_SET)

return ts_sec, ts_usec
if length < RECORD_HEADER_LEN:
raise StreamEOFError(f'PCAP: record truncated: {length} octet(s) left, '
f'fewer than the {RECORD_HEADER_LEN} a record header needs',
quiet=True)

def _decode_next_layer(self, dict_: 'Data_Frame', proto: 'Optional[int]' = None,
length: 'Optional[int]' = None, *, packet: 'Optional[dict[str, Any]]' = None) -> 'Data_Frame': # pylint: disable=arguments-differ
Expand Down Expand Up @@ -680,6 +647,39 @@ def _decode_next_layer(self, dict_: 'Data_Frame', proto: 'Optional[int]' = None,
self._protos = chain # pylint: disable=attribute-defined-outside-init
return dict_

def _make_timestamp(self, timestamp: 'Optional[float | Decimal | dt_type | int]' = None, ts_sec: 'Optional[int]' = None,
ts_usec: 'Optional[int]' = None, nanosecond: 'bool' = False) -> 'tuple[int, int]':
"""Make timestamp.

Args:
timestamp: UNIX-Epoch timestamp
ts_sec: timestamp seconds
ts_usec: timestamp microseconds
nanosecond: nanosecond-resolution file flag

Returns:
Second and microsecond/nanosecond value of timestamp.

"""
with localcontext(prec=64):
if timestamp is None:
if nanosecond:
timestamp = decimal.Decimal(time.time_ns()) / 1_000_000_000
else:
timestamp = decimal.Decimal(time.time())
else:
if isinstance(timestamp, datetime.datetime):
timestamp = totimestamp(timestamp)
timestamp = decimal.Decimal(timestamp)

if ts_sec is None:
ts_sec = int(timestamp)

if ts_usec is None:
ts_usec = int((timestamp - ts_sec) * RESOLUTION[bool(nanosecond)])

return ts_sec, ts_usec

def _dispatch_linktype(self, proto: 'Optional[int]', length: 'Optional[int]' = None) -> 'Optional[int]':
"""Link type a frame's data is dispatched under.

Expand Down
32 changes: 16 additions & 16 deletions pcapkit/protocols/misc/pcap/header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,22 @@ def make(self,
reversed=network_reversed, pack=False),
)

@classmethod
def from_data(cls, data: 'Data_Header | dict[str, Any]', **kwargs: 'Any') -> 'Self':
"""Create protocol instance from data.

Args:
data: Protocol data.
**kwargs: Construction keywords, as for :meth:`Protocol.from_data
<pcapkit.protocols.protocol.Protocol.from_data>`.

Returns:
Protocol instance, cut back to what was captured when the header
it was parsed from was cut short (:issue:`1470`).

"""
return replay_short_read(super().from_data(data, **kwargs), data)

##########################################################################
# Data models.
##########################################################################
Expand Down Expand Up @@ -281,22 +297,6 @@ def __length_hint__(self) -> 'Literal[24]':
"""Return an estimated length for the object."""
return GLOBAL_HEADER_LEN # type: ignore[return-value]

@classmethod
def from_data(cls, data: 'Data_Header | dict[str, Any]', **kwargs: 'Any') -> 'Self':
"""Create protocol instance from data.

Args:
data: Protocol data.
**kwargs: Construction keywords, as for :meth:`Protocol.from_data
<pcapkit.protocols.protocol.Protocol.from_data>`.

Returns:
Protocol instance, cut back to what was captured when the header
it was parsed from was cut short (:issue:`1470`).

"""
return replay_short_read(super().from_data(data, **kwargs), data)

@classmethod
def __index__(cls) -> 'NoReturn':
"""Numeral registry index of the protocol.
Expand Down
Loading
Loading