Skip to content

bib.bibtexbase.standardize_bib

Main BibTeX standardization module.

This module provides the primary interface for standardizing BibTeX files. It coordinates the processing of different block types (entries, comments, preamble, and strings) and provides a unified standardization workflow.

The StandardizeBib class serves as the main entry point for BibTeX standardization, handling the complete processing pipeline from raw BibTeX data to standardized output with comprehensive error reporting.

Constants

MARKS_FLAGS: Mapping of BibTeX entry types to their processing flags and abbreviations for standardized output.

Classes:

Name Description
StandardizeBib

Main standardization class that processes complete BibTeX files and returns standardized output with error reporting.

Classes

StandardizeBib 

StandardizeBib(default_additional_field_list=None)

Stanndardize bib.

Parameters:

Name Type Description Default
default_additional_field_list list[str] | None = None

Additional default fields.

 None
Source code in pybibtexer/bib/bibtexbase/standardize_bib.py 
54
55
56
57
58
def __init__(self, default_additional_field_list: list[str] | None = None) -> None:
    self._standardize_comment_block = StandardizeCommentBlock()
    self._standardize_entry_block = StandardizeEntryBlock(default_additional_field_list)
    self._standardize_preamble_block = StandardizePreambleBlock()
    self._standardize_string_block = StandardizeStringBlock()

Functions

standardize 
standardize(data_list)

Generate standard bib.

Parameters:

Name Type Description Default
data_list list[str]

Bib data.

 required

Returns:

Type Description
tuple[list[str], list[list[str]]]

list[str]: Standard bib.
Source code in pybibtexer/bib/bibtexbase/standardize_bib.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def standardize(self, data_list: list[str]) -> tuple[list[str], list[list[str]]]:
    """Generate standard bib.

    Args:
        data_list (list[str]): Bib data.

    Returns:
        list[str]: Standard bib.
    """
    # Initialize
    data_list = "".join(data_list).splitlines(keepends=True)
    data_list = [line for line in data_list if line.strip()]

    # Split data according to mark pattern
    data_list = SplitBibAccordingToMark().split_marks(data_list)

    new_data_list: list[str] = []
    implicit_comment_list: list[list[str]] = []

    # Generate dict
    mark_blocks_dict, temp_implicit_comment_list = ObtainMarkBlocksDict().obtain_dict(data_list, True)
    implicit_comment_list.extend(temp_implicit_comment_list)

    marks, flags = [i[0] for i in MARKS_FLAGS], [i[1] for i in MARKS_FLAGS]
    if not_in := {k: v for k, v in mark_blocks_dict.items() if k not in marks}:
        print(f"Warning: Not standard parts - {not_in}")

    for mark in mark_blocks_dict:
        if mark in marks:
            flag = flags[marks.index(mark)]

            for block in mark_blocks_dict[mark]:
                block, temp = eval(f"self._standardize_{flag}_block.standardize")(block)
                new_data_list.extend(block)
                implicit_comment_list.extend(temp)

    return new_data_list, implicit_comment_list