colrev.env.utilsΒΆ

Collection of utility functions

Functions

colrev.env.utils.custom_asdict_factory

Custom asdict factory for (dataclass)object-to-dict conversion

colrev.env.utils.dict_set_nested

Set dict value by nested key, this works on empty dict

colrev.env.utils.get_by_path

Access a nested object in root by item sequence.

colrev.env.utils.get_package_file_content

Get the content of a file in the CoLRev package

colrev.env.utils.get_template

Load a jinja template

colrev.env.utils.inplace_change

Replace a string in a file

colrev.env.utils.load_complementary_material_keywords

Load the list of keywords identifying complementary materials

colrev.env.utils.load_complementary_material_prefixes

Load the list of prefixes identifying complementary materials

colrev.env.utils.load_complementary_material_strings

Load the list of exact strings identifying complementary materials

colrev.env.utils.percent_upper_chars

Get the percentage of upper-case characters in a string

colrev.env.utils.remove_accents

Replace the accents in a string

colrev.env.utils.retrieve_package_file

Retrieve a file from the CoLRev package