Requests Wrapper

The darc.requests module wraps around the requests module, and provides some simple interface for the darc project.

darc.requests.default_user_agent(name='python-darc', proxy=None)

Generates the default user agent.

Parameters:

• name (str) – Base name.

• proxy (Optional[str]) – Proxy type.

Return type:

str

Returns:

User agent in format of {name}/{darc.__version__} ({proxy} Proxy).

darc.requests.i2p_session(futures=False)

I2P (.i2p) session.

Parameters:

futures (bool) – If returns a requests_futures.FuturesSession.

Returns:

The session object with I2P proxy settings.

Return type:

Union[requests.Session, requests_futures.FuturesSession]

See also

• darc.proxy.i2p.I2P_REQUESTS_PROXY

darc.requests.null_session(futures=False)

No proxy session.

Parameters:

futures (bool) – If returns a requests_futures.FuturesSession.

Returns:

The session object with no proxy settings.

Return type:

Union[requests.Session, requests_futures.FuturesSession]

darc.requests.request_session(link, futures=False)

Get requests session.

Parameters:

• link (Link) – Link requesting for requests.Session.

• futures (bool) – If returns a requests_futures.FuturesSession.

Returns:

The session object with corresponding proxy settings.

Return type:

Union[requests.Session, requests_futures.FuturesSession]

Raises:

UnsupportedLink – If the proxy type of link if not specified in the LINK_MAP.

See also

• darc.proxy.LINK_MAP

darc.requests.tor_session(futures=False)

Tor (.onion) session.

Parameters:

futures (bool) – If returns a requests_futures.FuturesSession.

Returns:

The session object with Tor proxy settings.

Return type:

Union[requests.Session, requests_futures.FuturesSession]

See also

• darc.proxy.tor.TOR_REQUESTS_PROXY