woob.capabilities.account
¶
- exception AccountRegisterError[source]¶
Bases:
UserError
Raised when there is an error during registration.
- class Account(id: str = None, url: str = None)[source]¶
Bases:
BaseObject
Describe an account and its properties.
- Variables
url – (
str
) urllogin – (
str
) Loginpassword – (
str
) Passwordproperties – (
dict
) List of key/value properties
- class StatusField(key: str, label: str, value: str, flags: Optional[int] = 0, url: Optional[str] = None)[source]¶
Bases:
BaseObject
Field of an account staeobjectus.
- Variables
url – (
str
) urlkey – (
str
) Keylabel – (
str
) Labelvalue – (
str
) Valueflags – (
int
) Flags
- FIELD_TEXT = 1¶
- FIELD_HTML = 2¶
- class CapAccount[source]¶
Bases:
Capability
Capability for websites when you can create and manage accounts.
- Variables
ACCOUNT_REGISTER_PROPERTIES – This class constant may be a list of
woob.tools.value.Value
objects. If the value remains None, woob considers thatregister_account()
isn’t supported.
- ACCOUNT_REGISTER_PROPERTIES = None¶
- static register_account(account: Account)[source]¶
Register an account on website
This is a static method, it would be called even if the backend is instancied.
- Parameters
account (
Account
) – describe the account to create- Raises
- get_account_status() List[StatusField] [source]¶
Get status of the current account.
- Returns
a list of fields
- Return type
list[StatusField]
- class CapCredentialsCheck[source]¶
Bases:
Capability