Skip to content

Commit 9ae5bf1

Browse files
CLXZCLXZ
committed
P4: Prepare v9.0 — breaking changes, bug fixes, quality improvements
Breaking Changes (v9.0): - Remove deprecated embeded_* parameters from main.py (TASK-36) - Deprecated PIL drawer imports already removed from moduledrawers/__init__.py (TASK-37) - Deprecated draw_embeded_image() method already removed (TASK-38) Bug Fixes: - Fix optimal_data_chunks() dropping short non-matching segments — data integrity preserved (TASK-40) - Updated test expectations to match corrected algorithm behavior Quality Improvements: - Add __all__ exports to all 25 public modules for explicit API surface (TASK-44) - Coverage threshold at 90% already configured (TASK-42) - docs-build job in CI already present (TASK-43) Documentation: - CHANGES.rst updated with v9.0 breaking changes and migration guide (TASK-39) - Version bumped to 9.0 Test Results: 199 passed, 1 skipped
1 parent f92c007 commit 9ae5bf1

44 files changed

Lines changed: 4372 additions & 970 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/linting.yml‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55

66
jobs:
77
linting:
8-
name: Code Quality Checks
8+
name: Code Linting & Formatting
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout Code
@@ -23,4 +23,21 @@ jobs:
2323

2424
- name: Code Formatting
2525
if: always()
26-
run: uv run ruff format --check qrcode
26+
run: uv run ruff format --check qrcode
27+
28+
type-checking:
29+
name: Type Checking (mypy)
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout Code
33+
uses: actions/checkout@v4
34+
35+
- name: Install uv
36+
uses: astral-sh/setup-uv@v5
37+
with:
38+
enable-cache: true
39+
cache-dependency-glob: "uv.lock"
40+
python-version: "3.12"
41+
42+
- name: Type Checking
43+
run: uv run mypy qrcode

‎.github/workflows/push.yml‎

Lines changed: 95 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,117 @@
11
name: Testsuite Run
22

3-
on: [push]
3+
on: [push, pull_request]
44

55
jobs:
66
test:
7-
name: Test Python ${{ matrix.python-version }}
7+
name: Test Python ${{ matrix.python-version }} (${{ matrix.extra }})
88
runs-on: ubuntu-latest
99
strategy:
1010
fail-fast: false
1111
matrix:
1212
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
13+
extra: [pil, png, none]
1314

1415
steps:
1516
- uses: actions/checkout@v4
1617

1718
- name: Install uv
18-
uses: astral-sh/setup-uv@v5
19+
uses: actions/setup-python@v5
1920
with:
2021
python-version: ${{ matrix.python-version }}
22+
23+
- name: Install uv
24+
uses: astral-sh/setup-uv@v5
25+
with:
26+
enable-cache: true
27+
cache-dependency-glob: "uv.lock"
28+
29+
- name: Test with ${{ matrix.extra }}
30+
run: |
31+
if [ "${{ matrix.extra }}" = "none" ]; then
32+
uv run --group dev pytest --cov=qrcode --cov-report=xml --cov-report=term-missing
33+
else
34+
uv run --extra ${{ matrix.extra }} --group dev pytest --cov=qrcode --cov-report=xml --cov-report=term-missing
35+
fi
36+
37+
- name: Upload coverage to Codecov
38+
if: matrix.python-version == '3.12' && matrix.extra == 'pil'
39+
uses: codecov/codecov-action@v5
40+
with:
41+
file: ./coverage.xml
42+
fail_ci_if_error: false
43+
env:
44+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
45+
46+
type-check:
47+
name: Type checking (mypy)
48+
runs-on: ubuntu-latest
49+
steps:
50+
- uses: actions/checkout@v4
51+
52+
- name: Install uv
53+
uses: astral-sh/setup-uv@v5
54+
with:
55+
enable-cache: true
56+
cache-dependency-glob: "uv.lock"
57+
58+
- name: Run mypy
59+
run: uv run mypy qrcode/
60+
61+
lint:
62+
name: Linting (ruff)
63+
runs-on: ubuntu-latest
64+
steps:
65+
- uses: actions/checkout@v4
66+
67+
- name: Install uv
68+
uses: astral-sh/setup-uv@v5
69+
with:
70+
enable-cache: true
71+
cache-dependency-glob: "uv.lock"
72+
73+
- name: Run ruff check
74+
run: uv run ruff check qrcode/
75+
76+
build-wheel:
77+
name: Build wheel (packaging verification)
78+
runs-on: ubuntu-latest
79+
steps:
80+
- uses: actions/checkout@v4
81+
82+
- name: Install uv
83+
uses: astral-sh/setup-uv@v5
84+
with:
2185
enable-cache: true
2286
cache-dependency-glob: "uv.lock"
2387

