from pyandform import is_form_same, is_pinyin_same  # pyandform 为解压后的文件夹名

def is_pinyin_same(words1, words2):
    """ 判断两个词语是否同音
    :param words1: 词语 1，unicode 编码
    :param words2: 词语 2，unicode 编码
    :return: 是否同音，布尔型
    example: >> is_pinyin_same(u'重要', u"你要")
                False
    """

def is_form_same(words1, words2, return_number=False):
    """ 判断两个词语是否形近
    :param words1: 词语 1，unicode 编码
    :param words2: 词语 2，unicode 编码
    :param return_number: 返回结果是否为 编辑距离数值，默认为 False
    :return: 是否形近，布尔型 （笔顺的编辑距离小于 3 则认为形近，否则为不形近）。
            当 return_number = True 时，返回结果为两个字符串笔顺的编辑距离取值，int 型
    example: >> is_form_same(u'习大大', u"习夶", return_number=True)
                1
             >> is_form_same(u'习大大', u"习夶")
                True
    """

def is_words_same(words1, words2):
    """ 判断两个句子是否相近
        :param words1: 词语 1，unicode 编码
        :param words2: 词语 2，unicode 编码
        :return: 是否形近，布尔型 （编辑距离小于 3，则认为相近，否则不相近）。
        example: >> is_words_same(u'习大大', u'大大习')
                    True
                 >> is_form_same(u'习大大', u"习夶")
                    False
        """

>> from pyandform import is_form_same, is_pinyin_same, is_words_same  
>> is_pinyin_same(u'重要', u"你要")
    False
>>
>> is_form_same(u'习大大', u"习夶", return_number=True)
    1
>> is_form_same(u'习大大', u"习夶")
    True
>> is_words_same(u'习大大', u'大大习')
    True
>> is_form_same(u'习大大', u"习夶")
    False