Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix polymodel class_ type inconsistency (#89) #93

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix polymodel class_ type inconsistency (#89) #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/google/appengine/ext/ndb/polymodel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ def _update_kind_map(cls):
cls._kind_map[cls._class_name()] = cls
class_key = cls._class_key()
if class_key:
cls._class_map[tuple(class_key)] = cls
cls._class_map[tuple(map(six.ensure_binary, class_key))] = cls
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone with six.ensure_binary because that's what _class_key was using.

Given the library isn't PY2-compatible and assuming _class_key always returns a list of str, a lambda should be faster:

Suggested change
cls._class_map[tuple(map(six.ensure_binary, class_key))] = cls
cls._class_map[tuple(map(lambda c: c.encode(), class_key))] = cls


@classmethod
def _from_pb(cls, pb, set_key=True, ent=None, key=None):
Expand All @@ -216,7 +216,7 @@ def _class_key(cls):

This is a list of class names, e.g. ['Animal', 'Feline', 'Cat'].
"""
return [six.ensure_binary(c._class_name()) for c in cls._get_hierarchy()]
return [c._class_name() for c in cls._get_hierarchy()]

@classmethod
def _get_kind(cls):
Expand Down
38 changes: 25 additions & 13 deletions tests/google/appengine/ext/ndb/polymodel_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,17 @@ class Sneaker(Shoe):
pump = model.BooleanProperty()

self.assertEqual(Shoe._class_name(), 'Shoe')
self.assertEqual(Shoe._class_key(), [b'Shoe'])
self.assertEqual(Shoe._class_key(), ['Shoe'])
self.assertEqual(Moccasin._class_name(), 'Moccasin')
self.assertEqual(Moccasin._class_key(), [b'Shoe', b'Moccasin'])
self.assertEqual(Moccasin._class_key(), ['Shoe', 'Moccasin'])
self.assertEqual(Sneaker._class_name(), 'Sneaker')
self.assertEqual(Sneaker._class_key(), [b'Shoe', b'Sneaker'])
self.assertEqual(Sneaker._class_key(), ['Shoe', 'Sneaker'])

s_key = model.Key('Shoe', 1)
self.assertEqual(Shoe().put(), s_key)
s = s_key.get()
self.assertEqual(s._get_kind(), 'Shoe')
self.assertEqual(s._class_key(), [b'Shoe'])
self.assertEqual(s._class_key(), ['Shoe'])
self.assertEqual(s.class_, ['Shoe'])

m_key = model.Key('Shoe', 2)
Expand Down Expand Up @@ -124,7 +124,7 @@ class Animal(PolyModel):
class Dog(Animal):
pass
fido = Dog()
self.assertEqual(fido.class_, [b'Animal', b'Dog'])
self.assertEqual(fido.class_, ['Animal', 'Dog'])
self.assertRaises(TypeError, setattr, fido, 'class_', ['Animal', 'Dog'])

def testPolyExpando(self):
Expand Down Expand Up @@ -198,7 +198,7 @@ class Ghoul(Monster, model.Expando):
self.assertEqual(expected_k9.legs, 4)
self.assertEqual(expected_k9._get_kind(), 'Animal')
self.assertEqual(expected_k9._class_name(), 'Canine')
self.assertEqual(expected_k9._class_key(), [b'Animal', b'Canine'])
self.assertEqual(expected_k9._class_key(), ['Animal', 'Canine'])

expected_cat = Cat(name='Tom', naps=12, sound='purr')
self.assertIsInstance(expected_cat, Cat)
Expand All @@ -210,13 +210,13 @@ class Ghoul(Monster, model.Expando):
self.assertEqual(expected_cat.legs, 4)
self.assertEqual(expected_cat._get_kind(), 'Animal')
self.assertEqual(expected_cat._class_name(), 'Cat')
self.assertEqual(expected_cat._class_key(), [b'Animal', b'Feline', b'Cat'])
self.assertEqual(expected_cat._class_key(), ['Animal', 'Feline', 'Cat'])

expected_wolf = Wolf(name='Warg')
self.assertEqual(expected_wolf._get_kind(), 'Animal')
self.assertEqual(expected_wolf._class_name(), 'Wolf')
self.assertEqual(
expected_wolf._class_key(), [b'Animal', b'Canine', b'Wolf'])
expected_wolf._class_key(), ['Animal', 'Canine', 'Wolf'])
self.assertRaises(AttributeError, lambda: expected_wolf.breed)

expected_ghoul = Ghoul(name='Westminster', book=b'The Graveyard Book')
Expand All @@ -225,19 +225,19 @@ class Ghoul(Monster, model.Expando):
self.assertEqual(expected_ghoul._class_name(), 'Ghoul')
self.assertEqual(
expected_ghoul._class_key(),
[b'Animal', b'Feline', b'Cat', b'Canine', b'Dog', b'Monster', b'Ghoul'])
['Animal', 'Feline', 'Cat', 'Canine', 'Dog', 'Monster', 'Ghoul'])

actual_k9 = expected_k9.put().get()
self.assertIsInstance(expected_k9, Canine)
self.assertEqual(expected_k9.name, 'Reynard')
self.assertEqual(expected_k9._get_kind(), 'Animal')
self.assertEqual(expected_k9._class_name(), 'Canine')
self.assertEqual(expected_k9._class_key(), [b'Animal', b'Canine'])
self.assertEqual(expected_k9._class_key(), ['Animal', 'Canine'])
self.assertIsInstance(actual_k9, Canine)
self.assertEqual(actual_k9.name, 'Reynard')
self.assertEqual(actual_k9._get_kind(), 'Animal')
self.assertEqual(actual_k9._class_name(), 'Canine')
self.assertEqual(actual_k9._class_key(), [b'Animal', b'Canine'])
self.assertEqual(actual_k9._class_key(), ['Animal', 'Canine'])
self.assertEqual(actual_k9, expected_k9)

actual_cat = expected_cat.put().get()
Expand Down Expand Up @@ -265,7 +265,7 @@ class Dog(Animal):
fido1 = pickle.loads(s)
self.assertEqual(fido1.name, 'Fido')
self.assertEqual(fido1.breed, 'chihuahua')
self.assertEqual(fido1.class_, [b'Animal', b'Dog'])
self.assertEqual(fido1.class_, ['Animal', 'Dog'])
self.assertEqual(fido, fido1)

def testClassNameOverride(self):
Expand All @@ -282,7 +282,7 @@ class Cat(Feline):
def _class_name(cls):
return 'Pussycat'
tom = Cat()
self.assertEqual(tom.class_, [b'Animal', b'Feline', b'Pussycat'])
self.assertEqual(tom.class_, ['Animal', 'Feline', 'Pussycat'])
tom.put()
expected = [tom]
actual = Cat.query().fetch()
Expand Down Expand Up @@ -340,6 +340,18 @@ class Cat(Animal):
self.assertEqual(Animal.query().filters, None)
self.assertNotEqual(Cat.query().filters, None)

def testEqualityAfterPut(self):
""" See https://github.com/GoogleCloudPlatform/appengine-python-standard/issues/89 """
class Animal(PolyModel):
pass

a = Animal(id=1)
b = Animal(id=1)
a.put()

self.assertEqual(a, b)


TOM_PB2 = """\
key {
app: "ndb-test-app-id"
Expand Down