khanh.pndc/odoo-docs
1
0
Fork 0
mirror of https://github.com/odoo/documentation.git synced 2025-12-12 07:29:27 +07:00
Code Issues Packages Projects Releases Wiki Activity

[ADD] tests: image compression and resource file name checkers

Browse Source 
task-2801043

closes odoo/documentation#4870

closes odoo/documentation#5436

X-original-commit: fa90e27c4e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Victor Feyens
2023-04-17 13:46:16 +00:00
committed by Antoine Vandevenne (anv)
parent 744b1cdfd2
commit b9c7cd2ee8
5 changed files with 48 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
tests/checkers/resource_files.py
View File

@@ -1,5 +1,6 @@
from pathlib import Path
from PIL import Image
import sphinxlint
@@ -7,6 +8,10 @@ MAX_IMAGE_SIZES = { # in bytes
'.png': 505000,
'.gif': 2100000,
}
MODE_TO_BPP = {
'1': 1, 'L': 8, 'P': 8, 'RGB': 24, 'RGBA': 32, 'CMYK': 32, 'YCbCr': 24, 'I': 32, 'F': 32
}
def log_error(file, line, msg, checker_name):
""" Log an error in sphinx-lint's log format to ease the processing of linting errors on Runbot.
@@ -28,6 +33,29 @@ def check_image_size(file):
'image-size',
)
def check_image_color_depth(file):
""" Check that PNG images are compressed to 8-bit color depth with PNGQuant. """
file_path = Path(file)
if file_path.suffix.lower() == '.png':
data = Image.open(file)
bpp = MODE_TO_BPP[data.mode]
if bpp > 8:
log_error(
file_path,
0,
f"the file has a color depth of {bpp} instead of 8; compress it with pngquant",
'image-color-depth'
)
def check_resource_file_name(file_path):
""" Check that resource file names use hyphens rather than underscores. """
if '_' in file_path.split('/')[-1]:
log_error(
file_path,
0,
"the resource file should have hyphens rather than underscores",
'resource-file-name'
)
@sphinxlint.checker('')
def check_file_extensions(file, lines, options=None):