Farama Notifications

Warnings

• gotcha The library is at an early development stage (version 0.0.4). While the Farama Foundation aims for semantic versioning, minor and patch releases (0.x.x) may introduce API changes. Users should review release notes for updates.
  Fix: Refer to the GitHub repository and Farama Foundation's project standards for the latest development practices and potential changes.
• gotcha The primary intent of `farama-notifications` is for Farama Foundation libraries to internally provide runtime and deprecation notifications. Directly manipulating the `farama_notifications.notifications` object by end-users might not be the intended main public API and could be subject to internal changes in how these notifications are managed by dependent libraries.
  Fix: If directly interacting with `farama_notifications.notifications`, be aware that its structure or lifecycle might evolve with updates to Farama Foundation libraries. It's best used for inspection or advanced integration rather than as a primary messaging system for user applications.
• gotcha The `farama_notifications.notifications` object is a mutable global dictionary-like state. Uncoordinated direct modification in complex applications could lead to unexpected behavior, race conditions, or overwriting of messages set by other Farama libraries or parts of your application.
  Fix: Exercise caution when modifying the `farama_notifications.notifications` object. If modifying, consider clear ownership, synchronization mechanisms, or careful key management to avoid conflicts in multi-threaded or complex application environments.

Install

• pip install farama-notifications Install stable version

Imports

• farama_notifications

  import farama_notifications

  The library exposes a module-level dictionary-like object for notifications.

Quickstart

This quickstart demonstrates how to import the `farama_notifications` library and interact with its `notifications` object. Farama libraries typically populate this object with messages upon import or during runtime.

import farama_notifications

# Example of how a notification might be set or retrieved
# In a typical use case, another Farama library would set these notifications.
NOTIFICATION_ID = 'example_event'
NOTIFICATION_MESSAGE = 'A test event has occurred!'

# Set a notification
farama_notifications.notifications[NOTIFICATION_ID] = NOTIFICATION_MESSAGE

# Retrieve and print all notifications
print('Current Farama Notifications:')
for key, value in farama_notifications.notifications.items():
    print(f'- {key}: {value}')

# Example of checking for a specific notification
if 'example_event' in farama_notifications.notifications:
    print(f"Found 'example_event': {farama_notifications.notifications['example_event']}")