YogeLiu/TexTeller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

🔧 Fix all ruff typo errors & test CI/CD workflow (#109)

Browse Source 
* [chore] Fix ruff typo

* [robot] Fix welcome robot
This commit is contained in:
OleehyO
2025-04-21 13:52:16 +08:00
committed by GitHub
parent ae776aa9c7
commit 511f69555c
9 changed files with 127 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/pr-welcome.yml vendored
View File

@@ -4,6 +4,10 @@ on:
pull_request: pull_request:
types: [opened] types: [opened]
permissions:
pull-requests: write
issues: write
jobs: jobs:
welcome: welcome:
runs-on: ubuntu-latest runs-on: ubuntu-latest

2
assets/fire.svg
View File

@@ -457,4 +457,4 @@
<animate attributeName="cy" values="114.80243604193255;7.19374553530416" keyTimes="0;1" dur="1s" repeatCount="indefinite" begin="-0.6866227460985781s"></animate> <animate attributeName="cy" values="114.80243604193255;7.19374553530416" keyTimes="0;1" dur="1s" repeatCount="indefinite" begin="-0.6866227460985781s"></animate>
<animate attributeName="r" values="9;0;0" keyTimes="0;0.6690048284116141;1" dur="1s" repeatCount="indefinite" begin="-0.6866227460985781s"></animate> <animate attributeName="r" values="9;0;0" keyTimes="0;0.6690048284116141;1" dur="1s" repeatCount="indefinite" begin="-0.6866227460985781s"></animate>
</circle></g> </circle></g>
</svg> </svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

66
docs/source/conf.py
View File

@@ -12,64 +12,64 @@
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('../..')) sys.path.insert(0, os.path.abspath("../.."))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'TexTeller' project = "TexTeller"
copyright = '2025, TexTeller Team' copyright = "2025, TexTeller Team"
author = 'TexTeller Team' author = "TexTeller Team"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [ extensions = [
'myst_parser', "myst_parser",
'sphinx.ext.duration', "sphinx.ext.duration",
'sphinx.ext.intersphinx', "sphinx.ext.intersphinx",
'sphinx.ext.autosectionlabel', "sphinx.ext.autosectionlabel",
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinx.ext.viewcode', "sphinx.ext.viewcode",
'sphinx.ext.napoleon', "sphinx.ext.napoleon",
'sphinx.ext.autosummary', "sphinx.ext.autosummary",
'sphinx_copybutton', "sphinx_copybutton",
# 'sphinx.ext.linkcode', # 'sphinx.ext.linkcode',
# 'sphinxarg.ext', # 'sphinxarg.ext',
'sphinx_design', "sphinx_design",
'nbsphinx', "nbsphinx",
] ]
templates_path = ['_templates'] templates_path = ["_templates"]
exclude_patterns = [] exclude_patterns = []
# Autodoc settings # Autodoc settings
autodoc_member_order = 'bysource' autodoc_member_order = "bysource"
add_module_names = False add_module_names = False
autoclass_content = 'both' autoclass_content = "both"
autodoc_default_options = { autodoc_default_options = {
'members': True, "members": True,
'member-order': 'bysource', "member-order": "bysource",
'undoc-members': True, "undoc-members": True,
'show-inheritance': True, "show-inheritance": True,
'imported-members': True, "imported-members": True,
} }
# Intersphinx settings # Intersphinx settings
intersphinx_mapping = { intersphinx_mapping = {
'python': ('https://docs.python.org/3', None), "python": ("https://docs.python.org/3", None),
'numpy': ('https://numpy.org/doc/stable', None), "numpy": ("https://numpy.org/doc/stable", None),
'torch': ('https://pytorch.org/docs/stable', None), "torch": ("https://pytorch.org/docs/stable", None),
'transformers': ('https://huggingface.co/docs/transformers/main/en', None), "transformers": ("https://huggingface.co/docs/transformers/main/en", None),
} }
html_theme = 'sphinx_book_theme' html_theme = "sphinx_book_theme"
html_theme_options = { html_theme_options = {
'repository_url': 'https://github.com/OleehyO/TexTeller', "repository_url": "https://github.com/OleehyO/TexTeller",
'use_repository_button': True, "use_repository_button": True,
'use_issues_button': True, "use_issues_button": True,
'use_edit_page_button': True, "use_edit_page_button": True,
'use_download_button': True, "use_download_button": True,
} }
html_logo = "../../assets/logo.svg" html_logo = "../../assets/logo.svg"

