Skip to content

docs: fix Extractor's exception mismatch and 40 phantom/stale Args: labels #501

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 3 commits into from
Sep 19, 2026
Merged

docs: fix Extractor's exception mismatch and 40 phantom/stale Args: labels #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34eba6f
docs: fix Extractor exception mismatch and phantom Args: params (#490)
JarryShaw Sep 19, 2026
1aef7bd
docs: clarify RFC 815 vs RFC 791 framing in TCP reassembly algorithm …
JarryShaw Sep 19, 2026
560abda
Merge branch 'main' into fix/490-docstrings-vs-code
JarryShaw Sep 19, 2026
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
9 changes: 5 additions & 4 deletions docs/source/pcapkit/foundation/reassembly/tcp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@ Algorithm
} give up until (no entry from HDL)
}

The following algorithm implement is based on **IP Datagram
Reassembly Algorithm** introduced in :rfc:`815`. It described an
algorithm dealing with ``RCVBT`` (fragment received bit table)
appeared in :rfc:`791`. And here is the process:
The following algorithm implement is based on the **IP Datagram
Reassembly Algorithm** introduced in :rfc:`815`, which presents hole
descriptors as an alternative to the ``RCVBT`` (fragment received bit
table) approach used by the reassembly procedure in :rfc:`791`. And
here is the process:

