aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings/python/notmuch
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/python/notmuch')
-rw-r--r--bindings/python/notmuch/compat.py67
-rw-r--r--bindings/python/notmuch/database.py22
-rw-r--r--bindings/python/notmuch/directory.py2
-rw-r--r--bindings/python/notmuch/filenames.py2
-rw-r--r--bindings/python/notmuch/globals.py35
-rw-r--r--bindings/python/notmuch/message.py135
-rw-r--r--bindings/python/notmuch/messages.py16
-rw-r--r--bindings/python/notmuch/query.py2
-rw-r--r--bindings/python/notmuch/tag.py2
-rw-r--r--bindings/python/notmuch/thread.py6
-rw-r--r--bindings/python/notmuch/threads.py2
11 files changed, 102 insertions, 189 deletions
diff --git a/bindings/python/notmuch/compat.py b/bindings/python/notmuch/compat.py
new file mode 100644
index 00000000..adc8d244
--- /dev/null
+++ b/bindings/python/notmuch/compat.py
@@ -0,0 +1,67 @@
+'''
+This file is part of notmuch.
+
+This module handles differences between python2.x and python3.x and
+allows the notmuch bindings to support both version families with one
+source tree.
+
+Notmuch is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+Notmuch is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with notmuch. If not, see <http://www.gnu.org/licenses/>.
+
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
+Copyright 2012 Justus Winter <4winter@informatik.uni-hamburg.de>
+'''
+
+import sys
+
+if sys.version_info[0] == 2:
+ from ConfigParser import SafeConfigParser
+
+ class Python3StringMixIn(object):
+ def __str__(self):
+ return unicode(self).encode('utf-8')
+
+ def encode_utf8(value):
+ '''
+ Ensure a nicely utf-8 encoded string to pass to wrapped
+ libnotmuch functions.
+
+ C++ code expects strings to be well formatted and unicode
+ strings to have no null bytes.
+ '''
+ if not isinstance(value, basestring):
+ raise TypeError('Expected str or unicode, got %s' % type(value))
+
+ if isinstance(value, unicode):
+ return value.encode('utf-8', 'replace')
+
+ return value
+else:
+ from configparser import SafeConfigParser
+
+ class Python3StringMixIn(object):
+ def __str__(self):
+ return self.__unicode__()
+
+ def encode_utf8(value):
+ '''
+ Ensure a nicely utf-8 encoded string to pass to wrapped
+ libnotmuch functions.
+
+ C++ code expects strings to be well formatted and unicode
+ strings to have no null bytes.
+ '''
+ if not isinstance(value, str):
+ raise TypeError('Expected str, got %s' % type(value))
+
+ return value.encode('utf-8', 'replace')
diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index e5c74cfb..5931f41b 100644
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -20,7 +20,8 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
import os
import codecs
from ctypes import c_char_p, c_void_p, c_uint, byref, POINTER
-from notmuch.globals import (
+from .compat import SafeConfigParser
+from .globals import (
nmlib,
Enum,
_str,
@@ -37,8 +38,8 @@ from .errors import (
NotInitializedError,
ReadOnlyDatabaseError,
)
-from notmuch.message import Message
-from notmuch.tag import Tags
+from .message import Message
+from .tag import Tags
from .query import Query
from .directory import Directory
@@ -546,7 +547,7 @@ class Database(object):
"""
self._assert_db_is_initialized()
tags_p = Database._get_all_tags(self._db)
- if tags_p == None:
+ if not tags_p:
raise NullPointerError()
return Tags(tags_p, self)
@@ -577,13 +578,6 @@ class Database(object):
""" Reads a user's notmuch config and returns his db location
Throws a NotmuchError if it cannot find it"""
- try:
- # python3.x
- from configparser import SafeConfigParser
- except ImportError:
- # python2.x
- from ConfigParser import SafeConfigParser
-
config = SafeConfigParser()
conf_f = os.getenv('NOTMUCH_CONFIG',
os.path.expanduser('~/.notmuch-config'))
@@ -597,7 +591,9 @@ class Database(object):
def db_p(self):
"""Property returning a pointer to `notmuch_database_t` or `None`
- This should normally not be needed by a user (and is not yet
- guaranteed to remain stable in future versions).
+ .. deprecated:: 0.14
+ If you really need a pointer to the notmuch
+ database object use the `_pointer` field. This
+ alias will be removed in notmuch 0.15.
"""
return self._db
diff --git a/bindings/python/notmuch/directory.py b/bindings/python/notmuch/directory.py
index ae115f81..3b0a525d 100644
--- a/bindings/python/notmuch/directory.py
+++ b/bindings/python/notmuch/directory.py
@@ -18,7 +18,7 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
from ctypes import c_uint, c_long
-from notmuch.globals import (
+from .globals import (
nmlib,
NotmuchDirectoryP,
NotmuchFilenamesP
diff --git a/bindings/python/notmuch/filenames.py b/bindings/python/notmuch/filenames.py
index a0b29563..229f414d 100644
--- a/bindings/python/notmuch/filenames.py
+++ b/bindings/python/notmuch/filenames.py
@@ -17,7 +17,7 @@ along with notmuch. If not, see <http://www.gnu.org/licenses/>.
Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
from ctypes import c_char_p
-from notmuch.globals import (
+from .globals import (
nmlib,
NotmuchMessageP,
NotmuchFilenamesP,
diff --git a/bindings/python/notmuch/globals.py b/bindings/python/notmuch/globals.py
index f5fad72a..c7632c32 100644
--- a/bindings/python/notmuch/globals.py
+++ b/bindings/python/notmuch/globals.py
@@ -16,7 +16,7 @@ along with notmuch. If not, see <http://www.gnu.org/licenses/>.
Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
-import sys
+
from ctypes import CDLL, Structure, POINTER
#-----------------------------------------------------------------------------
@@ -26,38 +26,7 @@ try:
except:
raise ImportError("Could not find shared 'notmuch' library.")
-
-if sys.version_info[0] == 2:
- class Python3StringMixIn(object):
- def __str__(self):
- return unicode(self).encode('utf-8')
-
-
- def _str(value):
- """Ensure a nicely utf-8 encoded string to pass to libnotmuch
-
- C++ code expects strings to be well formatted and
- unicode strings to have no null bytes."""
- if not isinstance(value, basestring):
- raise TypeError("Expected str or unicode, got %s" % type(value))
- if isinstance(value, unicode):
- return value.encode('UTF-8')
- return value
-else:
- class Python3StringMixIn(object):
- def __str__(self):
- return self.__unicode__()
-
-
- def _str(value):
- """Ensure a nicely utf-8 encoded string to pass to libnotmuch
-
- C++ code expects strings to be well formatted and
- unicode strings to have no null bytes."""
- if not isinstance(value, str):
- raise TypeError("Expected str, got %s" % type(value))
- return value.encode('UTF-8')
-
+from .compat import Python3StringMixIn, encode_utf8 as _str
class Enum(object):
"""Provides ENUMS as "code=Enum(['a','b','c'])" where code.a=0 etc..."""
diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py
index 0e65694e..d1c1b58c 100644
--- a/bindings/python/notmuch/message.py
+++ b/bindings/python/notmuch/message.py
@@ -41,10 +41,6 @@ from .tag import Tags
from .filenames import Filenames
import email
-try:
- import simplejson as json
-except ImportError:
- import json
class Message(Python3StringMixIn):
@@ -304,7 +300,7 @@ class Message(Python3StringMixIn):
raise NotInitializedError()
tags_p = Message._get_tags(self._msg)
- if tags_p == None:
+ if not tags_p:
raise NullPointerError()
return Tags(tags_p, self)
@@ -610,135 +606,6 @@ class Message(Python3StringMixIn):
out_part = parts[(num - 1)]
return out_part.get_payload(decode=True)
- def format_message_internal(self):
- """Create an internal representation of the message parts,
- which can easily be output to json, text, or another output
- format. The argument match tells whether this matched a
- query.
-
- .. deprecated:: 0.13
- This code adds functionality at the python
- level that is unlikely to be useful for
- anyone. Furthermore the python bindings strive
- to be a thin wrapper around libnotmuch, so
- this code will be removed in notmuch 0.14.
- """
- output = {}
- output["id"] = self.get_message_id()
- output["match"] = self.is_match()
- output["filename"] = self.get_filename()
- output["tags"] = list(self.get_tags())
-
- headers = {}
- for h in ["Subject", "From", "To", "Cc", "Bcc", "Date"]:
- headers[h] = self.get_header(h)
- output["headers"] = headers
-
- body = []
- parts = self.get_message_parts()
- for i in xrange(len(parts)):
- msg = parts[i]
- part_dict = {}
- part_dict["id"] = i + 1
- # We'll be using this is a lot, so let's just get it once.
- cont_type = msg.get_content_type()
- part_dict["content-type"] = cont_type
- # NOTE:
- # Now we emulate the current behaviour, where it ignores
- # the html if there's a text representation.
- #
- # This is being worked on, but it will be easier to fix
- # here in the future than to end up with another
- # incompatible solution.
- disposition = msg["Content-Disposition"]
- if disposition and disposition.lower().startswith("attachment"):
- part_dict["filename"] = msg.get_filename()
- else:
- if cont_type.lower() == "text/plain":
- part_dict["content"] = msg.get_payload()
- elif (cont_type.lower() == "text/html" and
- i == 0):
- part_dict["content"] = msg.get_payload()
- body.append(part_dict)
-
- output["body"] = body
-
- return output
-
- def format_message_as_json(self, indent=0):
- """Outputs the message as json. This is essentially the same
- as python's dict format, but we run it through, just so we
- don't have to worry about the details.
-
- .. deprecated:: 0.13
- This code adds functionality at the python
- level that is unlikely to be useful for
- anyone. Furthermore the python bindings strive
- to be a thin wrapper around libnotmuch, so
- this code will be removed in notmuch 0.14.
- """
- return json.dumps(self.format_message_internal())
-
- def format_message_as_text(self, indent=0):
- """Outputs it in the old-fashioned notmuch text form. Will be
- easy to change to a new format when the format changes.
-
- .. deprecated:: 0.13
- This code adds functionality at the python
- level that is unlikely to be useful for
- anyone. Furthermore the python bindings strive
- to be a thin wrapper around libnotmuch, so
- this code will be removed in notmuch 0.14.
- """
-
-
- format = self.format_message_internal()
- output = "\fmessage{ id:%s depth:%d match:%d filename:%s" \
- % (format['id'], indent, format['match'], format['filename'])
- output += "\n\fheader{"
-
- #Todo: this date is supposed to be prettified, as in the index.
- output += "\n%s (%s) (" % (format["headers"]["From"],
- format["headers"]["Date"])
- output += ", ".join(format["tags"])
- output += ")"
-
- output += "\nSubject: %s" % format["headers"]["Subject"]
- output += "\nFrom: %s" % format["headers"]["From"]
- output += "\nTo: %s" % format["headers"]["To"]
- if format["headers"]["Cc"]:
- output += "\nCc: %s" % format["headers"]["Cc"]
- if format["headers"]["Bcc"]:
- output += "\nBcc: %s" % format["headers"]["Bcc"]
- output += "\nDate: %s" % format["headers"]["Date"]
- output += "\n\fheader}"
-
- output += "\n\fbody{"
-
- parts = format["body"]
- parts.sort(key=lambda x: x['id'])
- for p in parts:
- if not "filename" in p:
- output += "\n\fpart{ "
- output += "ID: %d, Content-type: %s\n" % (p["id"],
- p["content-type"])
- if "content" in p:
- output += "\n%s\n" % p["content"]
- else:
- output += "Non-text part: %s\n" % p["content-type"]
- output += "\n\fpart}"
- else:
- output += "\n\fattachment{ "
- output += "ID: %d, Content-type:%s\n" % (p["id"],
- p["content-type"])
- output += "Attachment: %s\n" % p["filename"]
- output += "\n\fattachment}\n"
-
- output += "\n\fbody}\n"
- output += "\n\fmessage}"
-
- return output
-
def __hash__(self):
"""Implement hash(), so we can use Message() sets"""
file = self.get_filename()
diff --git a/bindings/python/notmuch/messages.py b/bindings/python/notmuch/messages.py
index 59ef40af..e83455b9 100644
--- a/bindings/python/notmuch/messages.py
+++ b/bindings/python/notmuch/messages.py
@@ -142,7 +142,7 @@ class Messages(object):
#reset _msgs as we iterated over it and can do so only once
self._msgs = None
- if tags_p == None:
+ if not tags_p:
raise NullPointerError()
return Tags(tags_p, self)
@@ -199,6 +199,13 @@ class Messages(object):
:param entire_thread: A bool, indicating whether we want to output
whole threads or only the matching messages.
:return: a list of lines
+
+ .. deprecated:: 0.14
+ This code adds functionality at the python
+ level that is unlikely to be useful for
+ anyone. Furthermore the python bindings strive
+ to be a thin wrapper around libnotmuch, so
+ this code will be removed in notmuch 0.15.
"""
result = list()
@@ -255,6 +262,13 @@ class Messages(object):
:param indent: A number indicating the reply depth of these messages.
:param entire_thread: A bool, indicating whether we want to output
whole threads or only the matching messages.
+
+ .. deprecated:: 0.14
+ This code adds functionality at the python
+ level that is unlikely to be useful for
+ anyone. Furthermore the python bindings strive
+ to be a thin wrapper around libnotmuch, so
+ this code will be removed in notmuch 0.15.
"""
handle.write(''.join(self.format_messages(format, indent, entire_thread)))
diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py
index 756e63b5..4abba5bd 100644
--- a/bindings/python/notmuch/query.py
+++ b/bindings/python/notmuch/query.py
@@ -18,7 +18,7 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
from ctypes import c_char_p, c_uint
-from notmuch.globals import (
+from .globals import (
nmlib,
Enum,
_str,
diff --git a/bindings/python/notmuch/tag.py b/bindings/python/notmuch/tag.py
index 363c3487..1d523457 100644
--- a/bindings/python/notmuch/tag.py
+++ b/bindings/python/notmuch/tag.py
@@ -17,7 +17,7 @@ along with notmuch. If not, see <http://www.gnu.org/licenses/>.
Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
from ctypes import c_char_p
-from notmuch.globals import (
+from .globals import (
nmlib,
Python3StringMixIn,
NotmuchTagsP,
diff --git a/bindings/python/notmuch/thread.py b/bindings/python/notmuch/thread.py
index 2f60d493..009cb2bf 100644
--- a/bindings/python/notmuch/thread.py
+++ b/bindings/python/notmuch/thread.py
@@ -18,7 +18,7 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
from ctypes import c_char_p, c_long, c_int
-from notmuch.globals import (
+from .globals import (
nmlib,
NotmuchThreadP,
NotmuchMessagesP,
@@ -29,7 +29,7 @@ from .errors import (
NotInitializedError,
)
from .messages import Messages
-from notmuch.tag import Tags
+from .tag import Tags
from datetime import date
class Thread(object):
@@ -238,7 +238,7 @@ class Thread(object):
raise NotInitializedError()
tags_p = Thread._get_tags(self._thread)
- if tags_p == None:
+ if not tags_p:
raise NullPointerError()
return Tags(tags_p, self)
diff --git a/bindings/python/notmuch/threads.py b/bindings/python/notmuch/threads.py
index d2e0a910..f8ca34a9 100644
--- a/bindings/python/notmuch/threads.py
+++ b/bindings/python/notmuch/threads.py
@@ -17,7 +17,7 @@ along with notmuch. If not, see <http://www.gnu.org/licenses/>.
Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
"""
-from notmuch.globals import (
+from .globals import (
nmlib,
Python3StringMixIn,
NotmuchThreadP,
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-23 15:31:09 +0000