Skip to content

Commit e82ad6f

Browse files
committed
Python: Add missing QLDoc
1 parent 9dcb26d commit e82ad6f

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

python/ql/src/semmle/python/frameworks/Aiohttp.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,10 @@ module AiohttpWebModel {
328328
override string getSourceType() { result = "aiohttp.web.Request" }
329329
}
330330

331+
/**
332+
* A read of the `request` attribute on an instance of a aiohttp.web View class,
333+
* which is the request being processed currently.
334+
*/
331335
class AiohttpViewClassRequestAttributeRead extends Request::InstanceSource,
332336
RemoteFlowSource::Range, DataFlow::Node {
333337
AiohttpViewClassRequestAttributeRead() {
@@ -378,13 +382,15 @@ module AiohttpWebModel {
378382
}
379383
}
380384

385+
/** An attribute read on a `aiohttp.web.Request` that is a `MultiDictProxy` instance. */
381386
class AiohttpRequestMultiDictProxyInstances extends Multidict::MultiDictProxy::InstanceSource {
382387
AiohttpRequestMultiDictProxyInstances() {
383388
this.(DataFlow::AttrRead).getObject() = Request::instance() and
384389
this.(DataFlow::AttrRead).getAttributeName() in ["query", "headers"]
385390
}
386391
}
387392

393+
/** An attribute read on a `aiohttp.web.Request` that is a `yarl.URL` instance. */
388394
class AiohttpRequestYarlUrlInstances extends Yarl::Url::InstanceSource {
389395
AiohttpRequestYarlUrlInstances() {
390396
this.(DataFlow::AttrRead).getObject() = Request::instance() and

python/ql/src/semmle/python/frameworks/Yarl.qll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ module Yarl {
111111
}
112112
}
113113

114+
/** An attribute read on a `yarl.URL` that is a `MultiDictProxy` instance. */
114115
class YarlUrlMultiDictProxyInstance extends Multidict::MultiDictProxy::InstanceSource {
115116
YarlUrlMultiDictProxyInstance() {
116117
this.(DataFlow::AttrRead).getObject() = Yarl::Url::instance() and

0 commit comments

Comments
 (0)