Tue, 10 Dec 2024 15:46:34 +0100
Updated copyright for 2025.
# -*- coding: utf-8 -*- # Copyright (c) 2022 - 2025 Detlev Offenbach <detlev@die-offenbachs.de> # """ Module implementing checks for using 'requests' or 'httpx' calls without timeout. """ # # This is a modified version of the one found in the bandit package. # # SPDX-License-Identifier: Apache-2.0 # def getChecks(): """ Public method to get a dictionary with checks handled by this module. @return dictionary containing checker lists containing checker function and list of codes @rtype dict """ return { "Call": [ (checkRequestWithouTimeout, ("S114",)), ], } def checkRequestWithouTimeout(reportError, context, _config): """ Function to check for use of requests without timeout. @param reportError function to be used to report errors @type func @param context security context object @type SecurityContext @param _config dictionary with configuration data (unused) @type dict """ httpVerbs = {"get", "options", "head", "post", "put", "patch", "delete"} httpxAttrs = {"request", "stream", "Client", "AsyncClient"} | httpVerbs qualName = context.callFunctionNameQual.split(".")[0] if (qualName == "requests" and context.callFunctionName in httpVerbs) or ( qualName == "httpx" and context.callFunctionName in httpxAttrs ): # check for missing timeout if context.checkCallArgValue("timeout") is None: reportError( context.node.lineno - 1, context.node.col_offset, "S114.1", "M", "L", qualName, ) # check for timeout=None if context.checkCallArgValue("timeout", "None"): reportError( context.node.lineno - 1, context.node.col_offset, "S114.2", "M", "L", qualName, )