Compare commits

...

22 Commits

Author SHA1 Message Date
Bastian Venthur
60bd86ec22 finalized benchmark 2025-01-22 15:17:28 +01:00
Bastian Venthur
69b729a471 Merge branch 'performance' into rebuild_needed_only 2025-01-22 14:46:42 +01:00
Bastian Venthur
f09e841200 Merge branch 'master' into rebuild_needed_only 2025-01-22 14:46:29 +01:00
Bastian Venthur
c94f9793b0 improved performance test 2025-01-22 14:46:14 +01:00
Bastian Venthur
5cddb62603 Merge branch 'master' into performance 2025-01-22 14:14:46 +01:00
Bastian Venthur
85e57a7ef2 added py313 to github actions test suite 2025-01-03 10:46:22 +01:00
dependabot[bot]
ef18685cef Bump the all group across 1 directory with 10 updates
Bumps the all group with 10 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.39` | `9.5.49` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.26.1` | `0.27.0` |
| [twine](https://github.com/pypa/twine) | `5.1.1` | `6.0.1` |
| [wheel](https://github.com/pypa/wheel) | `0.44.0` | `0.45.1` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.3.3` | `8.3.4` |
| [pytest-cov](https://github.com/pytest-dev/pytest-cov) | `5.0.0` | `6.0.0` |
| [ruff](https://github.com/astral-sh/ruff) | `0.6.9` | `0.8.4` |
| [mypy](https://github.com/python/mypy) | `1.11.2` | `1.14.0` |
| [types-markdown](https://github.com/python/typeshed) | `3.7.0.20240822` | `3.7.0.20241204` |
| [jinja2](https://github.com/pallets/jinja) | `3.1.4` | `3.1.5` |



Updates `mkdocs-material` from 9.5.39 to 9.5.49
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.39...9.5.49)

Updates `mkdocstrings[python]` from 0.26.1 to 0.27.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mkdocstrings/mkdocstrings/compare/0.26.1...0.27.0)

Updates `twine` from 5.1.1 to 6.0.1
- [Release notes](https://github.com/pypa/twine/releases)
- [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst)
- [Commits](https://github.com/pypa/twine/compare/v5.1.1...6.0.1)

Updates `wheel` from 0.44.0 to 0.45.1
- [Release notes](https://github.com/pypa/wheel/releases)
- [Changelog](https://github.com/pypa/wheel/blob/main/docs/news.rst)
- [Commits](https://github.com/pypa/wheel/compare/0.44.0...0.45.1)

Updates `pytest` from 8.3.3 to 8.3.4
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/8.3.3...8.3.4)

Updates `pytest-cov` from 5.0.0 to 6.0.0
- [Changelog](https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest-cov/compare/v5.0.0...v6.0.0)

Updates `ruff` from 0.6.9 to 0.8.4
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.6.9...0.8.4)

Updates `mypy` from 1.11.2 to 1.14.0
- [Changelog](https://github.com/python/mypy/blob/master/CHANGELOG.md)
- [Commits](https://github.com/python/mypy/compare/v1.11.2...v1.14.0)

Updates `types-markdown` from 3.7.0.20240822 to 3.7.0.20241204
- [Commits](https://github.com/python/typeshed/commits)

Updates `jinja2` from 3.1.4 to 3.1.5
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.4...3.1.5)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mkdocstrings[python]
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: twine
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: wheel
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: pytest
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: pytest-cov
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: all
- dependency-name: ruff
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: mypy
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: types-markdown
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: jinja2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-12-23 14:19:20 +00:00
Bastian Venthur
6b699f58ad simplified color scheme selection 2024-11-18 09:22:21 +01:00
Bastian Venthur
a3da95ea19 added benchmark 2024-10-29 12:13:05 +01:00
Bastian Venthur
c4f3c09730 WIP 2024-10-29 10:16:48 +01:00
Bastian Venthur
5943dab690 wip 2024-10-29 10:16:48 +01:00
Bastian Venthur
e631b17fb1 bumped version prepared upload 2024-10-13 20:13:10 +02:00
Bastian Venthur
07be96aa7c bumped changelog 2024-10-13 20:11:58 +02:00
Bastian Venthur
0d03733b4f ignoe FileNotFound Error that sometimes happens when getting mtime of directories
Fixes: #231
2024-10-11 11:09:32 +02:00
Bastian Venthur
8fed4894ee Merge remote-tracking branch 'origin/dependabot/pip/all-571baf080f' 2024-10-10 16:20:18 +02:00
Bastian Venthur
12db99f20a remove ruff's target-version 2024-10-10 16:18:52 +02:00
dependabot[bot]
086832986b Bump the all group with 2 updates
Bumps the all group with 2 updates: [build](https://github.com/pypa/build) and [ruff](https://github.com/astral-sh/ruff).


Updates `build` from 1.2.2 to 1.2.2.post1
- [Release notes](https://github.com/pypa/build/releases)
- [Changelog](https://github.com/pypa/build/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pypa/build/compare/1.2.2...1.2.2.post1)

Updates `ruff` from 0.6.8 to 0.6.9
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.6.8...0.6.9)

---
updated-dependencies:
- dependency-name: build
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: ruff
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-07 14:22:20 +00:00
Bastian Venthur
8112d9fb30 Merge pull request #253 from venthur/dependabot/pip/all-e1f04c1223
Bump the all group across 1 directory with 9 updates
2024-10-07 12:31:39 +02:00
dependabot[bot]
e977383ae0 Bump the all group across 1 directory with 9 updates
Bumps the all group with 9 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [build](https://github.com/pypa/build) | `1.2.1` | `1.2.2` |
| [mkdocs](https://github.com/mkdocs/mkdocs) | `1.6.0` | `1.6.1` |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.31` | `9.5.39` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.25.2` | `0.26.1` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.3.2` | `8.3.3` |
| [ruff](https://github.com/astral-sh/ruff) | `0.6.0` | `0.6.8` |
| [mypy](https://github.com/python/mypy) | `1.11.1` | `1.11.2` |
| [types-markdown](https://github.com/python/typeshed) | `3.6.0.20240316` | `3.7.0.20240822` |
| [markdown](https://github.com/Python-Markdown/markdown) | `3.6` | `3.7` |



Updates `build` from 1.2.1 to 1.2.2
- [Release notes](https://github.com/pypa/build/releases)
- [Changelog](https://github.com/pypa/build/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pypa/build/compare/1.2.1...1.2.2)

Updates `mkdocs` from 1.6.0 to 1.6.1
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](https://github.com/mkdocs/mkdocs/compare/1.6.0...1.6.1)

Updates `mkdocs-material` from 9.5.31 to 9.5.39
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.31...9.5.39)

Updates `mkdocstrings[python]` from 0.25.2 to 0.26.1
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mkdocstrings/mkdocstrings/compare/0.25.2...0.26.1)

Updates `pytest` from 8.3.2 to 8.3.3
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/8.3.2...8.3.3)

Updates `ruff` from 0.6.0 to 0.6.8
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.6.0...0.6.8)

Updates `mypy` from 1.11.1 to 1.11.2
- [Changelog](https://github.com/python/mypy/blob/master/CHANGELOG.md)
- [Commits](https://github.com/python/mypy/compare/v1.11.1...v1.11.2)

Updates `types-markdown` from 3.6.0.20240316 to 3.7.0.20240822
- [Commits](https://github.com/python/typeshed/commits)

Updates `markdown` from 3.6 to 3.7
- [Release notes](https://github.com/Python-Markdown/markdown/releases)
- [Changelog](https://github.com/Python-Markdown/markdown/blob/master/docs/changelog.md)
- [Commits](https://github.com/Python-Markdown/markdown/compare/3.6...3.7)

---
updated-dependencies:
- dependency-name: build
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mkdocs
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mkdocstrings[python]
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: pytest
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: ruff
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: mypy
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: all
- dependency-name: types-markdown
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: all
- dependency-name: markdown
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: all
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-30 14:43:59 +00:00
Bastian Venthur
71c866c9b3 Merge branch 'master' into rebuild_needed_only 2023-11-12 17:16:46 +01:00
Bastian Venthur
c87a300c71 Merge branch 'master' into rebuild_needed_only 2022-08-07 21:50:15 +02:00
Bastian Venthur
a939e6503c rebuild only files that need re-building
we compare the mtimes of src and dst
2022-08-06 21:56:41 +02:00
12 changed files with 101 additions and 42 deletions

View File

@@ -20,6 +20,7 @@ jobs:
- "3.10" - "3.10"
- "3.11" - "3.11"
- "3.12" - "3.12"
- "3.13"
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4

View File

@@ -1,8 +1,16 @@
# Changelog # Changelog
## [unreleased] -- ## [unreleased]
* Added Python 3.13 to github actions
## [2.3.2] -- 2024-10-13
* Ignore FileNotFoundError when trying to get the last modified time of files
in directories. This happens for example with temporary emacs files.
* Added changelog to docs * Added changelog to docs
* removed ruff's target-version from pyproject.toml, this value defaults to the
projects requires-python
## [2.3.1] -- 2024-07-06 ## [2.3.1] -- 2024-07-06

View File

@@ -65,6 +65,10 @@ serve-docs: $(VENV)
manpage: $(VENV) manpage: $(VENV)
help2man $(BIN)/blag --no-info -n "blog-aware, static site generator" -o debian/blag.1 help2man $(BIN)/blag --no-info -n "blog-aware, static site generator" -o debian/blag.1
.PHONY: benchmark
benchmark: $(VENV)
$(BIN)/pytest --no-cov -capture=no -rA tests/benchmark.py
.PHONY: clean .PHONY: clean
clean: clean:
rm -rf build dist *.egg-info rm -rf build dist *.egg-info

View File

@@ -323,6 +323,18 @@ def process_markdown(
for src, dst in convertibles: for src, dst in convertibles:
logger.debug(f"Processing {src}") logger.debug(f"Processing {src}")
# see first if the dst actually needs re-building. for that we compare
# the mtimes and assume mtime_dst > mtime_src means that it needs not
# to be rebuilt
if os.path.exists(f"{output_dir}/{dst}"):
mtime_src = os.stat(f"{input_dir}/{src}").st_mtime
mtime_dst = os.stat(f"{output_dir}/{dst}").st_mtime
if mtime_dst >= mtime_src:
logger.debug(
"Skipping, as target exists and is newer than source."
)
continue
with open(f"{input_dir}/{src}") as fh: with open(f"{input_dir}/{src}") as fh:
body = fh.read() body = fh.read()

View File

@@ -42,7 +42,12 @@ def get_last_modified(dirs: list[str]) -> float:
for dir in dirs: for dir in dirs:
for root, dirs, files in os.walk(dir): for root, dirs, files in os.walk(dir):
for f in files: for f in files:
mtime = os.stat(os.path.join(root, f)).st_mtime try:
mtime = os.stat(os.path.join(root, f)).st_mtime
except FileNotFoundError:
# ignore files that have been deleted since the os.walk
# call (for example temporary emacs files)
continue
if mtime > last_mtime: if mtime > last_mtime:
last_mtime = mtime last_mtime = mtime

View File

@@ -1,33 +1,16 @@
@import "code-light.css" (prefers-color-scheme: light); @import "code-light.css" (prefers-color-scheme: light);
@import "code-dark.css" (prefers-color-scheme: dark); @import "code-dark.css" (prefers-color-scheme: dark);
@media (prefers-color-scheme: light) { :root {
:root { color-scheme: light dark;
--background: #FFFFFF; --background: light-dark(#FFFFFF, #2B363B);
--background-dim: #f5f7f9; --background-dim: light-dark(#f5f7f9, #2F3C42);
--foreground: light-dark(#2B303A, #f0f2f3);
--foreground: #2B303A; --foreground-dim: light-dark(#576379, #d5d5d5);
--foreground-dim: #576379; --foreground-heavy: light-dark(#191C22, #f2f4f5);
--foreground-heavy: #191C22; --primary-color: light-dark(#375287, #A1C5FF);
--primary-color: #375287;
}
} }
@media (prefers-color-scheme: dark) {
:root {
--background: #2B363B;
--background-dim: #2F3C42;
--foreground: #f0f2f3;
--foreground-dim: #d5d5d5;
--foreground-heavy: #f2f4f5;
--primary-color: #A1C5FF;
}
}
html { html {
font-size: 18px; font-size: 18px;
font-family: serif; font-family: serif;

View File

@@ -1,3 +1,3 @@
"""Version information for the blag package.""" """Version information for the blag package."""
__VERSION__ = "2.3.1" __VERSION__ = "2.3.2"

10
debian/changelog vendored
View File

@@ -1,3 +1,13 @@
blag (2.3.2) unstable; urgency=medium
* Ignore FileNotFoundError when trying to get the last modified time of
files in directories. This happens for example with temporary emacs files.
* Added changelog to docs
* removed ruff's target-version from pyproject.toml, this value defaults to
the projects requires-python
-- Bastian Venthur <venthur@debian.org> Sun, 13 Oct 2024 20:12:29 +0200
blag (2.3.1) unstable; urgency=medium blag (2.3.1) unstable; urgency=medium
* added manpage * added manpage

View File

@@ -65,7 +65,6 @@ addopts = """
[tool.ruff] [tool.ruff]
line-length = 79 line-length = 79
target-version = "py310"
[tool.ruff.lint] [tool.ruff.lint]
select = [ select = [

View File

@@ -1,11 +1,11 @@
build==1.2.1 build==1.2.2.post1
mkdocs==1.6.0 mkdocs==1.6.1
mkdocs-material==9.5.31 mkdocs-material==9.5.49
mkdocstrings[python]==0.25.2 mkdocstrings[python]==0.27.0
twine==5.1.1 twine==6.0.1
wheel==0.44.0 wheel==0.45.1
pytest==8.3.2 pytest==8.3.4
pytest-cov==5.0.0 pytest-cov==6.0.0
ruff==0.6.0 ruff==0.8.4
mypy==1.11.1 mypy==1.14.0
types-markdown==3.6.0.20240316 types-markdown==3.7.0.20241204

View File

@@ -1,4 +1,4 @@
markdown==3.6 markdown==3.7
feedgenerator==2.1.0 feedgenerator==2.1.0
jinja2==3.1.4 jinja2==3.1.5
pygments==2.18.0 pygments==2.18.0

37
tests/benchmark.py Normal file
View File

@@ -0,0 +1,37 @@
"""Benchmark the performance of the blag build command."""
import logging
import os
from argparse import Namespace
from pytest import LogCaptureFixture
import blag
from blag.blag import build
def test_performance(args: Namespace, caplog: LogCaptureFixture) -> None:
"""Test performance of the build command."""
caplog.set_level(logging.ERROR)
FILES = 10000
print(f"Generating {FILES} markdown files")
# create random markdown files in the content directory
with open(os.path.join(blag.__path__[0], "content", "testpage.md")) as fh:
markdown = fh.read()
for i in range(FILES):
with open(f"content/{i}.md", "w") as f:
f.write(markdown)
f.write(str(i))
from time import time
t = time()
build(args)
t_first = time() - t
t = time()
build(args)
t_second = time() - t
print(f"First run: {t_first:.2f}s, second run: {t_second:.2f}s")
print(f"Speedup: {t_first/t_second:.2f}")