Remind-You Part2. setup.py打包代码, socket通讯

插线板的英文是socket噢！！！

内容

• 完成dict plugin的服务端启动socket监听
• 将Project使用setuptools进行打包
• 生成客户端程序save_word
• 使用argparse解析命令行参数

仓库代码中的day2分支 https://github.com/bymzy/remind-you/tree/day2

效果

使用python setup.py bdist_rpm生成rpm包，然后使用rpm -ivh remind_you-0.1-1.noarch.rpm安装。python库目录中将会安装remind_you包，同时会在系统目录中增加可执行文件save_word。
启动dict plugin服务端:

服务端启动后，dict plugin监听在目标端口

执行save_word命令

save_word命令执行

可以看到，客户端执行save_word命令后，服务端能够收到客户端的消息。

使用的库

setuptools

使用setuptools对整个代码打包(个人比较喜欢打成rpm包python setup.py bdist_rpm，方便安装删除)。同时，使用setuptools生成可执行文件(save_word)。仓库最上层目录下的setup.py文件记录了配置信息，代码如下：

from setuptools import setup, find_packages

setup(
    name = 'remind_you',
    version = '0.1',
    packages = find_packages(),
    package_data = { 
        '':['*.conf']
    },  
    data_files = [('/etc/', ['remind_you/plugins/scheduler.conf'])],
    author = 'mingzhengying',
    description = 'remind you something!!!',
    entry_points = { 
        'console_scripts': [
            'save_word = remind_you.cmds:save_word_cmd',
            ]   
    }   
)

setuptools是distutils的加强版本，上述配置文件中重要部分说明如下

• packages = find_packages() 表示在当前setup.py同等目录下寻找源文件
• package_data 部分表示将所有的包目录下*.conf文件进行打包
• data_files用来将配置文件，安装到/etc目录下
• console_scripts用来生成命令行执行程序，程序的执行入口是remind_you.cmds.save_word_cmd这个函数

socket， argparse

使用最简单的socket阻塞模型。dict plugin读取配置文件，然后监听在特定的端口上。客户端命令运行后同样读取配置文件，连接服务器端。

dict plugin服务端代码如下：

def generate_request(_word, _trans):
    trans = pack_int(_trans)
    word = pack_str(_word)
    totalLen = 4 + len(trans) + len(word)
    return pack_int(totalLen) + trans + word

def recv_request(cl):
    tmp = recv_len(cl, 4)
    wordLen = unpack_int(tmp)
    data = recv_len(cl, wordLen)
    trans = unpack_int(data[0:4])
    word = unpack_str(data[4:])
    return word, trans

def run(args):
    print 'my pid is: %u , %s ' % (os.getpid(), args)
    port = args.get('port')
    ip = args.get('ip')
    dbPath = args.get('db')

    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    sock.bind((ip, port))
    sock.listen(5)

    while True:
        cl, addr = sock.accept()
        word, trans = recv_request(cl)
        print 'receive word %s , need trans %d: ' % (word, trans)
        cl.close()

run方法作为dict plugin进程的主方法，会被主进程启动，然后监听在某个端口上。后续有客户端连接后，从客户端的输入中解析出请求的word, trans，分别表示单词，和是否返回翻译信息。目前的实现中，服务端仅仅会将得到的信息打印出来，然后断开连接等待下个请求。

---

客户端代码如下：

cmds.py

from plugins import dict_cmd

def save_word_cmd():
    dict_cmd.run()

setup.py配置中，生成的客户端命令save_word最终会调用save_word_cmd，进而调用dict_cmd.run(）方法。

dict_cmd.py

CONF = '/etc/scheduler.conf'
PLUGIN_NAME = 'dict'

def get_ip_port():
    with open(CONF) as f:
        data = f.read()

    di = json.loads(data)
    for plugin in di.get('plugins', []):
        if plugin.get('name') == PLUGIN_NAME:
            return plugin.get('args').get('ip'), plugin.get('args').get('port')
    return None, None

def parse_cmd_args():
    args_parser = argparse.ArgumentParser()
    args_parser.add_argument("-w", "--word", type=str, required=True);
    args_parser.add_argument('-t', '--trans', action='store_true', default=False);

    args = args_parser.parse_args()
    #use vars to get a dict
    #print vars(args), type(vars(args))
    return args.word, args.trans

def run():
    ip, port = get_ip_port()
    word, trans = parse_cmd_args()
    s = connect_ip_port(ip, port)
    if s is None:
        print 'connect to server %s:%d failed!!!' % (ip, port)
        sys.exit(1)
    req = generate_request(word, trans)
    send_data(s, req)

客户端的save_word命令，调用dict_cmd.run()方法后会做如下事情：

• 读取配置文件得到服务端的ip，port
• 解析命令行参数
• 生成请求req数据
• 调用send_data将req数据发送给服务端

send_data, connect_ip_port等函数在util.py中定义