usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

lib.wiring: remove stray references to signature freezing.

Browse source
This commit is contained in:
Wanda 2024-03-25 14:52:11 +01:00 committed by Catherine
parent efcd9a4538
commit cd51e02de2
1 changed files with 3 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
amaranth/lib/wiring.py
View file

@ -324,14 +324,11 @@ class Member:
class SignatureError(Exception): class SignatureError(Exception):
""" """
This exception is raised when an invalid operation specific to signature manipulation is This exception is raised when an invalid operation specific to signature manipulation is
performed with :class:`SignatureMembers`, such as adding a member to a frozen signature. performed with :class:`SignatureMembers`. Other exceptions, such as :exc:`TypeError` or
Other exceptions, such as :exc:`TypeError` or :exc:`NameError`, will still be raised where :exc:`NameError`, will still be raised where appropriate.
appropriate.
""" """
# Inherits from Mapping and not MutableMapping because it's only mutable in a very limited way
# and most of the methods (except for `update`) added by MutableMapping are useless.
@final @final
class SignatureMembers(Mapping): class SignatureMembers(Mapping):
"""Mapping of signature member names to their descriptions. """Mapping of signature member names to their descriptions.
@ -340,13 +337,7 @@ class SignatureMembers(Mapping):
attribute of signature objects. attribute of signature objects.
The keys in this container must be valid Python attribute names that are public (do not begin The keys in this container must be valid Python attribute names that are public (do not begin
with an underscore. The values must be instances of :class:`Member`. The container is mutable with an underscore. The values must be instances of :class:`Member`. The container is immutable.
in a restricted manner: new keys may be added, but existing keys may not be modified or removed.
In addition, the container can be `frozen`, which disallows addition of new keys. Freezing
a container recursively freezes the members of any signatures inside.
In addition to the use of the superscript operator, multiple members can be added at once with
the :py:`+=` opreator.
The :meth:`create` method converts this mapping into a mapping of names to signature members The :meth:`create` method converts this mapping into a mapping of names to signature members
(signals and interface objects) by creating them from their descriptions. The created mapping (signals and interface objects) by creating them from their descriptions. The created mapping