File: api.rst

package info (click to toggle)
python-nvchecker 2.16-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 736 kB
  • sloc: python: 4,801; makefile: 25
file content (26 lines) | stat: -rw-r--r-- 813 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
``nvchecker.api`` --- The source plugin API
===========================================

.. automodule:: nvchecker.api
   :members:
   :imported-members:
   :undoc-members:

.. py:data:: session
   :type: nvchecker.httpclient.base.BaseSession

   The object to send out HTTP requests, respecting various options in the configuration entry.

.. automodule:: nvchecker.httpclient.base
   :members: BaseSession, Response
   :undoc-members:

.. autodata:: nvchecker.api.proxy
.. autodata:: nvchecker.api.user_agent
.. autodata:: nvchecker.api.tries
.. autodata:: nvchecker.api.verify_cert

.. py:data:: nvchecker.api.entry_waiter
   :type: contextvars.ContextVar

   This :class:`ContextVar <contextvars.ContextVar>` contains an :class:`EntryWaiter <nvchecker.api.EntryWaiter>` instance for waiting on other entries.