Change open to 'with open' and exception IOError to 'EnvironmentError'

Use 'with open' when opening/writing files
http://sdqali.in/blog/2012/07/09/understanding-pythons-with/
The advantage of using a with statement is that it is guaranteed to close the file no matter how the nested block exits.
If an exception occurs before the end of the block,
it will close the file before the exception is caught by an outer exception handler.
If the nested block were to contain a return statement, or a continue or break statement,
the with statement would automatically close the file in those cases, too.

Switch exception to `EnvironmentError`
http://docs.python.org/2/library/exceptions.html#exceptions.EnvironmentError
Since it is the parent of IOError, OSError *and* WindowsError where available.

+ Cleanup test_lib a bit, still needs work.
+ Applied whitespace PEP8 fixes to the files touched.

closes midgetspygh-797

Author: thezoggy

sickbeard/helpers.py

@@ -16,14 +16,15 @@
 # You should have received a copy of the GNU General Public License
 # along with Sick Beard.  If not, see <http://www.gnu.org/licenses/>.
 
+from __future__ import with_statement
+
 import gzip
 import os
 import re
 import shutil
 import socket
 import stat
 import StringIO
-import sys
 import time
 import traceback
 import urllib
@@ -460,7 +461,7 @@ def chmodAsParent(childPath):
         return
 
     childPath_owner = childPathStat.st_uid
-    user_id = os.geteuid()  #only available on UNIX
+    user_id = os.geteuid()  # @UndefinedVariable - only available on UNIX
 
     if user_id != 0 and user_id != childPath_owner:
         logger.log(u"Not running as root or owner of " + childPath + ", not trying to set permissions", logger.DEBUG)
@@ -498,14 +499,14 @@ def fixSetGroupID(childPath):
             return
 
         childPath_owner = childStat.st_uid
-        user_id = os.geteuid()  #only available on UNIX
+        user_id = os.geteuid()  # @UndefinedVariable - only available on UNIX
 
         if user_id != 0 and user_id != childPath_owner:
             logger.log(u"Not running as root or owner of " + childPath + ", not trying to set the set-group-ID", logger.DEBUG)
             return
 
         try:
-            ek.ek(os.chown, childPath, -1, parentGID)  #@UndefinedVariable - only available on UNIX
+            ek.ek(os.chown, childPath, -1, parentGID)  # @UndefinedVariable - only available on UNIX
             logger.log(u"Respecting the set-group-ID bit on the parent directory for %s" % (childPath), logger.DEBUG)
         except OSError:
             logger.log(u"Failed to respect the set-group-ID bit on the parent directory for %s (setting group ID %i)" % (childPath, parentGID), logger.ERROR)
