Processor

class neophile.processor.Processor(config: Configuration, factory: Factory)

Bases: object

Process a set of repositories for updates.

Parameters

• config (neophile.config.Configuration) – The neophile configuration.

• factory (neophile.factory.Factory) – Used to create additional components where necessary.

Methods Summary

analyze_checkout(path)	Analyze a cloned repository without applying updates.
process()	Process all configured repositories for updates.
process_checkout(path)	Check a cloned repository for updates.
update_checkout(path)	Update a cloned repository.

Methods Documentation

async analyze_checkout(path: Path) → Dict[str, List[Update]]

Analyze a cloned repository without applying updates.

Parameters

path (pathlib.Path) – The path to the cloned repository.

Returns

updates – Any updates found, sorted by the analyzer that found the update.

Return type

Dict[str, List[neophile.update.base.Update]]

async process() → None

Process all configured repositories for updates.

async process_checkout(path: Path) → None

Check a cloned repository for updates.

Creates pull requests as necessary if any needed updates are found.

Parameters

path (pathlib.Path) – The path to the cloned repository.

async update_checkout(path: Path) → List[Update]

Update a cloned repository.

This does not switch branches. Updates are written to the current working tree.

Parameters

path (pathlib.Path) – The path to the cloned repository.

Returns

updates – All the updates that were applied.

Return type

List[neophile.update.base.Update]