BaseAnalyzer¶

class neophile.analysis.base.BaseAnalyzer¶

Bases: abc.ABC

Base class for an analysis step.

Methods Summary

`analyze`([update])	Analyze a tree and return a list of needed changes.
`name`()	The name of the analyzer type.
`update`()	Analyze a tree, apply updates, and return them as a list.

Methods Documentation

abstract async analyze(update: bool = False) → List[Update]¶

Analyze a tree and return a list of needed changes.

Parameters: update (bool, optional) – If set to True, leave the update applied if this is more efficient. Used by analyzers like the Python frozen dependency analyzer that have to do work and apply the update to see if any update is necessary. They can then mark the returned update as already applied and not have to run it twice.
Returns: results – A list of updates.
Return type: List[neophile.update.base.Update]

abstract name() → str¶

The name of the analyzer type.

Returns: name – A string representing the type of analyzer this is. Used for reporting results accumulated from a bunch of analyzers.
Return type: str

async update() → List[Update]¶

Analyze a tree, apply updates, and return them as a list.