2 u
"""Implements the markup used for description and effect text in the database.
4 The language used is a variation of Markdown and Markdown Extra. There are
5 docs for each at http://daringfireball.net/projects/markdown/ and
6 http://michelf.com/projects/php-markdown/extra/ respectively.
8 Pokédex links are represented with the extended syntax `[name]{type}`, e.g.,
9 `[Eevee]{pokemon}`. The actual code that parses these is in spline-pokedex.
11 from __future__
import absolute_import
14 import sqlalchemy
.types
16 class MarkdownString(object):
17 """Wraps a Markdown string. Stringifies to the original text, but .as_html
18 will return an HTML rendering.
20 To add extensions to the rendering (which is necessary for rendering links
21 correctly, and which spline-pokedex does), you must append to this class's
22 `markdown_extensions` list. Yep, that's gross.
25 markdown_extensions
= ['extra']
27 def __init__(self
, source_text
):
28 self
.source_text
= source_text
31 def __unicode__(self
):
32 return self
.source_text
35 return unicode(self
.source_text
).encode()
42 """Returns the string as HTML4."""
44 if self
._as_html
is not None:
47 md
= markdown
.Markdown(
48 extensions
=self
.markdown_extensions
,
50 output_format
='xhtml1',
53 self
._as_html
= md
.convert(self
.source_text
)
59 """Returns the string in a plaintext-friendly form.
61 At the moment, this is just the original source text.
63 return self
.source_text
65 def _markdownify_effect_text(move
, effect_text
):
66 effect_text
= effect_text
.replace(
68 unicode(move
.effect_chance
),
71 return MarkdownString(effect_text
)
73 class MoveEffectProperty(object):
74 """Property that wraps move effects. Used like this:
76 MoveClass.effect = MoveEffectProperty('effect')
78 some_move.effect # returns a MarkdownString
79 some_move.effect.as_html # returns a chunk of HTML
81 This class also performs simple substitution on the effect, replacing
82 `$effect_chance` with the move's actual effect chance.
84 Use `MoveEffectPropertyMap` for dict-like association proxies.
87 def __init__(self
, effect_column
):
88 self
.effect_column
= effect_column
90 def __get__(self
, obj
, cls
):
91 prop
= getattr(obj
.move_effect
, self
.effect_column
)
92 return _markdownify_effect_text(obj
, prop
)
94 class MoveEffectPropertyMap(MoveEffectProperty
):
95 """Similar to `MoveEffectProperty`, but works on dict-like association
98 def __get__(self
, obj
, cls
):
99 prop
= getattr(obj
.move_effect
, self
.effect_column
)
102 newdict
[key
] = _markdownify_effect_text(obj
, newdict
[key
])
105 class MarkdownColumn(sqlalchemy
.types
.TypeDecorator
):
106 """Generic SQLAlchemy column type for Markdown text.
108 Do NOT use this for move effects! They need to know what move they belong
109 to so they can fill in, e.g., effect chances. Use the MoveEffectProperty
110 property class above.
112 impl
= sqlalchemy
.types
.Unicode
114 def process_bind_param(self
, value
, dialect
):
118 if not isinstance(value
, basestring
):
119 # Can't assign, e.g., MarkdownString objects yet
120 raise NotImplementedError
122 return unicode(value
)
124 def process_result_value(self
, value
, dialect
):
128 return MarkdownString(value
)