List of common MagiCircles prefixes and suffixes

↑ Parent: More

Prefixes

Model fields

i_

• Stands for: Integer, because it's used to save string choices as integers
• Documentation: Save choices values as integer rather than strings

c_

• Stands for: CSV, comma separated values
• Documentation: Store comma separated values

d_

• Stands for: Dict, used to store dictionaries within model fields
• Documentation: Store dictionaries
• Note: Used by translated fields to store translations. Key = language, value = translated value.

m_

• Stands for: Markdown, for text fields that allow markdown formatting
• Documentation: Store Markdown texts

d_m_

• Stands for: Dict of Markdown, used to store dictionaries of texts that allow markdown formatting within model fields
• Documentation: Store dictionaries and Store Markdown texts

j_

• Stands for: JSON, store raw JSON data
• Documentation: Store JSON

_cache_

• Stands for: Cache
• Documentation: Use an internal cache for foreign keys in models

_original_

• Stands for: Original image file, before it was optimized with TinyPNG
• Documentation: MagiModel images and files
• Note: use recommended accessor with suffix {}_original, as well as {}_original_url and http_{}_original_url

_tthumbnail_

• Stands for: TinyPNG Thumbnail, a thumbnail generated by TinyPNG
• Documentation: MagiModel images and files
• Note: use recommended accessor with suffix {}_thumbnail, as well as {}_thumbnail_url and http_{}_thumbnail_url

_thumbnail_

• Stands for: Thumbnail, a thumbnail generated by our server, not optimized
• Documentation: MagiModel images and files
• Note: use recommended accessor with suffix {}_thumbnail, as well as {}_thumbnail_url and http_{}_thumbnail_url

_2x_

• Stands for: 2 times the size of the original image, an upgraded version of the original, generally generated by Waifu2x
• Documentation: MagiModel images and files
• Note: use recommended accessor with suffix {}_2x, as well as {}_2x_url and http_{}_2x_url

Model properties

t_

• Stands for: Translated, accessor for translated values
• Documentation: Translate fields values in multiple languages

display_

• Stands for: Display, used to customize how a field should be displayed in views
• Documentation: Customize views with MagiModel properties

has_

• Stands for: Has, for i_ choices only, to check if it has a value
• Documentation: Save choices values as integer rather than strings

cached_

• Stands for: Cached, to access values that have been cached
• Documentation: Use an internal cache for foreign keys in models

cached_t_

• Stands for: Cached translated, access a translation within a cached item
• Documentation: Use an internal cache for foreign keys in models

http_{}_url

• Stands for: HTTP URL, for files and images, allows you to get a full URL that starts with HTTP (vs {}_url which would give you a URL that starts with '//')
• Documentation: MagiModel images and files

Suffixes

Model properties

_url

• Stands for: URL, for files and images, allows you to get a URL that starts with // (see also http_{}_url)
• Documentation: MagiModel images and files

http_{}_url

• Stands for: HTTP URL, for files and images, allows you to get a full URL that starts with HTTP (vs {}_url which would give you a URL that starts with '//')
• Documentation: MagiModel images and files

_thumbnail

• Stands for: Thumbnail
• Documentation: MagiModel images and files
• Note: recommended accessor for images saved in _thumbnail_ and _tthumbnail_. Fallback to regular image (optimized or not).

_2x

• Stands for: 2 times the size of the original image, an upgraded version of the original, generally generated by Waifu2x
• Documentation: MagiModel images and files
• Note: recommended accessor for images saved in _2x_{}, no fallback when None.

_force_2x

• Stands for: 2 times the size of the original image, an upgraded version of the original, generally generated by Waifu2x
• Documentation: MagiModel images and files
• Note: unlike accessor _2x that gives you None if there are no value, this one will return what's in _original as a fallback

_image

• Stands for: Image, shortcut to access the image of an i_ choice
• Documentation: Save choices values as integer rather than strings

→ Next: Coding style