example_package package

Module contents

example_package.example_function(response: requests.models.Response, status: http.HTTPStatus, stream: IO[str] = sys.stdout) → requests.models.Request

Example function using requests.

It looks like autodoc is resolving type hints like requests.Response to their internal definition, e.g. requests.models.Response. This caused an issue (now fixed) with intersphinx references.

For comparison, this function includes type hints for the Python standard library and explicit references to the public APIs via interphinx-untangled.

Parameters

• response – A requests.Response instance.

• status – An http.HTTPStatus instance.

• stream – A typing.IO instance.

Returns

A requests.Request instance.

Raises

requests.HTTPError – A requests.HTTPError instance.

example_package.example_partial(response: requests.models.Response, *, status: http.HTTPStatus = HTTPStatus.ACCEPTED, stream: IO[str] = sys.stdout) → requests.models.Request

Example partial with default value for status.