CodeQL library for Python
codeql/python-all 2.1.3-dev (changelog, source)
Search

Class AiohttpWebModel::AiohttpRouteSetup

A route setup in aiohttp.web. Since all route-setups can technically use either coroutines or view-classes as the handler argument (although that’s not how you’re supposed to do things), we also need to handle this.

Extend this class to refine existing API models. If you want to model new APIs, extend AiohttpRouteSetup::Range instead.

Import path

import semmle.python.frameworks.Aiohttp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getARequestHandler

Gets a function that will handle incoming requests for this route, if any.

getARoutedParameter

Gets a parameter that will receive parts of the url when handling incoming requests for this route, if any. These automatically become a RemoteFlowSource.

getFramework

Gets a string that identifies the framework used for this route setup.

getHandlerArg

Gets the argument specifying the handler (either a coroutine or a view-class).

getUrlPatternArg

Gets the argument used to set the URL pattern.

getViewClass

Gets the view-class that is referenced in the view-class handler argument, if any.

Inherited predicates

asCfgNode

Gets the control-flow node corresponding to this node, if any.

from Node
asExpr

Gets the expression corresponding to this node, if any.

from Node
getALocalSource

Gets a local source node from which data may flow to this node in zero or more local data-flow steps.

from Node
getEnclosingCallable

Gets the enclosing callable of this node.

from Node
getLocation

Gets the location of this node

from Node
getScope

Gets the scope of this node.

from Node
getUrlPattern

Gets the URL pattern for this route, if it can be statically determined.

from Range
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

from Node
toString

Gets a textual representation of this element.

from Node