Multithreading Auth

[PrzeG]

Pull Request summary:

Adds support for multithreading authentication, which allows for concurrent requests using the same auth.

Usage example:

from threading import Thread
from catalystwan.session import ManagerSession
from catalystwan.vmanage_auth import vManageAuth
from copy import copy

def print_devices(manager: ManagerSession):
    # using context manager (recommended)
    with manager.login() as session:
        print(session.api.devices.get())

if __name__ =="__main__":

    # 1. Create shared authentication handler for user session
    auth = vManageAuth(username="username", password="password")
    # 2. Configure session with base url and attach authentication handler
    manager = ManagerSession(base_url="https://url:port", auth=auth)
    # 3. Make sure each thread gets own copy of ManagerSession object
    t1 = Thread(target=print_devices, args=(manager,))
    t2 = Thread(target=print_devices, args=(copy(manager),))
    t3 = Thread(target=print_devices, args=(copy(manager),))

    t1.start()
    t2.start()
    t3.start()

    t1.join()
    t2.join()
    t3.join()

    print("Done!")

Checklist:

• Make sure to run pre-commit before committing changes
• Make sure all checks have passed
• PR description is clear and comprehensive
• Mentioned the issue that this PR solves (if applicable)
• Make sure you test the changes

[smialy]

You can create dummy limiter and do it in this way:

Suggested change

	if self._limiter is None:
	response = super(ManagerSession, self).request(method, full_url, *args, **_kwargs)
	else:
	delayed_request = lambda: super(ManagerSession, self).request(method, full_url, *args, **_kwargs)
	response = self._limiter.send_request(delayed_request)
	with self._limiter:
	response = super(ManagerSession, self).request(method, full_url, *args, **_kwargs)

[smialy]

This name suggest something else than it does.

[smialy]

In this moment method clear is not public api method. Maybe you can replace clear(...) by _clear(...) and clear_sync(...) by clear(...)

[smialy]

I don't understand this line. Why we want make auth public after login. Do we need later?

[PrzeG]

Yes, we need it. Auth is called with every request and requests library expects it in that place.

[smialy]

We need it for requests :/

[sbasan]

lgtm