一、为什么要进行模块结构调整

  当一个脚本中有大量的配置、方法及接口时,脚本显得十分臃肿,可读性很差。为了提高代码的易读性,可以将一个繁杂的脚本根据不同的功能放在不同的目录下分类管理,这整个过程叫做模块结构调整。完成模块结构调整后的代码可读性强,修改起来也更简单,调整后的代码在任何服务器、操作系统都可以执行,不会报错。

二、模块结构调整实例

注册接口

  (1)注册信息存入redis数据库

  (2)redis的key用string类型的,密码使用md5加密

  (3)注册时需要校验用户是否已经被注册

登录接口

  (1)登录成功之后,返回seesionid、用户登录时间

  (2)如果用户是第一次登录或者seesion已失效,需要在redis中存入session。sessionid计算规则:(用户名+当前的时间戳 )md5加密,失效时间是60分钟

  (3)存入redis的session格式如下:

      Key:session:niuniu

      Value:{"seessionid":a5dfcb047721e02a6f8bff779c815165,"login_time":201805051820}

  (4)如果已经登录且未失效,则直接返回session和用户登录时间

1、创建API主目录及其下面各子目录

  (1)bin:存放启动服务的可执行脚本

  (2)config:存放配置文件,如mysql, redis的配置信息

  (3)data:存放sql语句,创建表格或者类似的东西

  (4)lib:存放开发使用到的函数和开发好的接口

  (5)logs:存放日志文件

  (6)readme:简要介绍程序运行及参数修改的说明文档

2、将主目录(my_api)加入环境变量

  各个模块(文件)放在不同的目录下相互引用,引用自己写的的Python文件做为模块时需要将路径加入环境变量,否则会报错。选中主目录右键→Mark Directory as→Sources Root后,Pycharm将整个api文件夹统一加入环境变量。但这种方式只对这台机器有效果,如果换一台机器或者把这个my_api项目放到服务器上执行,这种方式是不行的。所以一般使用这种方式加入环境变量是便于我们在Pycharm上编写和调试代码,另外一种加入环境变量的方式会在后面讲到。

3、将不同功能的Python文件放入对应的目录

a、将配置文件setting.py文件放入config目录下,存入要用到的配置参数,如:REDIS、MySQL配置信息以及服务端口等。

 # redis配置信息
REDIS_INFO = {
'host':'127.0.0.1',#IP
'password':'', #密码
'db':1, #数据库
'port':6379, #端口号
} # mysql配置信息
MYSQL_INFO = {
'host':'192.168.1.112',#IP
'user':'test', #用户名
'passwd':'', #密码
'db':'test', #数据库
'port':3306, #端口号
'charset':'utf8', #字符集
} # 服务端口号
SERVER_PORT = 8888

b、tools.py文件放入lib目录下,存放操作REDIS、MySQL以及MD5加密函数

 from config.setting import MYSQL_INFO,REDIS_INFO  # 从config.setting文件导入REDIS和MYSQL连接参数
# 连接mysql
def my_db(sql):
import pymysql
conn = pymysql.connect(**MYSQL_INFO)
cur = conn.cursor()
cur.execute(sql)
if sql.strip().split()[0].upper() == 'SELECT':
res = cur.fetchall()
else:
conn.commit()
res = 'OK'
cur.close()
conn.close()
return res # 操作redis
def op_redis(k,v=None,time=None):
import redis
r = redis.Redis(**REDIS_INFO)
if v:
r.set(k,v,time)
res = 'ok'
else:
res = r.get(k)
if res:
res = res.decode()
return res # 加密函数
def my_md5(str):
import hashlib
new_str = str.encode()
m = hashlib.md5()
m.update(new_str)
return m.hexdigest()

c、interface.py文件放入lib目录下,存放注册及登录接口

 import flask,json
server = flask.Flask(__name__) #把当前这个python文件当作一个服务
from lib.tools import my_md5,op_redis
@server.route('/reg',methods=['post']) #'reg'是接口路径,如果methods不写,则默认get请求
def reg():
username =flask.request.values.get('username')
pwd = flask.request.values.get('pwd')
if username and pwd:
key = 'user:%s'%username
if op_redis(key): # 判断用户是否存在
res = {'msg':'用户已存在','msg_code':2001}
else: # 不存在则将用户名和密码写入redis数据库
value = my_md5(pwd)
op_redis(key,value)
res = {'msg':'注册成功','msg_code':0000}
else:
res = {'msg':'必填字段未填,请查看接口文档!','msg_code':1001}
return json.dumps(res,ensure_ascii=False) @server.route('/login',methods= ['post'])
def login():
import time
username =flask.request.values.get('username')
pwd = flask.request.values.get('pwd')
if username and pwd:
user_key = 'user:%s'%username # 存放用户信息的key
passed = op_redis(user_key)
session_key = 'session:%s'%username # 存放登录session的key
session = op_redis(session_key)
if passed:
if my_md5(pwd) == passed:
if session: # 判断之前有没有登录过
res = json.loads(session)
else: # 之前没有登录过则将session写入redis数据库
login_time = str(time.strftime('%Y%m%d%H%M%S'))
sessionid = my_md5(username + str(time.time())) # 计算sessionid
res = {'sessionid': sessionid, 'login_time': login_time} # 构造好字典
op_redis(session_key,json.dumps(res),600) # 将session存入redis并设置失效时间
else:
res = {'msg':'密码错误','msg_code':2001}
else:
res = {'msg':'用户不存在','msg_code':2001}
else:
res = {'msg':'用户名或密码必填','msg_code':1001}
return json.dumps(res,ensure_ascii=False)

