Skip to content

refactor(corekit)!: Info.to_dict() returns an OrderedMultiDict; add MultiInfo and OrderedMultiInfo (#1484) #1523

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
Oct 10, 2026
Merged

refactor(corekit)!: Info.to_dict() returns an OrderedMultiDict; add MultiInfo and OrderedMultiInfo (#1484) #1523

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
24 changes: 23 additions & 1 deletion docs/source/pcapkit/corekit/infoclass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ Info Class

:mod:`pcapkit.corekit.infoclass` contains the :obj:`dict`-like class
:class:`~pcapkit.corekit.infoclass.Info`, modelled on
:func:`dataclasses.dataclass` (:pep:`557`).
:func:`dataclasses.dataclass` (:pep:`557`), and the immutable multi-mapping
classes :class:`~pcapkit.corekit.infoclass.MultiInfo` and
:class:`~pcapkit.corekit.infoclass.OrderedMultiInfo` that a finalised
:class:`~pcapkit.corekit.infoclass.Info` holds its option lists in.

.. autoclass:: pcapkit.corekit.infoclass.Info
:members:
Expand All @@ -24,16 +27,35 @@ Info Class

.. autodecorator:: pcapkit.corekit.infoclass.info_final

.. autoclass:: pcapkit.corekit.infoclass.MultiInfo
:no-members:
:show-inheritance:

.. autoclass:: pcapkit.corekit.infoclass.OrderedMultiInfo
:no-members:
:show-inheritance:

Internal Definitions
--------------------

.. autoclass:: pcapkit.corekit.infoclass.InfoMeta
:no-members:
:show-inheritance:

.. autoclass:: pcapkit.corekit.infoclass._MultiInfo
:no-members:
:show-inheritance:

.. autoclass:: pcapkit.corekit.infoclass._OrderedMultiDict
:no-members:
:show-inheritance:

Type Variables
--------------

.. data:: pcapkit.corekit.infoclass.KT
:type: typing.Any

.. data:: pcapkit.corekit.infoclass.VT
:type: typing.Any

Expand Down
9 changes: 0 additions & 9 deletions docs/source/pcapkit/corekit/multidict.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,6 @@ values per key, based on the `Werkzeug`_ project.
:no-special-members: __init__
:show-inheritance:

.. autoclass:: pcapkit.corekit.multidict.InfoDict
:no-members:
:no-special-members: __init__
:show-inheritance:

.. automethod:: keys
.. automethod:: values
.. automethod:: items

Type Variables
--------------

Expand Down
1 change: 1 addition & 0 deletions pcapkit/all.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
# pcapkit.corekit
'EnumRegistry', # Enum Registry
'Info', 'info_final', # Info Class
'MultiInfo', 'OrderedMultiInfo',
'ProtoChain', # ProtoChain
'VersionInfo', # Version
'NumberField', 'Int32Field', 'UInt32Field', # numeric protocol fields
Expand Down
3 changes: 2 additions & 1 deletion pcapkit/corekit/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class :class:`~pcapkit.corekit.infoclass.Info`,
from pcapkit.corekit.io import SeekableReader
from pcapkit.corekit.enum import EnumRegistry
from pcapkit.corekit.fields import *
from pcapkit.corekit.infoclass import Info, info_final
from pcapkit.corekit.infoclass import Info, MultiInfo, OrderedMultiInfo, info_final
from pcapkit.corekit.module import ModuleDescriptor
from pcapkit.corekit.multidict import MultiDict, OrderedMultiDict
from pcapkit.corekit.protochain import ProtoChain
Expand All @@ -29,6 +29,7 @@ class :class:`~pcapkit.corekit.infoclass.Info`,
'EnumRegistry',

'Info', 'info_final',
'MultiInfo', 'OrderedMultiInfo',

'ProtoChain',

Expand Down
Loading
Loading