1. Select the next hole descriptor from the hole descriptor
list. If there are no more entries, go to step eight.
Expand Down
4 changes: 2 additions & 2 deletions pcapkit/foundation/extraction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,8 +1019,8 @@ def __call__(self) -> '_P':
"""Works as a simple wrapper for the iteration protocol.

Raises:
IterableError: If :attr:`self._flag_a <pcapkit.foundation.extraction.Extractor._flag_a>`
is :data:`True`, as iteration is not applicable.
CallableError: If :attr:`self._flag_a <pcapkit.foundation.extraction.Extractor._flag_a>`
is :data:`True`, as such operation is not applicable.

"""
if not self._flag_a:
Expand Down
34 changes: 17 additions & 17 deletions pcapkit/protocols/internet/hopopt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ def make(self,
next_default: Default value of next header type.
next_namespace: Namespace of next header type.
next_reversed: If the namespace of next header type is reversed.
option: Hop-by-Hop Options.
options: Hop-by-Hop Options.
payload: Payload of current protocol.
**kwargs: Arbitrary keyword arguments.

Expand Down Expand Up @@ -499,7 +499,7 @@ def _read_opt_none(self, schema: 'Schema_UnassignedOption', *, options: 'Option'

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -537,7 +537,7 @@ def _read_opt_pad(self, schema: 'Schema_PadOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -594,7 +594,7 @@ def _read_opt_tun(self, schema: 'Schema_TunnelEncapsulationLimitOption', *, opti

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -628,7 +628,7 @@ def _read_opt_ra(self, schema: 'Schema_RouterAlertOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -668,7 +668,7 @@ def _read_opt_calipso(self, schema: 'Schema_CALIPSOOption', *, options: 'Option'

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -732,7 +732,7 @@ def _read_opt_smf_dpd(self, schema: 'Schema_SMFDPDOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -795,7 +795,7 @@ def _read_opt_pdm(self, schema: 'Schema_PDMOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -854,7 +854,7 @@ def _read_opt_qs(self, schema: 'Schema_QuickStartOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -917,7 +917,7 @@ def _read_opt_rpl(self, schema: 'Schema_RPLOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -961,7 +961,7 @@ def _read_opt_mpl(self, schema: 'Schema_MPLOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1022,7 +1022,7 @@ def _read_opt_ilnp(self, schema: 'Schema_ILNPOption', *, options: 'Option') -> '

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1054,7 +1054,7 @@ def _read_opt_lio(self, schema: 'Schema_LineIdentificationOption', *, options: '

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1085,7 +1085,7 @@ def _read_opt_jumbo(self, schema: 'Schema_JumboPayloadOption', *, options: 'Opti

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1129,7 +1129,7 @@ def _read_opt_home(self, schema: 'Schema_HomeAddressOption', *, options: 'Option

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1167,7 +1167,7 @@ def _read_opt_ip_dff(self, schema: 'Schema_IPDFFOption', *, options: 'Option') -

Args:
schema: parsed parameter schema
option: extracted HOPOPT options
options: extracted HOPOPT options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1238,7 +1238,7 @@ def _make_hopopt_options(self, options: 'list[Schema_Option | tuple[Enum_Option,
"""Make options for HOPOPT.

Args:
option: HOPOPT options
options: HOPOPT options

Returns:
Tuple of options and total length of options.
Expand Down
34 changes: 17 additions & 17 deletions pcapkit/protocols/internet/ipv6_opts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ def make(self,
next_default: Default value of next header type.
next_namespace: Namespace of next header type.
next_reversed: If the namespace of next header type is reversed.
option: Hop-by-Hop Options.
options: Hop-by-Hop Options.
payload: Payload of current protocol.
**kwargs: Arbitrary keyword arguments.

Expand Down Expand Up @@ -510,7 +510,7 @@ def _read_opt_none(self, schema: 'Schema_UnassignedOption', *, options: 'Option'

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -548,7 +548,7 @@ def _read_opt_pad(self, schema: 'Schema_PadOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -606,7 +606,7 @@ def _read_opt_tun(self, schema: 'Schema_TunnelEncapsulationLimitOption', *, opti

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -640,7 +640,7 @@ def _read_opt_ra(self, schema: 'Schema_RouterAlertOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -680,7 +680,7 @@ def _read_opt_calipso(self, schema: 'Schema_CALIPSOOption', *, options: 'Option'

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -744,7 +744,7 @@ def _read_opt_smf_dpd(self, schema: 'Schema_SMFDPDOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -807,7 +807,7 @@ def _read_opt_pdm(self, schema: 'Schema_PDMOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -866,7 +866,7 @@ def _read_opt_qs(self, schema: 'Schema_QuickStartOption', *, options: 'Option')

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -929,7 +929,7 @@ def _read_opt_rpl(self, schema: 'Schema_RPLOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -973,7 +973,7 @@ def _read_opt_mpl(self, schema: 'Schema_MPLOption', *, options: 'Option') -> 'Da

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1034,7 +1034,7 @@ def _read_opt_ilnp(self, schema: 'Schema_ILNPOption', *, options: 'Option') -> '

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1066,7 +1066,7 @@ def _read_opt_lio(self, schema: 'Schema_LineIdentificationOption', *, options: '

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1097,7 +1097,7 @@ def _read_opt_jumbo(self, schema: 'Schema_JumboPayloadOption', *, options: 'Opti

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1141,7 +1141,7 @@ def _read_opt_home(self, schema: 'Schema_HomeAddressOption', *, options: 'Option

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1179,7 +1179,7 @@ def _read_opt_ip_dff(self, schema: 'Schema_IPDFFOption', *, options: 'Option') -

Args:
schema: parsed parameter schema
option: extracted IPv6-Opts options
options: extracted IPv6-Opts options

Returns:
Parsed option data.
Expand Down Expand Up @@ -1250,7 +1250,7 @@ def _make_ipv6_opts(self, options: 'list[Schema_Option | tuple[Enum_Option, dict
"""Make options for IPv6-Opts.

Args:
option: IPv6-Opts options
options: IPv6-Opts options

Returns:
Tuple of options and total length of options.
Expand Down
3 changes: 2 additions & 1 deletion pcapkit/protocols/internet/ipv6_route.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,8 @@ def _read_data_type_rpl(self, schema: 'Schema_RPL', *, header: 'Schema_IPv6_Rout
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Args:
length: route data length
schema: parsed routing data schema
header: parsed IPv6-Route header schema

Returns:
Parsed route data.
Expand Down
1 change: 0 additions & 1 deletion pcapkit/protocols/link/ospf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,6 @@ def _make_encrypt_auth(self,
"""Make Authentication field when Cryptographic Authentication is employed.

Args:
auth_type: Authentication type.
auth_data: Authentication data.

Returns:
Expand Down
Loading
Loading