Merge lp:~james-w/python-oops-amqp/bson-compat into lp:python-oops-amqp

[James Westby]

Hi,

The world has two bson libraries with incompatible APIs. This is unfortunate.

However, we can make the world bright again if we support either API. This
is my attempt to do that.

Have a nice day!

James

[lp:~james-w/python-oops-amqp/bson-compat]

12. By James Westby on 2012-02-09

Add the missing file.

[Ian Booth (wallyworld)]

Thanks for this change to improve the robustness of our tools. It looks like a nice solution to a problem not of our making. I wonder, do we have a preferred bson library or can people just install whatever and hence we need this fix to cope with that?

review: Approve (code)

[James Westby (james-w)]

On Fri, 10 Feb 2012 01:24:17 -0000, Ian Booth <email address hidden> wrote:
> Review: Approve code

Thanks for the review. Would you be able to land the change for me as I
don't have access to do so? A release would be really nice too, but I
can always add the patch to our packaging.

> Thanks for this change to improve the robustness of our tools. It
> looks like a nice solution to a problem not of our making. I wonder,
> do we have a preferred bson library or can people just install
> whatever and hence we need this fix to cope with that?

The pymongo version seems to be winning (is packaged, is much faster, is
usually the one people refer to from what I can see.) That's not the
version that was in use though unfortunately.

People can install whatever, and if you use the python tools it's a bit
of a crapshoot which one you end up with.

The reason we are interested is that we're trying to depend on this
stuff, and we want it packaged up. As I have it now I have packaged the
non-pymongo version, but it conflicts with the pymongo version of the
code, and u1 already use that version. This will allow us to have the
package depend on the pymongo version.

Thanks,

James

[Ian Booth (wallyworld)]

Hi James,

I'll land and organise a release.

On Fri 10 Feb 2012 14:58:19 EST, James Westby wrote:
> On Fri, 10 Feb 2012 01:24:17 -0000, Ian Booth <email address hidden> wrote:
>> Review: Approve code
>
> Thanks for the review. Would you be able to land the change for me as I
> don't have access to do so? A release would be really nice too, but I
> can always add the patch to our packaging.
>
>> Thanks for this change to improve the robustness of our tools. It
>> looks like a nice solution to a problem not of our making. I wonder,
>> do we have a preferred bson library or can people just install
>> whatever and hence we need this fix to cope with that?
>
> The pymongo version seems to be winning (is packaged, is much faster, is
> usually the one people refer to from what I can see.) That's not the
> version that was in use though unfortunately.
>
> People can install whatever, and if you use the python tools it's a bit
> of a crapshoot which one you end up with.
>
> The reason we are interested is that we're trying to depend on this
> stuff, and we want it packaged up. As I have it now I have packaged the
> non-pymongo version, but it conflicts with the pymongo version of the
> code, and u1 already use that version. This will allow us to have the
> package depend on the pymongo version.
>
> Thanks,
>
> James
>

[Ian Booth (wallyworld)]

Hi James, I forgot to ask this originally.

Can you please update the NEWS file, adding something like:

<snip>
0.0.6
-----

* Support both pymongo and bson BSON libraries, whichever is installed.
  (James Westby)
<snip>

Also update version="0.0.5" to "0.0.6" in setup.py

Then I can merge in your changes without having to create a branch myself.

[James Westby (james-w)]

> Hi James, I forgot to ask this originally.
>
> Can you please update the NEWS file, adding something like:
>
> <snip>
> 0.0.6
> -----
>
> * Support both pymongo and bson BSON libraries, whichever is installed.
> (James Westby)
> <snip>
>
> Also update version="0.0.5" to "0.0.6" in setup.py
>
> Then I can merge in your changes without having to create a branch myself.

Done.

Thanks,

James

[lp:~james-w/python-oops-amqp/bson-compat]

13. By James Westby on 2012-02-10

Add a NEWS entry and bump the version. Thanks Ian.

14. By James Westby on 2012-02-10

Ensure that datetimes returned by bson are timezone-aware.

=== modified file 'NEWS'
--- NEWS	2011-12-08 18:23:11 +0000
+++ NEWS	2012-02-10 19:30:24 +0000
@@ -3,8 +3,11 @@
 
 Changes and improvements to oops-amqp, grouped by release.
 
