Python: Make sure that all Modules and ModuleObjects (even unused packages) have a working toString().

markshannon · markshannon · commit 4a4ed69adee0 · 2019-06-13T12:22:38.000+01:00
diff --git a/python/ql/src/semmle/python/Module.qll b/python/ql/src/semmle/python/Module.qll
@@ -9,9 +9,13 @@ class Module extends Module_, Scope, AstNode {
     override string toString() {
         result = this.getKind() + " " + this.getName()
         or
-        /* No name is defined, which means that this is not on an import path. So it must be a script */
+        /* No name is defined, which means that this module is not on an import path. So it must be a script */
         not exists(this.getName()) and not this.isPackage() and
         result = "Script " + this.getFile().getShortName()
+        or
+        /* Package missing name, so just use the path instead */
+        not exists(this.getName()) and this.isPackage() and
+        result = "Package at "  + this.getPath().getAbsolutePath()
     }
 
     /** This method will be deprecated in the next release. Please use `getEnclosingScope()` instead.
diff --git a/python/ql/src/semmle/python/types/ModuleObject.qll b/python/ql/src/semmle/python/types/ModuleObject.qll
@@ -32,6 +32,9 @@ abstract class ModuleObject extends Object {
 
     override string toString() {
         result = "Module " + this.getName()
+        or
+        not exists(this.getName()) and
+        result = this.getModule().toString()
     }
 
     /** Gets the named attribute of this module. Using attributeRefersTo() instead

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ abstract class ModuleObject extends Object {`
`32`	`32`
`33`	`33`	`override string toString() {`
`34`	`34`	`result = "Module " + this.getName()`
	`35`	`+ or`
	`36`	`+ not exists(this.getName()) and`
	`37`	`+ result = this.getModule().toString()`
`35`	`38`	`}`
`36`	`39`
`37`	`40`	`/** Gets the named attribute of this module. Using attributeRefersTo() instead`