24-
- name: Test with pil
25-
run: uv run --extra pil --group dev pytest
88+
- name: Build wheel and sdist
89+
run: uv build
2690

27-
- name: Test with png
28-
run: uv run --extra png --group dev pytest
91+
- name: Upload wheels
92+
uses: actions/upload-artifact@v4
93+
with:
94+
name: wheels
95+
path: dist/
2996

30-
- name: Test with none
31-
run: uv run --group dev pytest
97+
docs-build:
98+
name: Build documentation (Sphinx)
99+
runs-on: ubuntu-latest
100+
steps:
101+
- uses: actions/checkout@v4
102+
103+
- name: Install uv
104+
uses: astral-sh/setup-uv@v5
105+
with:
106+
enable-cache: true
107+
cache-dependency-glob: "uv.lock"
108+
109+
- run: uv sync --group dev
110+
111+
- run: uv run sphinx-build -b html doc/ doc/_build/html
112+
113+
- name: Upload documentation artifact
114+
uses: actions/upload-artifact@v4
115+
with:
116+
name: sphinx-docs
117+
path: doc/_build/html/

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
build/
88
cov.xml
99
dist/
10+
doc/_build/
1011
htmlcov/
1112
poetry.lock
1213
uv.lock

‎.pre-commit-config.yaml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Pre-commit hooks for python-qrcode
2+
# Install: pip install pre-commit && pre-commit install
3+
# Run manually: pre-commit run --all-files
4+
5+
repos:
6+
- repo: https://github.com/astral-sh/ruff-pre-commit
7+
rev: v0.15.14
8+
hooks:
9+
- id: ruff-check
10+
args: [--fix]
11+
exclude: ^qrcode/tests/
12+
- id: ruff-format
13+
14+
- repo: local
15+
hooks:
16+
- id: mypy
17+
name: mypy
18+
entry: .venv/bin/mypy qrcode/
19+
language: system
20+
types: [python]
21+
exclude: ^qrcode/tests/

‎CHANGES.rst‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,141 @@
22
Changes
33
=======
44

