Factory#

class neophile.factory.Factory(http_client)#

Bases: object

Factory to create neophile components.

Parameters:: http_client (AsyncClient) – HTTP client to use for requests.

Methods Summary

`create_all_scanners`()	Create all scanners.
`create_analyzers`([types])	Create all analyzers.
`create_pre_commit_analyzer`()	Create a new pre-commit hook analyzer.
`create_processor`([types])	Create a new repository processor.
`create_pull_requester`()	Create a new pull requester.
`create_python_analyzer`()	Create a new Python frozen dependency analyzer.

Methods Documentation

create_all_scanners()#

Create all scanners.

Returns:: List of all available scanners.
Return type:: list of BaseScanner

create_analyzers(types=None)#

Create all analyzers.

Parameters:: types (Optional[list[str]], default: None) – If given, only create analyzers of the given types.
Returns:: List of analyzers.
Return type:: list of BaseAnalyzer

Notes

The Python analyzer requires a clean Git tree in order to determine if any changes were necessary, and therefore must run first if the analyzers are run in update mode (which means they will make changes to the working tree).

create_pre_commit_analyzer()#

Create a new pre-commit hook analyzer.

Returns:: New analyzer.
Return type:: PreCommitAnalyzer

create_processor(types=None)#

Create a new repository processor.

Parameters:: types (Optional[list[str]], default: None) – If given, only process dependencies of the given types.
Returns:: New processor.
Return type:: Processor

create_pull_requester()#

Create a new pull requester.

Returns:: New pull requester.
Return type:: PullRequester

create_python_analyzer()#

Create a new Python frozen dependency analyzer.

Returns:: New analyzer.
Return type:: PythonAnalyzer