Class File

A file

Import path


                                import python

Direct supertypes

Indirect supertypes

@container

Known direct subtypes

Predicates

emptyLine	Whether line n is empty (it contains neither code nor comment).
fromSource	Whether this file is a source code file.
getAbsolutePath	Gets the absolute, canonical path of this container, using forward slashes as path separator.
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.
getImportRoot	Gets the path element from which this container would be loaded, given the index into the list of possible paths `n`.
getShortName	Gets a short name for this file (just the file name)
getSpecifiedEncoding
getURL	Gets the URL of this 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.
isPossibleEntryPoint	Holds if this file is likely to get executed directly, and thus act as an entry point for execution.

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
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
getChildContainer		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		from Container
getFolder		from Container
getImportRoot	Gets the path element from which this container would be loaded.	from Container
getName	Gets the name of this container. DEPRECATED: Use `getAbsolutePath` instead.	from Container
getParent		from Container
getParentContainer		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
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
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
toString	Gets a textual representation of the path of this container.	from Container