[ python ] 軟件開發規範

在python開發中，咱們建議採用以下規範：

soft/ ├── bin # 程序執行文件目錄
│   ├── __init__.py │   └── start.py # 程序開始執行腳本文件
├── conf                    # 配置文件目錄
│   ├── config.ini            # 配置文件
│   ├── __init__.py │   ├── my_log_settings.py # 日誌文件配置腳本
│   └── settings.py            # 配置腳本
├── core                    # 核心模塊
│   ├── core.py                # 核心功能腳本
│   └── __init__.py ├── db # 數據文件目錄
├── lib                        # 庫文件目錄
│   ├── __init__.py │   └── read_ini.py # 庫腳本文件
└── log                        # 日誌目錄
    └── all2.log            # 日誌文件

 

 

首先在 start.py 中要添加項目的環境變量：

 

bin/

import sys,os BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))    # 獲取項目的根目錄
sys.path.append(BASE_DIR)    # 將項目的根目錄添加到環境變量中

from core import core from conf import my_log_settings if __name__ == '__main__': my_log_settings.load_my_logging_cfg() core.run()

start.py

 

 

conf/

[DEFAULT] user_timeout = 1000 [hkey] password = 123 money=10000000000

config.ini

import os import logging.config # 定義三種日誌輸出格式 開始
 standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \ '[%(levelname)s][%(message)s]' #其中name爲getlogger指定的名字
 simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s' id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

# 定義日誌輸出格式 結束
 logfile_dir = r'%s\log' %os.path.dirname(os.path.dirname(os.path.abspath(__file__)))  # log文件的目錄
 logfile_name = 'all2.log'  # log文件名

# 若是不存在定義的日誌目錄就建立一個
if not os.path.isdir(logfile_dir): os.mkdir(logfile_dir) # log文件的全路徑
logfile_path = os.path.join(logfile_dir, logfile_name) # log配置字典
LOGGING_DIC = { 'version': 1, 'disable_existing_loggers': False, 'formatters': { 'standard': { 'format': standard_format }, 'simple': { 'format': simple_format }, }, 'filters': {}, 'handlers': { #打印到終端的日誌
        'console': { 'level': 'DEBUG', 'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple' }, #打印到文件的日誌,收集info及以上的日誌
        'default': { 'level': 'DEBUG', 'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件
            'formatter': 'standard', 'filename': logfile_path,  # 日誌文件
            'maxBytes': 1024*1024*5,  # 日誌大小 5M
            'backupCount': 5, 'encoding': 'utf-8',  # 日誌文件的編碼，不再用擔憂中文log亂碼了
 }, }, 'loggers': { #logging.getLogger(__name__)拿到的logger配置
        '': { 'handlers': ['default'],  # 這裏把上面定義的兩個handler都加上，即log數據既寫入文件又打印到屏幕
            'level': 'DEBUG', 'propagate': True,  # 向上（更高level的logger）傳遞
 }, }, } def load_my_logging_cfg(): logging.config.dictConfig(LOGGING_DIC) # 導入上面定義的logging配置
    logger = logging.getLogger(__name__)  # 生成一個log實例
    logger.info('It works!')  # 記錄該文件的運行狀態

if __name__ == '__main__': load_my_logging_cfg()

my_log_settings.py

 

 

settings.py

import os config_path=r'%s\%s' %(os.path.dirname(os.path.abspath(__file__)),'config.ini') user_timeout=10 user_db_path=r'%s\%s' %(os.path.dirname(os.path.dirname(os.path.abspath(__file__))),\ 'db')

settings.py

 

 

core/

import logging import time from conf import settings from lib import read_ini config=read_ini.read(settings.config_path) logger=logging.getLogger(__name__) current_user={'user':None,'login_time':None,'timeout':int(settings.user_timeout)} def auth(func): def wrapper(*args,**kwargs): if current_user['user']: interval=time.time()-current_user['login_time'] if interval < current_user['timeout']: return func(*args,**kwargs) name = input('name>>: ') password = input('password>>: ') if config.has_section(name): if password == config.get(name,'password'): logger.info('登陸成功') current_user['user']=name current_user['login_time']=time.time() return func(*args,**kwargs) else: logger.error('用戶名不存在') return wrapper @auth def buy(): print('buy...') @auth def run(): print(''' 1. 購物 2. 查看餘額 3. 轉帳 ''') while True: choice = input('>>: ').strip() if not choice:continue
        if choice == '1': buy() if __name__ == '__main__': run()

core.py

 

 

lib/

import logging import time from conf import settings from lib import read_ini config=read_ini.read(settings.config_path) logger=logging.getLogger(__name__) current_user={'user':None,'login_time':None,'timeout':int(settings.user_timeout)} def auth(func): def wrapper(*args,**kwargs): if current_user['user']: interval=time.time()-current_user['login_time'] if interval < current_user['timeout']: return func(*args,**kwargs) name = input('name>>: ') password = input('password>>: ') if config.has_section(name): if password == config.get(name,'password'): logger.info('登陸成功') current_user['user']=name current_user['login_time']=time.time() return func(*args,**kwargs) else: logger.error('用戶名不存在') return wrapper @auth def buy(): print('buy...') @auth def run(): print(''' 1. 購物 2. 查看餘額 3. 轉帳 ''') while True: choice = input('>>: ').strip() if not choice:continue
        if choice == '1': buy() if __name__ == '__main__': run()

read_ini.py

 

 

log/

all2.log