Apply ruff, add Makefile, revamp tox, update hooks

Author: deeplook

.pre-commit-config.yaml

@@ -1,11 +1,22 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
-    hooks:
-    -   id: trailing-whitespace
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.20.0
-    hooks:
-    -   id: pyupgrade
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: trailing-whitespace
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.20.0
+  hooks:
+  - id: pyupgrade
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.13.0
+  hooks:
+  - id: ruff-format
+    types_or: ["python"]
+  - id: ruff
+    types_or: ["python"]
+    args: ["--fix"]

Makefile

@@ -0,0 +1,66 @@
+.PHONY: help
+
+# Default to 'help' when no target is given
+DEFAULT_GOAL := help
+.DEFAULT_GOAL := $(DEFAULT_GOAL)
+
+help:  ## Display this help screen
+	@echo "Usage: make [target] ..."
+	@echo
+	@echo "Available targets:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Install dependencies and pre-commit hooks.
+	uv pip install -e ".[dev]"
+	uv run pre-commit install
+
+.PHONY: uninstall
+uninstall: ## Uninstall the package from the local virtual environment.
+	uv pip uninstall svglib -y
+
+.PHONY: test
+test: ## Run the test suite with coverage.
+	uv run pytest -s -v -rs --cov=src/svglib --cov-report=term-missing --cov-report=html tests
+	uv run coverage html
+
+.PHONY: lint
+lint: ## Run the formatter and linter.
+	uv run ruff format .
+	uv run ruff check --fix .
+
+.PHONY: hooks
+hooks:  ## Run all pre-commit hooks.
+	uv run pre-commit run --all-files
+
+.PHONY: all
+all: install lint hooks test ## Run all checks (install, lint, test).
+
+.PHONY: dist
+dist: ## Build the package for distribution.
+	uv build
+
+.PHONY: test-dist
+test-dist: ## Build and test the distribution wheel.
+	@./scripts/test-dist.sh
+
+.PHONY: clean
+clean: ## Remove temporary build files.
+	@find . -type f -name "*~" -delete
+	@find . -type f -name "*.py[co]" -delete
+	@find . -type f -name ".coverage" -delete
+	@find . -type f -name "coverage.xml" -delete
+	@find . -type d -name "__pycache__" -delete
+	@find . -type d -name ".mypy_cache" -delete
+	@find . -type d -name ".pytest_cache" -delete
+	@find . -type d -name ".rust_cache" -delete
+	@find . -type d -name "*.egg-info" -exec rm -rf {} +
+	@rm -rf .pytest_cache .ruff_cache .mypy_cache .tox
+
+.PHONY: testclean
+testclean: ## Delete PDF files generated by the test suite.
+	@find tests/samples -type f -name "*-svglib.pdf" -delete
+
+.PHONY: distclean
+distclean: clean ## Delete all temporary files and the virtual environment.
+	@rm -rf .venv

pyproject.toml

@@ -60,11 +60,30 @@ svg2pdf = "svglib:main"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.uv]
-dev-dependencies = [
+[project.optional-dependencies]
+dev = [
+    "pre-commit>=4.3.0",
     "pytest>=8.3.5",
+    "pytest-cov>=7.0.0",
     "pytest-runner>=6.0.1",
+    "ruff>=0.13.0",
+    "tox>=4.0.0",
 ]
 
-[tool.flake8]
-max-line-length = "99"
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors (essential syntax and style issues)
+    "F",  # Pyflakes messages (e.g., undefined names, unused imports)
+    "I",  # isort rules for enforcing import order
+]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[dependency-groups]
+dev = [
+    "tox>=4.30.2",
+]

requirements.txt

@@ -7,7 +7,7 @@
 import sys
 import textwrap
 from datetime import datetime
-from os.path import dirname, basename, splitext, exists
+from os.path import basename, dirname, exists, splitext
 
 from reportlab.graphics import renderPDF
 
@@ -88,9 +88,7 @@ def main():
             https://github.com/deeplook/svglib
 
         Copyleft by {author}, 2008-{copyleft_year} ({license}):
