Database

The app uses pony to manage a sqlite-database. The database is structured as follows.

class acg.db.CD(new_path)

Context manager for changing the current working directory to new_path.

class acg.db.Card

Bases: db.Entity

Object containing the data for a card.

add_media(self, **kwargs)

Add a new MediaFile to this card.

get_media(self, field_key)

Get MediaFile of this card by field_key which is unique.

write_media_files_to_folder(self, folder)

Write media-files in media_files to folder with name folder.

class acg.db.MediaFile

Bases: db.Entity

Class containing a media-file.

card

Relation to Card object.

content

Bytes object with media-file.

field_key

Name of the field of the card which the content belongs to.

id

Unique id.

type

File type, e.g. “mp3”, “jpg”, “png”, etc. …

update(self, **kwargs)

Update attributes by *kwargs.

class acg.db.Template

Bases: db.Entity

Contains data of a fields.Template and all cards that have been generated with the template.

add_card(self, name)

Create a new Card with relation to this template.

additional_info

Additional info.

cards

References to all the cards that have been generated using this template.

description

A short description of the template.

get_card(self, name)

Get a single Card by name. (unique attribute).

get_cards_by_selector(self, selector)

Get cards by selector.

id

Id.

name

A unique name for the template.

classmethod names(cls)

Return list of all Templates in database.

acg.db.update_word_state_dict(word, state)

Set state in app.word_state_dict.