Customized edit_behavior.py for Annki Chinese Support Plugin. Pulls word usage examples from dict.cn

edit_behavior.py

# -*- coding: utf-8 -*-
# Welcome to the Chinese Support Add-on's field edition ruleset.
# Here, you can tweak the note editor helper's behavior to your liking.
#
# If you messed things up, you can safely delete file 
# addons/chinese/edit_behavior.py from your Anki directory.
# It will be recreated the next time you restart Anki.
#
# You can read about all available functions at:
# https://github.com/ttempe/chinese-support-addon/wiki/Edit-behavior
# Also, see the Python tutorial at http://docs.python.org/2/tutorial

from edit_functions import *
import urllib
import urllib2
import re

anki1_model_names    = ["Chinese", "chinese", "Mandarin Vocab"] #"Mandarin" is used by the Pinyin Toolkit port by Chris Hatch
Hanzi_fields         = ["Expression", "Hanzi", "Chinese",  u"汉字", u"中文"]
Color_fields         = ["Color", "Colour", "Colored Hanzi", u"彩色"]
Transcription_fields = ["Reading", "Pinyin", "PY", u"拼音"]
Meaning_fields       = ["Meaning", "Definition", "English", "German", \
"French", u"意思", u"翻译", u"英语", u"法语", u"德语", u"法文", u"英文", u"德文"]
Sound_fields         = ["Audio", "Sound", "Spoken", u"声音"]
Simplified_fields    = ["Simplified", "Simp", "简体"]
Traditional_fields   = ["Traditional", "Trad", "繁体"]
Mean_Word_fields     = ["Mean Word", "MW", "Mean", "Classifier", "量词"]
Alternate_fields     = ["Also writted", "Alt", "Alternate"]
Ruby_fields          = ["Ruby"]
Silhouette_fields    = ["Silhouette"]

def build_query_url(source):
    qdict = source.encode('utf-8')
    return "http://dict.cn/" + urllib.quote(qdict)

def get_html(get_url):
    request = urllib2.Request(get_url)
    response = urllib2.urlopen(request)
    return response.read()
	
def update_fields(field, updated_field, model_name, model_type):
    # Update the Usage area with examples from dict.cn
    if updated_field == "Hanzi":
        get_url = build_query_url(field["Hanzi"])
	html = get_html(get_url)
        r = re.compile('<ol slider="2">.+?<\/ol>',re.DOTALL)
	usage_examples = r.search(unicode(html,"UTF-8")).group()
        field["Usage"] = unicode(usage_examples)
    
    #1st case : the new Ruby-based model
    if model_type == "Chinese Ruby":
        if updated_field == "Hanzi":
            #Update the ruby
            h = colorize(ruby(accentuate_pinyin(field["Hanzi"])))
            #Add the toneless transcription and hanzi, hidden, 
            #to make them searchable
            h = hide_ruby(h)
            field["Hanzi"] = h
            if field["Hanzi"] == "":
                field["Meaning"] = ""
            elif field["Meaning"] == "":
                field["Meaning"] = translate( field["Hanzi"] )
        elif updated_field[0:5] == "Hanzi":#Field name starts with "Hanzi"
            field[updated_field] = \
                colorize( ruby( accentuate_pinyin( field[updated_field] ) ) )

    #2nd case : use the old Anki1 Pinyin-toolkit rule1s if the deck is
    #called "Chinese" or was created as "Chinese (compatibility)" from
    #Anki2.
    #Note that we accept multiple field names for each field, to ensure
    #Anki1 compatibility.
    else:

        #Fields to update after the Hanzi field has been modified:
        if updated_field in Hanzi_fields:

            #Update Meaning field only if empty.
            m = ""
            if get_any(Meaning_fields, field)  == "" :
                m = translate(field[updated_field])
                #If there's no mean word field, then add it here
                if not has_field(Mean_Word_fields, field):
                    mw = get_mean_word(field[updated_field])
                    if mw:
                        m += "<br>Cl: "+mw
                #If there's no alt spelling field, then add it here
                if not has_field(Alternate_fields, field):
                    mw = get_alternate_spellings(field[updated_field])
                    if mw:
                        m += "<br>Also written: "+mw
                set_all(Meaning_fields, field, to = m)
            
            #Update Mean word field only if empty.
            if get_any(Mean_Word_fields, field)  == "" :
                m = get_mean_word(field[updated_field])
                set_all(Mean_Word_fields, field, to = m)
                
            #Update alt spelling field only if empty.
            if get_any(Alternate_fields, field)  == "" :
                m = get_alternate_spellings(field[updated_field])
                set_all(Alternate_fields, field, to = m)

            #Update Silhouette
            m = silhouette(get_any(Hanzi_fields,field))
            set_all(Silhouette_fields, field, to = m)
                

            #Update transcription field with default transcription (Pinyin?)
            #Only if it's empty
            if get_any(Transcription_fields, field)  == "" :
                t = colorize( transcribe( no_sound( field[updated_field] ) ) )
                #Hide the unaccented transcription in the field, 
                #to make searching easier
                t = hide(t, no_tone(t))
                set_all(Transcription_fields, field, to = t )

            #Erase other fields if the updated field was emptied
            if field[updated_field]=="":
                set_all(Meaning_fields, field, to="")
                set_all(Transcription_fields, field, to="")
                set_all(Sound_fields, field, to="")
                set_all(Simplified_fields, field, to="")
                set_all(Traditional_fields, field, to="")
                set_all(Mean_Word_fields, field, to="")
                set_all(Alternate_fields, field, to="")
                set_all(Ruby_fields, field, to="")
                set_all(Silhouette_fields, field, to="")

            #Update Color field from the Hanzi field, 
            #Take the tone info from the Transcription field
            h = no_sound( field[updated_field])
            t = no_sound( no_color(get_any(Transcription_fields, field) ) )
            c = colorize_fuse( h, t )
            set_all(Color_fields, field, to = c )

            #Update Sound field from Hanzi field if non-empty
            #(only if field actually exists, as it implies downloading 
            #a soundfile from Internet)
            if has_field(Sound_fields, field) and \
                    get_any(Sound_fields, field)=="":
                set_all(Sound_fields, field, to = sound(field[updated_field]))
				
            #Update simplified/traditional fields 
            #If it's the same, leave empty, so as to make this feature unobtrusive to simplified chinese users
            s = simplify(field[updated_field])
            if s <> field[updated_field]:
                set_all(Simplified_fields, field, to = s )
            else:
                set_all(Simplified_fields, field, to = "" )
            t = traditional(field[updated_field])
            if t <> field[updated_field]:
                set_all(Traditional_fields, field, to = t )
            else:
                set_all(Traditional_fields, field, to = "" )

            #Update ruby field
            m = colorize_fuse(get_any(Hanzi_fields, field), get_any(Transcription_fields, field), ruby=True)
            set_all(Ruby_fields, field, to = m)

        #If the transcription was modified, update the Color field
        elif updated_field in Transcription_fields:
            t = colorize( accentuate_pinyin( separate_pinyin(no_color(field[updated_field] ) )))
            t = hide(t, no_tone(t))
            field[updated_field] = t
            h = no_sound( get_any( Hanzi_fields, field) )
            t = no_sound( no_color( field[updated_field] ) )
            set_all(Color_fields, field, to = colorize_fuse( h, t ) ) 

            #Update ruby field
            m = colorize_fuse(get_any(Hanzi_fields, field), get_any(Transcription_fields, field), ruby=True)
            set_all(Ruby_fields, field, to = m)

                    
    return field