-NEXT
-----
+0.0.6
+-----
+
+* Support either http://pypi.python.org/pypi/bson/ or
+  http://pypi.python.org/pypi/pymongo as the bson library. (James Westby)
 
 0.0.5
 -----

=== modified file 'oops_amqp/__init__.py'
--- oops_amqp/__init__.py	2011-12-08 18:23:11 +0000
+++ oops_amqp/__init__.py	2012-02-10 19:30:24 +0000
@@ -97,7 +97,7 @@
 # established at this point, and setup.py will use a version of next-$(revno).
 # If the releaselevel is 'final', then the tarball will be major.minor.micro.
 # Otherwise it is major.minor.micro~$(revno).
-__version__ = (0, 0, 5, 'beta', 0)
+__version__ = (0, 0, 6, 'final', 0)
 
 __all__ = [
     'Publisher',

=== added file 'oops_amqp/anybson.py'
--- oops_amqp/anybson.py	1970-01-01 00:00:00 +0000
+++ oops_amqp/anybson.py	2012-02-10 19:30:24 +0000
@@ -0,0 +1,31 @@
+# Copyright (c) 2012, Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, version 3 only.
+#
+# This program 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# GNU Lesser General Public License version 3 (see the file LICENSE).
+
+__all__ = [
+    'dumps',
+    'loads',
+    ]
+
+
+try:
+    from bson import dumps, loads
+except ImportError:
+    from bson import BSON
+
+    def dumps(obj):
+        return BSON.encode(obj)
+
+    def loads(data):
+        return BSON(data).decode(tz_aware=True)

=== modified file 'oops_amqp/publisher.py'
--- oops_amqp/publisher.py	2011-12-08 09:29:35 +0000
+++ oops_amqp/publisher.py	2012-02-10 19:30:24 +0000
@@ -21,7 +21,7 @@
 from threading import local
 
 from amqplib import client_0_8 as amqp
-from bson import dumps
+from anybson import dumps
 
 from utils import (
     amqplib_error_types,

=== modified file 'oops_amqp/receiver.py'
--- oops_amqp/receiver.py	2011-12-08 10:15:23 +0000
+++ oops_amqp/receiver.py	2012-02-10 19:30:24 +0000
@@ -19,8 +19,7 @@
 
 import time
 
-import bson
-
+import anybson as bson
 from utils import (
     amqplib_error_types,
     close_ignoring_connection_errors,

=== modified file 'oops_amqp/tests/test_publisher.py'
--- oops_amqp/tests/test_publisher.py	2011-12-08 10:15:23 +0000
+++ oops_amqp/tests/test_publisher.py	2012-02-10 19:30:24 +0000
@@ -17,10 +17,10 @@
 
 from hashlib import md5
 
-import bson
-
-from oops_amqp import Publisher
-from oops_amqp.utils import close_ignoring_connection_errors
+from oops_amqp import (
+    anybson as bson,
+    Publisher,
+    )
 from oops_amqp.tests import (
     ChannelFixture,
     QueueFixture,

=== modified file 'oops_amqp/tests/test_receiver.py'
--- oops_amqp/tests/test_receiver.py	2011-12-08 09:29:35 +0000
+++ oops_amqp/tests/test_receiver.py	2012-02-10 19:30:24 +0000
@@ -19,10 +19,12 @@
 import socket
 
 from amqplib import client_0_8 as amqp
-import bson
 from oops import Config
 
-from oops_amqp import Receiver
+from oops_amqp import (
+    anybson as bson,
+    Receiver,
+    )
 from oops_amqp.tests import (
     ChannelFixture,
     QueueFixture,

=== modified file 'setup.py'
--- setup.py	2011-12-08 18:23:11 +0000
+++ setup.py	2012-02-10 19:30:24 +0000
@@ -23,7 +23,7 @@
         os.path.join(os.path.dirname(__file__), 'README'), 'rb').read()
 
 setup(name="oops_amqp",
-      version="0.0.5",
+      version="0.0.6",
       description=\
               "OOPS AMQP transport.",
       long_description=description,
@@ -40,7 +40,7 @@
           'Programming Language :: Python',
           ],
       install_requires = [
-          'bson',
+          'pymongo',
           'oops',
           'amqplib',
           ],