Skip to content

math_spec.typesetting.latex

LaTeX (amsmath). The format that lands in a journal.

Verbose source and a toolchain to compile it, in exchange for being the one target a paper actually accepts. CI compiles every example with a two-package TeX, which is also a check that the preamble stays installable from a small one.

LatexFormat #

See :class:math_spec.typesetting.format.Format.

cases_row = ' \\\\ ' class-attribute #

dash = '---' class-attribute #

notation = 'latex' class-attribute #

operators = {name: latex for name, (latex, _) in OPERATOR_SPELLINGS.items()} class-attribute #

suffix = '.tex' class-attribute #

apply(function, argument) #

Source code in src/math_spec/typesetting/latex.py 
121
122
def apply(self, function: str, argument: str) -> str:
    return f'{function}({argument})'

cardinality(inner) #

Source code in src/math_spec/typesetting/latex.py 
108
109
def cardinality(self, inner: str) -> str:
    return rf'\lvert {inner} \rvert'

cases(arms) #

Source code in src/math_spec/typesetting/latex.py 
114
115
116
def cases(self, arms: list[tuple[str, str]]) -> str:
    rows = self.cases_row.join(f'{value} & {condition}' for value, condition in arms)
    return rf'\begin{{cases}} {rows} \end{{cases}}'

document(blocks, *, standalone) #

Source code in src/math_spec/typesetting/latex.py 
150
151
152
def document(self, blocks: list[str], *, standalone: bool) -> str:
    body = '\n\n'.join(blocks) + '\n'
    return f'{_PREAMBLE}\n{body}\n\\end{{document}}\n' if standalone else body

equations(lines, *, numbered) #

Source code in src/math_spec/typesetting/latex.py 
129
130
131
132
133
134
135
136
137
138
def equations(self, lines: list[Line], *, numbered: bool) -> str:
    environment = 'align' if numbered else 'align*'
    rows = [
        f'{self.prose(line.label) if line.label else ""} && {line.left} & {line.right} && {line.condition}'.rstrip(
            ' &'
        )
        for line in lines
    ]
    body = ' \\\\\n'.join(rows)
    return f'\\begin{{{environment}}}\n{body}\n\\end{{{environment}}}'

escape(prose) #

Source code in src/math_spec/typesetting/latex.py 
91
92
def escape(self, prose: str) -> str:
    return _escape(prose)

fraction(numerator, denominator) #

Source code in src/math_spec/typesetting/latex.py 
111
112
def fraction(self, numerator: str, denominator: str) -> str:
    return rf'\frac{{{numerator}}}{{{denominator}}}'

glossary(title, entries) #

Source code in src/math_spec/typesetting/latex.py 
140
141
142
def glossary(self, title: str, entries: list[Entry]) -> str:
    rows = '\n'.join(rf'\item[{{{self.math(e.symbol)}}}] {e.meaning}' for e in entries)
    return f'\\paragraph{{{title}}}\n\\begin{{description}}\n{rows}\n\\end{{description}}'

greek(name) #

Source code in src/math_spec/typesetting/latex.py 
72
73
def greek(self, name: str) -> str:
    return f'\\{name}'

italic(name) #

Source code in src/math_spec/typesetting/latex.py 
63
64
def italic(self, name: str) -> str:
    return rf'\mathit{{{_escape(name)}}}'

joined(parts, operator) #

Source code in src/math_spec/typesetting/latex.py 
124
125
def joined(self, parts: list[str], operator: str) -> str:
    return f' {operator} '.join(parts) if operator else r',\ '.join(parts)

math(expression) #

Source code in src/math_spec/typesetting/latex.py 
94
95
def math(self, expression: str) -> str:
    return f'${expression}$'

mono(text) #

Source code in src/math_spec/typesetting/latex.py 
88
89
def mono(self, text: str) -> str:
    return rf'\texttt{{{_escape(text)}}}'

note(text) #

Source code in src/math_spec/typesetting/latex.py 
147
148
def note(self, text: str) -> str:
    return f'\\noindent {text}'

parenthesise(inner) #

Source code in src/math_spec/typesetting/latex.py 
105
106
def parenthesise(self, inner: str) -> str:
    return rf'\left( {inner} \right)'

prose(text) #

Source code in src/math_spec/typesetting/latex.py 
75
76
def prose(self, text: str) -> str:
    return rf'\text{{{_escape(text)}}}'

quoted(label) #

The quotes in text mode, the label itself upright in math mode.

Not one \text{'label'}: MathJax renders \_ inside \text as a literal backslash, and this format is what to_markdown inherits — in math mode the escape works everywhere, which is how every name already prints.

Source code in src/math_spec/typesetting/latex.py 
78
79
80
81
82
83
84
85
86
def quoted(self, label: str) -> str:
    r"""The quotes in text mode, the label itself upright in math mode.

    Not one ``\text{'label'}``: MathJax renders ``\_`` inside ``\text``
    as a literal backslash, and this format is what `to_markdown` inherits
    — in math mode the escape works everywhere, which is how every name
    already prints.
    """
    return rf"\text{{'}}{self.upright(label)}\text{{'}}"

script(letter) #

Source code in src/math_spec/typesetting/latex.py 
69
70
def script(self, letter: str) -> str:
    return rf'\mathcal{{{letter}}}'

section(title, body) #

Source code in src/math_spec/typesetting/latex.py 
144
145
def section(self, title: str, body: str) -> str:
    return f'\\paragraph{{{title}}}\n{body}'

subscript(base, indices) #

Source code in src/math_spec/typesetting/latex.py 
 99
100
def subscript(self, base: str, indices: list[str]) -> str:
    return f'{base}_{{{",".join(indices)}}}' if indices else base

summation(domain, body) #

Source code in src/math_spec/typesetting/latex.py 
118
119
def summation(self, domain: str, body: str) -> str:
    return rf'\sum_{{{domain}}} {body}'

superscript(base, tail) #

Source code in src/math_spec/typesetting/latex.py 
102
103
def superscript(self, base: str, tail: str) -> str:
    return f'{base}^{{{tail}}}'

upright(name) #

Source code in src/math_spec/typesetting/latex.py 
66
67
def upright(self, name: str) -> str:
    return rf'\mathrm{{{_escape(name)}}}'