Configuration Reference#

Bot Configuration#

class wikidata_bot_framework.Config(auto_dearchivify_urls: bool = True, auto_deprecate_archified_urls: bool = True, create_or_edit_main_property_whitelist_enabled: bool = False, create_or_edit_main_property_whitelist: List[str] = <factory>, copy_ranks_for_nonwhitelisted_main_properties: bool = True, create_or_edit_qualifiers_for_main_property_whitelist_enabled: bool = False, create_or_edit_qualifiers_for_main_property_whitelist: List[str] = <factory>, create_or_edit_references_for_main_property_whitelist_enabled: bool = False, create_or_edit_references_for_main_property_whitelist: List[str] = <factory>, act_on_cycle: bool = False, throw_on_no_edit_cycle: bool = True)[source]#
act_on_cycle: bool = False#

If the bot should do something if it detects a cycle. If False, there is a chance the bot gets stuck in an infinite loop

New in version 7.4.0.

Deprecated since version 7.4.1.

auto_dearchivify_urls: bool = True#

Automatically get rid of archive.org URLs and turn them into the original URL along with necessary qualifiers

auto_deprecate_archified_urls: bool = True#

Mark dearchivified URLs as deprecated

copy_ranks_for_nonwhitelisted_main_properties: bool = True#

Copy the rank of non-whitelisted main properties (requires create_or_edit_main_property_whitelist_enabled)

create_or_edit_main_property_whitelist: List[str]#

The whitelist for creating or editing main properties

create_or_edit_main_property_whitelist_enabled: bool = False#

Enable the whitelist for creating or editing main properties

create_or_edit_qualifiers_for_main_property_whitelist: List[str]#

The whitelist for creating or editing qualifiers when the main property is blacklisted (requires create_or_edit_main_property_whitelist_enabled)

create_or_edit_qualifiers_for_main_property_whitelist_enabled: bool = False#

Enable the whitelist for creating or editing qualifiers when the main property is blacklisted (requires create_or_edit_main_property_whitelist_enabled)

create_or_edit_references_for_main_property_whitelist: List[str]#

The whitelist for creating or editing references when the main property is blacklisted (requires create_or_edit_main_property_whitelist_enabled)

create_or_edit_references_for_main_property_whitelist_enabled: bool = False#

Enable the whitelist for creating or editing references when the main property is blacklisted (requires create_or_edit_main_property_whitelist_enabled)

throw_on_no_edit_cycle: bool = True#

If the bot should throw an exception if no edits were made to the item but a cycle is being signalled. If False, the loop will silently stop.

New in version 7.4.0.

Deprecated since version 7.4.1.