3 Commits
Author SHA1 Message Date
Djeex f96ce2f8c9 Update dependency pytest to v9 (#35)
CI / build-and-scan (push) Successful in 49s
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [pytest](https://github.com/pytest-dev/pytest) ([changelog](https://docs.pytest.org/en/stable/changelog.html)) | major | `==8.4.2` -> `==9.1.1` |

---

### Release Notes

<details>
<summary>pytest-dev/pytest (pytest)</summary>

### [`v9.1.1`](https://github.com/pytest-dev/pytest/releases/tag/9.1.1)

[Compare Source](https://github.com/pytest-dev/pytest/compare/9.1.0...9.1.1)

### pytest 9.1.1 (2026-06-19)

#### Bug fixes

-   [#&#8203;14220](https://github.com/pytest-dev/pytest/issues/14220): Fixed a logic bug in `pytest.RaisesGroup` which would might cause it to display incorrect "It matches <span class="title-ref">FooError()</span> which was paired with <span class="title-ref">BarError</span>" messages.
-   [#&#8203;14591](https://github.com/pytest-dev/pytest/issues/14591): Fixed a regression in pytest 9.1.0 which caused overriding a parametrized fixture with an indirect <span class="title-ref">[@&#8203;pytest](https://github.com/pytest).mark.parametrize</span> to fail with "duplicate parametrization of '\<fixture name>'".
-   [#&#8203;14606](https://github.com/pytest-dev/pytest/issues/14606): Fixed `list-item` typing errors from mypy in `@pytest.mark.parametrize <pytest.mark.parametrize ref>` `argvalues` parameter.
-   [#&#8203;14608](https://github.com/pytest-dev/pytest/issues/14608): Fixed a regression in pytest 9.1.0 where `conftest.py` files located in `<invocation dir>/test*` were no longer loaded as initial conftests when invoked without arguments.
    This could cause certain hooks (like `pytest_addoption`) in these files to not fire.

### [`v9.1.0`](https://github.com/pytest-dev/pytest/releases/tag/9.1.0)

[Compare Source](https://github.com/pytest-dev/pytest/compare/9.0.3...9.1.0)

### pytest 9.1.0 (2026-06-13)

#### Removals and backward incompatible breaking changes

-   [#&#8203;14533](https://github.com/pytest-dev/pytest/issues/14533): When using `--doctest-modules`, autouse fixtures with `module`, `package` or `session` scope that are defined inline in Python test modules (not plugins or conftests) will now possibly execute twice.

    If this is undesirable, move the fixture definition to a `conftest.py` file if possible.

    Technical explanation for those interested:
    When using <span class="title-ref">--doctest-modules</span>, pytest possibly collects Python modules twice, once as `pytest.Module` and once as a `DoctestModule` (depending on the configuration).
    Due to improvements in pytest's fixture implementation, if e.g. the `DoctestModule` collects a fixture, it is now visible to it only, and not to the `Module`.
    This means that both need to register the fixtures independently.

#### Deprecations (removal in next major release)

-   [#&#8203;10819](https://github.com/pytest-dev/pytest/issues/10819): Added a deprecation warning for class-scoped fixtures defined as instance methods (without `@classmethod`). Such fixtures set attributes on a different instance than the test methods use, leading to unexpected behavior. Use `@classmethod` decorator instead -- by `yastcher`.

    See `10819` and `14011`.

-   [#&#8203;12882](https://github.com/pytest-dev/pytest/issues/12882): Calling `request.getfixturevalue() <pytest.FixtureRequest.getfixturevalue>` during teardown to request a fixture that was not already requested is now deprecated and will become an error in pytest 10.

    See `dynamic-fixture-request-during-teardown` for details.

-   [#&#8203;13409](https://github.com/pytest-dev/pytest/issues/13409): Using non-`~collections.abc.Collection` iterables (such as generators, iterators, or custom iterable objects) for the `argvalues` parameter in `@pytest.mark.parametrize <pytest.mark.parametrize ref>` and `metafunc.parametrize <pytest.Metafunc.parametrize>` is now deprecated.

    These iterables get exhausted after the first iteration,
    leading to tests getting unexpectedly skipped in cases such as running `pytest.main()` multiple times,
    using class-level parametrize decorators,
    or collecting tests multiple times.

    See `parametrize-iterators` for details and suggestions.

-   [#&#8203;13946](https://github.com/pytest-dev/pytest/issues/13946): The private `config.inicfg` attribute is now deprecated.
    Use `config.getini() <pytest.Config.getini>` to access configuration values instead.

    See `config-inicfg` for more details.

-   [#&#8203;14004](https://github.com/pytest-dev/pytest/issues/14004): Passing `baseid` to `~pytest.FixtureDef` or `nodeid` strings to fixture registration APIs is now deprecated. These are internal pytest APIs that are used by some plugins.

    Use the `node` parameter instead for fixture scoping. This enables more robust node-based
    matching instead of string prefix matching.
    If you've used `nodeid=None`, pass `node=session` instead.

    This will be removed in pytest 10.

-   [#&#8203;14335](https://github.com/pytest-dev/pytest/issues/14335): The method of configuring hooks using markers, deprecated since pytest 7.2, is now scheduled to be removed in pytest 10.
    See `hook-markers` for more details.

-   [#&#8203;14434](https://github.com/pytest-dev/pytest/issues/14434): The `--pastebin` option is now deprecated.
    The same functionality is now available in an external plugin, `pytest-pastebin`.
    See `pastebin-deprecated` for more details.

-   [#&#8203;14513](https://github.com/pytest-dev/pytest/issues/14513): The private `FixtureDef.has_location` attribute is now deprecated and will be removed in pytest 10.
    See `fixturedef-has-location-deprecated` for details.

-   [#&#8203;1764](https://github.com/pytest-dev/pytest/issues/1764): `pytest.console_main` is now deprecated and will be removed in pytest 10.
    It was never intended for programmatic use; use `pytest.main` instead.

#### New features

-   [#&#8203;12376](https://github.com/pytest-dev/pytest/issues/12376): Added `pytest.register_fixture()` to register fixtures using an imperative interface.

    This is an advanced function intended for use by plugins.

    Normally, fixtures should be registered declaratively using the `@pytest.fixture <pytest.fixture>` decorator.
    Pytest looks for these fixture definitions during the collection phase and registers them automatically.
    For some plugin usecases the declarative interface can be cumbersome or unviable, in which case this imperative interface can be used.

-   [#&#8203;14023](https://github.com/pytest-dev/pytest/issues/14023): Added <span class="title-ref">--report-chars</span> long CLI option.

-   [#&#8203;14371](https://github.com/pytest-dev/pytest/issues/14371): Added `--max-warnings` command-line option and `max_warnings` configuration option to fail the test run when the number of warnings exceeds a given threshold -- by `miketheman`.

-   [#&#8203;6757](https://github.com/pytest-dev/pytest/issues/6757): Added the `assertion_text_diff_style` configuration option, allowing
    string equality failures to be rendered as separate `Left:` and `Right:`
    blocks instead of `ndiff` output.

-   [#&#8203;8395](https://github.com/pytest-dev/pytest/issues/8395): Added support for `~datetime.datetime` and `~datetime.timedelta` comparisons with `pytest.approx`. An explicit `abs` or `rel` tolerance as a `~datetime.timedelta` is required and relative tolerance is not supported for datetime comparisons -- by `hamza-mobeen`.

#### Improvements in existing functionality

-   [#&#8203;11225](https://github.com/pytest-dev/pytest/issues/11225): `pytest.warns` now shows "Regex pattern did not match" instead of "DID NOT WARN" when warnings were emitted but the `match` pattern did not match.

-   [#&#8203;11295](https://github.com/pytest-dev/pytest/issues/11295): Improved output of `--fixtures-per-test` by excluding internal-implementation fixtures generated by `@pytest.mark.parametrize` and similar.

-   [#&#8203;13241](https://github.com/pytest-dev/pytest/issues/13241): `pytest.raises`, `pytest.warns` and `pytest.deprecated_call` now uses `ParamSpec` for the type hint to the (old and not recommended) callable overload, instead of `Any`. This allows type checkers to raise errors when passing incorrect function parameters.
    `func` can now also be passed as a kwarg, which the type hint previously showed as possible but didn't accept.

-   [#&#8203;13862](https://github.com/pytest-dev/pytest/issues/13862): Improved the readability of "DID NOT RAISE" error messages by using the exception type's name instead of its <span class="title-ref">repr</span>.

-   [#&#8203;14026](https://github.com/pytest-dev/pytest/issues/14026): Added test coverage for compiled regex patterns in `pytest.raises` match parameter.

-   [#&#8203;14137](https://github.com/pytest-dev/pytest/issues/14137): <span class="title-ref">pytest.ScopeName</span> is now public to allow using it in function signatures.

-   [#&#8203;14342](https://github.com/pytest-dev/pytest/issues/14342): Marked `yield_fixture` as deprecated to type checkers using the `deprecated` decorator. Note it
    `has originally been deprecated <yield-fixture-deprecated>` in pytest 6.2 already.

-   [#&#8203;14373](https://github.com/pytest-dev/pytest/issues/14373): Added type annotations for `pytest.approx`.

-   [#&#8203;14430](https://github.com/pytest-dev/pytest/issues/14430): When using `--setup-show`, a space is now printed after the test name (and possibly used fixtures), to separate it from the test result.

-   [#&#8203;14441](https://github.com/pytest-dev/pytest/issues/14441): Reduced the default number of `gc.collect()` passes in the `unraisableexception` plugin from 5 to 1 on CPython, where reference counting makes a single pass sufficient. PyPy retains 5 passes due to object resurrection via `__del__`. This can noticeably speed up test suites that trigger many pytester runs.

-   [#&#8203;14461](https://github.com/pytest-dev/pytest/issues/14461): Improved assertion failure explanations for equality comparisons between mapping objects that are not `dict` instances.

-   [#&#8203;14513](https://github.com/pytest-dev/pytest/issues/14513): The order in which fixture definitions overriding each other are resolved is now determined first by their *visibility* in the collection tree rather than by the order in which they are registered.

    A fixture defined for a more specific node (e.g. a module or an item) now always takes precedence over one with the same name defined for a more general node (e.g. the session), even when the more general one was registered later.
    Fixtures with non-comparable visibility or the same visibility keep the existing behavior of "last registered wins".
    This change is supposed to only affect plugins which register multiple fixtures programmatically with the same name.

-   [#&#8203;14524](https://github.com/pytest-dev/pytest/issues/14524): Add official Python 3.15 support.

-   [#&#8203;1764](https://github.com/pytest-dev/pytest/issues/1764): Improved argparse program name to show `pytest`, `python -m pytest`, or `pytest.main()` based on how pytest was invoked, making help and error messages clearer.

-   [#&#8203;8265](https://github.com/pytest-dev/pytest/issues/8265): Emit a `PytestCollectionWarning` when a module-level `__getattr__` returns `None` for `pytestmark` instead of raising `AttributeError`.

    Previously this caused a cryptic `TypeError: got None instead of Mark` error.
    Now pytest issues a helpful warning and continues collecting the module normally.

#### Bug fixes

-   [#&#8203;13192](https://github.com/pytest-dev/pytest/issues/13192): Fixed <span class="title-ref">|</span> (pipe) not being treated as a regex meta-character that needs escaping in `pytest.raises(match=...) <pytest.raises>`.

-   [#&#8203;13484](https://github.com/pytest-dev/pytest/issues/13484): Fixed `-W` option values being duplicated in `Config.known_args_namespace`.

-   [#&#8203;13626](https://github.com/pytest-dev/pytest/issues/13626): Fixed function-scoped fixture values being kept alive after a test was interrupted by `KeyboardInterrupt` or early exit,
    allowing them to potentially be released more promptly.

-   [#&#8203;13784](https://github.com/pytest-dev/pytest/issues/13784): Fixed `capteesys` producing doubled output when used with `--capture=no` (`-s`).

-   [#&#8203;13817](https://github.com/pytest-dev/pytest/issues/13817): Fixed a secondary <span class="title-ref">AttributeError</span> masking the original error when an option argument fails to initialize.

-   [#&#8203;13884](https://github.com/pytest-dev/pytest/issues/13884): Fixed rare internal IndexError caused by <span class="title-ref">builtins.compile</span> being overridden in client code.

-   [#&#8203;13885](https://github.com/pytest-dev/pytest/issues/13885): Fixed autouse fixtures defined inside a `unittest.TestCase` class running even when the class is decorated with `unittest.skip` or `unittest.skipIf` -- regression since pytest 8.1.0.

-   [#&#8203;13917](https://github.com/pytest-dev/pytest/issues/13917): `unittest.SkipTest` is no longer considered an interactive exception, i.e. `pytest_exception_interact` is no longer called for it.

-   [#&#8203;13963](https://github.com/pytest-dev/pytest/issues/13963): Fixed subtests running with `pytest-xdist` when their contexts contain objects that are not JSON-serializable.

    Fixes [pytest-dev/pytest-xdist#1273](https://github.com/pytest-dev/pytest-xdist/issues/1273).

-   [#&#8203;14004](https://github.com/pytest-dev/pytest/issues/14004): Fixed conftest.py fixture scoping when `testpaths` points outside of the `rootdir <rootdir>`.

    Previously, fixtures from nested conftest.py files would incorrectly leak to sibling directories
    when using a relative `testpaths` like `../tests/sdk`.

    Conftest fixtures are now parsed during `Directory <pytest.Directory>` collection, using the `Directory` node for proper scoping.

-   [#&#8203;14050](https://github.com/pytest-dev/pytest/issues/14050): Display dictionary differences in assertion failures using the original key insertion order instead of sorted order.

-   [#&#8203;14080](https://github.com/pytest-dev/pytest/issues/14080): fix missing type annotations on `Pytester.makepyfile` and `Pytester.maketxtfile` methods.

-   [#&#8203;14114](https://github.com/pytest-dev/pytest/issues/14114): An exception from `pytest_fixture_post_finalizer` no longer prevents fixtures from being torn down, causing additional errors in the following tests.

-   [#&#8203;14161](https://github.com/pytest-dev/pytest/issues/14161): Fixed `monkeypatch.setattr() <pytest.MonkeyPatch.setattr>` leaving a stale entry on the undo stack when the underlying `setattr()` call fails (e.g. on immutable targets), causing an `AttributeError` crash during teardown.

-   [#&#8203;14214](https://github.com/pytest-dev/pytest/issues/14214): Fixed `-v` hint in `pytest.raises` match diff not working because assertion verbosity was not propagated.

-   [#&#8203;14234](https://github.com/pytest-dev/pytest/issues/14234): Allow `pytest.HIDDEN_PARAM <hidden-param>` in `@pytest.mark.parametrize(ids=...) <pytest.mark.parametrize ref>` typing.

-   [#&#8203;14248](https://github.com/pytest-dev/pytest/issues/14248): Fixed direct parametrization causing the static fixture closure (as reflected in `request.fixturenames <pytest.FixtureRequest.fixturenames>`) to omit fixtures that are requested transitively from overridden fixtures.

-   [#&#8203;14263](https://github.com/pytest-dev/pytest/issues/14263): Unraisable exceptions from finalizers are now collected during `pytest_unconfigure`, before pytest tears down the warning filters installed for the session. Previously the collection ran from a cleanup callback whose order relative to other plugins' cleanups was not guaranteed, so an active `error` filter could be removed before the exception surfaced and a late resource leak would pass silently. A `-W error` filter, or any filter matching `pytest.PytestUnraisableExceptionWarning`, now promotes these exceptions to failures regardless of plugin cleanup order.

-   [#&#8203;14377](https://github.com/pytest-dev/pytest/issues/14377): Fixed crash in <span class="title-ref">Config.get_terminal_writer</span> when an assertion fails with the `terminalreporter` plugin disabled.

-   [#&#8203;14381](https://github.com/pytest-dev/pytest/issues/14381): Fixed `-V` (short form of `--version`) to properly display the current version.

-   [#&#8203;14389](https://github.com/pytest-dev/pytest/issues/14389): Improved `pytest.raises(..., match=...) <pytest.raises>` failures to suppress the mismatched exception as a cause of the resulting `AssertionError`.

-   [#&#8203;14392](https://github.com/pytest-dev/pytest/issues/14392): Fixed a bug in `pytest.raises(match=...) <pytest.raises>` "fully escaped" detection, causing the regex diff display to be shown in some instances when the raw string diff display should be shown instead.

-   [#&#8203;14442](https://github.com/pytest-dev/pytest/issues/14442): Fixed a regression in pytest 9.0 where `--strict-markers` and `--strict-config` specified through `addopts` were silently ignored.

    Note that when targeting pytest >= 9.0, it's nicer to use `strict_markers` and `strict_config`, or `strict mode <strict mode>`.

-   [#&#8203;14456](https://github.com/pytest-dev/pytest/issues/14456): Fixed `pytest.approx` not recognizing types with `__array_interface__` as numpy-like arrays.

-   [#&#8203;14474](https://github.com/pytest-dev/pytest/issues/14474): Fixed a regression where `-k` and `-m` expressions containing both backslash characters in identifiers and string literal arguments would incorrectly raise a `SyntaxError` about escaping.

-   [#&#8203;14483](https://github.com/pytest-dev/pytest/issues/14483): Fixed JUnit XML report incorrectly escaping high Unicode codepoints (supplementary plane characters like emoji) in test failure messages. -- by `EternalRights`

-   [#&#8203;14492](https://github.com/pytest-dev/pytest/issues/14492): Fixed `Code.getargs()` incorrectly including local variable names in the returned argument tuple for functions with `*args` and/or `**kwargs`. The method was using `co_flags` bitmask values (`4` and `8`) directly as counts instead of converting them to `1` via `bool()`, and was not accounting for `co_kwonlyargcount` when `var=True`.

-   [#&#8203;3697](https://github.com/pytest-dev/pytest/issues/3697): Logging capture now works for non-propagating loggers.
    Previously only logs which reached the root logger were captured.
    This includes `caplog` and the "Captured log calls" test reporting.

-   [#&#8203;3850](https://github.com/pytest-dev/pytest/issues/3850): Fixed JUnit XML report: the `tests` attribute of the `<testsuite>` element now always matches the number of `<testcase>` elements in the file. In some cases (test passes but fails during teardown) the `tests` attribute would report an incorrect number of testcases in the XML file.

-   [#&#8203;5848](https://github.com/pytest-dev/pytest/issues/5848): `pytest_fixture_post_finalizer` is no longer called extra times for the same fixture teardown in some cases.

-   [#&#8203;719](https://github.com/pytest-dev/pytest/issues/719): Fixed `@pytest.mark.parametrize <pytest.mark.parametrize ref>` not unpacking single-element tuple values when using a string argnames with a trailing comma (e.g., `"arg,"`).

    The trailing comma form now correctly behaves like the tuple form `("arg",)`, treating argvalues as a list of tuples to unpack.

#### Improved documentation

-   [#&#8203;11022](https://github.com/pytest-dev/pytest/issues/11022): Document safer alternatives and scope guidance for monkeypatching standard library functions.
-   [#&#8203;11307](https://github.com/pytest-dev/pytest/issues/11307): Document that `@pytest.hookimpl(specname=...)` only works for function names starting with `pytest_`.
-   [#&#8203;13038](https://github.com/pytest-dev/pytest/issues/13038): Document that doctests do not support parametrized fixtures, including parametrized autouse fixtures.
-   [#&#8203;13155](https://github.com/pytest-dev/pytest/issues/13155): Clarified how the `request` fixture provides indirect parametrization values via `request.param`.
-   [#&#8203;13304](https://github.com/pytest-dev/pytest/issues/13304): Clarified in the documentation that hook implementations defined in `conftest.py` files are not available to other plugins during their `pytest_addoption()` execution, as conftest files are discovered and loaded after builtin and third-party plugins have been initialized. However, initial conftest files themselves can implement `pytest_addoption()` to add their own command-line options.
-   [#&#8203;13902](https://github.com/pytest-dev/pytest/issues/13902): Clarified how subtest progress markers are shown in the documentation.
-   [#&#8203;14012](https://github.com/pytest-dev/pytest/issues/14012): The `ini options ref` section of the API Reference now specified the type and default value of every configuration option.
-   [#&#8203;14148](https://github.com/pytest-dev/pytest/issues/14148): Documented a safe `pytestconfig.cache` access pattern when the
    `cacheprovider` plugin is disabled.
-   [#&#8203;14303](https://github.com/pytest-dev/pytest/issues/14303): The documentation is now built with Sphinx >= 9.
-   [#&#8203;14465](https://github.com/pytest-dev/pytest/issues/14465): Updated the hooks how-to page to link the `newhooks.py` file in `pytest-xdist` at tag `v3.8.0` instead of an unrelated 2017-era commit under the old layout. Pointing at a tag keeps the example in sync with the version users actually install, while remaining stable when the project's main branch moves on.

#### Miscellaneous internal changes

-   [#&#8203;14582](https://github.com/pytest-dev/pytest/issues/14582): Improved the recursion traceback test to exercise all requested traceback styles.

### [`v9.0.3`](https://github.com/pytest-dev/pytest/releases/tag/9.0.3)

[Compare Source](https://github.com/pytest-dev/pytest/compare/9.0.2...9.0.3)

### pytest 9.0.3 (2026-04-07)

#### Bug fixes

-   [#&#8203;12444](https://github.com/pytest-dev/pytest/issues/12444): Fixed `pytest.approx` which now correctly takes into account `~collections.abc.Mapping` keys order to compare them.

-   [#&#8203;13634](https://github.com/pytest-dev/pytest/issues/13634): Blocking a `conftest.py` file using the `-p no:` option is now explicitly disallowed.

    Previously this resulted in an internal assertion failure during plugin loading.

    Pytest now raises a clear `UsageError` explaining that conftest files are not plugins and cannot be disabled via `-p`.

-   [#&#8203;13734](https://github.com/pytest-dev/pytest/issues/13734): Fixed crash when a test raises an exceptiongroup with `__tracebackhide__ = True`.

-   [#&#8203;14195](https://github.com/pytest-dev/pytest/issues/14195): Fixed an issue where non-string messages passed to <span class="title-ref">unittest.TestCase.subTest()</span> were not printed.

-   [#&#8203;14343](https://github.com/pytest-dev/pytest/issues/14343): Fixed use of insecure temporary directory (CVE-2025-71176).

#### Improved documentation

-   [#&#8203;13388](https://github.com/pytest-dev/pytest/issues/13388): Clarified documentation for `-p` vs `PYTEST_PLUGINS` plugin loading and fixed an incorrect `-p` example.
-   [#&#8203;13731](https://github.com/pytest-dev/pytest/issues/13731): Clarified that capture fixtures (e.g. `capsys` and `capfd`) take precedence over the `-s` / `--capture=no` command-line options in `Accessing captured output from a test function <accessing-captured-output>`.
-   [#&#8203;14088](https://github.com/pytest-dev/pytest/issues/14088): Clarified that the default `pytest_collection` hook sets `session.items` before it calls `pytest_collection_finish`, not after.
-   [#&#8203;14255](https://github.com/pytest-dev/pytest/issues/14255): TOML integer log levels must be quoted: Updating reference documentation.

#### Contributor-facing changes

-   [#&#8203;12689](https://github.com/pytest-dev/pytest/issues/12689): The test reports are now published to Codecov from GitHub Actions.
    The test statistics is visible [on the web interface](https://app.codecov.io/gh/pytest-dev/pytest/tests).

    \-- by `aleguy02`

### [`v9.0.2`](https://github.com/pytest-dev/pytest/releases/tag/9.0.2)

[Compare Source](https://github.com/pytest-dev/pytest/compare/9.0.1...9.0.2)

### pytest 9.0.2 (2025-12-06)

#### Bug fixes

-   [#&#8203;13896](https://github.com/pytest-dev/pytest/issues/13896): The terminal progress feature added in pytest 9.0.0 has been disabled by default, except on Windows, due to compatibility issues with some terminal emulators.

    You may enable it again by passing `-p terminalprogress`. We may enable it by default again once compatibility improves in the future.

    Additionally, when the environment variable `TERM` is `dumb`, the escape codes are no longer emitted, even if the plugin is enabled.

-   [#&#8203;13904](https://github.com/pytest-dev/pytest/issues/13904): Fixed the TOML type of the `tmp_path_retention_count` settings in the API reference from number to string.

-   [#&#8203;13946](https://github.com/pytest-dev/pytest/issues/13946): The private `config.inicfg` attribute was changed in a breaking manner in pytest 9.0.0.
    Due to its usage in the ecosystem, it is now restored to working order using a compatibility shim.
    It will be deprecated in pytest 9.1 and removed in pytest 10.

-   [#&#8203;13965](https://github.com/pytest-dev/pytest/issues/13965): Fixed quadratic-time behavior when handling `unittest` subtests in Python 3.10.

#### Improved documentation

-   [#&#8203;4492](https://github.com/pytest-dev/pytest/issues/4492): The API Reference now contains cross-reference-able documentation of `pytest's command-line flags <command-line-flags>`.

### [`v9.0.1`](https://github.com/pytest-dev/pytest/releases/tag/9.0.1)

[Compare Source](https://github.com/pytest-dev/pytest/compare/9.0.0...9.0.1)

### pytest 9.0.1 (2025-11-12)

#### Bug fixes

-   [#&#8203;13895](https://github.com/pytest-dev/pytest/issues/13895): Restore support for skipping tests via `raise unittest.SkipTest`.
-   [#&#8203;13896](https://github.com/pytest-dev/pytest/issues/13896): The terminal progress plugin added in pytest 9.0 is now automatically disabled when iTerm2 is detected, it generated desktop notifications instead of the desired functionality.
-   [#&#8203;13904](https://github.com/pytest-dev/pytest/issues/13904): Fixed the TOML type of the verbosity settings in the API reference from number to string.
-   [#&#8203;13910](https://github.com/pytest-dev/pytest/issues/13910): Fixed <span class="title-ref">UserWarning: Do not expect file_or_dir</span> on some earlier Python 3.12 and 3.13 point versions.

#### Packaging updates and notes for downstreams

-   [#&#8203;13933](https://github.com/pytest-dev/pytest/issues/13933): The tox configuration has been adjusted to make sure the desired
    version string can be passed into its `package_env` through
    the `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST` environment
    variable as a part of the release process -- by `webknjaz`.

#### Contributor-facing changes

-   [#&#8203;13891](https://github.com/pytest-dev/pytest/issues/13891), [#&#8203;13942](https://github.com/pytest-dev/pytest/issues/13942): The CI/CD part of the release automation is now capable of
    creating GitHub Releases without having a Git checkout on
    disk -- by `bluetech` and `webknjaz`.
-   [#&#8203;13933](https://github.com/pytest-dev/pytest/issues/13933): The tox configuration has been adjusted to make sure the desired
    version string can be passed into its `package_env` through
    the `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST` environment
    variable as a part of the release process -- by `webknjaz`.

### [`v9.0.0`](https://github.com/pytest-dev/pytest/releases/tag/9.0.0)

[Compare Source](https://github.com/pytest-dev/pytest/compare/8.4.2...9.0.0)

### pytest 9.0.0 (2025-11-05)

#### New features

-   [#&#8203;1367](https://github.com/pytest-dev/pytest/issues/1367): **Support for subtests** has been added.

    `subtests <subtests>` are an alternative to parametrization, useful in situations where the parametrization values are not all known at collection time.

    Example:

    ```python
    def contains_docstring(p: Path) -> bool:
        """Return True if the given Python file contains a top-level docstring."""
        ...

    def test_py_files_contain_docstring(subtests: pytest.Subtests) -> None:
        for path in Path.cwd().glob("*.py"):
            with subtests.test(path=str(path)):
                assert contains_docstring(path)
    ```

    Each assert failure or error is caught by the context manager and reported individually, giving a clear picture of all files that are missing a docstring.

    In addition, `unittest.TestCase.subTest` is now also supported.

    This feature was originally implemented as a separate plugin in [pytest-subtests](https://github.com/pytest-dev/pytest-subtests), but since then has been merged into the core.

    > \[!NOTE]
    > This feature is experimental and will likely evolve in future releases. By that we mean that we might change how subtests are reported on failure, but the functionality and how to use it are stable.

-   [#&#8203;13743](https://github.com/pytest-dev/pytest/issues/13743): Added support for **native TOML configuration files**.

    While pytest, since version 6, supports configuration in `pyproject.toml` files under `[tool.pytest.ini_options]`,
    it does so in an "INI compatibility mode", where all configuration values are treated as strings or list of strings.
    Now, pytest supports the native TOML data model.

    In `pyproject.toml`, the native TOML configuration is under the `[tool.pytest]` table.

    ```toml
    ```

### pyproject.toml

\[tool.pytest]
minversion = "9.0"
addopts = \["-ra", "-q"]
testpaths = \[
"tests",
"integration",
]

````

The `[tool.pytest.ini_options]` table remains supported, but both tables cannot be used at the same time.

If you prefer to use a separate configuration file, or don't use `pyproject.toml`, you can use `pytest.toml` or `.pytest.toml`:

``` toml

### pytest.toml or .pytest.toml
[pytest]
minversion = "9.0"
addopts = ["-ra", "-q"]
testpaths = [
    "tests",
    "integration",
]
````

The documentation now (sometimes) shows configuration snippets in both TOML and INI formats, in a tabbed interface.

See `config file formats` for full details.

-   [#&#8203;13823](https://github.com/pytest-dev/pytest/issues/13823): Added a **"strict mode"** enabled by the `strict` configuration option.

    When set to `true`, the `strict` option currently enables

    -   `strict_config`
    -   `strict_markers`
    -   `strict_parametrization_ids`
    -   `strict_xfail`

    The individual strictness options can be explicitly set to override the global `strict` setting.

    The previously-deprecated `--strict` command-line flag now enables strict mode.

    If pytest adds new strictness options in the future, they will also be enabled in strict mode.
    Therefore, you should only enable strict mode if you use a pinned/locked version of pytest,
    or if you want to proactively adopt new strictness options as they are added.

    See `strict mode` for more details.

-   [#&#8203;13737](https://github.com/pytest-dev/pytest/issues/13737): Added the `strict_parametrization_ids` configuration option.

    When set, pytest emits an error if it detects non-unique parameter set IDs,
    rather than automatically making the IDs unique by adding <span class="title-ref">0</span>, <span class="title-ref">1</span>, ... to them.
    This can be particularly useful for catching unintended duplicates.

-   [#&#8203;13072](https://github.com/pytest-dev/pytest/issues/13072): Added support for displaying test session **progress in the terminal tab** using the [OSC 9;4;](https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC) ANSI sequence.
    When pytest runs in a supported terminal emulator like ConEmu, Gnome Terminal, Ptyxis, Windows Terminal, Kitty or Ghostty,
    you'll see the progress in the terminal tab or window,
    allowing you to monitor pytest's progress at a glance.

    This feature is automatically enabled when running in a TTY. It is implemented as an internal plugin. If needed, it can be disabled as follows:

    -   On a user level, using `-p no:terminalprogress` on the command line or via an environment variable `PYTEST_ADDOPTS='-p no:terminalprogress'`.
    -   On a project configuration level, using `addopts = "-p no:terminalprogress"`.

-   [#&#8203;478](https://github.com/pytest-dev/pytest/issues/478): Support PEP420 (implicit namespace packages) as <span class="title-ref">--pyargs</span> target when `consider_namespace_packages` is <span class="title-ref">true</span> in the config.

    Previously, this option only impacted package imports, now it also impacts tests discovery.

-   [#&#8203;13678](https://github.com/pytest-dev/pytest/issues/13678): Added a new `faulthandler_exit_on_timeout` configuration option set to "false" by default to let <span class="title-ref">faulthandler</span> interrupt the <span class="title-ref">pytest</span> process after a timeout in case of deadlock.

    Previously, a <span class="title-ref">faulthandler</span> timeout would only dump the traceback of all threads to stderr, but would not interrupt the <span class="title-ref">pytest</span> process.

    \-- by `ogrisel`.

-   [#&#8203;13829](https://github.com/pytest-dev/pytest/issues/13829): Added support for configuration option aliases via the `aliases` parameter in `Parser.addini() <pytest.Parser.addini>`.

    Plugins can now register alternative names for configuration options,
    allowing for more flexibility in configuration naming and supporting backward compatibility when renaming options.
    The canonical name always takes precedence if both the canonical name and an alias are specified in the configuration file.

#### Improvements in existing functionality

-   [#&#8203;13330](https://github.com/pytest-dev/pytest/issues/13330): Having pytest configuration spread over more than one file (for example having both a `pytest.ini` file and `pyproject.toml` with a `[tool.pytest.ini_options]` table) will now print a warning to make it clearer to the user that only one of them is actually used.

    \-- by `sgaist`

-   [#&#8203;13574](https://github.com/pytest-dev/pytest/issues/13574): The single argument `--version` no longer loads the entire plugin infrastructure, making it faster and more reliable when displaying only the pytest version.

    Passing `--version` twice (e.g., `pytest --version --version`) retains the original behavior, showing both the pytest version and plugin information.

    > \[!NOTE]
    > Since `--version` is now processed early, it only takes effect when passed directly via the command line. It will not work if set through other mechanisms, such as `PYTEST_ADDOPTS` or `addopts`.

-   [#&#8203;13823](https://github.com/pytest-dev/pytest/issues/13823): Added `strict_xfail` as an alias to the `xfail_strict` option,
    `strict_config` as an alias to the `--strict-config` flag,
    and `strict_markers` as an alias to the `--strict-markers` flag.
    This makes all strictness options consistently have configuration options with the prefix `strict_`.

-   [#&#8203;13700](https://github.com/pytest-dev/pytest/issues/13700): <span class="title-ref">--junitxml</span> no longer prints the <span class="title-ref">generated xml file</span> summary at the end of the pytest session when <span class="title-ref">--quiet</span> is given.

-   [#&#8203;13732](https://github.com/pytest-dev/pytest/issues/13732): Previously, when filtering warnings, pytest would fail if the filter referenced a class that could not be imported. Now, this only outputs a message indicating the problem.

-   [#&#8203;13859](https://github.com/pytest-dev/pytest/issues/13859): Clarify the error message for <span class="title-ref">pytest.raises()</span> when a regex <span class="title-ref">match</span> fails.

-   [#&#8203;13861](https://github.com/pytest-dev/pytest/issues/13861): Better sentence structure in a test's expected error message. Previously, the error message would be "expected exception must be \<expected>, but got \<actual>". Now, it is "Expected \<expected>, but got \<actual>".

#### Removals and backward incompatible breaking changes

-   [#&#8203;12083](https://github.com/pytest-dev/pytest/issues/12083): Fixed a bug where an invocation such as <span class="title-ref">pytest a/ a/b</span> would cause only tests from <span class="title-ref">a/b</span> to run, and not other tests under <span class="title-ref">a/</span>.

    The fix entails a few breaking changes to how such overlapping arguments and duplicates are handled:

    1.  <span class="title-ref">pytest a/b a/</span> or <span class="title-ref">pytest a/ a/b</span> are equivalent to <span class="title-ref">pytest a</span>; if an argument overlaps another arguments, only the prefix remains.
    2.  <span class="title-ref">pytest x.py x.py</span> is equivalent to <span class="title-ref">pytest x.py</span>; previously such an invocation was taken as an explicit request to run the tests from the file twice.

    If you rely on these behaviors, consider using `--keep-duplicates <duplicate-paths>`, which retains its existing behavior (including the bug).

-   [#&#8203;13719](https://github.com/pytest-dev/pytest/issues/13719): Support for Python 3.9 is dropped following its end of life.

-   [#&#8203;13766](https://github.com/pytest-dev/pytest/issues/13766): Previously, pytest would assume it was running in a CI/CD environment if either of the environment variables <span class="title-ref">$CI</span> or <span class="title-ref">$BUILD_NUMBER</span> was defined;
    now, CI mode is only activated if at least one of those variables is defined and set to a *non-empty* value.

-   [#&#8203;13779](https://github.com/pytest-dev/pytest/issues/13779): **PytestRemovedIn9Warning deprecation warnings are now errors by default.**

    Following our plan to remove deprecated features with as little disruption as
    possible, all warnings of type `PytestRemovedIn9Warning` now generate errors
    instead of warning messages by default.

    **The affected features will be effectively removed in pytest 9.1**, so please consult the
    `deprecations` section in the docs for directions on how to update existing code.

    In the pytest `9.0.X` series, it is possible to change the errors back into warnings as a
    stopgap measure by adding this to your `pytest.ini` file:

    ```ini
    [pytest]
    filterwarnings =
        ignore::pytest.PytestRemovedIn9Warning
    ```

    But this will stop working when pytest `9.1` is released.

    **If you have concerns** about the removal of a specific feature, please add a
    comment to `13779`.

#### Deprecations (removal in next major release)

-   [#&#8203;13807](https://github.com/pytest-dev/pytest/issues/13807): `monkeypatch.syspath_prepend() <pytest.MonkeyPatch.syspath_prepend>` now issues a deprecation warning when the prepended path contains legacy namespace packages (those using `pkg_resources.declare_namespace()`).
    Users should migrate to native namespace packages (`420`).
    See `monkeypatch-fixup-namespace-packages` for details.

#### Bug fixes

-   [#&#8203;13445](https://github.com/pytest-dev/pytest/issues/13445): Made the type annotations of `pytest.skip` and friends more spec-complaint to have them work across more type checkers.

-   [#&#8203;13537](https://github.com/pytest-dev/pytest/issues/13537): Fixed a bug in which `ExceptionGroup` with only `Skipped` exceptions in teardown was not handled correctly and showed as error.

-   [#&#8203;13598](https://github.com/pytest-dev/pytest/issues/13598): Fixed possible collection confusion on Windows when short paths and symlinks are involved.

-   [#&#8203;13716](https://github.com/pytest-dev/pytest/issues/13716): Fixed a bug where a nonsensical invocation like `pytest x.py[a]` (a file cannot be parametrized) was silently treated as `pytest x.py`. This is now a usage error.

-   [#&#8203;13722](https://github.com/pytest-dev/pytest/issues/13722): Fixed a misleading assertion failure message when using `pytest.approx` on mappings with differing lengths.

-   [#&#8203;13773](https://github.com/pytest-dev/pytest/issues/13773): Fixed the static fixture closure calculation to properly consider transitive dependencies requested by overridden fixtures.

-   [#&#8203;13816](https://github.com/pytest-dev/pytest/issues/13816): Fixed `pytest.approx` which now returns a clearer error message when comparing mappings with different keys.

-   [#&#8203;13849](https://github.com/pytest-dev/pytest/issues/13849): Hidden `.pytest.ini` files are now picked up as the config file even if empty.
    This was an inconsistency with non-hidden `pytest.ini`.

-   [#&#8203;13865](https://github.com/pytest-dev/pytest/issues/13865): Fixed <span class="title-ref">--show-capture</span> with <span class="title-ref">--tb=line</span>.

-   [#&#8203;13522](https://github.com/pytest-dev/pytest/issues/13522): Fixed `pytester` in subprocess mode ignored all :attr\`pytester.plugins \<pytest.Pytester.plugins>\` except the first.

    Fixed `pytester` in subprocess mode silently ignored non-str `pytester.plugins <pytest.Pytester.plugins>`.
    Now it errors instead.
    If you are affected by this, specify the plugin by name, or switch the affected tests to use `pytester.runpytest_inprocess <pytest.Pytester.runpytest_inprocess>` explicitly instead.

#### Packaging updates and notes for downstreams

-   [#&#8203;13791](https://github.com/pytest-dev/pytest/issues/13791): Minimum requirements on `iniconfig` and `packaging` were bumped to `1.0.1` and `22.0.0`, respectively.

#### Contributor-facing changes

-   [#&#8203;12244](https://github.com/pytest-dev/pytest/issues/12244): Fixed self-test failures when <span class="title-ref">TERM=dumb</span>.
-   [#&#8203;12474](https://github.com/pytest-dev/pytest/issues/12474): Added scheduled GitHub Action Workflow to run Sphinx linkchecks in repo documentation.
-   [#&#8203;13621](https://github.com/pytest-dev/pytest/issues/13621): pytest's own testsuite now handles the `lsof` command hanging (e.g. due to unreachable network filesystems), with the affected selftests being skipped after 10 seconds.
-   [#&#8203;13638](https://github.com/pytest-dev/pytest/issues/13638): Fixed deprecated `gh pr new` command in `scripts/prepare-release-pr.py`.
    The script now uses `gh pr create` which is compatible with GitHub CLI v2.0+.
-   [#&#8203;13695](https://github.com/pytest-dev/pytest/issues/13695): Flush <span class="title-ref">stdout</span> and <span class="title-ref">stderr</span> in <span class="title-ref">Pytester.run</span> to avoid truncated outputs in <span class="title-ref">test_faulthandler.py::test_timeout</span> on CI -- by `ogrisel`.
-   [#&#8203;13771](https://github.com/pytest-dev/pytest/issues/13771): Skip <span class="title-ref">test_do_not_collect_symlink_siblings</span> on Windows environments without symlink support to avoid false negatives.
-   [#&#8203;13841](https://github.com/pytest-dev/pytest/issues/13841): `tox>=4` is now required when contributing to pytest.
-   [#&#8203;13625](https://github.com/pytest-dev/pytest/issues/13625): Added missing docstrings to `pytest_addoption()`, `pytest_configure()`, and `cacheshow()` functions in `cacheprovider.py`.

#### Miscellaneous internal changes

-   [#&#8203;13830](https://github.com/pytest-dev/pytest/issues/13830): Configuration overrides (`-o`/`--override-ini`) are now processed during startup rather than during `config.getini() <pytest.Config.getini>`.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yNjQuMCIsInVwZGF0ZWRJblZlciI6IjM5LjI2NC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJib3QiLCJtYWpvciJdfQ==-->

Reviewed-on: https://git.djeex.fr/Djeex/lumeex/pulls/35
2026-08-31 09:17:12 +02:00
lumeex-ci c8f42b429a Bump build version to 2.1.5 [skip ci] 2026-08-26 13:41:23 +00:00
Djeex f22634e9d9 CI/CD hardening: lint, secret scan, coverage gate, auto CVE-fix PRs, GHCR + GitHub mirror publishing (#34)
CI / build-and-scan (push) Successful in 2m43s
- release changelog: commits rendered as description (link), divider lines dropped
- gitleaks secret scan and hadolint on every push/PR
- ruff lint/format gate (Python repos) with a pytest --cov-fail-under gate
- scheduled CRITICAL Trivy failures attempt an apk upgrade rebuild and open a follow-up PR if it clears the finding, instead of just failing red
- images also published to ghcr.io/djeex/<repo>
- a matching GitHub Release is created on the GitHub mirror, with a notice pointing back to this repo as the source of truth
2026-08-26 15:38:54 +02:00
20 changed files with 356 additions and 113 deletions
+100 -4
View File
@@ -18,6 +18,21 @@ jobs:
fetch-depth: 0
persist-credentials: false
- name: Scan for secrets
run: |
# docker cp, not a build COPY: a repo's own .dockerignore (e.g. one that
# excludes .git for prod builds) would otherwise silently give an empty,
# falsely-clean scan.
CID=$(docker create zricethezav/gitleaks:v8.30.1 detect --source=/repo --no-banner -v)
docker cp . "$CID:/repo"
docker start -a "$CID"
STATUS=$?
docker rm "$CID" > /dev/null
exit $STATUS
- name: Lint Dockerfile with hadolint
run: docker run --rm -i hadolint/hadolint:v2.15.1-alpine hadolint --failure-threshold error - < Dockerfile
- name: Build Docker image
run: |
docker build -t lumeex:ci . 2>&1 | tee build.log
@@ -46,7 +61,10 @@ jobs:
- name: Run unit tests
run: |
docker build --target test -t lumeex:test .
docker run --rm lumeex:test pytest -v
docker run --rm lumeex:test pytest -v --cov=. --cov-report=term-missing --cov-fail-under=90
- name: Lint with ruff
run: docker build --target lint -t lumeex:lint .
- name: Check deprecation warnings
run: |
@@ -56,12 +74,53 @@ jobs:
fi
- name: Scan with Trivy (critical - blocking)
id: trivy_critical
continue-on-error: true
run: |
docker run --rm \
-e DOCKER_HOST=tcp://dockerhost:2375 \
--add-host=dockerhost:host-gateway \
aquasec/trivy:0.74.0 image --exit-code 1 --severity CRITICAL lumeex:ci
- name: Handle CRITICAL findings
if: steps.trivy_critical.outcome == 'failure'
run: |
if [ "${{ github.event_name }}" != "schedule" ]; then
echo "::error::CRITICAL vulnerabilities found, failing the build."
exit 1
fi
echo "Scheduled scan found CRITICAL vulnerabilities — attempting an automatic apk upgrade + rescan."
sed -i '/^FROM .* AS base$/a RUN apk upgrade --no-cache' Dockerfile
docker build -t lumeex:remediated .
if docker run --rm \
-e DOCKER_HOST=tcp://dockerhost:2375 \
--add-host=dockerhost:host-gateway \
aquasec/trivy:0.74.0 image --exit-code 1 --severity CRITICAL lumeex:remediated; then
echo "apk upgrade clears the CRITICAL finding(s) — opening a PR for review."
BRANCH="auto/cve-fix-$(date +%Y%m%d)-$(echo "${{ github.sha }}" | cut -c1-7)"
git config user.name "lumeex-ci"
git config user.email "[email protected]"
git checkout -b "$BRANCH"
git add Dockerfile
git commit -m "Auto-remediate CRITICAL CVE via apk upgrade"
git config --unset-all http.https://git.djeex.fr/.extraheader || true
git push "https://Djeex:${{ secrets.CI_PUSH_TOKEN }}@git.djeex.fr/Djeex/lumeex.git" "HEAD:$BRANCH"
PR_JSON=$(curl -s -X POST \
-H "Authorization: token ${{ secrets.CI_PUSH_TOKEN }}" \
-H "Content-Type: application/json" \
-d "$(jq -n --arg head "$BRANCH" '{title: "🔒 Auto: remediate CRITICAL CVE via apk upgrade", head: $head, base: "main", body: "Opened automatically by the scheduled CVE scan. An `apk upgrade --no-cache` cleared the CRITICAL Trivy finding(s) in a rebuild — review the diff and merge to publish the fix."}')" \
"https://git.djeex.fr/api/v1/repos/Djeex/lumeex/pulls")
echo "PR API response: $(echo "$PR_JSON" | jq -r '.html_url // .message // "unknown"')"
else
echo "::error::apk upgrade does not clear the CRITICAL finding(s) — no automatic fix available, needs manual review."
exit 1
fi
- name: Scan with Trivy (high - informative)
run: |
docker run --rm \
@@ -126,6 +185,16 @@ jobs:
docker push "$IMAGE:$MINOR_TAG"
docker push "$IMAGE:$VERSION"
GHCR_IMAGE=ghcr.io/djeex/lumeex
echo "${{ secrets.GH_TOKEN }}" | docker login ghcr.io -u Djeex --password-stdin
docker tag lumeex:ci "$GHCR_IMAGE:latest"
docker tag lumeex:ci "$GHCR_IMAGE:$MINOR_TAG"
docker tag lumeex:ci "$GHCR_IMAGE:$VERSION"
docker push "$GHCR_IMAGE:latest"
docker push "$GHCR_IMAGE:$MINOR_TAG"
docker push "$GHCR_IMAGE:$VERSION"
TRIGGER_MSG=$(git log -1 --format=%s "${{ github.sha }}")
PR_NUM=$(echo "$TRIGGER_MSG" | grep -oE '#[0-9]+' | head -1 | tr -d '#' || true)
@@ -152,7 +221,7 @@ jobs:
fi
REPO_URL="https://git.djeex.fr/Djeex/lumeex"
COMMIT_LIST=$(git log --no-merges --format="- [%h](${REPO_URL}/commit/%H) %s" "$BASE_REF".."${{ github.sha }}")
COMMIT_LIST=$(git log --no-merges --format="- %s ([%h](${REPO_URL}/commit/%H))" "$BASE_REF".."${{ github.sha }}")
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
SOURCE_LINE="[${SHORT_SHA}](${REPO_URL}/commit/${{ github.sha }})"
@@ -162,10 +231,8 @@ jobs:
BODY=$(cat <<EOF
## Changelog
---
### ${CATEGORY}
---
${CHANGE_TITLE}
**Source:** ${SOURCE_LINE}
@@ -187,3 +254,32 @@ jobs:
-H "Content-Type: application/json" \
-d "$JSON_PAYLOAD" \
"https://git.djeex.fr/api/v1/repos/Djeex/lumeex/releases"
MIRROR_NOTICE="_This github repo is a mirror of https://git.djeex.fr/Djeex/lumeex. You'll find full package, PR, history and release note there._"
GH_BODY=$(printf '%s\n\n%s' "$MIRROR_NOTICE" "$BODY")
GH_JSON_PAYLOAD=$(jq -n \
--arg tag "$VERSION" \
--arg name "$VERSION" \
--arg body "$GH_BODY" \
--arg sha "${{ github.sha }}" \
'{tag_name: $tag, name: $name, target_commitish: $sha, body: $body}')
GH_STATUS=0
for i in 1 2 3 4 5; do
GH_STATUS=$(curl -s -o /tmp/gh_release.json -w "%{http_code}" -X POST \
-H "Authorization: Bearer ${{ secrets.GH_TOKEN }}" \
-H "Accept: application/vnd.github+json" \
-H "Content-Type: application/json" \
-d "$GH_JSON_PAYLOAD" \
"https://api.github.com/repos/Djeex/lumeex/releases")
if [ "$GH_STATUS" = "201" ]; then
break
fi
echo "GitHub Release attempt $i failed (HTTP $GH_STATUS) — mirror may not have synced this commit yet, retrying in 15s..."
sleep 15
done
echo "GitHub Release API response: $GH_STATUS"
if [ "$GH_STATUS" != "201" ]; then
cat /tmp/gh_release.json 2>/dev/null || true
fi
+7
View File
@@ -27,6 +27,13 @@ RUN pip install --no-cache-dir -r requirements-dev.txt
COPY ./tests/ ./tests/
COPY ./demo/ ./demo/
FROM base AS lint
RUN pip install --no-cache-dir ruff==0.16.4
COPY ruff.toml /app/ruff.toml
COPY ./tests/ ./tests/
RUN ruff check . && ruff format --check .
FROM base
ENTRYPOINT ["/app/entrypoint.sh"]
+1 -1
View File
@@ -1 +1 @@
2.1.4
2.1.5
+1
View File
@@ -1,4 +1,5 @@
import logging
from src.py.builder.site_builder import build
if __name__ == "__main__":
+1
View File
@@ -1,4 +1,5 @@
import logging
from src.py.builder.gallery_builder import update_gallery, update_hero
if __name__ == "__main__":
+1 -1
View File
@@ -1,3 +1,3 @@
-r requirements.txt
pytest==8.4.2
pytest==9.1.1
pytest-cov==7.1.0
+15
View File
@@ -0,0 +1,15 @@
line-length = 100
[lint]
select = ["E", "F", "I", "UP", "B"]
ignore = ["E501"]
[lint.isort]
# See nvidia-stock-bot's ruff.toml for why this is pinned explicitly rather
# than left to auto-detection.
known-first-party = ["src", "build", "gallery"]
[lint.per-file-ignores]
# Real findings (unused var, unused loop var) but app-logic changes,
# left for the user to decide rather than auto-fixed.
"src/py/webui/webui.py" = ["F841", "B007"]
+9 -3
View File
@@ -1,7 +1,7 @@
import logging
from pathlib import Path
from shutil import copyfile
def generate_css_variables(colors_dict, output_path):
"""Generate css variables for theme colors"""
css_lines = [":root {"]
@@ -13,6 +13,7 @@ def generate_css_variables(colors_dict, output_path):
f.write("\n".join(css_lines))
logging.info(f"[✓] CSS variables written to {output_path}")
def generate_fonts_css(fonts_dir, output_path, fonts_cfg=None):
"""Generate css variables fonts"""
font_files = list(fonts_dir.glob("*"))
@@ -35,7 +36,7 @@ def generate_fonts_css(fonts_dir, output_path, fonts_cfg=None):
css_lines = []
for font_name, sources in font_faces.items():
css_lines.append(f"@font-face {{")
css_lines.append("@font-face {")
css_lines.append(f" font-family: '{font_name}';")
srcs = [f"url('../fonts/{file}') format('{fmt}')" for file, fmt in sorted(sources)]
css_lines.append(f" src: {', '.join(srcs)};")
@@ -58,6 +59,7 @@ def generate_fonts_css(fonts_dir, output_path, fonts_cfg=None):
logging.info(f"[✓] Generated fonts CSS: {output_path}")
return preload_links
def generate_google_fonts_link(fonts):
"""Generate src link for Google fonts"""
if not fonts:
@@ -70,5 +72,9 @@ def generate_google_fonts_link(fonts):
families.append(f"{family}:wght@{';'.join(weights)}")
else:
families.append(family)
href = "https://fonts.googleapis.com/css2?" + "&".join(f"family={f}" for f in families) + "&display=swap"
href = (
"https://fonts.googleapis.com/css2?"
+ "&".join(f"family={f}" for f in families)
+ "&display=swap"
)
return f'<link href="{href}" rel="stylesheet">'
+17 -17
View File
@@ -1,7 +1,8 @@
import yaml
import os
from pathlib import Path
import yaml
# YAML file paths
GALLERY_YAML = "config/gallery.yaml"
@@ -9,31 +10,37 @@ GALLERY_YAML = "config/gallery.yaml"
GALLERY_DIR = Path("config/photos/gallery")
HERO_DIR = Path("config/photos/hero")
def load_yaml(path):
"""Load gallery config .yaml file"""
print(f"[→] Loading {path}...")
if not os.path.exists(path):
print(f"[✗] File not found: {path}")
return {}
with open(path, "r", encoding="utf-8") as f:
with open(path, encoding="utf-8") as f:
data = yaml.safe_load(f) or {}
images = data.get("images", []) or []
print(f"[✓] Loaded {len(images)} image(s) from {path}")
return data
def save_yaml(data, path):
"""Save modified gallery config .yaml file"""
with open(path, "w", encoding="utf-8") as f:
yaml.dump(data, f, sort_keys=False, allow_unicode=True)
print(f"[✓] Saved updated YAML to {path}")
def get_all_image_paths(directory):
"""Get the path to record for builded site"""
return sorted([
str(p.relative_to(directory.parent)).replace("\\", "/")
for p in directory.rglob("*")
if p.suffix.lower() in [".jpg", ".jpeg", ".png", ".webp"]
])
return sorted(
[
str(p.relative_to(directory.parent)).replace("\\", "/")
for p in directory.rglob("*")
if p.suffix.lower() in [".jpg", ".jpeg", ".png", ".webp"]
]
)
def update_gallery():
"""Update the gallery photo list"""
@@ -50,11 +57,7 @@ def update_gallery():
known_images = {img["src"] for img in gallery_images}
# Add new images
new_images = [
{"src": path, "tags": []}
for path in all_images
if path not in known_images
]
new_images = [{"src": path, "tags": []} for path in all_images if path not in known_images]
if new_images:
gallery_images.extend(new_images)
print(f"[✓] Added {len(new_images)} new image(s) to gallery.yaml (gallery)")
@@ -74,6 +77,7 @@ def update_gallery():
if not new_images and not deleted_images:
print("[✓] No changes to gallery.yaml (gallery)")
def update_hero():
"""Update the hero photo list"""
print("\n=== Updating gallery.yaml (hero section) ===")
@@ -89,11 +93,7 @@ def update_hero():
known_images = {img["src"] for img in hero_images}
# Add new images
new_images = [
{"src": path}
for path in all_images
if path not in known_images
]
new_images = [{"src": path} for path in all_images if path not in known_images]
if new_images:
hero_images.extend(new_images)
print(f"[✓] Added {len(new_images)} new image(s) to gallery.yaml (hero)")
+7 -2
View File
@@ -2,6 +2,7 @@ import json
import logging
from pathlib import Path
def render_template(template_path, context):
"""Render html templates"""
with open(template_path, encoding="utf-8") as f:
@@ -11,6 +12,7 @@ def render_template(template_path, context):
content = content.replace(placeholder, str(value) if value is not None else "")
return content
def render_gallery_images(images):
"""Render the photo gallery"""
html = ""
@@ -20,11 +22,12 @@ def render_gallery_images(images):
html += f"""
<div class="section" data-tags="{tags}">
<div class="tags">{tag_html}</div>
<img class="fade-in-img lazyload" data-src="/img/{img['src']}" alt="{img.get('alt', '')}" loading="lazy">
<img class="fade-in-img lazyload" data-src="/img/{img["src"]}" alt="{img.get("alt", "")}" loading="lazy">
</div>
"""
return html
def generate_gallery_json_from_images(images, output_dir):
"""Generte the hero carrousel photo list"""
try:
@@ -37,6 +40,7 @@ def generate_gallery_json_from_images(images, output_dir):
except Exception as e:
logging.error(f"[✗] Error generating gallery JSON: {e}")
def generate_robots_txt(canonical_url, allowed_paths, output_dir):
"""Generate the robot.txt"""
robots_lines = ["User-agent: *"]
@@ -65,10 +69,11 @@ def generate_robots_txt(canonical_url, allowed_paths, output_dir):
except Exception as e:
logging.error(f"[✗] Failed to write robots.txt: {e}")
def generate_sitemap_xml(canonical_url, allowed_paths, output_dir):
"""Generate the sitemap"""
urlset_start = '<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n'
urlset_end = '</urlset>\n'
urlset_end = "</urlset>\n"
urls = ""
for path in allowed_paths:
loc = canonical_url.rstrip("/") + path
+15 -4
View File
@@ -1,8 +1,10 @@
import logging
from pathlib import Path
from PIL import Image, features
from shutil import copyfile
from PIL import Image, features
def convert_and_resize_image(input_path, output_path, resize=True, max_width=1140):
"""Convert an image to WebP (or JPEG fallback) and optionally resize it."""
try:
@@ -37,6 +39,7 @@ def convert_and_resize_image(input_path, output_path, resize=True, max_width=114
except Exception as e:
logging.error(f"[✗] Error processing image {input_path}: {e}")
def process_images(images, resize_images, img_dir, build_dir):
"""Process a list of image references and update paths to optimized versions."""
for img in images:
@@ -52,6 +55,7 @@ def process_images(images, resize_images, img_dir, build_dir):
if jpg_path.exists():
img["src"] = str(Path(img["src"]).with_suffix(".jpg"))
def copy_original_images(images, img_dir, build_dir):
"""Copy original image files without processing."""
for img in images:
@@ -70,6 +74,7 @@ def copy_original_images(images, img_dir, build_dir):
except Exception as e:
logging.error(f"[✗] Error copying {src_path}: {e}")
def get_favicon_path(theme_vars, theme_dir):
"""Retrieve the favicon path from theme variables, ensuring it exists."""
fav_path = theme_vars.get("favicon", {}).get("path")
@@ -87,6 +92,7 @@ def get_favicon_path(theme_vars, theme_dir):
return path
def generate_favicons_from_logo(theme_vars, theme_dir, output_dir):
"""Generate multiple PNG favicons from a single source image."""
logo_path = get_favicon_path(theme_vars, theme_dir)
@@ -97,9 +103,13 @@ def generate_favicons_from_logo(theme_vars, theme_dir, output_dir):
try:
output_dir.mkdir(parents=True, exist_ok=True)
specs = [
(32, "favicon-32.png"), (96, "favicon-96.png"), (128, "favicon-128.png"),
(192, "favicon-192.png"), (196, "favicon-196.png"),
(152, "favicon-152.png"), (180, "favicon-180.png")
(32, "favicon-32.png"),
(96, "favicon-96.png"),
(128, "favicon-128.png"),
(192, "favicon-192.png"),
(196, "favicon-196.png"),
(152, "favicon-152.png"),
(180, "favicon-180.png"),
]
img = Image.open(logo_path).convert("RGBA")
for size, name in specs:
@@ -110,6 +120,7 @@ def generate_favicons_from_logo(theme_vars, theme_dir, output_dir):
except Exception as e:
logging.error(f"[✗] Error generating PNG favicons: {e}")
def generate_favicon_ico(theme_vars, theme_dir, output_path):
"""Generate a multi-size favicon.ico from a source image."""
logo_path = get_favicon_path(theme_vars, theme_dir)
+32 -11
View File
@@ -2,14 +2,27 @@ import logging
from datetime import datetime
from pathlib import Path
from shutil import copyfile
from PIL import Image
from .utils import ensure_dir, copy_assets, load_yaml, load_theme_config
from .css_generator import generate_css_variables, generate_fonts_css, generate_google_fonts_link
from .image_processor import process_images, copy_original_images, convert_and_resize_image, generate_favicons_from_logo, generate_favicon_ico
from .html_generator import render_template, render_gallery_images, generate_gallery_json_from_images, generate_robots_txt, generate_sitemap_xml
from .html_generator import (
generate_gallery_json_from_images,
generate_robots_txt,
generate_sitemap_xml,
render_gallery_images,
render_template,
)
from .image_processor import (
copy_original_images,
generate_favicon_ico,
generate_favicons_from_logo,
process_images,
)
from .utils import copy_assets, ensure_dir, load_theme_config, load_yaml
# Configure logging to display only the messages
logging.basicConfig(level=logging.INFO, format='%(message)s')
logging.basicConfig(level=logging.INFO, format="%(message)s")
# Define key directories used throughout the script
SRC_DIR = Path.cwd()
@@ -22,9 +35,10 @@ GALLERY_FILE = SRC_DIR / "config/gallery.yaml"
SITE_FILE = SRC_DIR / "config/site.yaml"
THEMES_DIR = SRC_DIR / "config/themes"
VERSION_FILE = SRC_DIR / "VERSION"
with open(VERSION_FILE, "r") as vf:
with open(VERSION_FILE) as vf:
build_version = vf.read().strip()
def build():
logging.info("\n")
logging.info("=" * 24)
@@ -57,9 +71,13 @@ def build():
logging.info(f"[✓] Theme CSS found, copied to build folder: {dest_theme_css}")
else:
theme_css = ""
logging.warning(f"[~] No theme.css found in {theme_css_path}, skipping theme CSS injection.")
logging.warning(
f"[~] No theme.css found in {theme_css_path}, skipping theme CSS injection."
)
preload_links = generate_fonts_css(fonts_dir, BUILD_DIR / "style" / "fonts.css", fonts_cfg=theme_vars.get("fonts"))
preload_links = generate_fonts_css(
fonts_dir, BUILD_DIR / "style" / "fonts.css", fonts_cfg=theme_vars.get("fonts")
)
generate_css_variables(theme_vars.get("colors", {}), BUILD_DIR / "style" / "colors.css")
generate_favicons_from_logo(theme_vars, theme_dir, BUILD_DIR / "img" / "favicon")
generate_favicon_ico(theme_vars, theme_dir, BUILD_DIR / "favicon.ico")
@@ -94,7 +112,7 @@ def build():
# Adding Google fonts if existing
google_fonts_link = generate_google_fonts_link(theme_vars.get("google_fonts", []))
logging.info(f"[✓] Google Fonts link generated")
logging.info("[✓] Google Fonts link generated")
# Generating thumbnail
thumbnail_path = site_vars.get("social", {}).get("thumbnail")
@@ -128,7 +146,9 @@ def build():
# Render the home page
head = render_template(TEMPLATE_DIR / "head.html", head_vars)
hero = render_template(TEMPLATE_DIR / "hero.html", {**site_vars["hero"], **head_vars})
footer = render_template(TEMPLATE_DIR / "footer.html", {**site_vars.get("footer", {}), **head_vars})
footer = render_template(
TEMPLATE_DIR / "footer.html", {**site_vars.get("footer", {}), **head_vars}
)
gallery_html = render_gallery_images(gallery_images)
gallery = render_template(TEMPLATE_DIR / "gallery.html", {"gallery_images": gallery_html})
@@ -185,7 +205,8 @@ def build():
generate_robots_txt(canonical_url, allowed_pages, BUILD_DIR)
generate_sitemap_xml(canonical_url, allowed_pages, BUILD_DIR)
else:
logging.warning("[~] No canonical URL found in site.yaml info section, skipping robots.txt and sitemap.xml generation.")
logging.warning(
"[~] No canonical URL found in site.yaml info section, skipping robots.txt and sitemap.xml generation."
)
logging.info("✅ Build complete.")
+10 -4
View File
@@ -1,26 +1,30 @@
import yaml
import logging
from pathlib import Path
from shutil import copytree, rmtree, copyfile
from shutil import copytree, rmtree
import yaml
def load_yaml(path):
"""Load gallery and site .yaml conf"""
if not path.exists():
logging.warning(f"[!] YAML file not found: {path}")
return {}
with open(path, "r", encoding="utf-8") as f:
with open(path, encoding="utf-8") as f:
return yaml.safe_load(f)
def load_theme_config(theme_name, themes_dir):
"""Load theme.yaml"""
theme_dir = themes_dir / theme_name
theme_config_path = theme_dir / "theme.yaml"
if not theme_config_path.exists():
raise FileNotFoundError(f"[✗] Theme config not found: {theme_config_path}")
with open(theme_config_path, "r", encoding="utf-8") as f:
with open(theme_config_path, encoding="utf-8") as f:
theme_vars = yaml.safe_load(f)
return theme_vars, theme_dir
def clear_dir(path: Path):
"""Clear the output dir"""
if not path.exists():
@@ -32,6 +36,7 @@ def clear_dir(path: Path):
elif child.is_dir():
rmtree(child)
def ensure_dir(path: Path):
"""Create the output dir if it does not exist"""
if not path.exists():
@@ -39,6 +44,7 @@ def ensure_dir(path: Path):
else:
clear_dir(path)
def copy_assets(js_dir, style_dir, build_dir):
"""Copy public assets to output dir"""
for folder in [js_dir, style_dir]:
+6 -2
View File
@@ -1,7 +1,9 @@
import logging
from pathlib import Path
from flask import Blueprint, request, current_app
from flask import Blueprint, current_app, request
from werkzeug.utils import secure_filename
from src.py.builder.gallery_builder import update_gallery, update_hero
# --- Create Flask blueprint for upload routes ---
@@ -10,10 +12,12 @@ upload_bp = Blueprint("upload", __name__)
# --- Allowed file types ---
ALLOWED_EXTENSIONS = {"png", "jpg", "jpeg", "webp"}
def allowed_file(filename: str) -> bool:
"""Check if the uploaded file has an allowed extension."""
return "." in filename and filename.rsplit(".", 1)[1].lower() in ALLOWED_EXTENSIONS
def save_uploaded_file(file, folder: Path):
"""Save an uploaded file to the specified folder."""
folder.mkdir(parents=True, exist_ok=True) # Create folder if not exists
@@ -22,6 +26,7 @@ def save_uploaded_file(file, folder: Path):
logging.info(f"[✓] Uploaded {filename} to {folder}")
return filename
@upload_bp.route("/api/<section>/upload", methods=["POST"])
def upload_photo(section: str):
"""
@@ -63,4 +68,3 @@ def upload_photo(section: str):
return {"status": "ok", "uploaded": uploaded}
return {"error": "No valid files uploaded"}, 400
+110 -40
View File
@@ -1,16 +1,27 @@
# --- Imports ---
import logging
import yaml
import os
import subprocess
import zipfile
import os
from pathlib import Path
import yaml
from flask import (
Flask, jsonify, request, send_from_directory, render_template,
send_file, after_this_request
Flask,
after_this_request,
jsonify,
render_template,
request,
send_file,
send_from_directory,
)
from src.py.builder.gallery_builder import (
GALLERY_YAML, load_yaml, save_yaml, update_gallery, update_hero
GALLERY_YAML,
load_yaml,
save_yaml,
update_gallery,
update_hero,
)
from src.py.webui.upload import upload_bp
@@ -19,16 +30,11 @@ logging.basicConfig(level=logging.INFO, format="%(message)s")
# --- Flask app setup ---
VERSION_FILE = Path(__file__).resolve().parents[3] / "VERSION"
with open(VERSION_FILE, "r") as vf:
with open(VERSION_FILE) as vf:
lumeex_version = vf.read().strip()
WEBUI_PATH = Path(__file__).parents[2] / "webui" # Path to static/templates
app = Flask(
__name__,
template_folder=WEBUI_PATH,
static_folder=WEBUI_PATH,
static_url_path=""
)
app = Flask(__name__, template_folder=WEBUI_PATH, static_folder=WEBUI_PATH, static_url_path="")
WEBUI_PORT = int(os.getenv("WEBUI_PORT", 5000))
@@ -40,26 +46,34 @@ app.config["PHOTOS_DIR"] = PHOTOS_DIR
# --- Register upload blueprint ---
app.register_blueprint(upload_bp)
# --- Theme editor helper functions ---
def get_theme_name():
"""Get current theme name from site.yaml."""
site_yaml_path = Path(__file__).resolve().parents[3] / "config" / "site.yaml"
with open(site_yaml_path, "r") as f:
with open(site_yaml_path) as f:
site_yaml = yaml.safe_load(f)
return site_yaml.get("build", {}).get("theme", "modern")
def get_theme_yaml(theme_name):
"""Load theme.yaml for a given theme."""
theme_yaml_path = Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
with open(theme_yaml_path, "r") as f:
theme_yaml_path = (
Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
)
with open(theme_yaml_path) as f:
return yaml.safe_load(f)
def save_theme_yaml(theme_name, theme_yaml):
"""Save theme.yaml for a given theme."""
theme_yaml_path = Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
theme_yaml_path = (
Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
)
with open(theme_yaml_path, "w") as f:
yaml.safe_dump(theme_yaml, f, sort_keys=False, allow_unicode=True)
def get_local_fonts(theme_name):
"""List local font files for a theme."""
fonts_dir = Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "fonts"
@@ -67,21 +81,23 @@ def get_local_fonts(theme_name):
return []
return [f.name for f in fonts_dir.glob("*") if f.is_file() and f.suffix in [".woff", ".woff2"]]
# --- ROUTES ---
# --- Main page ---
@app.route("/")
def index():
return render_template("index.html")
PREVIEW_PORT = int(os.getenv("PREVIEW_PORT", 3000))
@app.context_processor
def inject_version():
return dict(
lumeex_version=lumeex_version,
preview_port=PREVIEW_PORT
)
return dict(lumeex_version=lumeex_version, preview_port=PREVIEW_PORT)
# --- Gallery & Hero API ---
@app.route("/gallery-editor")
@@ -89,18 +105,21 @@ def gallery_editor():
"""Render gallery editor page."""
return render_template("gallery-editor/index.html")
@app.route("/api/gallery", methods=["GET"])
def get_gallery():
"""Get gallery images."""
data = load_yaml(GALLERY_YAML)
return jsonify(data.get("gallery", {}).get("images", []))
@app.route("/api/hero", methods=["GET"])
def get_hero():
"""Get hero images."""
data = load_yaml(GALLERY_YAML)
return jsonify(data.get("hero", {}).get("images", []))
@app.route("/api/gallery/update", methods=["POST"])
def update_gallery_api():
"""Update gallery images."""
@@ -110,6 +129,7 @@ def update_gallery_api():
save_yaml(data, GALLERY_YAML)
return jsonify({"status": "ok"})
@app.route("/api/hero/update", methods=["POST"])
def update_hero_api():
"""Update hero images."""
@@ -119,18 +139,21 @@ def update_hero_api():
save_yaml(data, GALLERY_YAML)
return jsonify({"status": "ok"})
@app.route("/api/gallery/refresh", methods=["POST"])
def refresh_gallery():
"""Refresh gallery images from disk."""
update_gallery()
return jsonify({"status": "ok"})
@app.route("/api/hero/refresh", methods=["POST"])
def refresh_hero():
"""Refresh hero images from disk."""
update_hero()
return jsonify({"status": "ok"})
# --- Gallery & Hero photo deletion ---
@app.route("/api/gallery/delete", methods=["POST"])
def delete_gallery_photo():
@@ -143,6 +166,7 @@ def delete_gallery_photo():
return {"status": "ok"}
return {"error": "❌ File not found"}, 404
@app.route("/api/hero/delete", methods=["POST"])
def delete_hero_photo():
"""Delete a hero photo."""
@@ -154,6 +178,7 @@ def delete_hero_photo():
return {"status": "ok"}
return {"error": "❌ File not found"}, 404
@app.route("/api/gallery/delete_all", methods=["POST"])
def delete_all_gallery_photos():
"""Delete all gallery photos."""
@@ -168,6 +193,7 @@ def delete_all_gallery_photos():
save_yaml(data, GALLERY_YAML)
return jsonify({"status": "ok", "deleted": deleted})
@app.route("/api/hero/delete_all", methods=["POST"])
def delete_all_hero_photos():
"""Delete all hero photos."""
@@ -182,36 +208,41 @@ def delete_all_hero_photos():
save_yaml(data, GALLERY_YAML)
return jsonify({"status": "ok", "deleted": deleted})
# --- Serve photos ---
@app.route("/photos/<section>/<path:filename>")
def photos(section, filename):
"""Serve a photo from a section."""
return send_from_directory(PHOTOS_DIR / section, filename)
@app.route("/photos/<path:filename>")
def serve_photo(filename):
"""Serve a photo from the photos directory."""
photos_dir = Path(__file__).resolve().parents[3] / "config" / "photos"
return send_from_directory(photos_dir, filename)
# --- Site info page & API ---
@app.route("/site-info")
def site_info():
"""Render site info editor page."""
return render_template("site-info/index.html")
@app.route("/api/site-info", methods=["GET"])
def get_site_info():
"""Get site info YAML as JSON."""
with open(SITE_YAML, "r") as f:
with open(SITE_YAML) as f:
data = yaml.safe_load(f)
return jsonify(data)
@app.route("/api/site-info", methods=["POST"])
def update_site_info():
"""Update site info YAML."""
new_data = request.json
with open(SITE_YAML, "r") as f:
with open(SITE_YAML) as f:
old_data = yaml.safe_load(f) or {}
def deep_merge(old, new):
@@ -227,6 +258,7 @@ def update_site_info():
yaml.safe_dump(merged, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok"})
# --- Theme management ---
@app.route("/api/themes")
def list_themes():
@@ -235,6 +267,7 @@ def list_themes():
themes = [d.name for d in themes_dir.iterdir() if d.is_dir()]
return jsonify(themes)
# --- Thumbnail upload/remove ---
@app.route("/api/thumbnail/upload", methods=["POST"])
def upload_thumbnail():
@@ -245,13 +278,14 @@ def upload_thumbnail():
return {"error": "❌ No file provided"}, 400
filename = "thumbnail.png"
file.save(PHOTOS_DIR / filename)
with open(SITE_YAML, "r") as f:
with open(SITE_YAML) as f:
data = yaml.safe_load(f)
data.setdefault("social", {})["thumbnail"] = filename
with open(SITE_YAML, "w") as f:
yaml.safe_dump(data, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok", "filename": filename})
@app.route("/api/thumbnail/remove", methods=["POST"])
def remove_thumbnail():
"""Remove thumbnail image and update site.yaml."""
@@ -259,7 +293,7 @@ def remove_thumbnail():
thumbnail_path = PHOTOS_DIR / "thumbnail.png"
if thumbnail_path.exists():
thumbnail_path.unlink()
with open(SITE_YAML, "r") as f:
with open(SITE_YAML) as f:
data = yaml.safe_load(f)
if "social" in data and "thumbnail" in data["social"]:
data["social"]["thumbnail"] = ""
@@ -267,6 +301,7 @@ def remove_thumbnail():
yaml.safe_dump(data, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok"})
# --- Theme upload ---
@app.route("/api/theme/upload", methods=["POST"])
def upload_theme():
@@ -286,6 +321,7 @@ def upload_theme():
file.save(dest_path)
return jsonify({"status": "ok", "theme": folder_name})
@app.route("/api/theme/remove", methods=["POST"])
def remove_theme():
"""Remove a custom theme folder."""
@@ -302,15 +338,18 @@ def remove_theme():
return jsonify({"error": "❌ Cannot remove default theme"}), 400
# Remove folder and all contents
import shutil
shutil.rmtree(theme_folder)
return jsonify({"status": "ok"})
# --- Theme editor page & API ---
@app.route("/theme-editor")
def theme_editor():
"""Render theme editor page."""
return render_template("theme-editor/index.html")
@app.route("/api/theme-info", methods=["GET", "POST"])
def api_theme_info():
"""Get or update theme.yaml for current theme."""
@@ -318,11 +357,9 @@ def api_theme_info():
if request.method == "GET":
theme_yaml = get_theme_yaml(theme_name)
google_fonts = theme_yaml.get("google_fonts", [])
return jsonify({
"theme_name": theme_name,
"theme_yaml": theme_yaml,
"google_fonts": google_fonts
})
return jsonify(
{"theme_name": theme_name, "theme_yaml": theme_yaml, "google_fonts": google_fonts}
)
else:
data = request.get_json()
theme_yaml = data.get("theme_yaml")
@@ -330,20 +367,24 @@ def api_theme_info():
save_theme_yaml(theme_name, theme_yaml)
return jsonify({"status": "ok"})
@app.route("/api/theme-google-fonts", methods=["POST"])
def update_theme_google_fonts():
"""Update only google_fonts in theme.yaml for current theme."""
data = request.get_json()
theme_name = data.get("theme_name")
google_fonts = data.get("google_fonts", [])
theme_yaml_path = Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
with open(theme_yaml_path, "r") as f:
theme_yaml_path = (
Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name / "theme.yaml"
)
with open(theme_yaml_path) as f:
theme_yaml = yaml.safe_load(f)
theme_yaml["google_fonts"] = google_fonts
with open(theme_yaml_path, "w") as f:
yaml.safe_dump(theme_yaml, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok"})
@app.route("/api/local-fonts")
def api_local_fonts():
"""List local fonts for a theme."""
@@ -351,6 +392,7 @@ def api_local_fonts():
fonts = get_local_fonts(theme_name)
return jsonify(fonts)
# --- Favicon upload/remove ---
@app.route("/api/favicon/upload", methods=["POST"])
def upload_favicon():
@@ -366,13 +408,14 @@ def upload_favicon():
theme_dir = Path(__file__).resolve().parents[3] / "config" / "themes" / theme_name
file.save(theme_dir / filename)
theme_yaml_path = theme_dir / "theme.yaml"
with open(theme_yaml_path, "r") as f:
with open(theme_yaml_path) as f:
theme_yaml = yaml.safe_load(f)
theme_yaml.setdefault("favicon", {})["path"] = filename
with open(theme_yaml_path, "w") as f:
yaml.safe_dump(theme_yaml, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok", "filename": filename})
@app.route("/api/favicon/remove", methods=["POST"])
def remove_favicon():
"""Remove favicon for a theme."""
@@ -386,7 +429,7 @@ def remove_favicon():
if favicon_path.exists():
favicon_path.unlink()
theme_yaml_path = theme_dir / "theme.yaml"
with open(theme_yaml_path, "r") as f:
with open(theme_yaml_path) as f:
theme_yaml = yaml.safe_load(f)
if "favicon" in theme_yaml:
theme_yaml["favicon"]["path"] = ""
@@ -394,6 +437,7 @@ def remove_favicon():
yaml.safe_dump(theme_yaml, f, sort_keys=False, allow_unicode=True)
return jsonify({"status": "ok"})
# --- Serve theme assets ---
@app.route("/themes/<theme>/<filename>")
def serve_theme_asset(theme, filename):
@@ -401,6 +445,7 @@ def serve_theme_asset(theme, filename):
theme_dir = Path(__file__).resolve().parents[3] / "config" / "themes" / theme
return send_from_directory(theme_dir, filename)
# --- Font upload/remove ---
@app.route("/api/font/upload", methods=["POST"])
def upload_font():
@@ -418,6 +463,7 @@ def upload_font():
font_basename = Path(file.filename).stem
return jsonify({"status": "ok", "filename": font_basename})
@app.route("/api/font/remove", methods=["POST"])
def remove_font():
"""Remove a font file for a theme."""
@@ -433,6 +479,7 @@ def remove_font():
return jsonify({"status": "ok"})
return jsonify({"error": "❌ Font not found"}), 404
# --- Build & Download ZIP ---
@app.route("/api/build", methods=["POST"])
def trigger_build():
@@ -446,7 +493,7 @@ def trigger_build():
if not site_yaml_path.exists():
return jsonify({"status": "error", "message": "❌ site.yaml not found"}), 400
with open(site_yaml_path, "r") as f:
with open(site_yaml_path) as f:
site_data = yaml.safe_load(f) or {}
# Dynamically check all main sections and nested keys
@@ -454,24 +501,45 @@ def trigger_build():
for section in main_sections:
value = site_data.get(section)
if not value:
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}"}), 400
return jsonify(
{"status": "error", "message": f"❌ Site info are not set: missing {section}"}
), 400
if isinstance(value, dict):
for k, v in value.items():
if v is None or v == "" or (isinstance(v, list) and not v):
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}.{k}"}), 400
return jsonify(
{
"status": "error",
"message": f"❌ Site info are not set: missing {section}.{k}",
}
), 400
elif isinstance(value, list):
if not value:
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}"}), 400
return jsonify(
{"status": "error", "message": f"❌ Site info are not set: missing {section}"}
), 400
for idx, item in enumerate(value):
if isinstance(item, dict):
for k, v in item.items():
if v is None or v == "" or (isinstance(v, list) and not v):
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}[{idx}].{k}"}), 400
return jsonify(
{
"status": "error",
"message": f"❌ Site info are not set: missing {section}[{idx}].{k}",
}
), 400
elif item is None or item == "":
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}[{idx}]"}), 400
return jsonify(
{
"status": "error",
"message": f"❌ Site info are not set: missing {section}[{idx}]",
}
), 400
else:
if value is None or value == "":
return jsonify({"status": "error", "message": f"❌ Site info are not set: missing {section}"}), 400
return jsonify(
{"status": "error", "message": f"❌ Site info are not set: missing {section}"}
), 400
try:
subprocess.run(["python3", "build.py"], check=True)
@@ -479,6 +547,7 @@ def trigger_build():
except Exception as e:
return jsonify({"status": "error", "message": f"{str(e)}"}), 500
@app.route("/download-output-zip", methods=["POST"])
def download_output_zip():
"""
@@ -505,6 +574,7 @@ def download_output_zip():
return send_file(zip_path, as_attachment=True)
# --- Run server ---
if __name__ == "__main__":
logging.info("[~] Starting WebUI at http://0.0.0.0:5000")
+2 -5
View File
@@ -50,9 +50,7 @@ def app_env(tmp_path, monkeypatch, make_image):
theme_dir = root / "config" / "themes" / "modern"
theme_dir.mkdir(parents=True)
(theme_dir / "theme.yaml").write_text(
"colors:\n browser_color: '#ffffff'\n"
"favicon:\n path: favicon.png\n"
"google_fonts: []\n",
"colors:\n browser_color: '#ffffff'\nfavicon:\n path: favicon.png\ngoogle_fonts: []\n",
encoding="utf-8",
)
make_image(theme_dir / "favicon.png", size=(32, 32), fmt="PNG")
@@ -61,8 +59,7 @@ def app_env(tmp_path, monkeypatch, make_image):
"hero:\n images: []\ngallery:\n images: []\n", encoding="utf-8"
)
(root / "config" / "site.yaml").write_text(
"info:\n title: Test\n canonical: https://example.com\n"
"social:\n thumbnail: ''\n",
"info:\n title: Test\n canonical: https://example.com\nsocial:\n thumbnail: ''\n",
encoding="utf-8",
)
+1 -3
View File
@@ -1,5 +1,3 @@
from pathlib import Path
from src.py.builder import utils
@@ -30,7 +28,7 @@ def test_load_theme_config_missing_raises(tmp_path):
themes_dir = tmp_path / "themes"
try:
utils.load_theme_config("missing", themes_dir)
assert False, "expected FileNotFoundError"
raise AssertionError("expected FileNotFoundError")
except FileNotFoundError:
pass
-2
View File
@@ -1,5 +1,3 @@
import yaml
from src.py.builder import gallery_builder as gb
+7 -4
View File
@@ -1,5 +1,3 @@
from pathlib import Path
from PIL import Image
from src.py.builder import image_processor as ip
@@ -101,8 +99,13 @@ def test_generate_favicons_from_logo_creates_all_sizes(tmp_path, make_image):
ip.generate_favicons_from_logo({"favicon": {"path": "favicon.png"}}, theme_dir, output_dir)
expected = [
"favicon-32.png", "favicon-96.png", "favicon-128.png",
"favicon-192.png", "favicon-196.png", "favicon-152.png", "favicon-180.png",
"favicon-32.png",
"favicon-96.png",
"favicon-128.png",
"favicon-192.png",
"favicon-196.png",
"favicon-152.png",
"favicon-180.png",
]
for name in expected:
assert (output_dir / name).exists()
+8 -4
View File
@@ -102,7 +102,13 @@ def test_site_info_get_and_post(client, app_env):
data = resp.get_json()
assert data["info"]["title"] == "Test"
client.post("/api/site-info", json={"info": {"subtitle": "New subtitle"}, "social": {"instagram_url": "https://insta.example"}})
client.post(
"/api/site-info",
json={
"info": {"subtitle": "New subtitle"},
"social": {"instagram_url": "https://insta.example"},
},
)
updated = client.get("/api/site-info").get_json()
assert updated["info"]["title"] == "Test"
@@ -271,9 +277,7 @@ def test_trigger_build_success_invokes_subprocess(client, app_env, monkeypatch):
)
calls = []
monkeypatch.setattr(
webui.subprocess, "run", lambda *a, **k: calls.append((a, k))
)
monkeypatch.setattr(webui.subprocess, "run", lambda *a, **k: calls.append((a, k)))
resp = client.post("/api/build")
assert resp.get_json() == {"status": "ok"}