@@ -545,8 +546,8 @@ def create_https_certificates(ssl_cert, ssl_key):
     Create self-signed HTTPS certificares and store in paths 'ssl_cert' and 'ssl_key'
     """
     try:
-        from OpenSSL import crypto  #@UnresolvedImport
-        from lib.certgen import createKeyPair, createCertRequest, createCertificate, TYPE_RSA, serial  #@UnresolvedImport
+        from OpenSSL import crypto  # @UnresolvedImport
+        from lib.certgen import createKeyPair, createCertRequest, createCertificate, TYPE_RSA, serial  # @UnresolvedImport
     except:
         logger.log(u"pyopenssl module missing, please install for https access", logger.WARNING)
         return False

sickbeard/metadata/generic.py

@@ -16,6 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Sick Beard.  If not, see <http://www.gnu.org/licenses/>.
 
+from __future__ import with_statement
+
 import os.path
 
 import xml.etree.cElementTree as etree
@@ -842,8 +844,8 @@ def retrieveShowMetadata(self, folder):
         logger.log(u"Loading show info from metadata file in " + folder, logger.DEBUG)
 
         try:
-            xmlFileObj = ek.ek(open, metadata_path, 'r')
-            showXML = etree.ElementTree(file=xmlFileObj)
+            with ek.ek(open, metadata_path, 'r') as xmlFileObj:
+                showXML = etree.ElementTree(file=xmlFileObj)
 
             if showXML.findtext('title') == None or (showXML.findtext('tvdbid') == None and showXML.findtext('id') == None):
                 logger.log(u"Invalid info in tvshow.nfo (missing name or id):" \
@@ -866,7 +868,7 @@ def retrieveShowMetadata(self, folder):
                 return empty_return
 
         except Exception, e:
-            logger.log(u"There was an error parsing your existing metadata file: " + ex(e), logger.WARNING)
+            logger.log(u"There was an error parsing your existing metadata file: '" + metadata_path + "' error: " + ex(e), logger.WARNING)
             return empty_return
 
         return (tvdb_id, name)

sickbeard/metadata/tivo.py

@@ -17,6 +17,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Sick Beard.  If not, see <http://www.gnu.org/licenses/>.
 
+from __future__ import with_statement
+
 import datetime
 import os
 
@@ -25,6 +27,7 @@
 from sickbeard import logger, exceptions, helpers
 from sickbeard.metadata import generic
 from sickbeard import encodingKludge as ek
+from sickbeard.exceptions import ex
 
 from lib.tvdb_api import tvdb_api, tvdb_exceptions
 
@@ -309,14 +312,15 @@ def write_ep_file(self, ep_obj):
                 helpers.chmodAsParent(nfo_file_dir)
 
             logger.log(u"Writing episode nfo file to " + nfo_file_path, logger.DEBUG)
-            nfo_file = ek.ek(open, nfo_file_path, 'w')
 
-            # Calling encode directly, b/c often descriptions have wonky characters.
-            nfo_file.write(data.encode("utf-8"))
-            nfo_file.close()
+            with ek.ek(open, nfo_file_path, 'w') as nfo_file:
+                # Calling encode directly, b/c often descriptions have wonky characters.
+                nfo_file.write(data.encode("utf-8"))
+
             helpers.chmodAsParent(nfo_file_path)
-        except IOError, e:
-            logger.log(u"Unable to write file to " + nfo_file_path + " - are you sure the folder is writable? " + str(e).decode('utf-8'), logger.ERROR)
+
+        except EnvironmentError, e:
+            logger.log(u"Unable to write file to " + nfo_file_path + " - are you sure the folder is writable? " + ex(e), logger.ERROR)
             return False
 
         return True

sickbeard/nzbSplitter.py

@@ -16,8 +16,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Sick Beard.  If not, see <http://www.gnu.org/licenses/>.
 
-import urllib2
+from __future__ import with_statement
 
+import urllib2
 import xml.etree.cElementTree as etree
 import xml.etree
 import re
@@ -26,14 +27,17 @@
 
 from sickbeard import logger, classes, helpers
 from sickbeard.common import Quality
+from sickbeard import encodingKludge as ek
+from sickbeard.exceptions import ex
+
 
 def getSeasonNZBs(name, urlData, season):
 
     try:
         showXML = etree.ElementTree(etree.XML(urlData))
     except SyntaxError:
-        logger.log(u"Unable to parse the XML of "+name+", not splitting it", logger.ERROR)
-        return ({},'')
+        logger.log(u"Unable to parse the XML of " + name + ", not splitting it", logger.ERROR)
+        return ({}, '')
 
     filename = name.replace(".nzb", "")
 
@@ -43,10 +47,10 @@ def getSeasonNZBs(name, urlData, season):
 
     sceneNameMatch = re.search(regex, filename, re.I)
     if sceneNameMatch:
-        showName, qualitySection, groupName = sceneNameMatch.groups() #@UnusedVariable
+        showName, qualitySection, groupName = sceneNameMatch.groups()  # @UnusedVariable
     else:
-        logger.log(u"Unable to parse "+name+" into a scene name. If it's a valid one log a bug.", logger.ERROR)
-        return ({},'')
+        logger.log(u"Unable to parse " + name + " into a scene name. If it's a valid one log a bug.", logger.ERROR)
+        return ({}, '')
 
     regex = '(' + re.escape(showName) + '\.S%02d(?:[E0-9]+)\.[\w\._]+\-\w+' % season + ')'
     regex = regex.replace(' ', '.')
@@ -72,6 +76,7 @@ def getSeasonNZBs(name, urlData, season):
 
     return (epFiles, xmlns)
 
+
 def createNZBString(fileElements, xmlns):
 
     rootElement = etree.Element("nzb")
@@ -86,12 +91,16 @@ def createNZBString(fileElements, xmlns):
 
 def saveNZB(nzbName, nzbString):
 
-    nzb_fh = open(nzbName+".nzb", 'w')
-    nzb_fh.write(nzbString)
-    nzb_fh.close()
+    try:
+        with ek.ek(open, nzbName + ".nzb", 'w') as nzb_fh:
+            nzb_fh.write(nzbString)
+
+    except EnvironmentError, e:
+        logger.log(u"Unable to save NZB: " + ex(e), logger.ERROR)
+
 
 def stripNS(element, ns):
-    element.tag = element.tag.replace("{"+ns+"}", "")
+    element.tag = element.tag.replace("{" + ns + "}", "")
     for curChild in element.getchildren():
         stripNS(curChild, ns)
 
@@ -103,15 +112,15 @@ def splitResult(result):
     urlData = helpers.getURL(result.url)
 
     if urlData is None:
-        logger.log(u"Unable to load url "+result.url+", can't download season NZB", logger.ERROR)
+        logger.log(u"Unable to load url " + result.url + ", can't download season NZB", logger.ERROR)
         return False
 
     # parse the season ep name
     try:
         np = NameParser(False)
         parse_result = np.parse(result.name)
     except InvalidNameException:
-        logger.log(u"Unable to parse the filename "+result.name+" into a valid episode", logger.WARNING)
+        logger.log(u"Unable to parse the filename " + result.name + " into a valid episode", logger.WARNING)
         return False
 
     # bust it up
@@ -123,28 +132,28 @@ def splitResult(result):
 
     for newNZB in separateNZBs:
 
-        logger.log(u"Split out "+newNZB+" from "+result.name, logger.DEBUG)
+        logger.log(u"Split out " + newNZB + " from " + result.name, logger.DEBUG)
 
         # parse the name
         try:
             np = NameParser(False)
             parse_result = np.parse(newNZB)
         except InvalidNameException:
-            logger.log(u"Unable to parse the filename "+newNZB+" into a valid episode", logger.WARNING)
+            logger.log(u"Unable to parse the filename " + newNZB + " into a valid episode", logger.WARNING)
             return False
 
         # make sure the result is sane
         if (parse_result.season_number != None and parse_result.season_number != season) or (parse_result.season_number == None and season != 1):
-            logger.log(u"Found "+newNZB+" inside "+result.name+" but it doesn't seem to belong to the same season, ignoring it", logger.WARNING)
+            logger.log(u"Found " + newNZB + " inside " + result.name + " but it doesn't seem to belong to the same season, ignoring it", logger.WARNING)
             continue
         elif len(parse_result.episode_numbers) == 0:
-            logger.log(u"Found "+newNZB+" inside "+result.name+" but it doesn't seem to be a valid episode NZB, ignoring it", logger.WARNING)
+            logger.log(u"Found " + newNZB + " inside " + result.name + " but it doesn't seem to be a valid episode NZB, ignoring it", logger.WARNING)
             continue
 
         wantEp = True
         for epNo in parse_result.episode_numbers:
             if not result.extraInfo[0].wantEpisode(season, epNo, result.quality):
-                logger.log(u"Ignoring result "+newNZB+" because we don't want an episode that is "+Quality.qualityStrings[result.quality], logger.DEBUG)
+                logger.log(u"Ignoring result " + newNZB + " because we don't want an episode that is " + Quality.qualityStrings[result.quality], logger.DEBUG)
                 wantEp = False
                 break
         if not wantEp:
@@ -164,4 +173,4 @@ def splitResult(result):
 
         resultList.append(curResult)
 
-    return resultList
+    return resultList

sickbeard/providers/generic.py

@@ -16,6 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Sick Beard.  If not, see <http://www.gnu.org/licenses/>.
 
+from __future__ import with_statement
 
 import datetime
 import os
@@ -139,11 +140,10 @@ def downloadResult(self, result):
         logger.log(u"Saving to " + file_name, logger.DEBUG)
 
         try:
-            fileOut = open(file_name, writeMode)
-            fileOut.write(data)
-            fileOut.close()
+            with open(file_name, writeMode) as fileOut:
+                fileOut.write(data)
             helpers.chmodAsParent(file_name)
-        except IOError, e:
+        except EnvironmentError, e:
             logger.log(u"Unable to save the file: " + ex(e), logger.ERROR)
             return False