check_alphabetical_order.py File Reference

Go to the source code of this file.

Classes
class	check_alphabetical_order.BulletBlocks
class	check_alphabetical_order.ScannedBlocks

Namespaces
namespace	check_alphabetical_order

Functions
ScannedBlocks	check_alphabetical_order._scan_bullet_blocks (Sequence[str] lines, int start, int end)
str	check_alphabetical_order.read_text (str path)
None	check_alphabetical_order.write_text (str path, str content)
List[str]	check_alphabetical_order._normalize_list_rst_lines (Sequence[str] lines)
str	check_alphabetical_order.normalize_list_rst (str data)
Optional[int]	check_alphabetical_order.find_heading (Sequence[str] lines, str title)
str	check_alphabetical_order.extract_label (str text)
bool	check_alphabetical_order._is_bullet_start (str line)
BulletBlocks	check_alphabetical_order._parse_bullet_blocks (Sequence[str] lines, int start, int end)
List[BulletBlock]	check_alphabetical_order.sort_blocks (Iterable[BulletItem] blocks)
List[Tuple[CheckLabel, DuplicateOccurrences]]	check_alphabetical_order.find_duplicate_entries (Sequence[str] lines, str title)
Optional[Tuple[int, int, int]]	check_alphabetical_order._find_section_bounds (Sequence[str] lines, str title, Optional[str] next_title)
List[str]	check_alphabetical_order._normalize_release_notes_section (Sequence[str] lines, str title, Optional[str] next_title)
str	check_alphabetical_order.normalize_release_notes (Sequence[str] lines)
Optional[str]	check_alphabetical_order._emit_duplicate_report (Sequence[str] lines, str title)
int	check_alphabetical_order.process_release_notes (str out_path, str rn_doc)
int	check_alphabetical_order.process_checks_list (str out_path, str list_doc)
int	check_alphabetical_order.main (Sequence[str] argv)

Variables
Final	check_alphabetical_order.DOC_LABEL_RN_RE = re.compile(r":doc:`(?P<label>[^`<]+)\s*(?:<[^>]+>)?`")
Final	check_alphabetical_order.DOC_LINE_RE = re.compile(r"^\s*:doc:`(?P<label>[^`<]+?)\s*<[^>]+>`.*$")
Final	check_alphabetical_order.EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")
Final	check_alphabetical_order.DOCS_DIR = os.path.join(EXTRA_DIR, "docs")
Final	check_alphabetical_order.CLANG_TIDY_DOCS_DIR = os.path.join(DOCS_DIR, "clang-tidy")
Final	check_alphabetical_order.CHECKS_DOCS_DIR = os.path.join(CLANG_TIDY_DOCS_DIR, "checks")
Final	check_alphabetical_order.LIST_DOC = os.path.join(CHECKS_DOCS_DIR, "list.rst")
Final	check_alphabetical_order.RELEASE_NOTES_DOC = os.path.join(DOCS_DIR, "ReleaseNotes.rst")
	check_alphabetical_order.CheckLabel = str
	check_alphabetical_order.Lines = List[str]
	check_alphabetical_order.BulletBlock = List[str]
	check_alphabetical_order.BulletItem = Tuple[CheckLabel, BulletBlock]
	check_alphabetical_order.BulletStart = int
	check_alphabetical_order.DuplicateOccurrences = List[Tuple[BulletStart, BulletBlock]]