Skip to content

fix(const): AppType.get takes EnumLookup.get's default and raises EnumValueError (#2545) #2568

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
Merged

fix(const): AppType.get takes EnumLookup.get's default and raises EnumValueError (#2545) #2568

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
7 changes: 7 additions & 0 deletions docs/source/pcapkit/const/reg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@ registry is one enumeration per transport protocol sharing a memberless base.
:class:`int` to its port number, and compares, orders and hashes as that
port.

.. versionchanged:: 1.6.0

:meth:`AppType.get() <pcapkit.const.reg.apptype.apptype.AppType.get>` takes
the ``default`` of :meth:`~pcapkit.corekit.enum.EnumLookup.get`, and a miss
raises :exc:`~pcapkit.utilities.exceptions.EnumValueError`, still a
:exc:`ValueError`, rather than a builtin one (:issue:`2545`).

.. autoclass:: pcapkit.const.reg.apptype.apptype.AppType
:members:
:undoc-members:
Expand Down
117 changes: 70 additions & 47 deletions pcapkit/const/reg/apptype/apptype.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,10 @@ def get(cls, key: 'int | str', default: 'Any' = NO_DEFAULT) -> 'TransportProtoco
name miss reaches the caller as
:exc:`~pcapkit.utilities.exceptions.EnumKeyError` from the base.
:class:`AppType` and its per-transport registries raise
:exc:`ValueError` from their own ``get()`` because it takes an
:class:`int` port and never accepts a name; that is not a name-miss
policy, so it sets none for this class to follow. The
:exc:`~pcapkit.utilities.exceptions.EnumValueError` from their own
``get()`` because it takes an :class:`int` port and never accepts a
name; that is not a name-miss policy, so it sets none for this class
to follow. The
maintainer's ruling given in review of the work for :issue:`808`, that
:class:`TransportProtocol` is not to be extended at all, holds either
way: the refusal is a refusal and mints nothing, whichever exception
Expand Down Expand Up @@ -2596,12 +2597,27 @@ def _dispatch(cls, key: 'int', proto: 'TransportProtocol | str | int') -> 'Type[
f'{cls.__name__}')

