Login managementΒΆ

When the website requires to be authenticated, you have to give credentials to the constructor of the browser. You can redefine the method create_default_browser():

from woob.tools.backend import Module
from woob.capabilities.bank import CapBank

class ExampleModule(Module, CapBank):
    # ...
    def create_default_browser(self):
        return self.create_browser(self.config['username'].get(), self.config['password'].get())

On the browser side, you need to inherit from LoginBrowser() and to implement the function do_login():

from woob.browser import LoginBrowser
from woob.exceptions import BrowserIncorrectPassword

class ExampleBrowser(LoginBrowser):
    login = URL('/login', LoginPage)
    # ...

    def do_login(self):

        self.page.login(self.username, self.password)

        if self.login_error.is_here():
            raise BrowserIncorrectPassword(self.page.get_error())

You may provide a custom do_logout() function if you need to customize the default logout process, which simply clears all cookies.

Also, your LoginPage may look like:

from woob.browser.pages import HTMLPage

class LoginPage(HTMLPage):
    def login(self, username, password):
        form = self.get_form(name='auth')
        form['username'] = username
        form['password'] = password

Then, each method on your browser which needs your user to be authenticated may be decorated by need_login():

from woob.browser import LoginBrowser, URL
from woob.browser import need_login

class ExampleBrowser(LoginBrowser):
    accounts = URL('/accounts$', ListPage)

    def iter_accounts(self):
        return self.page.get_accounts()

You finally have to set correctly the logged() attribute of each page you use. The need_login() decorator checks if the current page is a logged one by reading the attribute logged() of the instance. This attributes defaults to False, which means that need_login() will first call do_login() before calling the decorated method.

You can either define it yourself, as a class boolean attribute or as a property, or inherit your class from LoggedPage. In the latter case, remember that Python inheritance requires the LoggedPage to be placed first such as in:

from woob.browser.pages import LoggedPage, HTMLPage

class OnlyForLoggedUserPage(LoggedPage, HTMLPage):
    # ...