veniasilente/veekun_pokedex
1
0
Fork 0
mirror of https://github.com/veekun/pokedex.git synced 2024-08-20 18:16:34 +00:00
Code Issues Projects Releases Wiki Activity

Autodoc for backrefs

Browse source
This commit is contained in:
Petr Viktorin 2012-02-12 22:43:59 +01:00
parent 34481e9a11
commit 949ff883ea
2 changed files with 27 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
pokedex/db/tables.py
View file

@ -1407,9 +1407,9 @@ class PokemonSpecies(TableBase):
add_relationship('parent_species', PokemonSpecies,
primaryjoin=PokemonSpecies.evolves_from_species_id==PokemonSpecies.id,
remote_side=[PokemonSpecies.id],
backref='child_species',
info=dict(
description=u"The species from which this one evolves"))
backref=backref('child_species',
info=dict(description=u"The species to which this one evolves")),
info=dict(description=u"The species from which this one evolves"))
add_relationship('evolutions', PokemonEvolution,
primaryjoin=PokemonSpecies.id==PokemonEvolution.evolved_species_id,
backref=backref('evolved_species',
@ -1682,12 +1682,27 @@ def add_relationships():
def add_relationship(name, argument, secondary=None, **kwargs):
cls.relationship_info.setdefault('_order', [])
cls.relationship_info['_order'].append(name)
cls.relationship_info[name] = kwargs.pop('info', {})
cls.relationship_info[name] = info = kwargs.pop('info', {})
cls.relationship_info[name].update(kwargs)
cls.relationship_info[name].update(dict(
type='relationship',
argument=argument,
secondary=secondary))
the_backref = kwargs.get('backref')
if isinstance(the_backref, basestring):
the_backref = backref(the_backref)
if the_backref:
# XXX: This line exploits a SQLA implementation detail,
# after all relationships are converted we should make our
# own backref wrapper with known semantics.
backref_name, backref_kwargs = the_backref
backref_info = dict(
type='backref',
argument=cls,
secondary=secondary)
backref_info.update(backref_kwargs.pop('info', {}))
argument.relationship_info[backref_name] = backref_info
setattr(cls, name, relationship(argument, secondary=secondary,
**kwargs))
add_relationships(add_relationship=add_relationship)

10
pokedex/doc/tabledoc.py
View file

@ -194,8 +194,14 @@ def generate_strings(cls, remaining_attrs):
@with_header(u'Relationships')
def generate_relationships(cls, remaining_attrs):
for rel_name in [c for c in cls.relationship_info.get('_order', [])
if c in remaining_attrs]:
order = cls.relationship_info.get('_order', [])
def sort_key((key, value)):
try:
return 0, order.index(key)
except ValueError:
return 1, key
infos = sorted(cls.relationship_info.items(), key=sort_key)
for rel_name, info in infos:
if rel_name in remaining_attrs:
info = cls.relationship_info.get(rel_name)
yield u'%s.\ **%s**' % (cls.__name__, rel_name)