colrev.exceptions

Exceptions

Exceptions

colrev.exceptions.AppendOnlyViolation(msg)

Invalid changes to a file in append-only mode.

colrev.exceptions.CleanRepoRequiredError(...)

A clean git repository would be required.

colrev.exceptions.CoLRevException

Base class for all exceptions raised by this package

colrev.exceptions.CoLRevUpgradeError(old, new)

The version of the local CoLRev package does not match with the CoLRev version used to create the latest commit in the project.

colrev.exceptions.CorrectionPreconditionException(message)

Precondition for corrections not given (clean git repository).

colrev.exceptions.CuratedOutletNotUnique([msg])

The outlets (journals or conferences) with curated metadata are not unique.

colrev.exceptions.DataException(*, msg)

Exception in the data operation

colrev.exceptions.DedupeError(message)

An exception in the dedupe operation

colrev.exceptions.DependencyConfigurationError(dep)

The required dependency is not configured correctly.

colrev.exceptions.DirtyRepoAfterProcessingError(msg)

The git repository was not clean after completing the operation.

colrev.exceptions.DuplicateIDsError(msg)

Duplicate IDs were detected.

colrev.exceptions.FieldValueError(msg)

An error in field values was detected (in the main records).

colrev.exceptions.GitConflictError(path)

There are git conflicts to be resolved before resuming operations.

colrev.exceptions.GitNotAvailableError()

Git is currently not available.

colrev.exceptions.ImportException(msg)

An error occurred in the import functions.

colrev.exceptions.InvalidLanguageCodeException(...)

Language code field does not comply with the required standard.

colrev.exceptions.InvalidPDFException(path)

The PDF is invalid (empty, encrypted or broken).

colrev.exceptions.InvalidQueryException(msg)

The query format is not valid.

colrev.exceptions.InvalidSettingsError(*, msg)

Invalid value in SETTINGS_FILE.

colrev.exceptions.MissingDependencyError(dep)

The required dependency is not available.

colrev.exceptions.MissingRecordQualityRuleSpecification(msg)

A quality rule is missing.

colrev.exceptions.NoRecordsError()

The operation cannot be started because no records have been imported yet.

colrev.exceptions.NoRecordsToImport(msg)

No records to import.

colrev.exceptions.NonEmptyDirectoryError(*, ...)

Trying to initialize CoLRev in a non-empty directory.

colrev.exceptions.NotEnoughDataToIdentifyException(*)

The meta-data is not sufficiently complete to identify the record.

colrev.exceptions.NotFeedIdentifiableException([msg])

The record does not contain the required source_identifier (cannot be added to the feed).

colrev.exceptions.NotTOCIdentifiableException([msg])

The record cannot be identified through table-of-contents.

colrev.exceptions.OriginError(msg)

An error in the colrev_origin field values was detected.

colrev.exceptions.PDFHashError(path)

An error occurred during PDF hashing.

colrev.exceptions.PackageParameterError(dep)

The parameter for the package are not correct.

colrev.exceptions.PackageSettingMustStartWithPackagesException(...)

Package settings must start with packages key.

colrev.exceptions.ParameterError(*, ...)

An invalid parameter was passed to CoLRev.

colrev.exceptions.PortAlreadyRegisteredException(message)

The port (localhost) is already registered.

colrev.exceptions.ProcessOrderViolation(...)

The process triggered dooes not have priority

colrev.exceptions.PropagatedIDChange(...)

Changes in propagated records ID detected.

colrev.exceptions.RecordNotFoundException(msg)

Record not found in the main records file.

colrev.exceptions.RecordNotFoundInPrepSourceException(*, msg)

The record was not found in the prep search source.

colrev.exceptions.RecordNotInIndexException(...)

The requested record was not found in the LocalIndex.

colrev.exceptions.RecordNotInRepoException(...)

The record was not found in the main records.

colrev.exceptions.RecordNotInTOCException(*, ...)

The record is not part of the table-of-contents (TOC).

colrev.exceptions.RecordNotIndexableException([...])

The requested record could not be added to the LocalIndex.

colrev.exceptions.RecordNotParsableException(msg)

The record could not be parsed.

colrev.exceptions.RepoInitError(*, msg)

Error during initialization of CoLRev project.

colrev.exceptions.RepoSetupError([msg])

The project files are not properly set up as a CoLRev project.

colrev.exceptions.ReviewManagerNotNotifiedError()

The ReviewManager was not notified about the operation.

colrev.exceptions.SearchNotAutomated(msg)

The search cannot be completed automatically.

colrev.exceptions.SearchSourceException(msg)

Records cannot be retrieved from the SearchSource.

colrev.exceptions.ServiceNotAvailableException(dep)

An environment service is not available.

colrev.exceptions.StatusFieldValueError(...)

An error in the status field values was detected.

colrev.exceptions.StatusTransitionError(msg)

An invalid status transition was observed

colrev.exceptions.TEIException

An exception related to the TEI format

colrev.exceptions.TEITimeoutException

A timeout occurred during TEI generation

colrev.exceptions.TOCNotAvailableException([msg])

Tables of contents (toc) are not available for the requested item.

colrev.exceptions.TemplateNotAvailableError(...)

The requested template is not available.

colrev.exceptions.UnstagedGitChangesError(...)

Unstaged git changes were found although a clean repository is required.

colrev.exceptions.UnsupportedImportFormatError(...)

The file format is not supported.