magnet.ic package

Submodules

magnet.ic.field module

class magnet.ic.field.Charge(magnet: Magnet)

Bases: object

async emp(name=None)

Deletes the specified stream if the name matches the current stream, or prints an error message if the name doesn’t match or the stream doesn’t exist.

Args:

name (str, optional): The name of the stream to delete. Defaults to None.

async excite(job: dict = {})

Publishes data to the NATS server using the specified category and payload.

Args:

job (dict, optional): The data to be published. Defaults to {}.

async list_streams()

async off()

Disconnects from the NATS server and prints a warning message.

async on()

async pulse(payload: Payload | GeneratedPayload | EmbeddingPayload | JobParams = None, v=False)

Publishes data to the NATS server using the specified category and payload.

Args:

payload (dict): The data to be published.

async reset(name=None)

Purges the specified category if the name matches the current category, or prints an error message if the name doesn’t match or the category doesn’t exist.

Args:

name (str, optional): The name of the category to purge. Defaults to None.

class magnet.ic.field.Resonator(magnet: Magnet)

Bases: object

async conduct(cb=<built-in function print>)

async info()

Retrieves information about a consumer in a JetStream stream.

Parameters:

session – A string representing the session name of the consumer. If not provided, information about all consumers in the stream will be retrieved.

Returns:

None

async listen(cb=<built-in function print>, job_n: int = None, generic: bool = False, verbose=False)

async off()

Unsubscribes from the category and stream and disconnects from the NATS server.

Returns:

None

async on(job: bool = None, local: bool = False, bandwidth: int = 1000)

Connects to the NATS server, subscribes to a specific category in a stream, and consumes messages from that category.

Args:

category (str, optional): The category to subscribe to. Defaults to ‘no_category’. stream (str, optional): The stream to subscribe to. Defaults to ‘documents’. session (str, optional): The session name for durable subscriptions. Defaults to ‘magnet’.

Returns:

None

Raises:

TimeoutError: If there is a timeout error while connecting to the NATS server. Exception: If there is an error in consuming the message or processing the callback function.

async worker(cb=<built-in function print>)

Consume messages from a specific category in a stream and process them as jobs.

Args:

cb (function, optional): The callback function to process the received messages. Defaults to print.

Returns:

None

Raises:

Exception: If there is an error in consuming the message or processing the callback function.