Updated to handle the removing of episode_id parameter.

Author: fuzzycode

pytvdbapi/api.py

@@ -64,7 +64,7 @@
 from pytvdbapi.show import Show
 from pytvdbapi.urls import mirrors, search, zap2itid, imdbid, series, episode, airdate, absolute_order, \
     dvd_order, default_order
-from pytvdbapi.utils import unicode_arguments
+from pytvdbapi.utils import unicode_arguments, deprecate_episode_id
 from pytvdbapi._compat import implements_to_string, make_bytes, make_unicode, text_type, int_types
 
 
@@ -384,7 +384,8 @@ def get_series(self, series_id, language, id_type='tvdb', cache=True):
             return Show(series_data[0], self, language, self.config, data)
 
     @unicode_arguments
-    def get_episode(self, episode_id, language, method="id", cache=True, **kwargs):
+    @deprecate_episode_id
+    def get_episode(self, language, method="id", cache=True, **kwargs):
         """
         .. versionadded:: 0.4
         .. versionchanged:: 0.5 Added the possibility to get an episode using default, dvd, and absolute
@@ -438,12 +439,10 @@ def get_episode(self, episode_id, language, method="id", cache=True, **kwargs):
         """
         methods = {"default": default_order, "dvd": dvd_order, "absolute": absolute_order, "id": episode}
 
-        logger.debug(u"Getting episode with id {0} with language {1}".format(episode_id, language))
-
         if language != 'all' and language not in __LANGUAGES__:
             raise error.TVDBValueError(u"{0} is not a valid language".format(language))
 
-        context = {'episodeid': kwargs.get('episodeid', episode_id), "language": language,
+        context = {"language": language,
                    'mirror': self.mirrors.get_mirror(TypeMask.XML).url,
                    'api_key': self.config['api_key']}
 

pytvdbapi/tests/test_api.py

@@ -663,15 +663,14 @@ def test_invalid_language(self):
         self.assertRaises(error.TVDBValueError, api.get_episode, 308834, "foo")
         self.assertRaises(error.TVDBValueError, api.get_episode, 308834, "")
 
-    def test_invalid_id(self):
-        """
-        If the episode can not be found, a TVDBValueError should be raised.
-        """
+    def test_missing_id(self):
+        """It should be possible to call get_episode without passing id as positional argument"""
         api = TVDB("B43FF87DE395DF56")
 
-        self.assertRaises(error.TVDBNotFoundError, api.get_episode, -1, "en")
-        self.assertRaises(error.TVDBNotFoundError, api.get_episode, "foo", "en")
-        self.assertRaises(error.TVDBNotFoundError, api.get_episode, "", "en")
+        ep = api.get_episode("en", "id", True, episodeid=308834)
+
+        self.assertEqual(ep.id, 308834)
+        self.assertEqual(ep.EpisodeName, 'Crocodile')
 
     def test_episode_id_kwarg(self):
         """It should be possible to load the episode passing the episode id as a kwarg"""

pytvdbapi/utils.py

@@ -25,7 +25,9 @@
 
 from functools import wraps
 from collections import MutableMapping
-from pytvdbapi._compat import make_unicode
+
+from pytvdbapi._compat import make_unicode, int_types
+
 
 __all__ = ['unicode_arguments', 'merge', 'TransformedDictionary', 'InsensitiveDictionary']
 
@@ -47,6 +49,29 @@ def __wrapper__(*args, **kwargs):
     return __wrapper__
 
 
+def deprecate_episode_id(func):
+    """
+    Utility function to help deprecating the episode_id parameter without loosing backward compatibility.
+
+    :param func: The function to wrap
+    :type func: A function object
+    """
+    @wraps(func)
+    def __wrapper__(*args, **kwargs):
+        args = list(args)
+
+        # Check if the first argument is an int, and assume that it was the episode id
+        if isinstance(args[1], int_types):
+            episodeid = args[1]
+            if 'episodeid' not in kwargs:
+                kwargs['episodeid'] = episodeid
+
+            del args[1]
+
+        return func(*args, **kwargs)
+    return __wrapper__
+
+
 def merge(dict1, dict2, decision=lambda x, y: y):
     """
     :param dict1: First dictionary to merge