cpp_indexer Namespace Reference

Classes
class	_ClassInfo
class	_Indexer
class	Location
class	SymbolsIndex

Functions
SymbolsIndex	load_index (str filename)

Function Documentation

load_index()

SymbolsIndex cpp_indexer.load_index

(

str

filename

)

Load symbols index from the given file.

If index is out of date or missing it will be generated.

Definition at line 272 of file cpp_indexer.py.

def load_index(filename: str) -> SymbolsIndex:
    """Load symbols index from the given file.
 
    If index is out of date or missing it will be generated.
    """
    index: SymbolsIndex
 
    if os.path.exists(filename):
        with open(filename, 'r', encoding='utf-8') as json_file:
            index = _SymbolsIndexSchema.loads(json_file.read())
        if _get_current_commit_hash() == index.commit:
            logging.info('Loaded symbols index from %s', filename)
            return index
        logging.warning(
            '%s is generated for commit %s while current commit is %s',
            filename, index.commit, _get_current_commit_hash())
 
    index = _index_source()
    with open(filename, 'w', encoding='utf-8') as json_file:
        json_file.write(_SymbolsIndexSchema.dumps(index))
    logging.info(
        'Successfully indexed C++ source and written symbols index into %s',
        filename)
    return index