hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-18 09:43:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Python: Modernise the py/not-named-self query.

Browse Source
This commit is contained in:
Rasmus Wriedt Larsen
2019-09-25 15:54:21 +02:00
parent c6d9eb9254
commit a81bf720f5
4 changed files with 39 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
python/ql/src/Functions/NonSelf.ql
View File

@@ -16,39 +16,37 @@
import python
import semmle.python.libraries.Zope
predicate first_arg_self(Function f) {
f.getArgName(0) = "self"
predicate is_type_method(FunctionValue fv) {
exists(ClassValue c | c.declaredAttribute(_) = fv and c.getASuperType() = ClassValue::type())
}
predicate is_type_method(FunctionObject f) {
exists(ClassObject c | c.lookupAttribute(_) = f and c.getASuperType() = theTypeType())
}
predicate used_in_defining_scope(FunctionObject f) {
exists(Call c |
c.getScope() = f.getFunction().getScope() and
c.getFunc().refersTo(f)
predicate used_in_defining_scope(FunctionValue fv) {
exists(Call c |
c.getScope() = fv.getScope().getScope() and c.getFunc().pointsTo(fv)
)
}
from Function f, PyFunctionObject func, string message
from Function f, FunctionValue fv, string message
where
exists(ClassObject cls, string name |
cls.declaredAttribute(name) = func and cls.isNewStyle() and
exists(ClassValue cls, string name |
cls.declaredAttribute(name) = fv and cls.isNewStyle() and
not name = "__new__" and
not name = "__metaclass__" and
/* declared in scope */
f.getScope() = cls.getPyClass()
f.getScope() = cls.getScope()
) and
not first_arg_self(f) and not is_type_method(func) and
func.getFunction() = f and not f.getName() = "lambda" and
not used_in_defining_scope(func) and
not f.getArgName(0) = "self" and
not is_type_method(fv) and
fv.getScope() = f and
not f.getName() = "lambda" and
not used_in_defining_scope(fv) and
(
if exists(f.getArgName(0)) then
message = "Normal methods should have 'self', rather than '" + f.getArgName(0) + "', as their first parameter."
else
message = "Normal methods should have at least one parameter (the first of which should be 'self')." and not f.hasVarArg()
message = "Normal methods should have at least one parameter (the first of which should be 'self')." and
not f.hasVarArg()
) and
not func instanceof ZopeInterfaceMethod
not fv instanceof ZopeInterfaceMethodValue
select f, message

21
python/ql/src/semmle/python/libraries/Zope.qll
View File

@@ -2,8 +2,10 @@
import python
private import semmle.python.pointsto.PointsTo
/** A method that to a sub-class of `zope.interface.Interface` */
class ZopeInterfaceMethod extends PyFunctionObject {
deprecated class ZopeInterfaceMethod extends PyFunctionObject {
/** Holds if this method belongs to a class that sub-classes `zope.interface.Interface` */
ZopeInterfaceMethod() {
@@ -26,3 +28,20 @@ class ZopeInterfaceMethod extends PyFunctionObject {
}
}
/** A method that belongs to a sub-class of `zope.interface.Interface` */
class ZopeInterfaceMethodValue extends PythonFunctionValue {
/** Holds if this method belongs to a class that sub-classes `zope.interface.Interface` */
ZopeInterfaceMethodValue() {
exists(Value interface, ClassValue owner |
interface = Module::named("zope.interface").attr("Interface") and
owner.declaredAttribute(_) = this and
// `zope.interface.Interface` will be recognized as a Value by the pointsTo analysis,
// because it is the result of instantiating a "meta" class. getASuperType only returns
// ClassValues, so we do this little trick to make things work
Types::getBase(owner.getASuperType(), _) = interface
)
}
}