跳转至

Session

weilink.Session

Public handle for a WeiLink session.

Obtained via wl.sessions["name"]. Provides read-only properties and management methods (rename, set_default, login, logout).

Example::

wl = WeiLink()
for name in wl.sessions:
    print(name)

s = wl.sessions["zb"]
s.set_default()
s.rename("new_name")

name property

Session name.

bot_id property

Bot identifier, or None if not logged in.

user_id property

WeChat user ID that authorized the bot, or None.

is_connected property

Whether this session has valid credentials.

is_default property

Whether this session is the current default.

created_at property

Epoch timestamp when this session was first saved, or None.

rename(new_name)

Rename this session.

Parameters:

Name Type Description Default
new_name str

New session name.

required

Raises:

Type Description
ValueError

If new_name is already taken or is "default".

set_default()

Set this session as the default.

The default session is used when API methods are called without a session name (e.g. login(), send()).

login(force=False)

Login a session via QR code scan.

Parameters:

Name Type Description Default
force bool

Force a new QR code login even if credentials exist.

False

Returns:

Type Description
BotInfo

BotInfo with bot_id, base_url, and token.

logout()

Logout this session, removing persisted credentials.