Zim names with a re-release letter are parsed, and an undated Zim no longer warns at every start (#943)

The kiwix naming scheme is {name}_{YYYY-MM}.zim, and a re-release in the same
month carries a letter: 3dprinting.stackexchange.com_en_all_2026-07a.zim.
parse_name rejected the letter, so such a Zim was never checked for newer
releases and zims.yaml keyed it by its full stem instead of its name.  The
letter is now accepted and folded into the day of the month-precision date, so
a re-release orders after the plain release wherever dates are compared.  The
pattern also anchors the ".zim" extension instead of matching any character.

A Zim that is not kiwix-named (edibleplantdb.zim) has no date to compare and is
simply not checked.  find_outdated_zim_files logged that at WARNING for every
such file at every start; it is a DEBUG line now.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
lrnselfreliance 2026-11-02 19:35:54 -07:00 • committed by Roland
parent 9797af157a
commit 87137cc40c
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
2 changed files with 38 additions and 10 deletions

View file

@ -609,15 +609,22 @@ async def check_zim(path: pathlib.Path) -> int:
return result.return_code
ZIM_NAME_PARSER = re.compile(r'(.+?)_(\d{4}-\d{2}).zim')
# The kiwix naming scheme: {name}_{YYYY-MM}.zim. A re-release in the same month carries a letter (2026-07a).
ZIM_NAME_PARSER = re.compile(r'(.+?)_(\d{4}-\d{2})([a-z]?)\.zim$')
def parse_name(path: pathlib.Path) -> Tuple[str, datetime]:
"""The name and release date of a kiwix-named Zim. The date has month precision; a re-release letter is folded
into the otherwise unused day (2026-07 -> July 1, 2026-07a -> July 2), so dates order the releases.
@raise ValueError: the name is not kiwix-named (edibleplantdb.zim), so it has no date to compare."""
match = ZIM_NAME_PARSER.match(path.name)
if not match:
raise ValueError(f'Zim file name does not match expected pattern: {path.name}')
name, date = match.groups()
name, date, release = match.groups()
date = datetime.strptime(date, '%Y-%m')
if release:
date = date.replace(day=2 + ord(release) - ord('a'))
return name, date
@ -634,8 +641,9 @@ def find_outdated_zim_files(path: pathlib.Path = None) -> Tuple[List[pathlib.Pat
for file in files:
try:
name, date = parse_name(file)
except Exception:
logger.warning(f'Found Zim {file} but its name does not match.')
except ValueError:
# Not kiwix-named (a Zim the user made), so there is no date to compare: it is never outdated.
logger.debug(f'Zim {file} is not named the kiwix way; it is not checked for newer releases.')
continue
zims.append((name, date, file))

View file

@ -1,5 +1,6 @@
import asyncio
import json
import logging
import sys
from unittest import mock
from http import HTTPStatus
@ -214,6 +215,18 @@ def test_parse_name():
assert name == 'wikipedia_en_all_maxi'
assert date == datetime(2023, 1, 1)
# A re-release in the same month carries a letter; it is newer than the plain release and older than the next
# letter. The letter is folded into the day, which the month-precision date does not otherwise use.
name, date = lib.parse_name(pathlib.Path('3dprinting.stackexchange.com_en_all_2026-07a.zim'))
assert name == '3dprinting.stackexchange.com_en_all'
assert datetime(2026, 7, 1) < date < lib.parse_name(pathlib.Path('x_2026-07b.zim'))[1] < datetime(2026, 8, 1)
# The extension is a real suffix, not any character followed by "zim".
with pytest.raises(ValueError):
lib.parse_name(pathlib.Path('wikipedia_en_all_maxi_2023-01xzim'))
with pytest.raises(ValueError):
lib.parse_name(pathlib.Path('wikipedia_en_all_maxi_2023-01.zim.part'))
with pytest.raises(ValueError):
lib.parse_name(pathlib.Path('edibleplantdb.zim'))
@ -222,7 +235,7 @@ def test_parse_name():
@pytest.mark.asyncio
async def test_find_outdated_zim_files(test_session, test_directory, test_zim_bytes, async_client):
async def test_find_outdated_zim_files(test_session, test_directory, test_zim_bytes, async_client, caplog):
"""Outdated Zim files are found and reported. They can automatically be deleted."""
# Can search empty directory.
outdated, current = lib.find_outdated_zim_files()
@ -232,24 +245,31 @@ async def test_find_outdated_zim_files(test_session, test_directory, test_zim_by
wikibooks_one = test_directory / 'zims/books/wikibooks_en_nopic_maxi_2023-01.zim' # unique
wikipedia_one = test_directory / 'zims/wikipedia_en_all_maxi_2023-01.zim' # outdated
wikipedia_two = test_directory / 'zims/wikipedia_en_all_maxi_2023-02.zim' # keep this one
wikipedia_two = test_directory / 'zims/wikipedia_en_all_maxi_2023-02.zim' # outdated by the re-release
wikipedia_two_a = test_directory / 'zims/wikipedia_en_all_maxi_2023-02a.zim' # keep this one
asdf = test_directory / 'zims/asdf.zim' # Name cannot be parsed.
wikibooks_one.write_bytes(test_zim_bytes)
wikipedia_one.write_bytes(test_zim_bytes)
wikipedia_two.write_bytes(test_zim_bytes)
wikipedia_two_a.write_bytes(test_zim_bytes)
asdf.write_bytes(test_zim_bytes)
empty = test_directory / 'zims/wikipedia_en_all_maxi_2023-03.zim' # empty files should be ignored.
empty.touch()
request, response = await async_client.get('/api/zim/outdated')
with caplog.at_level(logging.WARNING, logger='wrolpi'):
request, response = await async_client.get('/api/zim/outdated')
assert response.status_code == HTTPStatus.OK
assert response.json['outdated'] == [str(wikipedia_one.relative_to(test_directory)), ]
assert response.json['outdated'] == [str(wikipedia_one.relative_to(test_directory)),
str(wikipedia_two.relative_to(test_directory))]
# A Zim that is not named the kiwix way is simply not checked; it does not warn at every start.
assert 'asdf.zim' not in caplog.text
request, response = await async_client.delete('/api/zim/outdated')
assert response.status_code == HTTPStatus.NO_CONTENT
# Only the outdated was deleted.
# Only the outdated were deleted.
assert wikibooks_one.is_file()
assert not wikipedia_one.exists()
assert wikipedia_two.is_file()
assert not wikipedia_two.exists()
assert wikipedia_two_a.is_file()
assert asdf.is_file()
assert empty.is_file()