forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Template refactor (#385)

Browse Source 
* Initial implementation of new textx parser for template

* Implemented parser as singleton

* Moved grammar to .tx file

* Added filter templates

* Added filter templates

* Added tests for nested templates

* Added tests for filter+path_sep

* Added tests for filter+path_sep

* Added punctuation templates

* Added hook for --replace-keywords

* Updated docs for phototemplate

* Updated docs for phototemplate

* Updated tests data

* Updated tests data

* Updated docs for phototemplate

* Version bump

* Updated CLI help

* Fixed template processing for boolean, default
This commit is contained in:
Rhet Turnbull
2021-02-21 20:19:51 -08:00
committed by GitHub
parent 63bfa92563
commit 515df0a5dc
32 changed files with 1203 additions and 857 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
tests/photoinfo_mock.py Normal file
View File

@@ -0,0 +1,48 @@
"""Selectively mock a PhotoInfo object"""
from osxphotos import PhotoInfo
class PhotoInfoMock(PhotoInfo):
def __init__(self, photo, **kwargs):
self._photo = photo
self._db = photo._db
self._info = photo._info
for kw in kwargs:
if hasattr(photo, kw):
setattr(self, f"_mock_{kw}", kwargs[kw])
else:
raise ValueError(f"Not a PhotoInfo attribute: {kw}")
@property
def hdr(self):
return (
self._mock_hdr
if getattr(self, "_mock_hdr", None) is not None
else self._photo.hdr
)
@property
def hasadjustments(self):
return (
self._mock_hasadjustments
if getattr(self, "_mock_hasadjustments", None) is not None
else self._photo.hasadjustments
)
@property
def keywords(self):
return (
self._mock_keywords
if getattr(self, "_mock_keywords", None) is not None
else self._photo.keywords
)
@property
def title(self):
return (
self._mock_title
if getattr(self, "_mock_title", None) is not None
else self._photo.title
)

2
tests/search_info_test_data_10_15_7.json
View File

File diff suppressed because one or more lines are too long

163
tests/test_template.py
View File

@@ -3,6 +3,8 @@ import pytest
import osxphotos
from osxphotos.exiftool import get_exiftool_path
from photoinfo_mock import PhotoInfoMock
try:
exiftool = get_exiftool_path()
except:
@@ -45,15 +47,36 @@ UUID_MEDIA_TYPE = {
UUID_MULTI_KEYWORDS = "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4"
TEMPLATE_VALUES_MULTI_KEYWORDS = {
"{keyword}": ["flowers", "wedding"],
"{keyword|parens}": ["(flowers)", "(wedding)"],
"{keyword|braces}": ["{flowers}", "{wedding}"],
"{keyword|brackets}": ["[flowers]", "[wedding]"],
"{keyword|parens|brackets|capitalize}": ["[(flowers)]", "[(wedding)]"],
"{keyword|capitalize|parens|brackets}": ["[(Flowers)]", "[(Wedding)]"],
"{keyword|upper}": ["FLOWERS", "WEDDING"],
"{keyword|lower}": ["flowers", "wedding"],
"{keyword|titlecase}": ["Flowers", "Wedding"],
"{keyword|capitalize}": ["Flowers", "Wedding"],
"{+keyword}": ["flowerswedding"],
"{+keyword|titlecase}": ["Flowerswedding"],
"{+keyword|capitalize}": ["Flowerswedding"],
"{;+keyword}": ["flowers;wedding"],
"{; +keyword}": ["flowers; wedding"],
"{; +keyword|titlecase}": ["Flowers; Wedding"],
"{; +keyword|titlecase|parens}": ["(Flowers; Wedding)"],
}
UUID_TITLE = "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4"
TEMPLATE_VALUES_TITLE = {
"{title}": ["Tulips tied together at a flower shop"],
"{title|titlecase}": ["Tulips Tied Together At A Flower Shop"],
"{title|upper}": ["TULIPS TIED TOGETHER AT A FLOWER SHOP"],
"{title|titlecase|lower|upper}": ["TULIPS TIED TOGETHER AT A FLOWER SHOP"],
"{title|upper|titlecase}": ["Tulips Tied Together At A Flower Shop"],
"{title|capitalize}": ["Tulips tied together at a flower shop"],
"{title[ ,_]}": ["Tulips_tied_together_at_a_flower_shop"],
"{title[ ,_|e,]}": ["Tulips_tid_togthr_at_a_flowr_shop"],
"{title[ ,|e,]}": ["Tulipstidtogthrataflowrshop"],
"{title[e,]}": ["Tulips tid togthr at a flowr shop"],
"{+title}": ["Tulips tied together at a flower shop"],
"{,+title}": ["Tulips tied together at a flower shop"],
"{, +title}": ["Tulips tied together at a flower shop"],
@@ -98,6 +121,14 @@ UUID_EXIFTOOL = {
"UK",
"United_Kingdom",
],
"{exiftool:IPTC:Keywords[ ,_|.,|L,]}": [
"England",
"ondon",
"ondon_2018",
"St_James's_Park",
"UK",
"United_Kingdom",
],
"{,+exiftool:IPTC:Keywords}": [
"England,London,London 2018,St. James's Park,UK,United Kingdom"
],
@@ -140,6 +171,8 @@ TEMPLATE_VALUES = {
"{exif.camera_make}": "Apple",
"{exif.camera_model}": "iPhone 6s",
"{exif.lens_model}": "iPhone 6s back camera 4.15mm f/2.2",
"{album?{folder_album},{created.year}/{created.mm}}": "2020/02",
"{title?Title is '{title} - {descr}',No Title}": "Title is 'Glen Ord - Jack Rose Dining Saloon'",
}
@@ -271,9 +304,10 @@ def test_lookup_multi(photosdb_places):
for subst in TEMPLATE_SUBSTITUTIONS_MULTI_VALUED:
lookup_str = re.match(r"\{([^\\,}]+)\}", subst).group(1)
if subst == "{exiftool}":
continue
lookup = template.get_template_value_multi(lookup_str, path_sep=os.path.sep)
assert isinstance(lookup, list)
assert len(lookup) >= 1
def test_subst(photosdb_places):
@@ -382,19 +416,19 @@ def test_subst_unknown_val(photosdb_places):
template = "{created.year}/{foo}"
rendered, unknown = photo.render_template(template)
assert rendered[0] == "2020/{foo}"
# assert rendered[0] == "2020/{foo}"
assert unknown == ["foo"]
def test_subst_double_brace(photosdb_places):
""" Test substitution with double brace {{ which should be ignored """
# def test_subst_double_brace(photosdb_places):
# """ Test substitution with double brace {{ which should be ignored """
photo = photosdb_places.photos(uuid=[UUID_DICT["place_dc"]])[0]
# photo = photosdb_places.photos(uuid=[UUID_DICT["place_dc"]])[0]
template = "{created.year}/{{foo}}"
rendered, unknown = photo.render_template(template)
assert rendered[0] == "2020/{foo}"
assert not unknown
# template = "{created.year}/{{foo}}"
# rendered, unknown = photo.render_template(template)
# assert rendered[0] == "2020/{foo}"
# assert not unknown
def test_subst_unknown_val_with_default(photosdb_places):
@@ -406,7 +440,7 @@ def test_subst_unknown_val_with_default(photosdb_places):
template = "{created.year}/{foo,bar}"
rendered, unknown = photo.render_template(template)
assert rendered[0] == "2020/{foo,bar}"
# assert rendered[0] == "2020/{foo,bar}"
assert unknown == ["foo"]
@@ -496,16 +530,14 @@ def test_subst_multi_0_2_0_default_val_unknown_val(photosdb):
# one album, one keyword, two persons
photo = photosdb.photos(uuid=[UUID_DICT["0_2_0"]])[0]
template = (
"{created.year}/{album,NOALBUM}/{keyword,NOKEYWORD}/{person}/{foo}/{{baz}}"
)
template = "{created.year}/{album,NOALBUM}/{keyword,NOKEYWORD}/{person}/{foo}/{baz}"
expected = [
"2019/NOALBUM/wedding/_/{foo}/{baz}",
"2019/NOALBUM/flowers/_/{foo}/{baz}",
]
rendered, unknown = photo.render_template(template)
assert sorted(rendered) == sorted(expected)
assert unknown == ["foo"]
# assert sorted(rendered) == sorted(expected)
assert unknown == ["foo", "baz"]
def test_subst_multi_0_2_0_default_val_unknown_val_2(photosdb):
@@ -515,14 +547,14 @@ def test_subst_multi_0_2_0_default_val_unknown_val_2(photosdb):
# one album, one keyword, two persons
photo = photosdb.photos(uuid=[UUID_DICT["0_2_0"]])[0]
template = "{created.year}/{album,NOALBUM}/{keyword,NOKEYWORD}/{person}/{foo,bar}/{{baz,bar}}"
template = "{created.year}/{album,NOALBUM}/{keyword,NOKEYWORD}/{person}/{foo,bar}/{baz,bar}"
expected = [
"2019/NOALBUM/wedding/_/{foo,bar}/{baz,bar}",
"2019/NOALBUM/flowers/_/{foo,bar}/{baz,bar}",
]
rendered, unknown = photo.render_template(template)
assert sorted(rendered) == sorted(expected)
assert unknown == ["foo"]
# assert sorted(rendered) == sorted(expected)
assert unknown == ["foo", "baz"]
def test_subst_multi_folder_albums_1(photosdb):
@@ -557,6 +589,22 @@ def test_subst_multi_folder_albums_1_path_sep(photosdb):
assert unknown == []
def test_subst_multi_folder_albums_1_path_sep_lower(photosdb):
""" Test substitutions for folder_album are correct with custom PATH_SEP """
# photo in an album in a folder
photo = photosdb.photos(uuid=[UUID_DICT["folder_album_1"]])[0]
template = "{folder_album|lower(:)}"
expected = [
"2018-10 - sponsion, museum, frühstück, römermuseum",
"2019-10/11 paris clermont",
"folder1:subfolder2:albuminfolder",
]
rendered, unknown = photo.render_template(template)
assert sorted(rendered) == sorted(expected)
assert unknown == []
def test_subst_multi_folder_albums_2(photosdb):
""" Test substitutions for folder_album are correct """
@@ -599,8 +647,21 @@ def test_subst_multi_folder_albums_3_path_sep(photosdb_14_6):
# photo in an album in a folder
photo = photosdb_14_6.photos(uuid=[UUID_DICT["mojave_album_1"]])[0]
template = "{folder_album(:)}"
expected = ["Folder1:SubFolder2:AlbumInFolder", "Pumpkin Farm", "Test Album (1)"]
template = "{folder_album(>)}"
expected = ["Folder1>SubFolder2>AlbumInFolder", "Pumpkin Farm", "Test Album (1)"]
rendered, unknown = photo.render_template(template)
assert sorted(rendered) == sorted(expected)
assert unknown == []
def test_subst_multi_folder_albums_4_path_sep_lower(photosdb_14_6):
""" Test substitutions for folder_album on < Photos 5 with custom PATH_SEP """
import osxphotos
# photo in an album in a folder
photo = photosdb_14_6.photos(uuid=[UUID_DICT["mojave_album_1"]])[0]
template = "{folder_album|lower(>)}"
expected = ["folder1>subfolder2>albuminfolder", "pumpkin farm", "test album (1)"]
rendered, unknown = photo.render_template(template)
assert sorted(rendered) == sorted(expected)
assert unknown == []
@@ -712,13 +773,13 @@ def test_partial_match(photosdb_cloud):
for uuid in COMMENT_UUID_DICT:
photo = photosdb_cloud.get_photo(uuid)
rendered, notmatched = photo.render_template("{keywords}")
assert [rendered, notmatched] == [["{keywords}"], ["keywords"]]
assert [rendered, notmatched] == [[], ["keywords"]]
rendered, notmatched = photo.render_template("{keywords,}")
assert [rendered, notmatched] == [["{keywords,}"], ["keywords"]]
assert [rendered, notmatched] == [[], ["keywords"]]
rendered, notmatched = photo.render_template("{keywords,foo}")
assert [rendered, notmatched] == [["{keywords,foo}"], ["keywords"]]
assert [rendered, notmatched] == [[], ["keywords"]]
rendered, notmatched = photo.render_template("{,+keywords,foo}")
assert [rendered, notmatched] == [["{,+keywords,foo}"], ["keywords"]]
assert [rendered, notmatched] == [[], ["keywords"]]
def test_expand_in_place_with_delim(photosdb):
@@ -750,3 +811,57 @@ def test_exiftool_template(photosdb):
rendered, _ = photo.render_template(template)
assert sorted(rendered) == sorted(UUID_EXIFTOOL[uuid][template])
def test_hdr(photosdb):
""" Test hdr """
photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
photomock = PhotoInfoMock(photo, hdr="hdr")
rendered, _ = photomock.render_template("{hdr}")
assert rendered == ["hdr"]
def test_edited(photosdb):
""" Test edited """
photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
photomock = PhotoInfoMock(photo, hasadjustments=True)
rendered, _ = photomock.render_template("{edited}")
assert rendered == ["edited"]
def test_nested_template_bool(photosdb):
photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
template = "{hdr?{edited?HDR_EDITED,HDR_NOT_EDITED},{edited?NOT_HDR_EDITED,NOT_HDR_NOT_EDITED}}"
photomock = PhotoInfoMock(photo, hdr=True, hasadjustments=True)
rendered, _ = photomock.render_template(template)
assert rendered == ["HDR_EDITED"]
photomock = PhotoInfoMock(photo, hdr=True, hasadjustments=False)
rendered, _ = photomock.render_template(template)
assert rendered == ["HDR_NOT_EDITED"]
photomock = PhotoInfoMock(photo, hdr=False, hasadjustments=False)
rendered, _ = photomock.render_template(template)
assert rendered == ["NOT_HDR_NOT_EDITED"]
photomock = PhotoInfoMock(photo, hdr=False, hasadjustments=True)
rendered, _ = photomock.render_template(template)
assert rendered == ["NOT_HDR_EDITED"]
def test_nested_template(photosdb):
photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
photomock = PhotoInfoMock(photo, keywords=[], title="My Title")
rendered, _ = photomock.render_template("{keyword,{title}}")
assert rendered == ["My Title"]
def test_punctuation(photosdb):
from osxphotos.phototemplate import PUNCTUATION
photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
for punc in PUNCTUATION:
rendered, _ = photo.render_template("{" + punc + "}")
assert rendered[0] == PUNCTUATION[punc]