python: deprecated add_message calls index_file correctly and returns result
authorGaute Hope <eg@gaute.vetsj.com>
Wed, 30 Aug 2017 08:16:33 +0000 (10:16 +0200)
committerDavid Bremner <david@tethera.net>
Tue, 12 Sep 2017 18:21:40 +0000 (15:21 -0300)
The deprecated Database.add_message now calls the new index_file with
correct number of arguments (without an extra `self`), and returns the
tuple from index_file - as it used to do before.

This change also adds a DeprecationWarning to the function.

bindings/python/notmuch/database.py

index a2c025ebe6c068247530c11512e34b89768e93ef..1279804a1c81eab28018e663f0b543085c0ce250 100644 (file)
@@ -19,6 +19,7 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
 
 import os
 import codecs
+import warnings
 from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER
 from .compat import SafeConfigParser
 from .globals import (
@@ -471,7 +472,10 @@ class Database(object):
     def add_message(self, filename, sync_maildir_flags=False):
         """Deprecated alias for :meth:`index_file`
         """
-        self.index_file(self, filename, sync_maildir_flags=sync_maildir_flags)
+        warnings.warn(
+                "This function is deprecated and will be removed in the future, use index_file.", DeprecationWarning)
+
+        return self.index_file(filename, sync_maildir_flags=sync_maildir_flags)
 
     _remove_message = nmlib.notmuch_database_remove_message
     _remove_message.argtypes = [NotmuchDatabaseP, c_char_p]