Make a bunch of text columns nullable to support missing translations

diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py
index 727582c..5670da9 100644 (file)
--- a/pokedex/db/tables.py
+++ b/pokedex/db/tables.py
@@ -121,9 +121,9 @@ create_translation_table('ability_names', Ability, 'names',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('ability_prose', Ability, 'prose',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('ability_prose', Ability, 'prose',

-    effect = Column(markdown.MarkdownColumn(5120), nullable=False,
+    effect = Column(markdown.MarkdownColumn(5120), nullable=True,

         info=dict(description="A detailed description of this ability's effect", format='markdown')),
         info=dict(description="A detailed description of this ability's effect", format='markdown')),

-    short_effect = Column(markdown.MarkdownColumn(255), nullable=False,
+    short_effect = Column(markdown.MarkdownColumn(255), nullable=True,

         info=dict(description="A short summary of this ability's effect", format='markdown')),
 )
 
         info=dict(description="A short summary of this ability's effect", format='markdown')),
 )
 


@@ -232,9 +232,9 @@ class ContestEffect(TableBase):
         info=dict(description="The base number of hearts the user's opponent loses"))
 
 create_translation_table('contest_effect_prose', ContestEffect, 'prose',
         info=dict(description="The base number of hearts the user's opponent loses"))
 
 create_translation_table('contest_effect_prose', ContestEffect, 'prose',

-    flavor_text = Column(Unicode(64), nullable=False,
+    flavor_text = Column(Unicode(64), nullable=True,

         info=dict(description="The in-game description of this effect", official=True, format='gametext')),
         info=dict(description="The in-game description of this effect", official=True, format='gametext')),

-    effect = Column(Unicode(255), nullable=False,
+    effect = Column(Unicode(255), nullable=True,

         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 
         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 


@@ -250,11 +250,11 @@ class ContestType(TableBase):
 
 create_translation_table('contest_type_names', ContestType, 'names',
     relation_lazy='joined',
 
 create_translation_table('contest_type_names', ContestType, 'names',
     relation_lazy='joined',

-    name = Column(Unicode(6), nullable=False, index=True,
+    name = Column(Unicode(6), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=True)),
         info=dict(description="The name", format='plaintext', official=True)),

-    flavor = Column(Unicode(6), nullable=False,
+    flavor = Column(Unicode(6), nullable=True,

         info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')),
         info=dict(description="The name of the corresponding Berry flavor", official=True, format='plaintext')),

-    color = Column(Unicode(6), nullable=False,
+    color = Column(Unicode(6), nullable=True,

         info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')),
 )
 
         info=dict(description=u"The name of the corresponding Pokéblock color", official=True, format='plaintext')),
 )
 


@@ -500,9 +500,9 @@ create_translation_table('item_names', Item, 'names',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('item_prose', Item, 'prose',
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
 )
 create_translation_table('item_prose', Item, 'prose',

-    short_effect = Column(markdown.MarkdownColumn(256), nullable=False,
+    short_effect = Column(markdown.MarkdownColumn(256), nullable=True,

         info=dict(description="A short summary of the effect", format='markdown')),
         info=dict(description="A short summary of the effect", format='markdown')),

-    effect = Column(markdown.MarkdownColumn(5120), nullable=False,
+    effect = Column(markdown.MarkdownColumn(5120), nullable=True,

         info=dict(description=u"Detailed description of the item's effect.", format='markdown')),
 )
 create_translation_table('item_flavor_summaries', Item, 'flavor_summaries',
         info=dict(description=u"Detailed description of the item's effect.", format='markdown')),
 )
 create_translation_table('item_flavor_summaries', Item, 'flavor_summaries',


@@ -540,9 +540,9 @@ class ItemFlag(TableBase):
         info=dict(description="Identifier of the flag", format='identifier'))
 
 create_translation_table('item_flag_prose', ItemFlag, 'prose',
         info=dict(description="Identifier of the flag", format='identifier'))
 
 create_translation_table('item_flag_prose', ItemFlag, 'prose',

-    name = Column(Unicode(24), nullable=False, index=True,
+    name = Column(Unicode(24), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(Unicode(64), nullable=False,
+    description = Column(Unicode(64), nullable=True,

         info=dict(description="Short description of the flag", format='plaintext')),
 )
 
         info=dict(description="Short description of the flag", format='plaintext')),
 )
 


@@ -784,9 +784,9 @@ class MoveDamageClass(TableBase):
 
 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',
     relation_lazy='joined',
 
 create_translation_table('move_damage_class_prose', MoveDamageClass, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(16), nullable=False, index=True,
+    name = Column(Unicode(16), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(Unicode(64), nullable=False,
+    description = Column(Unicode(64), nullable=True,

         info=dict(description="A description of the class", format='plaintext')),
 )
 
         info=dict(description="A description of the class", format='plaintext')),
 )
 


@@ -799,9 +799,9 @@ class MoveEffect(TableBase):
         info=dict(description="A numeric ID"))
 
 create_translation_table('move_effect_prose', MoveEffect, 'prose',
         info=dict(description="A numeric ID"))
 
 create_translation_table('move_effect_prose', MoveEffect, 'prose',

-    short_effect = Column(Unicode(256), nullable=False,
+    short_effect = Column(Unicode(256), nullable=True,

         info=dict(description="A short summary of the effect", format='plaintext')),
         info=dict(description="A short summary of the effect", format='plaintext')),

-    effect = Column(Unicode(5120), nullable=False,
+    effect = Column(Unicode(5120), nullable=True,

         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 
         info=dict(description="A detailed description of the effect", format='plaintext')),
 )
 


@@ -877,9 +877,9 @@ class MoveFlagType(TableBase):
 
 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
     relation_lazy='joined',
 
 create_translation_table('move_flag_type_prose', MoveFlagType, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(32), nullable=False, index=True,
+    name = Column(Unicode(32), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(markdown.MarkdownColumn(128), nullable=False,
+    description = Column(markdown.MarkdownColumn(128), nullable=True,

         info=dict(description="A short description of the flag", format='markdown')),
 )
 
         info=dict(description="A short description of the flag", format='markdown')),
 )
 


@@ -979,9 +979,9 @@ class MoveTarget(TableBase):
 
 create_translation_table('move_target_prose', MoveTarget, 'prose',
     relation_lazy='joined',
 
 create_translation_table('move_target_prose', MoveTarget, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(32), nullable=False, index=True,
+    name = Column(Unicode(32), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(Unicode(128), nullable=False,
+    description = Column(Unicode(128), nullable=True,

         info=dict(description="A description", format='plaintext')),
 )
 
         info=dict(description="A description", format='plaintext')),
 )
 


@@ -1072,9 +1072,9 @@ class Pokedex(TableBase):
 
 create_translation_table('pokedex_prose', Pokedex, 'prose',
     relation_lazy='joined',
 
 create_translation_table('pokedex_prose', Pokedex, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(16), nullable=False, index=True,
+    name = Column(Unicode(16), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(Unicode(512), nullable=False,
+    description = Column(Unicode(512), nullable=True,

         info=dict(description=u"A longer description of the Pokédex", format='plaintext')),
 )
 
         info=dict(description=u"A longer description of the Pokédex", format='plaintext')),
 )
 


@@ -1202,9 +1202,9 @@ class Pokemon(TableBase):
 
 create_translation_table('pokemon_names', Pokemon, 'names',
     relation_lazy='joined',
 
 create_translation_table('pokemon_names', Pokemon, 'names',
     relation_lazy='joined',

-    name = Column(Unicode(20), nullable=False, index=True,
+    name = Column(Unicode(20), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=True, ripped=True)),
         info=dict(description="The name", format='plaintext', official=True, ripped=True)),

-    species = Column(Unicode(16), nullable=False,
+    species = Column(Unicode(16), nullable=True,

         info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"',
         official=True, format='plaintext')),
 )
         info=dict(description=u'The short flavor text, such as "Seed" or "Lizard"; usually affixed with the word "Pokémon"',
         official=True, format='plaintext')),
 )


@@ -1389,7 +1389,7 @@ PokemonFormGroup.id = PokemonFormGroup.pokemon_id
 create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose',
     term = Column(Unicode(16), nullable=True,
         info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')),
 create_translation_table('pokemon_form_group_prose', PokemonFormGroup, 'prose',
     term = Column(Unicode(16), nullable=True,
         info=dict(description=u"The term for this Pokémon's forms, e.g. \"Cloak\" for Burmy or \"Forme\" for Deoxys.", official=True, format='plaintext')),

-    description = Column(markdown.MarkdownColumn(1024), nullable=False,
+    description = Column(markdown.MarkdownColumn(1024), nullable=True,

         info=dict(description=u"Description of how the forms work", format='markdown')),
 )
 
         info=dict(description=u"Description of how the forms work", format='markdown')),
 )
 


@@ -1481,9 +1481,9 @@ class PokemonMoveMethod(TableBase):
 
 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',
     relation_lazy='joined',
 
 create_translation_table('pokemon_move_method_prose', PokemonMoveMethod, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(64), nullable=False, index=True,
+    name = Column(Unicode(64), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    description = Column(Unicode(255), nullable=False,
+    description = Column(Unicode(255), nullable=True,

         info=dict(description=u"A detailed description of how the method works", format='plaintext')),
 )
 
         info=dict(description=u"A detailed description of how the method works", format='plaintext')),
 )
 


@@ -1499,9 +1499,9 @@ class PokemonShape(TableBase):
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
     relation_lazy='joined',
 
 create_translation_table('pokemon_shape_prose', PokemonShape, 'prose',
     relation_lazy='joined',

-    name = Column(Unicode(24), nullable=False, index=True,
+    name = Column(Unicode(24), nullable=True, index=True,

         info=dict(description="The name", format='plaintext', official=False)),
         info=dict(description="The name", format='plaintext', official=False)),

-    awesome_name = Column(Unicode(16), nullable=False,
+    awesome_name = Column(Unicode(16), nullable=True,

         info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
 )
 
         info=dict(description=u"A splendiferous name of the body shape", format='plaintext')),
 )
 

diff --git a/pokedex/tests/test_schema.py b/pokedex/tests/test_schema.py
index 83f9de7..2ad795c 100644 (file)
--- a/pokedex/tests/test_schema.py
+++ b/pokedex/tests/test_schema.py
@@ -171,6 +171,7 @@ def test_texts():
             good_formats = 'identifier latex'.split()
             assert_text = '%s is not language-specific'
         columns = sorted(cls.__table__.c, key=lambda c: c.name)
             good_formats = 'identifier latex'.split()
             assert_text = '%s is not language-specific'
         columns = sorted(cls.__table__.c, key=lambda c: c.name)

+        text_columns = []

         for column in columns:
             format = column.info.get('format', None)
             if format is not None:
         for column in columns:
             format = column.info.get('format', None)
             if format is not None:


@@ -183,6 +184,7 @@ def test_texts():
                     raise AssertionError('%s: identifier column name/type mismatch' % column)
                 if column.info.get('official', None) and format not in 'gametext plaintext':
                     raise AssertionError('%s: official text with bad format' % column)
                     raise AssertionError('%s: identifier column name/type mismatch' % column)
                 if column.info.get('official', None) and format not in 'gametext plaintext':
                     raise AssertionError('%s: official text with bad format' % column)

+                text_columns.append(column)

             else:
                 if isinstance(column.type, (markdown.MarkdownColumn, tables.Unicode)):
                     raise AssertionError('%s: text column without format' % column)
             else:
                 if isinstance(column.type, (markdown.MarkdownColumn, tables.Unicode)):
                     raise AssertionError('%s: text column without format' % column)


@@ -190,6 +192,11 @@ def test_texts():
                 raise AssertionError('%s: non-plaintext name' % column)
             # No mention of English in the description
             assert 'English' not in column.info['description'], column
                 raise AssertionError('%s: non-plaintext name' % column)
             # No mention of English in the description
             assert 'English' not in column.info['description'], column

+        # If there's more than one text column in a translation table,
+        # they have to be nullable, to support missing translations
+        if hasattr(cls, 'local_language') and len(text_columns) > 1:
+            for column in text_columns:
+                assert column.nullable

 
 def test_identifiers_with_names():
     """Test that named tables have identifiers, and non-named tables don't
 
 def test_identifiers_with_names():
     """Test that named tables have identifiers, and non-named tables don't