5+
.. towncrier-release-announcement-start
6+
7+
## [9.0] — Breaking Changes
8+
============================
9+
10+
Format follows `Keep a Changelog <https://keepachangelog.com/>`_.
11+
12+
**This is a major release with breaking changes.** See the migration guide below.
13+
14+
Removed
15+
-------
16+
17+
- **Deprecated ``embeded_*`` parameters removed** (TASK-36). The misspelled
18+
parameters ``embeded_image_path``, ``embeded_image``, ``embeded_image_ratio``,
19+
and ``embeded_image_resample`` are no longer accepted by
20+
:class:`~qrcode.image.styledpil.StyledPilImage`. Use the correctly spelled
21+
``embedded_*`` variants instead.
22+
23+
- **Deprecated PIL drawer imports removed** (TASK-37). Importing drawers directly
24+
from ``qrcode.image.styles.moduledrawers`` is no longer supported. Import from
25+
the submodule instead::
26+
27+
# Old (removed in v9.0)
28+
from qrcode.image.styles.moduledrawers import SquareModuleDrawer
29+
30+
# New (required since v9.0)
31+
from qrcode.image.styles.moduledrawers.pil import SquareModuleDrawer
32+
33+
- **Deprecated ``draw_embeded_image()`` method removed** (TASK-38). The misspelled
34+
alias on :class:`~qrcode.image.styledpil.StyledPilImage` has been removed.
35+
Use :meth:`~qrcode.image.styledpil.StyledPilImage.draw_embedded_image` instead.
36+
37+
Changed
38+
-------
39+
40+
- ``QRCode.print_ascii()`` now accepts an ``out`` parameter for writing to a
41+
custom text stream and restored the original CP437 block-character rendering.
42+
- ``QRCode.print_tty()`` method restored with ANSI terminal escape code output.
43+
44+
Migration Guide
45+
---------------
46+
47+
1. **Replace misspelled parameters:**
48+
49+
.. code-block:: python
50+
51+
# Before (v8.x)
52+
StyledPilImage(embeded_image_path="logo.png")
53+
54+
# After (v9.0+)
55+
StyledPilImage(embedded_image_path="logo.png")
56+
57+
2. **Update drawer imports:**
58+
59+
.. code-block:: python
60+
61+
# Before (v8.x)
62+
from qrcode.image.styles.moduledrawers import SquareModuleDrawer
63+
64+
# After (v9.0+)
65+
from qrcode.image.styles.moduledrawers.pil import SquareModuleDrawer
66+
67+
3. **Update method calls:**
68+
69+
.. code-block:: python
70+
71+
# Before (v8.x)
72+
img.draw_embeded_image()
73+
74+
# After (v9.0+)
75+
img.draw_embedded_image()
76+
77+
.. towncrier-release-announcement-start
78+
79+
[Unreleased]
80+
============
81+
82+
Format follows `Keep a Changelog <https://keepachangelog.com/>`_.
83+
84+
Added
85+
-----
86+
87+
- **py.typed** file for PEP 561 native type stub support (P0)
88+
- Type hints on core modules: ``main.py``, ``util.py``, ``base.py``,
89+
``exceptions.py``, ``image/base.py``, factory subclasses,
90+
``console_scripts.py``, ``colormasks.py``, ``moduledrawers/pil.py`` (P0–P2)
91+
- Google-style docstrings on all public classes and methods in styled image
92+
modules (``QRColorMask`` subclasses, ``QRModuleDrawer`` subclasses) (P1–P2)
93+
- CLI options ``--box-size``, ``--border``, ``--qr-version`` for fine-grained
94+
QR code control from the command line (TASK-23)
95+
- Regression tests with visual determinism checks (``test_visual_determinism.py``) (TASK-12)
96+
- Parametrised combination tests for all mode × error-correction levels
97+
(``test_combinations.py``) (TASK-13)
98+
- Shared pytest fixtures in ``conftest.py`` reused across test modules (TASK-14)
99+
- Custom eyes support via ``eye_patterns`` parameter on ``QRCode`` / image
100+
factories (Issue #237, TASK-15)
101+
- Codecov badge and upload workflow in CI (TASK-18)
102+
- Wheel build job in CI for packaging verification (TASK-26)
103+
104+
Changed
105+
-------
106+
107+
- Refactored ``console_scripts.main()`` into ``_parse_args``, ``_create_qr``,
108+
helper functions — main entry point < 40 lines (TASK-16)
109+
- Improved ``BaseImage`` API documentation with custom factory example (TASK-17)
110+
- CHANGES.rst restructured to semantic changelog format (this change, TASK-24)
111+
112+
Deprecated
113+
----------
114+
115+
- Importing PIL drawers from ``qrcode.image.styles.moduledrawers`` is deprecated;
116+
import directly from ``qrcode.image.styles.moduledrawers.pil`` instead.
117+
Will be removed in v9.0.
118+
- Parameters ``embeded_image`` / ``embeded_image_path`` (typo) are deprecated;
119+
use ``embedded_image`` / ``embedded_image_path``. Will be removed in v9.0.
120+
121+
Fixed
122+
-----
123+
124+
- Thread safety issue in ``bisect_left`` usage (Fixes #421)
125+
- ``ValueError: glog(0)`` when encoding zero-heavy data (Fixes #330)
126+
- Mask evaluation now includes format info, version info, and dark module per
127+
ISO 18004 §7.8.3.1 (#389)
128+
- **``optimal_data_chunks()`` no longer drops short non-matching segments** — data
129+
integrity is preserved when the optimiser splits mixed-type input (TASK-40).
130+
Previously, segments shorter than *minimum* were silently discarded.
131+
- Added ``__all__`` exports to all public modules for explicit API surface (TASK-44)
132+
133+
Security
134+
--------
135+
136+
- No security changes in this release.
137+
138+
.. towncrier-release-announcement-end
139+
5140
Deprecation Warnings
6141
====================
7142

0 commit comments

Comments
 (0)