CodeQL library for Python
Search

Class XMLFile

An XML file.

Import path

import python

Direct supertypes

Indirect supertypes

Predicates

getADTD

Gets a DTD associated with this XML file.

getARootElement

Gets a top-most element in an XML file.

getEncoding

Gets the encoding of this XML file.

getFile

Gets the XML file itself.

getFolder

DEPRECATED: Use getParentContainer().getAbsolutePath() instead.

getName

Gets the name of this XML file.

getPath

DEPRECATED: Use getAbsolutePath() instead.

toString

Gets a printable representation of this XML file.

Inherited predicates

allCharactersString

Gets the result of appending all the character sequences of this XML parent from left to right, separated by a space.

from XMLParent
charsSetUpTo

DEPRECATED: Internal.

from XMLParent
emptyLine

Whether line n is empty (it contains neither code nor comment).

from File
fromSource

Whether this file is a source code file.

from File
getACharactersSet

Gets a character sequence that is a child of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent.

from XMLParent
getAChild

Gets a child element of this XML parent with the given name.

from XMLParent
getAChildContainer

Gets a file or sub-folder in this container.

from Container
getAComment

Gets a comment that is a child of this XML parent.

from XMLParent
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 File
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
getChild

Gets the child element at a specified index of this XML parent.

from XMLParent
getChild

Gets a child of this container

from Container
getChildContainerfrom Container
getContents

Gets the contents of this file as a string. This will only work for those non-python files that are specified to be extracted.

from File
getDepth

Gets the depth in the tree. (Overridden in XMLElement.)

from XMLParent
getExtension

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

from Container
getFilefrom Container
getFolderfrom Container
getFullName

DEPRECATED: Use getAbsolutePath instead.

from File
getImportRoot

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

from Container
getImportRoot

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

from File
getNumberOfCharacterSets

Gets the number of places in the body of this XML parent where text occurs.

from XMLParent
getNumberOfChildren

Gets the number of child XML elements of this XML parent.

from XMLParent
getParentfrom Container
getParentContainerfrom 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
getShortName

Gets a short name for this file (just the file name)

from File
getSpecifiedEncodingfrom File
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
getTextValue

Gets the text value contained in this XML parent.

from XMLParent
getURL

Gets the URL of this file.

from File
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

from File
inStdlib

Whether this file or folder is part of the standard library

from Container
inStdlib

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

from Container
isImportRoot

Holds if this folder is on the import path.

from Container
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.

from Container
isPossibleEntryPoint

Holds if this file is likely to get executed directly, and thus act as an entry point for execution.

from File
isStdLibRoot

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

from Container
isStdLibRoot

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

from Container

Charpred