Skip to content

tools.replace.replace

Classes

Functions

replace_to_standard_cite_keys 

replace_to_standard_cite_keys(
    full_tex_md, full_bib, path_output, options
)

Replace citation keys in TeX/Markdown files with standardized keys from BibTeX.

Processes both LaTeX and Markdown files, replacing old citation keys with newly generated standardized keys while maintaining the corresponding BibTeX database.

Parameters:

Name Type Description Default
full_tex_md str

Path to TeX or Markdown file containing citations

 required
full_bib str

Path to BibTeX file with reference entries

 required
path_output str

Output directory for processed files

 required
options dict[str, Any]

Configuration options for key generation

 required

Returns:

Type Description
list[str]

list[str]: Lines of processed text content with updated citation keys
Source code in pybibtexer/tools/replace/replace.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def replace_to_standard_cite_keys(
    full_tex_md: str, full_bib: str, path_output: str, options: dict[str, Any]
) -> list[str]:
    """Replace citation keys in TeX/Markdown files with standardized keys from BibTeX.

    Processes both LaTeX and Markdown files, replacing old citation keys with newly
    generated standardized keys while maintaining the corresponding BibTeX database.

    Args:
        full_tex_md: Path to TeX or Markdown file containing citations
        full_bib: Path to BibTeX file with reference entries
        path_output: Output directory for processed files
        options: Configuration options for key generation

    Returns:
        list[str]: Lines of processed text content with updated citation keys
    """
    # Validate input file type
    ext = os.path.splitext(full_tex_md)[-1]
    if ext not in [".tex", ".md", "md", "tex"]:
        print(f"{full_tex_md} must be `.tex` or `.md` file.")
        return []

    # Standardize output path and read BibTeX data
    path_output = standard_path(path_output)
    bib_data = transform_to_data_list(full_bib, ".bib")

    # Generate mapping from old to new citation keys
    old_key_new_entry_dict = generate_old_key_new_entry_dict(bib_data, options)

    # Read and process document content
    data = "".join(transform_to_data_list(full_tex_md, ext))

    # Replace citation keys in content
    for old_key, new_entry in old_key_new_entry_dict.items():
        if ext == ".tex":
            # LaTeX citation patterns: \cite{}, \citet{}, \citep{}, and so on
            data = re.sub(r"\\cite([a-z]*){\s*" + old_key + r"\s*}", r"\\cite\1{" + new_entry.key + "}", data)
            data = re.sub(r"\\cite([a-z]*){\s*" + old_key + r"\s*,", r"\\cite\1{" + new_entry.key + ",", data)
            data = re.sub(r",\s*" + old_key + r"\s*,", r"," + new_entry.key + r",", data)
            data = re.sub(r",\s*" + old_key + r"\s*}", r"," + new_entry.key + "}", data)
        elif ext == ".md":
            # Markdown citation patterns: [@], comma-separated lists
            data = re.sub(r"\[@\s*" + old_key + r"\s*\]", r"[@" + new_entry.key + "]", data)
            data = re.sub(r"\[@\s*" + old_key + r"\s*,", r"[@" + new_entry.key + ",", data)
            data = re.sub(r",\s*" + old_key + r"\s*,", r"," + new_entry.key + r",", data)
            data = re.sub(r",\s*" + old_key + r"\s*\]", r"," + new_entry.key + "]", data)
        else:
            pass

    # Write processed document
    data_list = data.splitlines(keepends=True)
    write_list(data_list, f"new{ext}", "w", path_output, False)

    # Write updated BibTeX file with new citation keys
    _options = {}
    _options.update(options)
    _options["is_sort_blocks"] = False  # Preserve original entry order and default is True
    _python_write = PythonWriters(_options)
    _python_write.write_to_file(list(old_key_new_entry_dict.values()), "new.bib", "w", path_output, False)
    return data_list