pass session object to client

[mishaschwartz]

Add option to make requests with WeaverClient using a requests.Session instance.

This allows requests to be made with the session cookies that may already be attached to this requests.Session instance.

Useful as an alternative to authenticating with an auth argument when a user has already authenticated and they have access to the session cookie. This is mostly so that we can take advantage of this feature with weaver bird-house/birdhouse-deploy#407

[fmigneault]

@mishaschwartz
Why not use the MagpieAuth object directly?
https://pavics-weaver.readthedocs.io/en/latest/cli.html#authentication-example

Alternatively, could also use https://pavics-weaver.readthedocs.io/en/latest/autoapi/weaver/cli/index.html#weaver.cli.CookieAuthHandler

[fmigneault]

Not sure if the session object is serializable for the caching decorator.

Would also avoid the extra parameter. Everything should be in RequestCachingKeywords.

[mishaschwartz]

Not sure if the session object is serializable for the caching decorator.

Local tests seem to show that it caches it ok.

Everything should be in RequestCachingKeywords

Are you sure? These get passed directly to session.request in the underlying function and that doesn't have a session parameter. So we'd have to factor it out later on.

[fmigneault]

See PR comment about using other AuthHandler alternatives. Seems to me that available ones are sufficient to handle the use case (passing Magpie cookies).

If they are still not sufficient for some reason (please justify if so), I would rather have a SessionAuthHandler that reuses the same auth parameter instead of adding a new one only for that use case.

[mishaschwartz]

Seems to me that available ones are sufficient to handle the use case

Unless I'm missing some other way of using these handlers, I think they cover a different use case (see: #597 (comment))

I would rather have a SessionAuthHandler

Actually that would be really easy. We could do something like:

class SessionAuthHandler(AuthBase):
    def __init__(self, session):
        self.session = session

    def __call__(self, r):
        r.prepare_cookies(self.session.cookies)
        return r

I actually like this a lot better than my initial solution... if you're ok with it as well I can update this PR with the new handler

[mishaschwartz]

Why not use the MagpieAuth object directly?
Alternatively, could also use ... [CookieAuthHandler]

Both of these make a request to a URL to obtain a token/cookie. The session strategy is for the use-case where you already have the session cookies. It's the same use-case that motivated this change (bird-house/birdhouse-deploy#407)