yuyo.list_status#

Close the counter.

Get a possibly cached guild count from this counter.

Returns:

• int –

  The current guild count(s).

  If this is an int then this is a global count. If this is a mapping then this is shard-specific counts.

Raises:

• CountUnknownError –

  If the count is currently unknown.

Open the counter.

Get user object of the bot this manager is bound to.

Returns:

• User –

  User object of the bot this manager is bound to.

Get an aiohttp session to use to make requests within the services.

Returns:

• ClientSession –

  an aiohttp session to use to make requests within the services.

Raises:

• RuntimeError –
  • If this is called in an environment with no running event loop.
  • If the client isn't running.

Initialise a bots.gg service.

Parameters:

• token (str) –

  Authorization token used to update the bot's status.

Initialise a cache strategy.

Parameters:

• cache (Cache) –

  The cache object this should use for getting the guild count.

• shards (ShardAware) –

  The shard aware client this should use for grouping counts per-shard.

Initialise a discordbotlist.com service.

Parameters:

• token (str) –

  Authorization token used to update the bot's status.

Initialise an event etrategy.

Parameters:

• event_manager (EventManager) –

  The event manager this should use to track shard guild counts.

• shards (ShardAware) –

  The shard manager this should use to track shard guild counts.

Initialise a Sake strategy.

Unlike CacheStrategy and EventStrategy this strategy must be directly initialised and passed to ServiceManager.__init__ as strategy=.

Parameters:

• cache (GuildCache) –

  The Sake guild cache to use to get the guild count.

Initialise a service manager.

Parameters:

• rest (RESTClient) –

  The RESTAware Hikari client to bind this manager to.

• cache (Optional[Cache], default: None ) –

  The cache aware Hikari client this manager should use.

• event_manager (Optional[EventManager], default: None ) –

  The event manager aware Hikari client this manager should use.

• shards (Optional[ShardAware], default: None ) –

  The shard aware Hikari client this manager should use.

• event_managed (Optional[bool], default: None ) –

  Whether this client should be automatically opened and closed based on event_manager's lifetime events.

  Defaults to True when event_manager is passed.

• strategy (Optional[AbstractCountStrategy], default: None ) –

  The counter strategy this manager should expose to services.

  If this is left as None then the manager will try to pick a suitable standard strategy based on the provided Hikari clients.

• user_agent (Optional[str], default: None ) –

  Override the standard user agent used during requests to bot list services.

Raises:

• ValueError –

  If the manager failed to find a suitable standard strategy to use when strategy was left as None.

  If event_managed is passed as True when event_manager is None.

Add a service to this manager.

Parameters:

• service (ServiceSig) –

  Asynchronous callback used to update this service.

• repeat (Union[timedelta, int, float], default: timedelta(hours=1) ) –

  How often this service should be updated in seconds.

Returns:

• Self –

  Object of this service manager.

Raises:

• ValueError –

  If repeat is less than 1 second.

• RuntimeError –

  If the client is already running.

Close this manager.

Build a service manager from a gateway bot.

Parameters:

• bot (ShardAware & RESTAware & EventManagerAware) –

  The gateway bot to build a service manager from.

• event_managed (bool, default: True ) –

  Whether this client should be automatically opened and closed based on bot's lifetime events.

• strategy (Optional[AbstractCountStrategy], default: None ) –

  The counter strategy this manager should expose to services.

  If this is left as None then the manager will try to pick a suitable standard strategy based on the provided Hikari clients.

• user_agent (Optional[str], default: None ) –

  Override the standard user agent used during requests to bot list services.

Returns:

• ServiceManager –

  The build service manager.

Raises:

• ValueError –

  If the manager failed to find a suitable standard strategy to use when strategy was left as None.

Build a service manager from a Tanjun client.

This will use the Tanjun client's alluka client and registers ServiceManager and AbstractManager as type dependencies on Tanjun.

Parameters:

• tanjun_client (Client) –

  The Tanjun client to build a service manager from.

• tanjun_managed (bool, default: True ) –

  Whether this client should be automatically opened and closed based on the Tanjun client's lifetime client callback.

• strategy (Optional[AbstractCountStrategy], default: None ) –

  The counter strategy this manager should expose to services.

  If this is left as None then the manager will try to pick a suitable standard strategy based on the provided Hikari clients.

• user_agent (Optional[str], default: None ) –

  Override the standard user agent used during requests to bot list services.

Returns:

• ServiceManager –

  The build service manager.

Raises:

• ValueError –

  If the manager failed to find a suitable standard strategy to use when strategy was left as None.

Start this manager.

Raises:

• RuntimeError –

  If this manager is already running.

Remove the first found entry of the registered service.

Parameters:

• service (ServiceSig) –

  Service callback to unregister.

Raises:

• RuntimeError –

  If called while the manager is active.

• ValueError –

  If the service callback isn't found.

Add a service to this manager by decorating a function.

Parameters:

• repeat (Union[timedelta, int, float], default: timedelta(hours=1) ) –

  How often this service should be updated in seconds.

Returns:

• Callable[[ServiceSig], ServiceSig] –

  Decorator callback used to add a service.

Raises:

• ValueError –

  If repeat is less than 1 second.

• RuntimeError –

  If the client is already running.

Initialise a top.gg service.

Parameters:

• token (str) –

  Authorization token used to update the bot's status.