4
examples/client_demo.py
View File

@@ -3,8 +3,8 @@ import requests
server_url = "http://127.0.0.1:8000/predict" server_url = "http://127.0.0.1:8000/predict"
img_path = "/path/to/your/image" img_path = "/path/to/your/image"
with open(img_path, 'rb') as img: with open(img_path, "rb") as img:
files = {'img': img} files = {"img": img}
response = requests.post(server_url, files=files) response = requests.post(server_url, files=files)
print(response.text) print(response.text)

26
texteller/api/format.py
View File

@@ -19,8 +19,8 @@ TEXT_LINE_START = ""
COMMENT_LINE_START = "% " COMMENT_LINE_START = "% "
# Opening and closing delimiters # Opening and closing delimiters
OPENS = ['{', '(', '['] OPENS = ["{", "(", "["]
CLOSES = ['}', ')', ']'] CLOSES = ["}", ")", "]"]
# Names of LaTeX verbatim environments # Names of LaTeX verbatim environments
VERBATIMS = ["verbatim", "Verbatim", "lstlisting", "minted", "comment"] VERBATIMS = ["verbatim", "Verbatim", "lstlisting", "minted", "comment"]
@@ -138,7 +138,7 @@ class Pattern:
contains_env_end=ENV_END in s, contains_env_end=ENV_END in s,
contains_item=ITEM in s, contains_item=ITEM in s,
contains_splitting=True, contains_splitting=True,
contains_comment='%' in s, contains_comment="%" in s,
) )
else: else:
return cls( return cls(
@@ -146,7 +146,7 @@ class Pattern:
contains_env_end=False, contains_env_end=False,
contains_item=False, contains_item=False,
contains_splitting=False, contains_splitting=False,
contains_comment='%' in s, contains_comment="%" in s,
) )
@@ -169,11 +169,11 @@ def find_comment_index(line: str, pattern: Pattern) -> Optional[int]:
in_command = False in_command = False
for i, c in enumerate(line): for i, c in enumerate(line):
if c == '\\': if c == "\\":
in_command = True in_command = True
elif in_command and not c.isalpha(): elif in_command and not c.isalpha():
in_command = False in_command = False
elif c == '%' and not in_command: elif c == "%" and not in_command:
return i return i
return None return None
@@ -390,10 +390,10 @@ def find_wrap_point(line: str, indent_length: int, args: Args) -> Optional[int]:
line_width += 1 line_width += 1
if line_width > wrap_boundary and wrap_point is not None: if line_width > wrap_boundary and wrap_point is not None:
break break
if c == ' ' and prev_char != '\\': if c == " " and prev_char != "\\":
if after_char: if after_char:
wrap_point = i wrap_point = i
elif c != '%': elif c != "%":
after_char = True after_char = True
prev_char = c prev_char = c
@@ -483,8 +483,8 @@ def split_line(line: str, state: State, file: str, args: Args, logs: List[Log])
if not match: if not match:
return line, "" return line, ""
prev = match.group('prev') prev = match.group("prev")
rest = match.group('env') rest = match.group("env")
if args.verbosity >= 3: # Trace level if args.verbosity >= 3: # Trace level
logs.append( logs.append(
@@ -517,8 +517,8 @@ def clean_text(text: str, args: Args) -> str:
text = RE_NEWLINES.sub(f"{LINE_END}{LINE_END}", text) text = RE_NEWLINES.sub(f"{LINE_END}{LINE_END}", text)
# Remove tabs if they shouldn't be used # Remove tabs if they shouldn't be used
if args.tabchar != '\t': if args.tabchar != "\t":
text = text.replace('\t', ' ' * args.tabsize) text = text.replace("\t", " " * args.tabsize)
# Remove trailing spaces # Remove trailing spaces
text = RE_TRAIL.sub(LINE_END, text) text = RE_TRAIL.sub(LINE_END, text)
@@ -577,7 +577,7 @@ def _format_latex(old_text: str, file: str, args: Args) -> Tuple[str, List[Log]]
new_text = "" new_text = ""
# Select the character used for indentation # Select the character used for indentation
indent_char = '\t' if args.tabchar == '\t' else ' ' indent_char = "\t" if args.tabchar == "\t" else " "
# Get any extra environments to be indented as lists # Get any extra environments to be indented as lists
lists_begin = [f"\\begin{{{l}}}" for l in args.lists] lists_begin = [f"\\begin{{{l}}}" for l in args.lists]

134
texteller/api/katex.py
View File

@@ -5,13 +5,13 @@ from .format import format_latex
def _rm_dollar_surr(content): def _rm_dollar_surr(content):
pattern = re.compile(r'\\[a-zA-Z]+\$.*?\$|\$.*?\$') pattern = re.compile(r"\\[a-zA-Z]+\$.*?\$|\$.*?\$")
matches = pattern.findall(content) matches = pattern.findall(content)
for match in matches: for match in matches:
if not re.match(r'\\[a-zA-Z]+', match): if not re.match(r"\\[a-zA-Z]+", match):
new_match = match.strip('$') new_match = match.strip("$")
content = content.replace(match, ' ' + new_match + ' ') content = content.replace(match, " " + new_match + " ")
return content return content
@@ -33,97 +33,97 @@ def to_katex(formula: str) -> str:
""" """
res = formula res = formula
# remove mbox surrounding # remove mbox surrounding
res = change_all(res, r'\mbox ', r' ', r'{', r'}', r'', r'') res = change_all(res, r"\mbox ", r" ", r"{", r"}", r"", r"")
res = change_all(res, r'\mbox', r' ', r'{', r'}', r'', r'') res = change_all(res, r"\mbox", r" ", r"{", r"}", r"", r"")
# remove hbox surrounding # remove hbox surrounding
res = re.sub(r'\\hbox to ?-? ?\d+\.\d+(pt)?\{', r'\\hbox{', res) res = re.sub(r"\\hbox to ?-? ?\d+\.\d+(pt)?\{", r"\\hbox{", res)
res = change_all(res, r'\hbox', r' ', r'{', r'}', r'', r' ') res = change_all(res, r"\hbox", r" ", r"{", r"}", r"", r" ")
# remove raise surrounding # remove raise surrounding
res = re.sub(r'\\raise ?-? ?\d+\.\d+(pt)?', r' ', res) res = re.sub(r"\\raise ?-? ?\d+\.\d+(pt)?", r" ", res)
# remove makebox # remove makebox
res = re.sub(r'\\makebox ?\[\d+\.\d+(pt)?\]\{', r'\\makebox{', res) res = re.sub(r"\\makebox ?\[\d+\.\d+(pt)?\]\{", r"\\makebox{", res)
res = change_all(res, r'\makebox', r' ', r'{', r'}', r'', r' ') res = change_all(res, r"\makebox", r" ", r"{", r"}", r"", r" ")
# remove vbox surrounding, scalebox surrounding # remove vbox surrounding, scalebox surrounding
res = re.sub(r'\\raisebox\{-? ?\d+\.\d+(pt)?\}\{', r'\\raisebox{', res) res = re.sub(r"\\raisebox\{-? ?\d+\.\d+(pt)?\}\{", r"\\raisebox{", res)
res = re.sub(r'\\scalebox\{-? ?\d+\.\d+(pt)?\}\{', r'\\scalebox{', res) res = re.sub(r"\\scalebox\{-? ?\d+\.\d+(pt)?\}\{", r"\\scalebox{", res)
res = change_all(res, r'\scalebox', r' ', r'{', r'}', r'', r' ') res = change_all(res, r"\scalebox", r" ", r"{", r"}", r"", r" ")
res = change_all(res, r'\raisebox', r' ', r'{', r'}', r'', r' ') res = change_all(res, r"\raisebox", r" ", r"{", r"}", r"", r" ")
res = change_all(res, r'\vbox', r' ', r'{', r'}', r'', r' ') res = change_all(res, r"\vbox", r" ", r"{", r"}", r"", r" ")
origin_instructions = [ origin_instructions = [
r'\Huge', r"\Huge",
r'\huge', r"\huge",
r'\LARGE', r"\LARGE",
r'\Large', r"\Large",
r'\large', r"\large",
r'\normalsize', r"\normalsize",
r'\small', r"\small",
r'\footnotesize', r"\footnotesize",
r'\tiny', r"\tiny",
] ]
for old_ins, new_ins in zip(origin_instructions, origin_instructions): for old_ins, new_ins in zip(origin_instructions, origin_instructions):
res = change_all(res, old_ins, new_ins, r'$', r'$', '{', '}') res = change_all(res, old_ins, new_ins, r"$", r"$", "{", "}")
res = change_all(res, r'\mathbf', r'\bm', r'{', r'}', r'{', r'}') res = change_all(res, r"\mathbf", r"\bm", r"{", r"}", r"{", r"}")
res = change_all(res, r'\boldmath ', r'\bm', r'{', r'}', r'{', r'}') res = change_all(res, r"\boldmath ", r"\bm", r"{", r"}", r"{", r"}")
res = change_all(res, r'\boldmath', r'\bm', r'{', r'}', r'{', r'}') res = change_all(res, r"\boldmath", r"\bm", r"{", r"}", r"{", r"}")
res = change_all(res, r'\boldmath ', r'\bm', r'$', r'$', r'{', r'}') res = change_all(res, r"\boldmath ", r"\bm", r"$", r"$", r"{", r"}")
res = change_all(res, r'\boldmath', r'\bm', r'$', r'$', r'{', r'}') res = change_all(res, r"\boldmath", r"\bm", r"$", r"$", r"{", r"}")
res = change_all(res, r'\scriptsize', r'\scriptsize', r'$', r'$', r'{', r'}') res = change_all(res, r"\scriptsize", r"\scriptsize", r"$", r"$", r"{", r"}")
res = change_all(res, r'\emph', r'\textit', r'{', r'}', r'{', r'}') res = change_all(res, r"\emph", r"\textit", r"{", r"}", r"{", r"}")
res = change_all(res, r'\emph ', r'\textit', r'{', r'}', r'{', r'}') res = change_all(res, r"\emph ", r"\textit", r"{", r"}", r"{", r"}")
# remove bold command # remove bold command
res = change_all(res, r'\bm', r' ', r'{', r'}', r'', r'') res = change_all(res, r"\bm", r" ", r"{", r"}", r"", r"")
origin_instructions = [ origin_instructions = [
r'\left', r"\left",
r'\middle', r"\middle",
r'\right', r"\right",
r'\big', r"\big",
r'\Big', r"\Big",
r'\bigg', r"\bigg",
r'\Bigg', r"\Bigg",
r'\bigl', r"\bigl",
r'\Bigl', r"\Bigl",
r'\biggl', r"\biggl",
r'\Biggl', r"\Biggl",
r'\bigm', r"\bigm",
r'\Bigm', r"\Bigm",
r'\biggm', r"\biggm",
r'\Biggm', r"\Biggm",
r'\bigr', r"\bigr",
r'\Bigr', r"\Bigr",
r'\biggr', r"\biggr",
r'\Biggr', r"\Biggr",
] ]
for origin_ins in origin_instructions: for origin_ins in origin_instructions:
res = change_all(res, origin_ins, origin_ins, r'{', r'}', r'', r'') res = change_all(res, origin_ins, origin_ins, r"{", r"}", r"", r"")
res = re.sub(r'\\\[(.*?)\\\]', r'\1\\newline', res) res = re.sub(r"\\\[(.*?)\\\]", r"\1\\newline", res)
if res.endswith(r'\newline'): if res.endswith(r"\newline"):
res = res[:-8] res = res[:-8]
# remove multiple spaces # remove multiple spaces
res = re.sub(r'(\\,){1,}', ' ', res) res = re.sub(r"(\\,){1,}", " ", res)
res = re.sub(r'(\\!){1,}', ' ', res) res = re.sub(r"(\\!){1,}", " ", res)
res = re.sub(r'(\\;){1,}', ' ', res) res = re.sub(r"(\\;){1,}", " ", res)
res = re.sub(r'(\\:){1,}', ' ', res) res = re.sub(r"(\\:){1,}", " ", res)
res = re.sub(r'\\vspace\{.*?}', '', res) res = re.sub(r"\\vspace\{.*?}", "", res)
# merge consecutive text # merge consecutive text
def merge_texts(match): def merge_texts(match):
texts = match.group(0) texts = match.group(0)
merged_content = ''.join(re.findall(r'\\text\{([^}]*)\}', texts)) merged_content = "".join(re.findall(r"\\text\{([^}]*)\}", texts))
return f'\\text{{{merged_content}}}' return f"\\text{{{merged_content}}}"
res = re.sub(r'(\\text\{[^}]*\}\s*){2,}', merge_texts, res) res = re.sub(r"(\\text\{[^}]*\}\s*){2,}", merge_texts, res)
res = res.replace(r'\bf ', '') res = res.replace(r"\bf ", "")
res = _rm_dollar_surr(res) res = _rm_dollar_surr(res)
# remove extra spaces (keeping only one) # remove extra spaces (keeping only one)
res = re.sub(r' +', ' ', res) res = re.sub(r" +", " ", res)
# format latex # format latex
res = res.strip() res = res.strip()

2
texteller/models/__init__.py
View File

@@ -1,3 +1,3 @@
from .texteller import TexTeller from .texteller import TexTeller
__all__ = ['TexTeller'] __all__ = ["TexTeller"]

4
texteller/utils/image.py
View File

@@ -41,7 +41,7 @@ def readimgs(image_paths: list[str]) -> list[np.ndarray]:
if image is None: if image is None:
raise ValueError(f"Image at {path} could not be read.") raise ValueError(f"Image at {path} could not be read.")
if image.dtype == np.uint16: if image.dtype == np.uint16:
_logger.warning(f'Converting {path} to 8-bit, image may be lossy.') _logger.warning(f"Converting {path} to 8-bit, image may be lossy.")
image = cv2.convertScaleAbs(image, alpha=(255.0 / 65535.0)) image = cv2.convertScaleAbs(image, alpha=(255.0 / 65535.0))
channels = 1 if len(image.shape) == 2 else image.shape[2] channels = 1 if len(image.shape) == 2 else image.shape[2]
@@ -112,7 +112,7 @@ def transform(images: List[Union[np.ndarray, Image.Image]]) -> List[torch.Tensor
assert IMG_CHANNELS == 1, "Only support grayscale images for now" assert IMG_CHANNELS == 1, "Only support grayscale images for now"
images = [ images = [
np.array(img.convert('RGB')) if isinstance(img, Image.Image) else img for img in images np.array(img.convert("RGB")) if isinstance(img, Image.Image) else img for img in images
] ]
images = [trim_white_border(image) for image in images] images = [trim_white_border(image) for image in images]
images = [general_transform_pipeline(image) for image in images] images = [general_transform_pipeline(image) for image in images]

8
texteller/utils/latex.py
View File

@@ -21,7 +21,7 @@ def _change(input_str, old_inst, new_inst, old_surr_l, old_surr_r, new_surr_l, n
j = start + 1 j = start + 1
escaped = False escaped = False
while j < n and count > 0: while j < n and count > 0:
if input_str[j] == '\\' and not escaped: if input_str[j] == "\\" and not escaped:
escaped = True escaped = True
j += 1 j += 1
continue continue
@@ -71,10 +71,10 @@ def change_all(input_str, old_inst, new_inst, old_surr_l, old_surr_r, new_surr_l
for p in pos[::-1]: for p in pos[::-1]:
res[p:] = list( res[p:] = list(
_change( _change(
''.join(res[p:]), old_inst, new_inst, old_surr_l, old_surr_r, new_surr_l, new_surr_r "".join(res[p:]), old_inst, new_inst, old_surr_l, old_surr_r, new_surr_l, new_surr_r
) )
) )
res = ''.join(res) res = "".join(res)
return res return res
@@ -121,7 +121,7 @@ def add_newlines(latex_str: str) -> str:
# 4. Cleanup: Collapse multiple consecutive newlines into a single newline. # 4. Cleanup: Collapse multiple consecutive newlines into a single newline.
# This handles cases where the replacements above might have created \n\n. # This handles cases where the replacements above might have created \n\n.
processed_str = re.sub(r'\n{2,}', '\n', processed_str) processed_str = re.sub(r"\n{2,}", "\n", processed_str)
# Remove leading/trailing whitespace (including potential single newlines # Remove leading/trailing whitespace (including potential single newlines
# at the very start/end resulting from the replacements) from the entire result. # at the very start/end resulting from the replacements) from the entire result.