adds different ways of naming the downloaded files

Author: beaufour

flickr_download/filename_handlers.py

@@ -0,0 +1,79 @@
+"""
+Defines a set of functions that handle naming of the downloaded files.
+"""
+
+from collections import defaultdict
+
+
+def title(pset, photo, suffix):
+    """
+    Name file after title.
+
+    @param pset: Flickr.Photoset, the photoset
+    @param photo: Flickr.Photo, the photo
+    @param suffice: str, optional suffix
+    @return: str, the filename
+    """
+    return '{0}{1}.jpg'.format(photo.title, suffix)
+
+
+def idd(pset, photo, suffix):
+    """
+    Name file after id
+
+    @param pset: Flickr.Photoset, the photoset
+    @param photo: Flickr.Photo, the photo
+    @param suffice: str, optional suffix
+    @return: str, the filename
+    """
+    return '{0}{1}.jpg'.format(photo.id, suffix)
+
+
+def title_and_id(pset, photo, suffix):
+    """
+    Name file after title and photo id
+
+    @param pset: Flickr.Photoset, the photoset
+    @param photo: Flickr.Photo, the photo
+    @param suffice: str, optional suffix
+    @return: str, the filename
+    """
+    return '{0}-{1}{2}.jpg'.format(photo.title, photo.id, suffix)
+
+
+INCREMENT_INDEX = defaultdict(lambda: defaultdict(int))
+"""Photoset -> filename index for title_increment function duplicate tracking"""
+
+
+def title_increment(pset, photo, suffix):
+    """
+    Name file after photo title, but add an incrementing counter on duplicates
+
+    @param pset: Flickr.Photoset, the photoset
+    @param photo: Flickr.Photo, the photo
+    @param suffice: str, optional suffix
+    @return: str, the filename
+    """
+    extra = ''
+    photo_index = INCREMENT_INDEX[pset.id][photo.title]
+    if photo_index:
+        extra = '({0})'.format(photo_index)
+    INCREMENT_INDEX[pset.id][photo.title] += 1
+    return '{0}{1}{2}.jpg'.format(photo.title, suffix, extra)
+
+
+HANDLERS = {
+    'title': title,
+    'id': idd,
+    'title_and_id': title_and_id,
+    'title_increment': title_increment,
+}
+
+
+def get_filename_handler(name='title'):
+    """
+    Returns the given filename handler as a function
+    @param name: str, name of the handler to return
+    @return: Function, handler
+    """
+    return HANDLERS[name]

flickr_download/flick_download.py

@@ -17,6 +17,8 @@
 from dateutil import parser
 import yaml
 
+from flickr_download.filename_handlers import get_filename_handler
+
 CONFIG_FILE = "~/.flickr_download"
 OAUTH_TOKEN_FILE = "~/.flickr_token"
 
@@ -77,23 +79,12 @@ def _load_defaults():
     return {}
 
 
-def get_filename(pset, photo, suffix):
-    """
-    Create the filename to use for a given photo.
-
-    @param pset: Flickr.Photoset, the photoset
-    @param photo: Flickr.Photo, the photo
-    @param suffice: str, optional suffix
-    @return: str, the filename
-    """
-    return '{0}{1}.jpg'.format(photo.title, suffix)
-
-
-def download_set(set_id, size_label=None):
+def download_set(set_id, get_filename, size_label=None):
     """
     Download the set with 'set_id' to the current directory.
 
     @param set_id: str, id of the photo set
+    @param get_filename: Function, function that creates a filename for the photo
     @param size_label: str|None, size to download (or None for largest available)
     """
     suffix = " ({})".format(size_label) if size_label else ""
@@ -157,6 +148,8 @@ def main():
                         help='Download the given set')
     parser.add_argument('-q', '--quality', type=str, metavar='SIZE_LABEL',
                         default=None, help='Quality of the picture')
+    parser.add_argument('-n', '--naming', type=str, metavar='NAMING_MODE',
+                        default='title', help='Photo naming mode')
     parser.set_defaults(**_load_defaults())
 
     args = parser.parse_args()
@@ -173,7 +166,8 @@ def main():
         print_sets(args.list)
     elif args.download:
         try:
-            download_set(args.download, args.quality)
+            get_filename = get_filename_handler(args.naming)
+            download_set(args.download, get_filename, args.quality)
         except KeyboardInterrupt:
             print >> sys.stderr, 'Forcefully aborting. Last photo download might be partial :('
     else: