mirror of
https://github.com/github/codeql.git
synced 2026-03-21 06:57:09 +01:00
52 lines
1.8 KiB
Plaintext
52 lines
1.8 KiB
Plaintext
/**
|
|
* @name Explicit export is not defined
|
|
* @description Including an undefined attribute in __all__ causes an exception when
|
|
* the module is imported using '*'
|
|
* @kind problem
|
|
* @tags reliability
|
|
* maintainability
|
|
* @problem.severity error
|
|
* @sub-severity low
|
|
* @precision high
|
|
* @id py/undefined-export
|
|
*/
|
|
|
|
import python
|
|
|
|
/** Whether name is declared in the __all__ list of this module */
|
|
predicate declaredInAll(Module m, StrConst name)
|
|
{
|
|
exists(Assign a, GlobalVariable all |
|
|
a.defines(all) and a.getScope() = m and
|
|
all.getId() = "__all__" and ((List)a.getValue()).getAnElt() = name
|
|
)
|
|
}
|
|
|
|
predicate mutates_globals(PythonModuleObject m) {
|
|
exists(CallNode globals |
|
|
globals = Object::builtin("globals").(FunctionObject).getACall() and
|
|
globals.getScope() = m.getModule() |
|
|
exists(AttrNode attr | attr.getObject() = globals)
|
|
or
|
|
exists(SubscriptNode sub | sub.getValue() = globals and sub.isStore())
|
|
)
|
|
or
|
|
exists(Object enum_convert |
|
|
enum_convert.hasLongName("enum.Enum._convert") and
|
|
exists(CallNode call |
|
|
call.getScope() = m.getModule()
|
|
|
|
|
enum_convert.(FunctionObject).getACall() = call or
|
|
call.getFunction().refersTo(enum_convert)
|
|
)
|
|
)
|
|
}
|
|
|
|
from PythonModuleObject m, StrConst name, string exported_name
|
|
where declaredInAll(m.getModule(), name) and
|
|
exported_name = name.strValue() and
|
|
not m.hasAttribute(exported_name) and
|
|
not (m.getShortName() = "__init__" and exists(m.getPackage().getModule().getSubModule(exported_name))) and
|
|
not exists(ImportStarNode imp | imp.getEnclosingModule() = m.getModule() | not imp.getModule().refersTo(_)) and
|
|
not mutates_globals(m)
|
|
select name, "The name '" + exported_name + "' is exported by __all__ but is not defined." |