@classmethod
def get(cls, key: 'int', *, # type: ignore[override] # pylint: disable=arguments-differ
def get(cls, key: 'int', default: 'Any' = NO_DEFAULT, *,
proto: 'TransportProtocol | str | int' = TransportProtocol.undefined) -> 'AppType':
"""Resolve port ``key`` to the member for its canonical service.

Takes the ``default`` :meth:`~pcapkit.corekit.enum.EnumLookup.get`
advertises, since an override honours the base's signature rather than
suppressing the mismatch (:issue:`935`), and answers a miss as the base
does, from :mod:`pcapkit.utilities.exceptions` (:issue:`923`).

Args:
key: Port number to look up.
default: An already-registered value to fall back to when ``key``
resolves to nothing: a member's ``value``, such as
``'http [80 - tcp]'``, and not a port or a member, which hashes
as its port. Resolved as
:meth:`~pcapkit.corekit.enum.EnumLookup.get` resolves its own,
through ``_value2member_map_`` and so never minting, in the
registry ``key`` was dispatched to, or else in the class called
on, which on :class:`AppType` itself holds no members.
:data:`~pcapkit.corekit.sentinels.NO_DEFAULT`, the default, means
*no default*.
proto: Transport protocol carrying ``key``. Selects the registry to
search when called on :class:`AppType` itself, which holds no
members; ignored when called on one of those registries, each of
Expand All @@ -2628,53 +2644,60 @@ def get(cls, key: 'int', *, # type: ignore[override] # pylint: disable=argument
registry's own transport (:issue:`2048`).

Raises:
ValueError: If called on a class that holds no members, i.e. on
:class:`AppType` itself, with a ``proto`` naming no registry to
delegate to. Also for a ``key`` that is not a port number, since
this registry resolves ports and not service names -- including
one outside ``0..65535``, whose rejection by :meth:`_missing_` this
method propagates rather than minting over, so that ``get`` is
never more permissive than ``AppType(...)``. Also covers a
``proto`` int that matches no registry at all, composite or
not -- looked up as the whole value it is rather than
decoded into the registries its bits would each name, so it
is refused only when that whole value itself names none of
them, not simply for being composite -- see
:meth:`_dispatch`.
EnumValueError: If ``key`` resolves to nothing and there is no
usable ``default``: a ``key`` that is not a port number, since
this registry resolves ports and not service names, including
one outside ``0..65535``, which :meth:`_missing_` rejects rather
than minting over, so that ``get`` is never more permissive than
``AppType(...)``; or, on :class:`AppType` itself, a ``proto``
naming no registry to delegate to, composite or not (see
:meth:`_dispatch`). A :exc:`ValueError`, and quiet, as from the
base.
EnumKeyError: If, on :class:`AppType` itself, ``proto`` is a name no
:class:`TransportProtocol` member carries, from
:meth:`TransportProtocol.get`.

"""
owner = cls._dispatch(key, proto)
owner = cls
try:
owner = cls._dispatch(key, proto)

matched = owner.__registry__.getlist(key) # type: ignore[union-attr]
if matched:
canonical = owner.__canonical__.get(key)
if canonical is not None:
for member in matched:
if member.svc == canonical:
return member
# NOTE: IANA's oldest row, for a port whose collision postdates
# :data:`__canonical__` -- including one ``aenum.extend_enum``
# created, which must not displace what the registry already
# answered with.
return matched[0]
matched = owner.__registry__.getlist(key) # type: ignore[union-attr]
if matched:
canonical = owner.__canonical__.get(key)
if canonical is not None:
for member in matched:
if member.svc == canonical:
return member
# NOTE: IANA's oldest row, for a port whose collision postdates
# :data:`__canonical__` -- including one ``aenum.extend_enum``
# created, which must not displace what the registry already
# answered with.
return matched[0]

# NOTE: :meth:`_missing_` answers :obj:`None` for a port it holds no row
# for, and that answer does not mint (GitHub issue #860), following the
# owner's ruling there that ``get`` should not mint because it lacks the
# information to create a new member: only IANA-registered values are
# legitimate, and ``register`` is the proper way to add one. That ruling
# was given for the FEATCode, Command and Method branches, and covers
# this family under the same issue. A port outside ``0..65535`` *raises*
# rather than reaching here at all. Minting on the ``None`` answer would
# name a member ``PORT_{key}_{transport}`` -- GitHub issue #758's
# defect, which also minted ``PORT_999999_tcp`` and ``PORT_-1_tcp``, the
# latter a name no attribute access could reach -- so, as inside
# :meth:`_missing_` itself, the port gets an unregistered member
# instead: neither is a value anyone asked to be named. A port IANA
# lists on other transports only is in no span on this one: 8011,
# reserved on TCP and ``bier-echo`` on UDP, answers ``unknown`` on DCCP
# and SCTP (#2048).
ret = owner._missing_(key)
# NOTE: :meth:`_missing_` answers :obj:`None` for a port it holds no row
# for, and that answer does not mint (GitHub issue #860), following the
# owner's ruling there that ``get`` should not mint because it lacks the
# information to create a new member: only IANA-registered values are
# legitimate, and ``register`` is the proper way to add one. That ruling
# was given for the FEATCode, Command and Method branches, and covers
# this family under the same issue. A port outside ``0..65535`` *raises*
# rather than reaching here at all. Minting on the ``None`` answer would
# name a member ``PORT_{key}_{transport}`` -- GitHub issue #758's
# defect, which also minted ``PORT_999999_tcp`` and ``PORT_-1_tcp``, the
# latter a name no attribute access could reach -- so, as inside
# :meth:`_missing_` itself, the port gets an unregistered member
# instead: neither is a value anyone asked to be named. A port IANA
# lists on other transports only is in no span on this one: 8011,
# reserved on TCP and ``bier-echo`` on UDP, answers ``unknown`` on DCCP
# and SCTP (#2048).
ret = owner._missing_(key)
except ValueError as error:
# NOTE: answered as EnumLookup.get answers a value miss (#923, #2545),
# with ``default`` from the registry dispatched to, else from ``cls``.
if default is NO_DEFAULT or default not in owner._value2member_map_:
raise EnumValueError(str(error), quiet=True) from error
return owner._value2member_map_[default]
if ret is None:
ret = owner._unregistered_member(key, 'unknown', owner.__transport__)
return ret
Expand Down
121 changes: 72 additions & 49 deletions pcapkit/vendor/reg/apptype/apptype.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,10 @@ def get(cls, key: 'int | str', default: 'Any' = NO_DEFAULT) -> 'TransportProtoco
name miss reaches the caller as
:exc:`~pcapkit.utilities.exceptions.EnumKeyError` from the base.
:class:`AppType` and its per-transport registries raise
:exc:`ValueError` from their own ``get()`` because it takes an
:class:`int` port and never accepts a name; that is not a name-miss
policy, so it sets none for this class to follow. The
:exc:`~pcapkit.utilities.exceptions.EnumValueError` from their own
``get()`` because it takes an :class:`int` port and never accepts a
name; that is not a name-miss policy, so it sets none for this class
to follow. The
maintainer's ruling given in review of the work for :issue:`808`, that
:class:`TransportProtocol` is not to be extended at all, holds either
way: the refusal is a refusal and mints nothing, whichever exception
Expand Down Expand Up @@ -550,12 +551,27 @@ def _dispatch(cls, key: 'int', proto: 'TransportProtocol | str | int') -> 'Type[
f'{{cls.__name__}}')

