scalpel.file_system.FileSystem

class documentation

class FileSystem: (source)

Constructor: FileSystem(entry_point, file_ext)

View In Hierarchy

This class is an upgraded implementation of import graph which will be removed in to later releases. It is a data structure that allows users to manipulate different files under a Python project. It leverage import relations in each of source files along with their absolute import name.

Method __init__ To constuct a the filesystem. Args: entry_point: the top level folder (packaage) path such as "my-python-projects/homework1". file_ext: the file extension type of building this class. It is intended to be either Python source files or stub files.
Method build To build enhanced directory tree for further analysis
Method get_leaf_nodes To return all the leaf nodes in this tree. Each of leaf nodes represents a single Python script. During the transversal, full path names to the top level module for each leaf node are generated. We will support the intermediate subfolders next.
Method get_subpackages Undocumented
Instance Variable all_mod_nodes Undocumented
Instance Variable entry_point Undocumented
Instance Variable file_ext Undocumented
Method _meta_data To parse each of modules and extract meta information.
def __init__(self, entry_point, file_ext='.py'): (source)

To constuct a the filesystem. Args: entry_point: the top level folder (packaage) path such as "my-python-projects/homework1". file_ext: the file extension type of building this class. It is intended to be either Python source files or stub files.

def build(self): (source)

To build enhanced directory tree for further analysis

def get_leaf_nodes(self) -> List[Node]: (source)

To return all the leaf nodes in this tree. Each of leaf nodes represents a single Python script. During the transversal, full path names to the top level module for each leaf node are generated. We will support the intermediate subfolders next.

Returns: a list of Nodes

def get_subpackages(self) -> List[Node]: (source)

Undocumented

all_mod_nodes: List[Node] = (source)

Undocumented

entry_point = (source)

Undocumented

file_ext = (source)

Undocumented

def _meta_data(): (source)

To parse each of modules and extract meta information.