hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-30 19:26:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5614 from tausbn/python-allow-absolute-imports-from-source-directory

Browse Source 
Python: Allow absolute imports from source directory
This commit is contained in:
Taus
2021-04-12 18:02:00 +02:00
committed by GitHub
parent bc56d16c18 6c69c1aeeb
commit 6d4ddc0329
26 changed files with 118 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
python/ql/src/semmle/python/Files.qll
View File

@@ -72,6 +72,33 @@ class File extends Container {
* are specified to be extracted.
*/
string getContents() { file_contents(this, result) }
/** Holds if this file is likely to get executed directly, and thus act as an entry point for execution. */
predicate isPossibleEntryPoint() {
// Only consider files in the source code, and not things like the standard library
exists(this.getRelativePath()) and
(
// The file doesn't have the extension `.py` but still contains Python statements
not this.getExtension().matches("py%") and
exists(Stmt s | s.getLocation().getFile() = this)
or
// The file contains the usual `if __name__ == '__main__':` construction
exists(If i, Name name, StrConst main, Cmpop op |
i.getScope().(Module).getFile() = this and
op instanceof Eq and
i.getTest().(Compare).compares(name, op, main) and
name.getId() = "__name__" and
main.getText() = "__main__"
)
or
// The file contains a `#!` line referencing the python interpreter
exists(Comment c |
c.getLocation().getFile() = this and
c.getLocation().getStartLine() = 1 and
c.getText().regexpMatch("^#! */.*python(2|3)?[ \\\\t]*$")
)
)
}
}
private predicate occupied_line(File f, int n) {

22
python/ql/src/semmle/python/Module.qll
View File

@@ -205,11 +205,31 @@ private string moduleNameFromBase(Container file) {
file instanceof File and result = file.getStem()
}
/**
* Holds if `file` may be transitively imported from a file that may serve as the entry point of
* the execution.
*/
private predicate transitively_imported_from_entry_point(File file) {
file.getExtension().matches("%py%") and
exists(File importer |
importer.getParent() = file.getParent() and
exists(ImportExpr i | i.getLocation().getFile() = importer and i.getName() = file.getStem())
|
importer.isPossibleEntryPoint() or transitively_imported_from_entry_point(importer)
)
}
string moduleNameFromFile(Container file) {
exists(string basename |
basename = moduleNameFromBase(file) and
legalShortName(basename) and
legalShortName(basename)
|
result = moduleNameFromFile(file.getParent()) + "." + basename
or
// If `file` is a transitive import of a file that's executed directly, we allow references
// to it by its `basename`.
transitively_imported_from_entry_point(file) and
result = basename
)
or
isPotentialSourcePackage(file) and

7
python/ql/test/3/library-tests/modules/entry_point/hash_bang/main.py Executable file
View File

@@ -0,0 +1,7 @@
#! /usr/bin/python3
print(__file__)
import module
import package
import namespace_package
import namespace_package.namespace_package_main
print(module.message)

2
python/ql/test/3/library-tests/modules/entry_point/hash_bang/module.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
message = "Hello world!"

2
python/ql/test/3/library-tests/modules/entry_point/hash_bang/namespace_package/namespace_package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
import namespace_package.namespace_package_module

1
python/ql/test/3/library-tests/modules/entry_point/hash_bang/namespace_package/namespace_package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

2
python/ql/test/3/library-tests/modules/entry_point/hash_bang/package/__init__.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_main

2
python/ql/test/3/library-tests/modules/entry_point/hash_bang/package/package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_module

1
python/ql/test/3/library-tests/modules/entry_point/hash_bang/package/package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

14
python/ql/test/3/library-tests/modules/entry_point/modules.expected Normal file
View File

@@ -0,0 +1,14 @@
| module | hash_bang/module.py:0:0:0:0 | Module module |
| module | name_main/module.py:0:0:0:0 | Module module |
| package | hash_bang/package:0:0:0:0 | Package package |
| package | name_main/package:0:0:0:0 | Package package |
| package | no_py_extension/package:0:0:0:0 | Package package |
| package.__init__ | hash_bang/package/__init__.py:0:0:0:0 | Module package.__init__ |
| package.__init__ | name_main/package/__init__.py:0:0:0:0 | Module package.__init__ |
| package.__init__ | no_py_extension/package/__init__.py:0:0:0:0 | Module package.__init__ |
| package.package_main | hash_bang/package/package_main.py:0:0:0:0 | Module package.package_main |
| package.package_main | name_main/package/package_main.py:0:0:0:0 | Module package.package_main |
| package.package_main | no_py_extension/package/package_main.py:0:0:0:0 | Module package.package_main |
| package.package_module | hash_bang/package/package_module.py:0:0:0:0 | Module package.package_module |
| package.package_module | name_main/package/package_module.py:0:0:0:0 | Module package.package_module |
| package.package_module | no_py_extension/package/package_module.py:0:0:0:0 | Module package.package_module |

4
python/ql/test/3/library-tests/modules/entry_point/modules.ql Normal file
View File

@@ -0,0 +1,4 @@
import python
from Module m
select m.getName(), m

8
python/ql/test/3/library-tests/modules/entry_point/name_main/main.py Executable file
View File

@@ -0,0 +1,8 @@
print(__file__)
import module
import package
import namespace_package
import namespace_package.namespace_package_main
if __name__ == '__main__':
print(module.message)

2
python/ql/test/3/library-tests/modules/entry_point/name_main/module.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
message = "Hello world!"

2
python/ql/test/3/library-tests/modules/entry_point/name_main/namespace_package/namespace_package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
import namespace_package.namespace_package_module

1
python/ql/test/3/library-tests/modules/entry_point/name_main/namespace_package/namespace_package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

2
python/ql/test/3/library-tests/modules/entry_point/name_main/package/__init__.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_main

2
python/ql/test/3/library-tests/modules/entry_point/name_main/package/package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_module

1
python/ql/test/3/library-tests/modules/entry_point/name_main/package/package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

6
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/main.secretpy Executable file
View File

@@ -0,0 +1,6 @@
print(__file__)
import module
import package
import namespace_package
import namespace_package.namespace_package_main
print(module.message)

2
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/module.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
message = "Hello world!"

2
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/namespace_package/namespace_package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
import namespace_package.namespace_package_module

1
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/namespace_package/namespace_package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

2
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/package/__init__.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_main

2
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/package/package_main.py Normal file
View File

@@ -0,0 +1,2 @@
print(__file__.split("entry_point")[1])
from . import package_module

1
python/ql/test/3/library-tests/modules/entry_point/no_py_extension/package/package_module.py Normal file
View File

@@ -0,0 +1 @@
print(__file__.split("entry_point")[1])

1
python/ql/test/3/library-tests/modules/entry_point/options Normal file
View File

@@ -0,0 +1 @@
semmle-extractor-options: --lang=3 --path bogus -R . --filter=include:**/*.secretpy