coretex.networking.requests_manager.RequestsManager Class Reference

Public Member Functions
NetworkResponse	genericRequest (self, RequestType requestType, str endpoint, Optional[Dict[str, str]] headers=None, Any data=None, Any files=None, int retryCount=0)
NetworkResponse	get (self, str endpoint, Optional[Dict[str, str]] headers=None, Any data=None, Any jsonObject=None, int retryCount=0)
NetworkResponse	post (self, str endpoint, Optional[Dict[str, str]] headers=None, Any data=None, Any jsonObject=None, int retryCount=0)

Detailed Description

    Represents class that is used for handling requests

Definition at line 34 of file requests_manager.py.

Member Function Documentation

genericRequest()

NetworkResponse coretex.networking.requests_manager.RequestsManager.genericRequest	(		self,
		RequestType	requestType,
		str	endpoint,
		Optional[Dict[str, str]]	headers = None,
		Any	data = None,
		Any	files = None,
		int	retryCount = 0
	)

    Sends generic HTTP request

    Parameters
    ----------
    requestType : RequestType
request type
    endpoint : str
API endpoint
    headers : Optional[Dict[str, str]]
headers (not required)
    data : Any
(not required)
    files : Any
(not required)
    retryCount : int
number of function calls if request has failed

    Returns
    -------
    NetworkResponse -> NetworkResponse object as response content to request

Definition at line 55 of file requests_manager.py.

    def genericRequest(
        self,
        requestType: RequestType,
        endpoint: str,
        headers: Optional[Dict[str, str]] = None,
        data: Any = None,
        files: Any = None,
        retryCount: int = 0
    ) -> NetworkResponse:
        """
            Sends generic HTTP request
 
            Parameters
            ----------
            requestType : RequestType
                request type
            endpoint : str
                API endpoint
            headers : Optional[Dict[str, str]]
                headers (not required)
            data : Any
                (not required)
            files : Any
                (not required)
            retryCount : int
                number of function calls if request has failed
 
            Returns
            -------
            NetworkResponse -> NetworkResponse object as response content to request
        """
 
        logging.getLogger("coretexpylib").debug(f"Sending request {requestType}, {endpoint}, HEADERS: {headers}, DATA: {data}")
 
        try:
            requestsResponse = self.__session.request(
                method = requestType.value,
                url = self.__url(endpoint),
                headers = headers,
                data = data,
                files = files
                # timeout = (self.__connectionTimeout, self.__readTimeout)
            )
 
            return NetworkResponse(requestsResponse, endpoint)
        except Exception as ex:
            if retryCount < RequestsManager.MAX_RETRY_COUNT:
                RequestsManager.__logRetry(requestType, endpoint, retryCount, ex)
                return self.genericRequest(requestType, endpoint, headers, data, files, retryCount = retryCount + 1)
 
            raise RequestFailedError
 

get()

NetworkResponse coretex.networking.requests_manager.RequestsManager.get	(		self,
		str	endpoint,
		Optional[Dict[str, str]]	headers = None,
		Any	data = None,
		Any	jsonObject = None,
		int	retryCount = 0
	)

    Sends HTTP get request

    Parameters
    ----------
    endpoint : str
API endpoint
    headers : Optional[Dict[str, str]]
headers (not required)
    data : Any
(not required)
    jsonObject : Any
(not required)
    retryCount : int
number of function calls if request has failed

    Returns
    -------
    NetworkResponse -> NetworkResponse object as response content to request

Definition at line 107 of file requests_manager.py.

    def get(
        self,
        endpoint: str,
        headers: Optional[Dict[str, str]] = None,
        data: Any = None,
        jsonObject: Any = None,
        retryCount: int = 0
    ) -> NetworkResponse:
        """
            Sends HTTP get request
 
            Parameters
            ----------
            endpoint : str
                API endpoint
            headers : Optional[Dict[str, str]]
                headers (not required)
            data : Any
                (not required)
            jsonObject : Any
                (not required)
            retryCount : int
                number of function calls if request has failed
 
            Returns
            -------
            NetworkResponse -> NetworkResponse object as response content to request
        """
 
        logging.getLogger("coretexpylib").debug(f"Sending request {endpoint}, HEADERS: {headers}, DATA: {data}, JSON_OBJECT: {jsonObject}")
 
        try:
            requestsResponse = self.__session.get(
                url = self.__url(endpoint),
                headers = headers,
                data = data,
                json = jsonObject
                # timeout = (self.__connectionTimeout, self.__readTimeout)
            )
 
            return NetworkResponse(requestsResponse, endpoint)
        except Exception as ex:
            if retryCount < RequestsManager.MAX_RETRY_COUNT:
                RequestsManager.__logRetry(RequestType.get, endpoint, retryCount, ex)
                return self.get(endpoint, headers, data, jsonObject, retryCount = retryCount + 1)
 
            raise RequestFailedError
 

post()

NetworkResponse coretex.networking.requests_manager.RequestsManager.post	(		self,
		str	endpoint,
		Optional[Dict[str, str]]	headers = None,
		Any	data = None,
		Any	jsonObject = None,
		int	retryCount = 0
	)

    Sends HTTP post request

    Parameters
    ----------
    endpoint : str
API endpoint
    headers : Optional[Dict[str, str]]
headers (not required)
    data : Any
(not required)
    jsonObject : Any
(not required)
    retryCount : int
number of function calls if request has failed

    Returns
    -------
    NetworkResponse -> NetworkResponse object as response content to request

Definition at line 155 of file requests_manager.py.

    def post(
        self,
        endpoint: str,
        headers: Optional[Dict[str, str]] = None,
        data: Any = None,
        jsonObject: Any = None,
        retryCount: int = 0
    ) -> NetworkResponse:
        """
            Sends HTTP post request
 
            Parameters
            ----------
            endpoint : str
                API endpoint
            headers : Optional[Dict[str, str]]
                headers (not required)
            data : Any
                (not required)
            jsonObject : Any
                (not required)
            retryCount : int
                number of function calls if request has failed
 
            Returns
            -------
            NetworkResponse -> NetworkResponse object as response content to request
        """
 
        logging.getLogger("coretexpylib").debug(f"Sending request {endpoint}, HEADERS: {headers}, DATA: {data}, JSON_OBJECT: {jsonObject}")
 
        try:
            requestsResponse = self.__session.post(
                url = self.__url(endpoint),
                headers = headers,
                data = data,
                json = jsonObject
                # timeout = (self.__connectionTimeout, self.__readTimeout)
            )
 
            return NetworkResponse(requestsResponse, endpoint)
        except Exception as ex:
            if retryCount < RequestsManager.MAX_RETRY_COUNT:
                RequestsManager.__logRetry(RequestType.post, endpoint, retryCount, ex)
                return self.post(endpoint, headers, data, jsonObject, retryCount = retryCount + 1)
 
            raise RequestFailedError
 

---

The documentation for this class was generated from the following file:

• src/coretex/networking/requests_manager.py