Base¶
Python objects¶
Define Bodhi’s base classes for its message schemas.
Each message is defined as a Python class. For details, see fedora-messaging documentation on messages.
-
class
bodhi.messages.schemas.base.
BodhiMessage
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
fedora_messaging.message.Message
A base class for Bodhi messages.
-
property
agent
¶ Return the agent’s username for this message.
- Returns
The agent’s username, or None if the body has no agent key.
-
property
agent_avatar
¶ Return a URL to the avatar of the user who caused the action.
- Returns
The URL to the user’s avatar, or None if username is None.
-
property
app_icon
¶ Return a URL that points to the application’s icon.
This is used when displaying the message to users.
- Returns
A URL for Bodhi’s app icon.
-
property
containers
¶ List of containers affected by the action that generated this message.
- Returns
A list of affected container names.
-
property
flatpaks
¶ List of flatpaks affected by the action that generated this message.
- Returns
A list of affected flatpaks names.
-
classmethod
from_dict
(message: dict) → bodhi.messages.schemas.base.BodhiMessage[source]¶ Generate a message based on the given message dictionary.
- Parameters
message – A dictionary representation of the message you wish to instantiate.
- Returns
A Message.
-
property
modules
¶ List of modules affected by the action that generated this message.
- Returns
A list of affected module names.
-
property
usernames
¶ List of users affected by the action that generated this message.
- Returns
A list of affected usernames.
-
property
-
class
bodhi.messages.schemas.base.
BuildV1
[source]¶ Bases:
tuple
A model for referencing a Build.
-
nvr
¶ The koji id of the build.
-
__annotations__
= {'nvr': <class 'str'>}¶
-
__getnewargs__
()¶ Return self as a plain tuple. Used by copy and pickle.
-
static
__new__
(_cls, nvr: str)¶ Create new instance of BuildV1(nvr,)
-
__repr__
()¶ Return a nicely formatted representation string
-
__slots__
= ()¶
-
nvr
Alias for field number 0
-
property
package
¶ Return the name of the package that this build is associated with.
-
-
class
bodhi.messages.schemas.base.
FedMsgEncoder
(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶ Bases:
json.encoder.JSONEncoder
Encoder with convenience support.
If an object has a
__json__()
method, use it to serialize to JSON.
-
class
bodhi.messages.schemas.base.
ReleaseV1
[source]¶ Bases:
tuple
A model for referencing a Release.
-
name
¶ The name of the release.
-
__annotations__
= {'name': <class 'str'>}¶
-
__getnewargs__
()¶ Return self as a plain tuple. Used by copy and pickle.
-
static
__new__
(_cls, name: str)¶ Create new instance of ReleaseV1(name,)
-
__repr__
()¶ Return a nicely formatted representation string
-
__slots__
= ()¶
-
name
Alias for field number 0
-
-
class
bodhi.messages.schemas.base.
UpdateV1
[source]¶ Bases:
tuple
A model for referencing an Update object.
-
alias
¶ The alias of the update.
-
builds
¶ A list of builds associated with the update.
-
__annotations__
= {'alias': <class 'str'>, 'builds': typing.Iterable[bodhi.messages.schemas.base.BuildV1], 'release': ForwardRef('ReleaseV1'), 'request': typing.Union[NoneType, str], 'status': <class 'str'>, 'user': ForwardRef('UserV1')}¶
-
__getnewargs__
()¶ Return self as a plain tuple. Used by copy and pickle.
-
static
__new__
(_cls, alias: str, builds: Iterable[bodhi.messages.schemas.base.BuildV1], user: UserV1, status: str, request: Union[None, str], release: ReleaseV1)¶ Create new instance of UpdateV1(alias, builds, user, status, request, release)
-
__repr__
()¶ Return a nicely formatted representation string
-
__slots__
= ()¶
-
alias
Alias for field number 0
-
builds
Alias for field number 1
-
property
packages
¶ Return a list of package names included in this update.
-
release
¶ Alias for field number 5
-
request
¶ Alias for field number 4
-
status
¶ Alias for field number 3
-
user
¶ Alias for field number 2
-
-
class
bodhi.messages.schemas.base.
UserV1
[source]¶ Bases:
tuple
A model for referencing a User object.
-
name
¶ The User’s account name
-
__annotations__
= {'name': <class 'str'>}¶
-
__getnewargs__
()¶ Return self as a plain tuple. Used by copy and pickle.
-
static
__new__
(_cls, name: str)¶ Create new instance of UserV1(name,)
-
__repr__
()¶ Return a nicely formatted representation string
-
__slots__
= ()¶
-
name
Alias for field number 0
-