Mainly adhere to PEP 8 code style (http://www.python.org/dev/peps/pep-0008/)

Add some commented code for working on Panel view enhancement and natural sorting.

kcc/comic2ebook.py

@@ -21,13 +21,29 @@ __license__   = 'ISC'
 __copyright__ = '2012-2013, Ciro Mattia Gonano <ciromattia@gmail.com>'
 __docformat__ = 'restructuredtext en'
 
-import os, sys, tempfile
+import os
-from shutil import move,copyfile,copytree,rmtree,make_archive
+import sys
+import tempfile
+import re
+from shutil import move
+from shutil import copyfile
+from shutil import copytree
+from shutil import rmtree
+from shutil import make_archive
 from optparse import OptionParser
-import image, cbxarchive, pdfjpgextract
+import image
+import cbxarchive
+import pdfjpgextract
 
-def buildHTML(path,file):
+
-    filename = getImageFileName(file)
+def sort_nicely(l):
+    convert = lambda text: int(text) if text.isdigit() else text
+    alphanum_key = lambda key: [convert(c) for c in re.split('([0-9]+)', key)]
+    l.sort(key=alphanum_key)
+
+
+def buildHTML(path, imgfile):
+    filename = getImageFileName(imgfile)
     if filename is not None:
         htmlpath = ''
         postfix = ''
@@ -44,25 +60,39 @@ def buildHTML(path,file):
             os.makedirs(htmlpath)
         htmlfile = os.path.join(htmlpath, filename[0] + '.html')
         f = open(htmlfile, "w")
-        f.writelines(["<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">\n",
+        f.writelines(["<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" ",
+                      "\"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">\n",
                       "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n",
                       "<head>\n",
                       "<title>", filename[0], "</title>\n",
                       "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>\n",
                       "</head>\n",
                       "<body>\n",
-                      "<div><img src=\"","../" * backref,"Images/",postfix,file,"\" alt=\"",file,"\" /></div>\n",
+                      "<div><img src=\"../" * backref, "Images/", postfix, imgfile, "\" alt=\"",
+                      imgfile, "\" class=\"singlePage\"/></div>\n",
+                      #"<div id=\"", filename[0], "-1\">\n",
+                      #"<a class=\"app-amzn-magnify\" data-app-amzn-magnify='{\"targetId\":\"", filename[0],
+                      #"-1-magTargetParent\", \"ordinal\":1}'></a>\n",
+                      #"</div>\n",
+                      #"<div id=\"", filename[0], "-1-magTargetParent\" class=\"target-mag-parent\">\n",
+                      #"<div class=\"target-mag-lb\">\n",
+                      #"</div>\n",
+                      #"<div id=\"", filename[0], "-1-magTarget\" class=\"target-mag\">\n",
+                      #"<img src=\"../" * backref, "Images/", postfix, imgfile, "\" alt=\"", imgfile, "\"/>\n",
+                      #"</div></div>\n",
                       "</body>\n",
                       "</html>"
                       ])
         f.close()
-        return path,file
+        return path, imgfile
+
 
 def buildNCX(dstdir, title, chapters):
     ncxfile = os.path.join(dstdir, 'OEBPS', 'toc.ncx')
     f = open(ncxfile, "w")
     f.writelines(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n",
-        "<!DOCTYPE ncx PUBLIC \"-//NISO//DTD ncx 2005-1//EN\" \"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">\n",
+                  "<!DOCTYPE ncx PUBLIC \"-//NISO//DTD ncx 2005-1//EN\" ",
+                  "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">\n",
                   "<ncx version=\"2005-1\" xml:lang=\"en-US\" xmlns=\"http://www.daisy.org/z3986/2005/ncx/\">\n",
                   "<head>\n",
                   "<meta name=\"dtb:uid\" content=\"015ffaec-9340-42f8-b163-a0c5ab7d0611\"/>\n",
@@ -83,6 +113,7 @@ def buildNCX(dstdir, title, chapters):
     f.close()
     return
 
+
 def buildOPF(profile, dstdir, title, filelist, cover=None, righttoleft=False):
     opffile = os.path.join(dstdir, 'OEBPS', 'content.opf')
     # read the first file resolution
@@ -95,10 +126,13 @@ def buildOPF(profile, dstdir, title, filelist, cover=None, righttoleft=False):
     f = open(opffile, "w")
     f.writelines(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n",
                   "<package version=\"2.0\" unique-identifier=\"BookID\" xmlns=\"http://www.idpf.org/2007/opf\">\n",
-        "<metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:opf=\"http://www.idpf.org/2007/opf\">\n",
+                  "<metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\" ",
+                  "xmlns:opf=\"http://www.idpf.org/2007/opf\">\n",
                   "<dc:title>", title, "</dc:title>\n",
                   "<dc:language>en-US</dc:language>\n",
-        "<dc:identifier id=\"BookID\" opf:scheme=\"UUID\">015ffaec-9340-42f8-b163-a0c5ab7d0611</dc:identifier>\n",
+                  "<dc:identifier id=\"BookID\" opf:scheme=\"UUID\">",
+                  "015ffaec-9340-42f8-b163-a0c5ab7d0611</dc:identifier>\n",
+                  "<meta name=\"RegionMagnification\" content=\"true\"/>\n",
                   "<meta name=\"cover\" content=\"cover\"/>\n",
                   "<meta name=\"book-type\" content=\"comic\"/>\n",
                   "<meta name=\"zero-gutter\" content=\"true\"/>\n",
@@ -107,7 +141,8 @@ def buildOPF(profile, dstdir, title, filelist, cover=None, righttoleft=False):
                   "<meta name=\"orientation-lock\" content=\"portrait\"/>\n",
                   "<meta name=\"original-resolution\" content=\"" + imgres + "\"/>\n",
                   "<meta name=\"primary-writing-mode\" content=\"" + writingmode + "\"/>\n",
-        "</metadata>\n<manifest>\n<item id=\"ncx\" href=\"toc.ncx\" media-type=\"application/x-dtbncx+xml\"/>\n"
+                  "</metadata>\n<manifest>\n<item id=\"ncx\" href=\"toc.ncx\" ",
+                  "media-type=\"application/x-dtbncx+xml\"/>\n"
                   ])
     # set cover
     if cover is not None:
@@ -123,13 +158,15 @@ def buildOPF(profile, dstdir, title, filelist, cover=None, righttoleft=False):
         filename = getImageFileName(path[1])
         uniqueid = os.path.join(folder, filename[0]).replace('/', '_')
         reflist.append(uniqueid)
-        f.write("<item id=\"page_" + uniqueid + "\" href=\"" + os.path.join(folder.replace('Images','Text'),filename[0])
+        f.write("<item id=\"page_" + uniqueid + "\" href=\""
+                + os.path.join(folder.replace('Images', 'Text'), filename[0])
                 + ".html\" media-type=\"application/xhtml+xml\"/>\n")
         if '.png' == filename[1]:
             mt = 'image/png'
         else:
             mt = 'image/jpeg'
-        f.write("<item id=\"img_" + uniqueid + "\" href=\"" + os.path.join(folder,path[1]) + "\" media-type=\"" + mt + "\"/>\n")
+        f.write("<item id=\"img_" + uniqueid + "\" href=\"" + os.path.join(folder, path[1]) + "\" media-type=\""
+                + mt + "\"/>\n")
     f.write("</manifest>\n<spine toc=\"ncx\">\n")
     for entry in reflist:
         f.write("<itemref idref=\"page_" + entry + "\" />\n")
@@ -150,20 +187,26 @@ def buildOPF(profile, dstdir, title, filelist, cover=None, righttoleft=False):
     f.close()
     return
 
-def getImageFileName(file):
+
-    filename = os.path.splitext(file)
+def getImageFileName(imgfile):
-    if filename[0].startswith('.') or (filename[1].lower() != '.png' and filename[1].lower() != '.jpg' and filename[1].lower() != '.jpeg'):
+    filename = os.path.splitext(imgfile)
+    if filename[0].startswith('.') or\
+            (filename[1].lower() != '.png' and
+             filename[1].lower() != '.jpg' and
+             filename[1].lower() != '.jpeg'):
         return None
     return filename
 
-def isInFilelist(file,list):
+
-    filename = os.path.splitext(file)
+def isInFilelist(filename, filelist):
+    filename = os.path.splitext(filename)
     seen = False
-    for item in list:
+    for item in filelist:
         if filename[0] == item[0]:
             seen = True
     return seen
 
+
 def applyImgOptimization(img):
     img.optimizeImage()
     img.cropWhiteSpace(10.0)
@@ -177,17 +220,17 @@ def dirImgProcess(path):
     global options
 
     for (dirpath, dirnames, filenames) in os.walk(path):
-        for file in filenames:
+        for afile in filenames:
-            if getImageFileName(file) is not None:
+            if getImageFileName(afile) is not None:
                 if options.verbose:
-                    print "Optimizing " + file + " for " + options.profile
+                    print "Optimizing " + afile + " for " + options.profile
                 else:
                     print ".",
-                img = image.ComicPage(os.path.join(dirpath,file), options.profile)
+                img = image.ComicPage(os.path.join(dirpath, afile), options.profile)
                 split = img.splitPage(dirpath, options.righttoleft)
                 if split is not None:
                     if options.verbose:
-                        print "Splitted " + file
+                        print "Splitted " + afile
                     img0 = image.ComicPage(split[0], options.profile)
                     applyImgOptimization(img0)
                     img0.saveToDir(dirpath)
@@ -198,6 +241,7 @@ def dirImgProcess(path):
                     applyImgOptimization(img)
                     img.saveToDir(dirpath)
 
+
 def genEpubStruct(path):
     global options
     filelist = []
@@ -206,18 +250,18 @@ def genEpubStruct(path):
     os.mkdir(os.path.join(path, 'OEBPS', 'Text'))
     for (dirpath, dirnames, filenames) in os.walk(os.path.join(path, 'OEBPS', 'Images')):
         chapter = False
-        for file in filenames:
+        for afile in filenames:
-            filename = getImageFileName(file)
+            filename = getImageFileName(afile)
             if filename is not None:
                 # put credits at the end
-                if "credit" in file.lower():
+                if "credit" in afile.lower():
-                    os.rename(os.path.join(dirpath,file), os.path.join(dirpath,'ZZZ999_'+file))
+                    os.rename(os.path.join(dirpath, afile), os.path.join(dirpath, 'ZZZ999_' + afile))
-                    file = 'ZZZ999_'+file
+                    afile = 'ZZZ999_' + afile
-                if "+" in file.lower() or "#" in file.lower():
+                if "+" in afile.lower() or "#" in afile.lower():
-                    newfilename = file.replace('+','_').replace('#','_')
+                    newfilename = afile.replace('+', '_').replace('#', '_')
-                    os.rename(os.path.join(dirpath,file), os.path.join(dirpath,newfilename))
+                    os.rename(os.path.join(dirpath, afile), os.path.join(dirpath, newfilename))
-                    file = newfilename
+                    afile = newfilename
-                filelist.append(buildHTML(dirpath,file))
+                filelist.append(buildHTML(dirpath, afile))
                 if not chapter:
                     chapterlist.append((dirpath.replace('Images', 'Text'), filelist[-1][1]))
                     chapter = True
@@ -229,22 +273,23 @@ def genEpubStruct(path):
     filelist = sorted(filelist, key=lambda name: (name[0].lower(), name[1].lower()))
     buildOPF(options.profile, path, options.title, filelist, cover, options.righttoleft)
 
-def getWorkFolder(file):
+
+def getWorkFolder(afile):
     workdir = tempfile.mkdtemp()
-    fname = os.path.splitext(file)
+    fname = os.path.splitext(afile)
-    if os.path.isdir(file):
+    if os.path.isdir(afile):
         try:
             import shutil
             os.rmdir(workdir)   # needed for copytree() fails if dst already exists
-            copytree(file, workdir)
+            copytree(afile, workdir)
             path = workdir
         except OSError:
             raise
     elif fname[1].lower() == '.pdf':
-        pdf = pdfjpgextract.PdfJpgExtract(file)
+        pdf = pdfjpgextract.PdfJpgExtract(afile)
-        path = pdf.extract(workdir)
+        path = pdf.extract()
     else:
-        cbx = cbxarchive.CBxArchive(file)
+        cbx = cbxarchive.CBxArchive(afile)
         if cbx.isCbxFile():
             path = cbx.extract(workdir)
         else:
@@ -253,15 +298,18 @@ def getWorkFolder(file):
     move(path + "_temp", os.path.join(path, 'OEBPS', 'Images'))
     return path
 
+
 def Copyright():
     print ('comic2ebook v%(__version__)s. '
            'Written 2012 by Ciro Mattia Gonano.' % globals())
 
+
 def Usage():
     print "Generates HTML, NCX and OPF for a Comic ebook from a bunch of images"
     print "Optimized for creating Mobipockets to be read into Kindle Paperwhite"
     parser.print_help()
 
+
 def main(argv=None):
     global parser, options, epub_path
     usage = "Usage: %prog [options] comic_file|comic_folder"
@@ -281,7 +329,8 @@ def main(argv=None):
     parser.add_option("--stretch-images", action="store_true", dest="stretch", default=False,
                       help="Stretch images to device's resolution [default=False]")
     parser.add_option("--black-borders", action="store_true", dest="black_borders", default=False,
-        help="Use black borders (instead of white ones) when not stretching and ratio is not like the device's one [default=False]")
+                      help="Use black borders (instead of white ones) when not stretching and ratio "
+                      + "is not like the device's one [default=False]")
     parser.add_option("--no-cut-page-numbers", action="store_false", dest="cutpagenumbers", default=True,
                       help="Do not try to cut page numbering on images [default=True]")
     options, args = parser.parse_args(argv)
@@ -306,6 +355,7 @@ def main(argv=None):
     rmtree(path)
     return epubpath
 
+
 def getEpubPath():
     global epub_path
     return epub_path