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

refactored private vars in PhotoInfo

Browse Source
This commit is contained in:
Rhet Turnbull
2019-12-09 21:45:50 -08:00
parent 911804317b
commit d5a5bd41b3
1 changed files with 48 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
osxphotos/__init__.py
View File

@@ -27,7 +27,6 @@ from ._version import __version__
# TODO: Fix command line so multiple --keyword, etc. are AND (instead of OR as they are in .photos()) # TODO: Fix command line so multiple --keyword, etc. are AND (instead of OR as they are in .photos())
# Or fix the help text to match behavior # Or fix the help text to match behavior
# TODO: Add test for __str__ and to_json # TODO: Add test for __str__ and to_json
# TODO: standardize _ and __ as leading char for private variables
# TODO: fix docstrings # TODO: fix docstrings
# TODO: Add special albums and magic albums # TODO: Add special albums and magic albums
@@ -1256,23 +1255,23 @@ class PhotoInfo:
""" """
def __init__(self, db=None, uuid=None, info=None): def __init__(self, db=None, uuid=None, info=None):
self.__uuid = uuid self._uuid = uuid
self.__info = info self._info = info
self.__db = db self._db = db
def filename(self): def filename(self):
""" filename of the picture """ """ filename of the picture """
return self.__info["filename"] return self._info["filename"]
def original_filename(self): def original_filename(self):
""" original filename of the picture """ """ original filename of the picture """
""" Photos 5 mangles filenames upon import """ """ Photos 5 mangles filenames upon import """
return self.__info["originalFilename"] return self._info["originalFilename"]
def date(self): def date(self):
""" image creation date as timezone aware datetime object """ """ image creation date as timezone aware datetime object """
imagedate = self.__info["imageDate"] imagedate = self._info["imageDate"]
seconds = self.__info["imageTimeZoneOffsetSeconds"] or 0 seconds = self._info["imageTimeZoneOffsetSeconds"] or 0
delta = timedelta(seconds=seconds) delta = timedelta(seconds=seconds)
tz = timezone(delta) tz = timezone(delta)
imagedate_utc = imagedate.astimezone(tz=tz) imagedate_utc = imagedate.astimezone(tz=tz)
@@ -1280,43 +1279,43 @@ class PhotoInfo:
def tzoffset(self): def tzoffset(self):
""" timezone offset from UTC in seconds """ """ timezone offset from UTC in seconds """
return self.__info["imageTimeZoneOffsetSeconds"] return self._info["imageTimeZoneOffsetSeconds"]
def path(self): def path(self):
""" absolute path on disk of the original picture """ """ absolute path on disk of the original picture """
photopath = "" photopath = ""
if self.__db._db_version < _PHOTOS_5_VERSION: if self._db._db_version < _PHOTOS_5_VERSION:
vol = self.__info["volume"] vol = self._info["volume"]
if vol is not None: if vol is not None:
photopath = os.path.join("/Volumes", vol, self.__info["imagePath"]) photopath = os.path.join("/Volumes", vol, self._info["imagePath"])
else: else:
photopath = os.path.join( photopath = os.path.join(
self.__db._masters_path, self.__info["imagePath"] self._db._masters_path, self._info["imagePath"]
) )
if self.__info["isMissing"] == 1: if self._info["isMissing"] == 1:
photopath = None # path would be meaningless until downloaded photopath = None # path would be meaningless until downloaded
# TODO: Is there a way to use applescript or PhotoKit to force the download in this # TODO: Is there a way to use applescript or PhotoKit to force the download in this
else: else:
if self.__info["masterFingerprint"]: if self._info["masterFingerprint"]:
# if masterFingerprint is not null, path appears to be valid # if masterFingerprint is not null, path appears to be valid
if self.__info["directory"].startswith("/"): if self._info["directory"].startswith("/"):
photopath = os.path.join( photopath = os.path.join(
self.__info["directory"], self.__info["filename"] self._info["directory"], self._info["filename"]
) )
else: else:
photopath = os.path.join( photopath = os.path.join(
self.__db._masters_path, self._db._masters_path,
self.__info["directory"], self._info["directory"],
self.__info["filename"], self._info["filename"],
) )
else: else:
photopath = None photopath = None
logging.debug(f"WARNING: masterFingerprint null {pformat(self.__info)}") logging.debug(f"WARNING: masterFingerprint null {pformat(self._info)}")
# TODO: fix the logic for isMissing # TODO: fix the logic for isMissing
if self.__info["isMissing"] == 1: if self._info["isMissing"] == 1:
photopath = None # path would be meaningless until downloaded photopath = None # path would be meaningless until downloaded
logging.debug(photopath) logging.debug(photopath)
@@ -1328,11 +1327,11 @@ class PhotoInfo:
""" None if photo has not been edited """ """ None if photo has not been edited """
photopath = "" photopath = ""
if self.__db._db_version < _PHOTOS_5_VERSION: if self._db._db_version < _PHOTOS_5_VERSION:
if self.__info["hasAdjustments"]: if self._info["hasAdjustments"]:
edit_id = self.__info["edit_resource_id"] edit_id = self._info["edit_resource_id"]
if edit_id is not None: if edit_id is not None:
library = self.__db._library_path library = self._db._library_path
folder_id, file_id = _get_resource_loc(edit_id) folder_id, file_id = _get_resource_loc(edit_id)
# todo: is this always true or do we need to search file file_id under folder_id # todo: is this always true or do we need to search file file_id under folder_id
photopath = os.path.join( photopath = os.path.join(
@@ -1346,7 +1345,7 @@ class PhotoInfo:
) )
if not os.path.isfile(photopath): if not os.path.isfile(photopath):
logging.warning( logging.warning(
f"edited file for UUID {self.__uuid} should be at {photopath} but does not appear to exist" f"edited file for UUID {self._uuid} should be at {photopath} but does not appear to exist"
) )
photopath = None photopath = None
else: else:
@@ -1356,7 +1355,7 @@ class PhotoInfo:
else: else:
photopath = None photopath = None
# if self.__info["isMissing"] == 1: # if self._info["isMissing"] == 1:
# photopath = None # path would be meaningless until downloaded # photopath = None # path would be meaningless until downloaded
else: else:
# in Photos 5.0 / Catalina / MacOS 10.15: # in Photos 5.0 / Catalina / MacOS 10.15:
@@ -1368,27 +1367,27 @@ class PhotoInfo:
# where original format was not jpg/jpeg # where original format was not jpg/jpeg
# if more than one edit, previous edit is stored as UUID_p.jpeg # if more than one edit, previous edit is stored as UUID_p.jpeg
if self.__info["hasAdjustments"]: if self._info["hasAdjustments"]:
library = self.__db._library_path library = self._db._library_path
directory = self.__uuid[0] # first char of uuid directory = self._uuid[0] # first char of uuid
photopath = os.path.join( photopath = os.path.join(
library, library,
"resources", "resources",
"renders", "renders",
directory, directory,
f"{self.__uuid}_1_201_a.jpeg", f"{self._uuid}_1_201_a.jpeg",
) )
if not os.path.isfile(photopath): if not os.path.isfile(photopath):
logging.warning( logging.warning(
f"edited file for UUID {self.__uuid} should be at {photopath} but does not appear to exist" f"edited file for UUID {self._uuid} should be at {photopath} but does not appear to exist"
) )
photopath = None photopath = None
else: else:
photopath = None photopath = None
# TODO: might be possible for original/master to be missing but edit to still be there # TODO: might be possible for original/master to be missing but edit to still be there
# if self.__info["isMissing"] == 1: # if self._info["isMissing"] == 1:
# photopath = None # path would be meaningless until downloaded # photopath = None # path would be meaningless until downloaded
logging.debug(photopath) logging.debug(photopath)
@@ -1397,30 +1396,30 @@ class PhotoInfo:
def description(self): def description(self):
""" long / extended description of picture """ """ long / extended description of picture """
return self.__info["extendedDescription"] return self._info["extendedDescription"]
def persons(self): def persons(self):
""" list of persons in picture """ """ list of persons in picture """
return self.__info["persons"] return self._info["persons"]
def albums(self): def albums(self):
""" list of albums picture is contained in """ """ list of albums picture is contained in """
albums = [] albums = []
for album in self.__info["albums"]: for album in self._info["albums"]:
albums.append(self.__db._dbalbum_details[album]["title"]) albums.append(self._db._dbalbum_details[album]["title"])
return albums return albums
def keywords(self): def keywords(self):
""" list of keywords for picture """ """ list of keywords for picture """
return self.__info["keywords"] return self._info["keywords"]
def name(self): def name(self):
""" name / title of picture """ """ name / title of picture """
return self.__info["name"] return self._info["name"]
def uuid(self): def uuid(self):
""" UUID of picture """ """ UUID of picture """
return self.__uuid return self._uuid
def ismissing(self): def ismissing(self):
""" returns true if photo is missing from disk (which means it's not been downloaded from iCloud) """ returns true if photo is missing from disk (which means it's not been downloaded from iCloud)
@@ -1432,27 +1431,27 @@ class PhotoInfo:
downloaded from cloud to local storate their status in the database might still show downloaded from cloud to local storate their status in the database might still show
isMissing = 1 isMissing = 1
""" """
return True if self.__info["isMissing"] == 1 else False return True if self._info["isMissing"] == 1 else False
def hasadjustments(self): def hasadjustments(self):
""" True if picture has adjustments / edits """ """ True if picture has adjustments / edits """
return True if self.__info["hasAdjustments"] == 1 else False return True if self._info["hasAdjustments"] == 1 else False
def external_edit(self): def external_edit(self):
""" Returns True if picture was edited outside of Photos using external editor """ """ Returns True if picture was edited outside of Photos using external editor """
return ( return (
True True
if self.__info["adjustmentFormatID"] == "com.apple.Photos.externalEdit" if self._info["adjustmentFormatID"] == "com.apple.Photos.externalEdit"
else False else False
) )
def favorite(self): def favorite(self):
""" True if picture is marked as favorite """ """ True if picture is marked as favorite """
return True if self.__info["favorite"] == 1 else False return True if self._info["favorite"] == 1 else False
def hidden(self): def hidden(self):
""" True if picture is hidden """ """ True if picture is hidden """
return True if self.__info["hidden"] == 1 else False return True if self._info["hidden"] == 1 else False
def location(self): def location(self):
""" returns (latitude, longitude) as float in degrees or None """ """ returns (latitude, longitude) as float in degrees or None """
@@ -1460,15 +1459,15 @@ class PhotoInfo:
def _longitude(self): def _longitude(self):
""" Returns longitude, in degrees """ """ Returns longitude, in degrees """
return self.__info["longitude"] return self._info["longitude"]
def _latitude(self): def _latitude(self):
""" Returns latitude, in degrees """ """ Returns latitude, in degrees """
return self.__info["latitude"] return self._info["latitude"]
def __repr__(self): def __repr__(self):
# TODO: update to use __class__ and __name__ # TODO: update to use __class__ and __name__
return f"osxphotos.PhotoInfo(db={self.__db}, uuid='{self.__uuid}', info={self.__info})" return f"osxphotos.PhotoInfo(db={self._db}, uuid='{self._uuid}', info={self._info})"
def __str__(self): def __str__(self):
info = { info = {