-            https://www.gnu.org/licenses/lgpl-3.0.html""".format(
-            **args
-        )
+            https://www.gnu.org/licenses/lgpl-3.0.html""".format(**args)
     )
     p = argparse.ArgumentParser(
         description=desc,

src/svglib/__init__.py

@@ -9,7 +9,6 @@
 from reportlab.pdfbase.pdfmetrics import registerFont
 from reportlab.pdfbase.ttfonts import TTFError, TTFont
 
-
 STANDARD_FONT_NAMES = (
     "Times-Roman",
     "Times-Italic",
@@ -42,8 +41,8 @@ def __init__(self):
         """
         The map has the form:
         'internal_name': {
-           'svg_family': 'family_name', 'svg_weight': 'font-weight', 'svg_style': 'font-style',
-           'rlgFont': 'rlgFontName'
+            'svg_family': 'family_name', 'svg_weight': 'font-weight',
+            'svg_style': 'font-style', 'rlgFont': 'rlgFontName'
         }
         for faster searching we use internal keys for finding the matching font
         """
@@ -63,7 +62,7 @@ def build_internal_name(family, weight="normal", style="normal"):
         if weight != "normal" or style != "normal":
             result_name += "-"
         if weight != "normal":
-            if type(weight) is int:
+            if isinstance(weight, int):
                 result_name += f"{weight}"
             else:
                 result_name += weight.lower().capitalize()

src/svglib/fonts.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 """A library for reading and converting SVG.
 
 This is a converter from SVG to RLG (ReportLab Graphics) drawings.
@@ -24,14 +23,10 @@
 import shlex
 import shutil
 from collections import defaultdict, namedtuple
-from io import BytesIO
 from importlib.metadata import version
+from io import BytesIO
 
 from PIL import Image as PILImage
-
-from reportlab.pdfbase.pdfmetrics import stringWidth
-from reportlab.pdfgen.canvas import FILL_EVEN_ODD, FILL_NON_ZERO
-from reportlab.pdfgen.pdfimages import PDFImage
 from reportlab.graphics.shapes import (
     _CLOSEPATH,
     Circle,
@@ -41,43 +36,48 @@
     Image,
     Line,
     Path,
-    PolyLine,
     Polygon,
+    PolyLine,
     Rect,
     SolidShape,
     String,
 )
 from reportlab.lib import colors
 from reportlab.lib.units import pica, toLength
+from reportlab.pdfbase.pdfmetrics import stringWidth
+from reportlab.pdfgen.canvas import FILL_EVEN_ODD, FILL_NON_ZERO
+from reportlab.pdfgen.pdfimages import PDFImage
 
 try:
     from reportlab.graphics.transform import mmult
 except ImportError:
     # Before Reportlab 3.5.61
     from reportlab.graphics.shapes import mmult
 
-from lxml import etree
 import cssselect2
 import tinycss2
-
-from .utils import (
-    bezier_arc_from_end_points,
-    convert_quadratic_to_cubic_path,
-    normalise_svg_path,
-)
+from lxml import etree
 
 from .fonts import (
-    get_global_font_map,
     DEFAULT_FONT_NAME,
-    DEFAULT_FONT_WEIGHT,
-    DEFAULT_FONT_STYLE,
     DEFAULT_FONT_SIZE,
+    DEFAULT_FONT_STYLE,
+    DEFAULT_FONT_WEIGHT,
+    get_global_font_map,
+)
+from .fonts import (
+    find_font as _fonts_find_font,
 )
 
-# To keep backward compatibility, since those functions where previously part of the svglib module
+# To keep backward compatibility, since those functions where previously part of
+# the svglib module
 from .fonts import (
     register_font as _fonts_register_font,
-    find_font as _fonts_find_font,
+)
+from .utils import (
+    bezier_arc_from_end_points,
+    convert_quadratic_to_cubic_path,
+    normalise_svg_path,
 )
 
 
@@ -625,7 +625,8 @@ def renderNode(self, node, parent=None):
                 # and simplify further analyses of generated document
                 item.setProperties({"svgid": nid})
                 # labels are used in inkscape to name specific groups as layers
-                # preserving them simplify extraction of feature from the generated document
+                # preserving them simplify extraction of feature from the generated
+                # document
                 label_attrs = [v for k, v in node.attrib.items() if "label" in k]
                 if len(label_attrs) == 1:
                     (label,) = label_attrs
@@ -905,7 +906,8 @@ def renderUse(self, node, group=None, clipping=None):
         if clipping:
             group.add(clipping)
         if len(node.getchildren()) == 0:
-            # Append a copy of the referenced node as the <use> child (if not already done)
+            # Append a copy of the referenced node as the <use> child (if not
+            # already done)
             node.append(copy.deepcopy(item))
         self.renderNode(list(node.iter_children())[-1], parent=group)
         self.apply_node_attr_to_group(node, group)
@@ -1089,7 +1091,8 @@ def convertText(self, node):
 
             frag_lengths.append(stringWidth(text, ff, fs))
 
-            # When x, y, dx, or dy is a list, we calculate position for each char of text.
+            # When x, y, dx, or dy is a list, we calculate position for each char of
+            # text.
             if any(isinstance(val, list) for val in (x1, y1, dx, dy)):
                 if has_x:
                     xlist = x1 if isinstance(x1, list) else [x1]
@@ -1225,9 +1228,12 @@ def convertPath(self, node):
                 x0, y0 = points[-2:]
                 x1, y1, xn, yn = nums
                 last_quadratic_cp = (x1, y1)
-                (x0, y0), (x1, y1), (x2, y2), (xn, yn) = (
-                    convert_quadratic_to_cubic_path((x0, y0), (x1, y1), (xn, yn))
-                )
+                (
+                    (x0, y0),
+                    (x1, y1),
+                    (x2, y2),
+                    (xn, yn),
+                ) = convert_quadratic_to_cubic_path((x0, y0), (x1, y1), (xn, yn))
                 path.curveTo(x1, y1, x2, y2, xn, yn)
             elif op == "T":
                 if last_quadratic_cp is not None:
@@ -1238,9 +1244,12 @@ def convertPath(self, node):
                 xi, yi = x0 + (x0 - xp), y0 + (y0 - yp)
                 last_quadratic_cp = (xi, yi)
                 xn, yn = nums
-                (x0, y0), (x1, y1), (x2, y2), (xn, yn) = (
-                    convert_quadratic_to_cubic_path((x0, y0), (xi, yi), (xn, yn))
-                )
+                (
+                    (x0, y0),
+                    (x1, y1),
+                    (x2, y2),
+                    (xn, yn),
+                ) = convert_quadratic_to_cubic_path((x0, y0), (xi, yi), (xn, yn))
                 path.curveTo(x1, y1, x2, y2, xn, yn)
 
             # quadratic bezier, relative
@@ -1249,9 +1258,12 @@ def convertPath(self, node):
                 x1, y1, xn, yn = nums
                 x1, y1, xn, yn = x0 + x1, y0 + y1, x0 + xn, y0 + yn
                 last_quadratic_cp = (x1, y1)
-                (x0, y0), (x1, y1), (x2, y2), (xn, yn) = (
-                    convert_quadratic_to_cubic_path((x0, y0), (x1, y1), (xn, yn))
-                )
+                (
+                    (x0, y0),
+                    (x1, y1),
+                    (x2, y2),
+                    (xn, yn),
+                ) = convert_quadratic_to_cubic_path((x0, y0), (x1, y1), (xn, yn))
                 path.curveTo(x1, y1, x2, y2, xn, yn)
             elif op == "t":
                 if last_quadratic_cp is not None:
@@ -1263,9 +1275,12 @@ def convertPath(self, node):
                 xn, yn = x0 + xn, y0 + yn
                 xi, yi = x0 + (x0 - xp), y0 + (y0 - yp)
                 last_quadratic_cp = (xi, yi)
-                (x0, y0), (x1, y1), (x2, y2), (xn, yn) = (
-                    convert_quadratic_to_cubic_path((x0, y0), (xi, yi), (xn, yn))
-                )
+                (
+                    (x0, y0),
+                    (x1, y1),
+                    (x2, y2),
+                    (xn, yn),
+                ) = convert_quadratic_to_cubic_path((x0, y0), (xi, yi), (xn, yn))
                 path.curveTo(x1, y1, x2, y2, xn, yn)
 
             # elliptical arc
@@ -1342,7 +1357,8 @@ def applyTransformOnGroup(self, transform, group):
                 group.scale(*values)
             elif op == "translate":
                 if isinstance(values, (int, float)):
-                    # From the SVG spec: If <ty> is not provided, it is assumed to be zero.
+                    # From the SVG spec: If <ty> is not provided, it is assumed to
+                    # be zero.
                     values = values, 0
                 group.translate(*values)
             elif op == "rotate":
@@ -1441,11 +1457,11 @@ def applyStyleOnShape(self, shape, node, only_explicit=False):
             shape.fillColor.alpha = shape.fillOpacity
         if getattr(shape, "strokeWidth", None) == 0:
             # Quoting from the PDF 1.7 spec:
-            # A line width of 0 denotes the thinnest line that can be rendered at device
-            # resolution: 1 device pixel wide. However, some devices cannot reproduce 1-pixel
-            # lines, and on high-resolution devices, they are nearly invisible. Since the
-            # results of rendering such zero-width lines are device-dependent, their use
-            # is not recommended.
+            # A line width of 0 denotes the thinnest line that can be rendered at
+            # device resolution: 1 device pixel wide. However, some devices cannot
+            # reproduce 1-pixel lines, and on high-resolution devices, they are
+            # nearly invisible. Since the results of rendering such zero-width
+            # lines are device-dependent, their use is not recommended.
             shape.strokeColor = None
 
 
@@ -1584,8 +1600,8 @@ def monkeypatch_reportlab():
     ReportLab always use 'Even-Odd' filling mode for paths, this patch forces
     RL to honor the path fill rule mode (possibly 'Non-Zero Winding') instead.
     """
-    from reportlab.pdfgen.canvas import Canvas
     from reportlab.graphics import shapes
+    from reportlab.pdfgen.canvas import Canvas
 
     original_renderPath = shapes._renderPath