From a289cce2fbd2bf2d9a230fcaab8a787db7bb9590 Mon Sep 17 00:00:00 2001 From: Konsta Vesterinen Date: Wed, 30 Oct 2013 14:42:22 +0200 Subject: [PATCH] Added example for naturally_equivalent --- sqlalchemy_utils/functions/__init__.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/sqlalchemy_utils/functions/__init__.py b/sqlalchemy_utils/functions/__init__.py index 89d4d38..80bf863 100644 --- a/sqlalchemy_utils/functions/__init__.py +++ b/sqlalchemy_utils/functions/__init__.py @@ -243,6 +243,20 @@ def naturally_equivalent(obj, obj2): Returns whether or not two given SQLAlchemy declarative instances are naturally equivalent (all their non primary key properties are equivalent). + + :: + + from sqlalchemy_utils import naturally_equivalent + + + user = User(name=u'someone') + user2 = User(name=u'someone') + + user == user2 # False + + naturally_equivalent(user, user2) # True + + :param obj: SQLAlchemy declarative model object :param obj2: SQLAlchemy declarative model object to compare with `obj` """