core.requester
==============

.. py:module:: core.requester

.. autoapi-nested-parse::

   Requester object to make HTTP requests to the Jobmon Flask services.



Attributes
----------

.. autoapisummary::

   core.requester.logger


Classes
-------

.. autoapisummary::

   core.requester.Requester


Functions
---------

.. autoapisummary::

   core.requester.http_request_ok
   core.requester.get_content


Module Contents
---------------

.. py:data:: logger

.. py:function:: http_request_ok(status_code: int) -> bool

   Return True if HTTP return codes that are deemed ok.


.. py:class:: Requester(url: str, route_prefix: str = '', request_timeout: int = 20, retries_timeout: int = 300, retries_attempts: int = 10, use_otlp: bool = False)

   Bases: :py:obj:`object`


   Requester object to make HTTP requests to the Jobmon Flask services.


   .. py:attribute:: _otlp_api
      :value: None



   .. py:attribute:: base_url


   .. py:attribute:: route_prefix
      :value: ''



   .. py:attribute:: request_timeout
      :value: 20



   .. py:attribute:: retries_timeout
      :value: 300



   .. py:attribute:: retries_attempts
      :value: 10



   .. py:attribute:: server_structlog_context
      :type:  Dict[str, str]


   .. py:method:: _init_otlp() -> None
      :classmethod:



   .. py:method:: from_defaults() -> Requester
      :classmethod:


      Instantiate a requester from default config values.



   .. py:property:: url
      :type: str


      Return the base url for the requester.


   .. py:method:: add_server_structlog_context(**kwargs: Any) -> None

      Add the structlogging context if it has been provided.



   .. py:method:: tracing_span(app_route: str, request_type: str) -> Any


   .. py:method:: _maybe_trace(func: Callable) -> Callable


   .. py:method:: _maybe_retry(func: Callable, tenacious: bool) -> Any


   .. py:method:: _send_request(app_route: str, message: dict, request_type: str) -> Tuple[int, Any]


   .. py:method:: send_request(app_route: str, message: dict, request_type: str, tenacious: bool = True) -> Tuple[int, Any]

      Send a request to the Jobmon server.



.. py:function:: get_content(response: Any) -> Tuple[int, Any]

   Parse the response.