add legacy conversions for ObjectId

Author: Mike Dirolf

pymongo/objectid.py

@@ -98,25 +98,53 @@ def __validate(self, oid):
  raise TypeError("id must be an instance of (str, ObjectId), "
  "not %s" % type(oid))
 
- def url_encode(self):
+ def url_encode(self, legacy=False):
  """Get a string representation of this ObjectId safe for use in a url.
 
+ The `legacy` parameter is for backwards compatibility only and should
+ almost always be kept False. It might eventually be removed.
+
  The reverse can be achieved using `url_decode()`.
+
+ :Parameters:
+ - `legacy` (optional): use the legacy byte ordering to represent the
+ ObjectId. if you aren't positive you need this it is probably best
+ left as False.
  """
- return self.__id.encode("hex")
+ if legacy:
+ return self.legacy_str().encode("hex")
+ else:
+ return self.__id.encode("hex")
 
- def url_decode(cls, encoded_oid):
+ def url_decode(cls, encoded_oid, legacy=False):
  """Create an ObjectId from an encoded hex string.
 
+ The `legacy` parameter is for backwards compatibility only and should
+ almost always be kept False. It might eventually be removed.
+
  The reverse can be achieved using `url_encode()`.
 
  :Parameters:
  - `encoded_oid`: string encoding of an ObjectId (as created
  by `url_encode()`)
+ - `legacy` (optional): use the legacy byte ordering to represent the
+ ObjectId. if you aren't positive you need this it is probably best
+ left as False.
  """
- return cls(encoded_oid.decode("hex"))
+ if legacy:
+ oid = encoded_oid.decode("hex")
+ return cls.from_legacy_str(oid)
+ else:
+ return cls(encoded_oid.decode("hex"))
  url_decode = classmethod(url_decode)
 
+ def legacy_str(self):
+ return self.__id[7::-1] + self.__id[:7:-1]
+
+ def from_legacy_str(cls, legacy_str):
+ return cls(legacy_str[7::-1] + legacy_str[:7:-1])
+ from_legacy_str = classmethod(from_legacy_str)
+
  def __str__(self):
  return self.__id
 

test/test_objectid.py

@@ -62,5 +62,19 @@ def test_url(self):
  encoded = b.url_encode()
  self.assertEqual(b, ObjectId.url_decode(encoded))
 
+ def test_url_legacy(self):
+ a = ObjectId()
+ self.assertNotEqual(a.url_encode(), a.url_encode(legacy=True))
+ self.assertEqual(a, ObjectId.url_decode(a.url_encode(legacy=True), legacy=True))
+
+ def test_legacy_string(self):
+ a = ObjectId()
+
+ self.assertEqual(a.url_encode(legacy=True), a.legacy_str().encode("hex"))
+
+ self.assertNotEqual(str(a), a.legacy_str())
+ self.assertEqual(a, ObjectId.from_legacy_str(a.legacy_str()))
+
+
 if __name__ == "__main__":
  unittest.main()