colrev.ops.prep_debug.PrepDebug
- class colrev.ops.prep_debug.PrepDebug(*, review_manager, notify_state_transition_operation, polish)[source]
Bases:
PrepDebug prepare records (metadata)
Methods
check_preconditionCheck the operation precondition
concludeConclude the operation (stop Docker containers)
decorateDecorator for operations
main- rtype:
Any
notifyNotify the review_manager about the next operation
preparePrepare a record (based on package_endpoints in the settings)
run_debug- rtype:
Any
set_idsSet IDs (regenerate).
setup_custom_scriptSetup a custom prep script
Attributes
max_retries_on_errorpadpolishtimeouttypedebug_idscommit_shafirst_roundlast_roundprep_package_endpoints- check_precondition()
Check the operation precondition
- Return type:
None
- conclude()
Conclude the operation (stop Docker containers)
- Return type:
None
- classmethod decorate()
Decorator for operations
- Return type:
Callable
- notify(*, state_transition=True)
Notify the review_manager about the next operation
- Return type:
None
- prepare(item)
Prepare a record (based on package_endpoints in the settings)
- Return type:
dict
- set_ids()
Set IDs (regenerate). In force-mode, all IDs are regenerated and PDFs are renamed
- Return type:
None
- setup_custom_script()
Setup a custom prep script
- Return type:
None