colrev.ops.checker.Checker

class colrev.ops.checker.Checker(*, review_manager)

Bases: object

The CoLRev checker makes sure the project setup is ok

Methods

check_change_in_propagated_id	Check whether propagated IDs were changed
check_fields	Check field values
check_repo	Check whether the repository is in a consistent state Entrypoint for pre-commit hooks
check_repo_basics	Calls data.main() to update the stats
check_repo_extended	Calls all checks that require prior data (take longer)
check_repository_setup	Check the repository setup
check_sources	Check the sources
check_status_transitions	Check for invalid state transitions
get_colrev_versions	Get the colrev version as a list: (last_version, current_version)
in_virtualenv	Check whether CoLRev operates in a virtual environment

Attributes

records

check_change_in_propagated_id(*, prior_id, new_id='TBD', project_context)

Check whether propagated IDs were changed

A propagated ID is a record ID that is stored outside the records.bib. Propagated IDs should not be changed in the records.bib because this would break the link between the propagated ID and its metadata.

Return type:

list

check_fields(*, status_data)

Check field values

Return type:

None

check_repo()

Check whether the repository is in a consistent state Entrypoint for pre-commit hooks

Return type:

dict

check_repo_basics()

Calls data.main() to update the stats

Return type:

list

check_repo_extended()

Calls all checks that require prior data (take longer)

Return type:

list

check_repository_setup()

Check the repository setup

Return type:

None

check_sources()

Check the sources

Return type:

None

check_status_transitions(*, status_data)

Check for invalid state transitions

Return type:

None

get_colrev_versions()

Get the colrev version as a list: (last_version, current_version)

Return type:

list[str]

classmethod in_virtualenv()

Check whether CoLRev operates in a virtual environment

Return type:

bool