@classmethod
def get(cls, key: 'int', *, # type: ignore[override] # pylint: disable=arguments-differ
def get(cls, key: 'int', default: 'Any' = NO_DEFAULT, *,
proto: 'TransportProtocol | str | int' = TransportProtocol.undefined) -> '{NAME}':
"""Resolve port ``key`` to the member for its canonical service.

Takes the ``default`` :meth:`~pcapkit.corekit.enum.EnumLookup.get`
advertises, since an override honours the base's signature rather than
suppressing the mismatch (:issue:`935`), and answers a miss as the base
does, from :mod:`pcapkit.utilities.exceptions` (:issue:`923`).

Args:
key: Port number to look up.
default: An already-registered value to fall back to when ``key``
resolves to nothing: a member's ``value``, such as
``'http [80 - tcp]'``, and not a port or a member, which hashes
as its port. Resolved as
:meth:`~pcapkit.corekit.enum.EnumLookup.get` resolves its own,
through ``_value2member_map_`` and so never minting, in the
registry ``key`` was dispatched to, or else in the class called
on, which on :class:`{NAME}` itself holds no members.
:data:`~pcapkit.corekit.sentinels.NO_DEFAULT`, the default, means
*no default*.
proto: Transport protocol carrying ``key``. Selects the registry to
search when called on :class:`{NAME}` itself, which holds no
members; ignored when called on one of those registries, each of
Expand All @@ -582,53 +598,60 @@ def get(cls, key: 'int', *, # type: ignore[override] # pylint: disable=argument
registry's own transport (:issue:`2048`).

Raises:
ValueError: If called on a class that holds no members, i.e. on
:class:`{NAME}` itself, with a ``proto`` naming no registry to
delegate to. Also for a ``key`` that is not a port number, since
this registry resolves ports and not service names -- including
one outside ``0..65535``, whose rejection by :meth:`_missing_` this
method propagates rather than minting over, so that ``get`` is
never more permissive than ``{NAME}(...)``. Also covers a
``proto`` int that matches no registry at all, composite or
not -- looked up as the whole value it is rather than
decoded into the registries its bits would each name, so it
is refused only when that whole value itself names none of
them, not simply for being composite -- see
:meth:`_dispatch`.
EnumValueError: If ``key`` resolves to nothing and there is no
usable ``default``: a ``key`` that is not a port number, since
this registry resolves ports and not service names, including
one outside ``0..65535``, which :meth:`_missing_` rejects rather
than minting over, so that ``get`` is never more permissive than
``{NAME}(...)``; or, on :class:`{NAME}` itself, a ``proto``
naming no registry to delegate to, composite or not (see
:meth:`_dispatch`). A :exc:`ValueError`, and quiet, as from the
base.
EnumKeyError: If, on :class:`{NAME}` itself, ``proto`` is a name no
:class:`TransportProtocol` member carries, from
:meth:`TransportProtocol.get`.

"""
owner = cls._dispatch(key, proto)

matched = owner.__registry__.getlist(key) # type: ignore[union-attr]
if matched:
canonical = owner.__canonical__.get(key)
if canonical is not None:
for member in matched:
if member.svc == canonical:
return member
# NOTE: IANA's oldest row, for a port whose collision postdates
# :data:`__canonical__` -- including one ``aenum.extend_enum``
# created, which must not displace what the registry already
# answered with.
return matched[0]

# NOTE: :meth:`_missing_` answers :obj:`None` for a port it holds no row
# for, and that answer does not mint (GitHub issue #860), following the
# owner's ruling there that ``get`` should not mint because it lacks the
# information to create a new member: only IANA-registered values are
# legitimate, and ``register`` is the proper way to add one. That ruling
# was given for the FEATCode, Command and Method branches, and covers
# this family under the same issue. A port outside ``0..65535`` *raises*
# rather than reaching here at all. Minting on the ``None`` answer would
# name a member ``PORT_{{key}}_{{transport}}`` -- GitHub issue #758's
# defect, which also minted ``PORT_999999_tcp`` and ``PORT_-1_tcp``, the
# latter a name no attribute access could reach -- so, as inside
# :meth:`_missing_` itself, the port gets an unregistered member
# instead: neither is a value anyone asked to be named. A port IANA
# lists on other transports only is in no span on this one: 8011,
# reserved on TCP and ``bier-echo`` on UDP, answers ``unknown`` on DCCP
# and SCTP (#2048).
ret = owner._missing_(key)
owner = cls
try:
owner = cls._dispatch(key, proto)

matched = owner.__registry__.getlist(key) # type: ignore[union-attr]
if matched:
canonical = owner.__canonical__.get(key)
if canonical is not None:
for member in matched:
if member.svc == canonical:
return member
# NOTE: IANA's oldest row, for a port whose collision postdates
# :data:`__canonical__` -- including one ``aenum.extend_enum``
# created, which must not displace what the registry already
# answered with.
return matched[0]

# NOTE: :meth:`_missing_` answers :obj:`None` for a port it holds no row
# for, and that answer does not mint (GitHub issue #860), following the
# owner's ruling there that ``get`` should not mint because it lacks the
# information to create a new member: only IANA-registered values are
# legitimate, and ``register`` is the proper way to add one. That ruling
# was given for the FEATCode, Command and Method branches, and covers
# this family under the same issue. A port outside ``0..65535`` *raises*
# rather than reaching here at all. Minting on the ``None`` answer would
# name a member ``PORT_{{key}}_{{transport}}`` -- GitHub issue #758's
# defect, which also minted ``PORT_999999_tcp`` and ``PORT_-1_tcp``, the
# latter a name no attribute access could reach -- so, as inside
# :meth:`_missing_` itself, the port gets an unregistered member
# instead: neither is a value anyone asked to be named. A port IANA
# lists on other transports only is in no span on this one: 8011,
# reserved on TCP and ``bier-echo`` on UDP, answers ``unknown`` on DCCP
# and SCTP (#2048).
ret = owner._missing_(key)
except ValueError as error:
# NOTE: answered as EnumLookup.get answers a value miss (#923, #2545),
# with ``default`` from the registry dispatched to, else from ``cls``.
if default is NO_DEFAULT or default not in owner._value2member_map_:
raise EnumValueError(str(error), quiet=True) from error
return owner._value2member_map_[default]
if ret is None:
ret = owner._unregistered_member(key, 'unknown', owner.__transport__)
return ret
Expand Down
Loading
Loading