pycinputbar使用说明

概述：

　　pycinputbar是一个Python模块，可以在Windows控制台(CMD)中实现可以控制的输入条，返回一个Unicode字符串。

　　目前该模块只支持Python2。

　　目前版本实现了基本的输入功能。同时支持字符串长度限制，响应左右光标键，BackSpace键、Delete(Del)键，字符插入等功能。

　　pycinputbar需要WConio模块支持，WConio模块官方地址：http://newcenturycomputers.net/projects/wconio.html

项目地址：

　　https://code.csdn.net/hymyg/pycinputbar/tree/master

反馈及支持：

　　https://code.csdn.net/hymyg/pycinputbar/issues?closed=0

版本更新：

　　V0.1　　　　实现了基本的输入功能。　　　　支持字符串长度限制，响应左右光标键，BackSpace键、Delete(Del)键，字符插入　　　　　　V0.2　　　　增加 显示默认字符串功能，可在命令执行时在输入条中显示用户自已定义的字符串以达到对现有变量修改的作用。　　V0.3　　　　增加 字符校验功能。　　　　增加 字符串录入时显示为*号问题(可用来作为密码录入框)　　V0.4　　　　增加 对Home键和End键的支持。按Home键，光标移动到输入条首字母处，按End键，光标移动到字符串尾部。　　V0.5　　　　增加 对Esc键的支持。按Esc键将会清除已经输入的字符串，并将光标移动到输入框行首，需要设置参数return_FunKey=1。　　　　增加 Up键、Down键、F1键结束输入的支持的同时返回结束输入的功能键名称。需要设置参数return_FunKey=1。　　　　修复 字符串为空时按左、右光标键报错的BUG。

安装：

　　将pycinputbar.py文件复制到python2安装路径下的Lib\site-packages目录中。

示例：

　　我使用的是python2.7.12，安装目录是C:\Program Files (x86)\python\Python27，将pycmenu.py文件复制到C:\Program Files (x86)\python\Python27\Lib\site-packages路径下即可

使用说明：

inputbar(prompt,text,length,check=True)

参数：

prompt

　　提示信息，必须为unicode编码,所以字符串前面要加前缀u

text

　　默认(初始)字符串内容，通常对一个已经存在的字符串进行修改时使用。该参数也必须为unicode格式的字符串。

length

　　字符串长度，一个全角字符的长度为2，一个半角字符的长度为1

check

　　check参数是用来对已经输入的字符串进行校验。
　　check有两种情况，一种可以是一个值，另一种可以是一个函数。

　　check是一个值时又分三种情况：

　　1、这个值如果为True或是其他任何非0的值，输入框可以输入任意可打印字符，即不做任何校验。

　　2、这个值如果是False或是0，则此输入框不接受任何输入（这个功能其实是程序实现过程中的副产品，想着也许会有人用的着，就保留了）。

　　3、这个值如果是’‘，则输入的字符只显示为号，一般在输入密码时使用。

　　check是一个函数时（暂且称之为“校验函数”），事实上是提供了一个接口，可以由用户自己定义字符串的校验函数。每输入一个字符或汉字时，该校验函数都会对已经输入部分的字符串进行检验，如果满足函数内部条件的限制（函数返回Ture or False)，满足则接受输入，否则不接受输入。

　　　　校验函数的参数：

　　　　　　这个函数必须有一个text参数用来接受用户输入的字符串。

　　　　　　text　　当前已经录入的字符串，在input()主函数中由程序自己传入。

　　　　校验函数的格式为：

　　　　　　check(text)

　　　　校验函数的返回值：

　　　　　　返回值只能是True，或是False

　　　　　　True 当返回值是True时代表接受这个字符的输入这个字符的输入

　　　　　　False 当返回值是False时代表不接受这个字符的输入

　　check默认值为True

retrun_FunKey

　　return_FunKey参数有两个值，分别为0和1。

　　return_FunKey=0时，用户在输入过程只中能按Enter键结束输入，且inputbar()函数只会返回用户输入的字符串。return_FunKey的默认值就是0。

　　return_FunKey=1时，用户须输入过程中可以通过按以下键退出输入：

　　　　F1键

　　　　Up键

　　　　Down键

　　除此以外，inputbar()函数会返回一个包含两个元素的列表，列表的第一个元素是用户输入的字符串,第二个元素是用户退出输入时的按键名称，即Enter、F1、Up、Down。

示例1：

#-*-coding:utf-8-*-import pycinputbarprint                                   #打印一个空行，只是为了美观pycinputbar.inputbar(u'请输入姓名：',u'',4)

示例1执行结果展示

示例2：

#-*-coding:utf-8-*-import pycinputbarprint                                   #打印一个空行，只是为了美观pycinputbar.inputbar(u'请输入字符：',u'abc一二三',20)

示例2执行结果展示

示例3：（对现有变量进行修改）

#-*-coding:utf-8-*-import pycinputbarprint                                   #打印一个空行，只是为了美观a=pycinputbar.inputbar(u'请输入变量a的值：',u'',20)print aa=pycinputbar.inputbar(u'对变量值a进行修改：',a,20)print a

示例3执行结果展示

示例4（密码框）

#-*-coding:utf-8-*-from pycinputbar import inputbarprintpassword=inputbar(u'请输入密码：',u'',8,'*')printprint u'你的密码是：',password

示例4执行结果展示

示例5（使用自定义函数对输入进行校验）

#-*-coding:utf-8-*-from pycinputbar import inputbardef limit(text):    '''    限定第一位能输入字符D，第二位只能输入A、B、C三个字符中的一个，第五位只能输入字符8    '''    for i in range(len(text)):        if i==0:            if text[i]!=u'D':                return False        elif i==1:            if text[i] not in u'ABC':                return False        elif i==4:            if text[i]!=u'8':                return False    return True                       #这个return不能放在for循环中printpassword=inputbar(u'请输入字符串：',u'',8,limit)printprint u'你的字符串是：',password

示例5说明（供新手参考，高手绕行）

　　1、示例5中的代码执行效果因为是动态的，截图不能表达的清楚，所以省略截图。文字描述就是用户录入时，录入到相应位置的字符，如果跟limit函数中的条件不符合，则输入框不会接受输入，但从界面上来看不会有任何变化。通俗的讲就是不符合条件的字符打不上屏幕。

　　2、示例5代码中的 password=inputbar(u'请输入字符串：',u'',8,limit)中的 limit虽然是一个函数，但在写入时不需要加括号写在limit()的形式。

　　3、用来作为check参数的自定义函数limit(text)中的代码只是参考，当然写法也可以多种多样，但在写入的时候要考虑到IndexError的问题。

　　比如直接使用text[5]时要确保text字符串第6位字符已经存在（被用户录入），否则会出现 IndexError: string index out of range 错误提示。所以示例5代码中通过for循环和if语句来避免这种情况的发生。
　　

　　当然，也可以使用正则表达式进行校验，但同样正则表达式的代码要考虑到你设定条件的字符位已经被用户输入（即是否已经存在）。

示例6(return_FunKey=1）

#-*-coding:utf-8-*-from pycinputbar import inputbara=inputbar(u'',u'',10,return_FunKey=1)printprint a

示例6执行结果展示