iode.Identities.rename

Identities.rename(old_name: str, new_name: str, overwrite: bool = True)

Rename an object of the database.

Parameters:

old_name: str

current name in the database

new_name: str

new name in the database

overwrite: bool, optional

whether or not to overwrite an existing object with name new_name. Defaults to True.

Examples

>>> from iode import SAMPLE_DATA_DIR
>>> from iode import comments
>>> comments.load(f"{SAMPLE_DATA_DIR}/fun.cmt")
Loading .../fun.cmt
317 objects loaded 
>>> comments["ACAF"]
'Ondernemingen: ontvangen kapitaaloverdrachten.'

>>> # rename comment 'ACAF' as 'ACCAF'
>>> comments.rename("ACAF", "ACCAF")
>>> "ACCAF" in comments
True
>>> comments["ACCAF"]
'Ondernemingen: ontvangen kapitaaloverdrachten.'