login
W&Bのログイン認証情報を設定します。
login(
anonymous: Optional[Literal['must', 'allow', 'never']] = None,
key: Optional[str] = None,
relogin: Optional[bool] = None,
host: Optional[str] = None,
force: Optional[bool] = None,
timeout: Optional[int] = None,
verify: bool = (False)
) -> bool
デフォルトでは、認証情報はW&Bサーバーで検証されることなくローカルにのみ保存されます。認証情報を検証するには、verify=Trueを渡してください。
引数 | |
---|---|
anonymous | (string, optional) "must"、"allow"、"never"のいずれかを指定できます。"must"が設定されると、常に匿名でログインします。"allow"が設定されると、ユーザーが既にログインしていない場合にのみ匿名ユーザーを作成します。 |
key | (string, optional) 認証キー。 |
relogin | (bool, optional) trueに設定すると、APIキーの再入力を求めます。 |
host | (string, optional) 接続するホスト。 |
force | (bool, optional) trueに設定すると、強制的に再ログインします。 |
timeout | (int, optional) ユーザー入力を待つ秒数。 |
verify | (bool) W&Bサーバーで認証情報を検証します。 |
戻り値 | |
---|---|
bool | キーが設定されている場合 |
例外 | |
---|---|
AuthenticationError - api_keyのサーバーでの検証に失敗した場合 UsageError - api_keyが設定できず、ttyがない場合 |