CodeQL library for Python
codeql/python-all 0.12.1 (changelog, source)
Search

Class Container

A container is an abstract representation of a file system object that can hold elements of interest.

Import path

import python

Direct supertypes

Known direct subtypes

Predicates

getChildContainer
getImportRoot

Gets the path element from which this container would be loaded.

getImportRoot

Gets the path element from which this container would be loaded, given the index into the list of possible paths n.

getParent
getParentContainer

Gets the parent container of this file or folder, if any.

inStdlib

Whether this file or folder is part of the standard library

inStdlib

Whether this file or folder is part of the standard library for version major.minor

isImportRoot

Holds if this folder is on the import path.

isImportRoot

Holds if this folder is on the import path, at index n in the list of paths. The list of paths is composed of the paths passed to the extractor and sys.path.

isStdLibRoot

Holds if this folder is the root folder for the standard library.

isStdLibRoot

Holds if this folder is the root folder for the standard library.

Inherited predicates

getAChildContainer

Gets a file or sub-folder in this container.

from Container
getAFile

Gets a file in this container.

from Container
getAFolder

Gets a sub-folder in this container.

from Container
getAbsolutePath

Gets the absolute, canonical path of this container, using forward slashes as path separator.

from Container
getBaseName

Gets the base name of this container including extension, that is, the last segment of its absolute path, or the empty string if it has no segments.

from Container
getExtension

Gets the extension of this container, that is, the suffix of its base name after the last dot character, if any.

from Container
getFile

Gets the file in this container that has the given baseName, if any.

from Container
getFolder

Gets the sub-folder in this container that has the given baseName, if any.

from Container
getRelativePath

Gets the relative path of this file or folder from the root folder of the analyzed source location. The relative path of the root folder itself is the empty string.

from Container
getStem

Gets the stem of this container, that is, the prefix of its base name up to (but not including) the last dot character if there is one, or the entire base name if there is not.

from Container
getURL

Gets a URL representing the location of this container.

from Container
toString

Gets a textual representation of the path of this container.

from Container