d、start.py文件放入bin目录下,用来启动服务

 # 手工加环境变量,这样项目在任何环境任何系统中执行都不会报错
import sys,os
BASE_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # 获取到当前程序的主目录
sys.path.insert(0,BASE_PATH) # 将程序主目录加入python环境变量 from lib.interface import server
from config.setting import SERVER_PORT
server.run(host='0.0.0.0',port=SERVER_PORT,debug=True)

至此,模块结构调整完成,运行start.py即可启动程序。

Python学习之==>模块结构调整的更多相关文章

  1. Python学习--Selenium模块

    1. Python学习--Selenium模块介绍(1) 2.Python学习--Selenium模块学习(2) 其他: 1. Python学习--打码平台

  2. Python学习--Selenium模块学习(2)

    Selenium的基本操作 获取浏览器驱动寻找方式 1. 通过手动指定浏览器驱动路径2. 通过 `$PATH`环境变量找寻浏览器驱动 可参考Python学习--Selenium模块简单介绍(1) 控制 ...

  3. Python学习---重点模块的学习【all】

    time     [时间模块] import time # print(help(time)) # time模块的帮助 print(time.time()) # 时间戳 print(time.cloc ...

  4. python学习——常用模块

    在学习常用模块时我们应该知道模块和包是什么,关于模块和包会单独写一篇随笔,下面先来了解有关在python中的几个常用模块. 一.什么是模块 常见的场景:一个模块就是一个包含了python定义和声明的文 ...

  5. Python学习之模块进程函数详解

    今天在看<Beginning Linux Programming>中的进程相关部分,讲到Linux几个进程相关的系统函数: system , exec , fork ,wait . Pyt ...

  6. Python学习(22):模块

    转自 http://www.cnblogs.com/BeginMan/p/3183656.html 一.模块基础 1.模块 自我包含,且有组织的代码片段就是模块 模块是Pyhon最高级别的程序组织单元 ...

  7. Python学习之模块基础

    模块就是程序 编写以下简单代码 print('hello python') 并将py文件保存在c盘的python(假设新建)文件下,通过pycharm的Terminal 或者windom命令窗口调出p ...

  8. python学习之模块导入,操作邮件,redis

    python基础学习06 模块导入 导入模块的顺序 1.先从当前目录下找 2.当前目录下找不到,再从环境变量中找,如果在同时在当前目录和环境变量中建立相同的py文件,优先使用当前目录下的 导入模块的实 ...

  9. python学习笔记-模块和包

    模块导入方法 1.import 语句 import module1[,module2[,...moduleN]] 当我们使用import语句的时候,Python解释器是怎么找到对应对文件对呢?答案是解 ...

随机推荐

  1. php中禁止单个ip与ip段访问的代码小结

    1.禁止单个IP <?php //IP访问限制 if(getenv('HTTP_CLIENT_IP') && strcasecmp(getenv('HTTP_CLIENT_IP' ...

  2. [易学易懂系列|rustlang语言|零基础|快速入门|(9)|Control Flows流程控制]

    [易学易懂系列|rustlang语言|零基础|快速入门|(9)] 有意思的基础知识 Control Flows 我们今天再来看看流程控制. 条件控制 if-else if -else: / Simpl ...

  3. js - 基础 之 预编译总结

    js运行步骤 语法解析(检查有无语法错误) 预编译 解释运行(将 js 翻译成计算机识别的语言(0.1组成),翻译一行执行一行) 预编译 [全局]: 创建 GO( Grobal Object ) 对象 ...

  4. Java 11必掌握的8大特性,完美代码信手拈来

    [MyEclipse CI 2019.4.0安装包下载] 美国时间 09 月 25 日,Oralce正式发布了Java 11,这是据Java 8以后支持的首个长期版本.从官方发布的支持路线图表看出,J ...

  5. Java中CharSet字符集

    java.nio.charset包中提供了Charset类,它继承了Comparable接口:还有CharsetDecoder.CharsetEncoder编码和解码的类,它们都是继承Object类. ...

  6. python主流框架简介和Django框架的使用

    目录 一.手撸简易web框架 二.动静态网页 1. 静态网页 2. 动态网页 三.jinja2模板语法 1. jinja2的作用 四.python主流web框架 1. django 3. tornad ...

  7. 【NOIP2016提高A组集训第1场10.29】完美标号

    题目 给定M个二元组(A_i, B_i),求X_1, ..., X_N满足:对于任意(A_i, B_i),有|X_{A_i} - X_{B_i}| = 1成立. 分析 显然,对于二元组(x,y),X_ ...

  8. electron-vue打包引用的图标不显示问题

    在electron-vue中使用了字体图标,但是打包成.exe文件后图标不显示,路劲问题 把字体图标放到static目录下就可以了,静态图片也一样 我原来放在其它地方不行 改到static目录就可以了

  9. LOJ #539. 「LibreOJ NOIP Round #1」旅游路线 倍增floyd + 思维

    考试的时候是这么想的: 求出每一个点花掉 $i$ 的花费向其他点尽可能走的最长距离,然后二分这个花费,找到第一个大于 $d$ 的就输出$.$然而,我这个记忆化搜索 $TLE$ 的很惨$.$这里讲一下正 ...

  10. 2018百度之星B轮 degree

    degree Accepts: 1581 Submissions: 3494 Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 131072/1 ...