python软件开发文档目录_python学习之-软件开发的目录规范
通常軟件目錄下有幾個標準文件夾
軟件主文件夾命名，通常都是大寫(ATM_SHOPPING)
-------------------------------------------------------------------------
bin ： 啟動文件文件夾(整個軟件的啟動文件，也可直接寫在根目錄下省略這個文件夾)
conf ： 軟件配置文件(軟件全局性的一些變量和參數(shù))
core ：用戶層(就是一個功能的集合體文件，功能實現(xiàn)通過調用其他的模塊)
db ：數(shù)據(jù)層(數(shù)據(jù)處理動作模塊，存儲和調用，這個模塊放lib文件夾內也可)
lib ：接口模塊文件夾(每一個功能的模塊)
log ：日志文件
Readme.txt 軟件介紹的文本
---------------------------------------------------------------------------
bin ：start.py? 啟動文件
import sys
import os
BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #就是取執(zhí)行文件的絕對路徑，然后獲取執(zhí)行文件的目錄賦值給一個變量
sys.path.append(BASE_DIR)
from core import src
src.run()
PS：調用sys和os模塊，os模塊下有個path模塊下有個dirname模塊和abspath模塊，用abspath獲取絕對路徑，dirname就是取執(zhí)行文件的目錄，要讓其他的模塊能夠獲取這個模塊內的數(shù)據(jù)，往前推幾層能夠到達項目根目錄，那么取幾次dirname即可
PS：有一個內置的全局變量是__file__，是當前執(zhí)行文件的絕對路徑
PS：sys模塊下有一個path模塊，指的是環(huán)境變量，將變量放入環(huán)境變量即可調用所有模塊
conf : setting.py 配置文件
import os，logging
BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #動態(tài)獲取路徑，獲取當前文件的絕對路徑，然后獲取執(zhí)行文件的目錄，有幾層目錄寫幾次
file_path=r'%s\log\transaction.log' %BASE_DIR #這里將文件的路徑以動態(tài)方式放入log_path變量以供其他文件調用
"""
logging配置 #日志管理模塊，標準格式化寫入日志文件
"""
logfile_path= r'%s\log\管理員日志.txt '%BASE_DIR
user_logfile_path = r'%s\user_log\用戶日志.txt ' %BASE_DIR
standard_format = '%(asctime)s - %(threadName)s:%(thread)d - task_id:%(name)s - %(filename)s:%(lineno)d'\
'- %(levelname)s - %(message)s'
simple_format = '%(levelname)s - %(asctime)s - %(filename)s:%(lineno)d - %(message)s'
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'
},
'default': {
'level': 'DEBUG',
'class': 'logging.FileHandler',
'formatter': 'standard',
'filename': logfile_path,
'encoding': 'utf-8',
},
'user_log': {
'level': 'INFO',
'class': 'logging.FileHandler',
'formatter': 'simple',
'filename': user_logfile_path,
'encoding': 'utf-8',
},
},
'loggers': {
'用戶日志': {
'handlers': ['user_log'],
'level': 'INFO',
},
'管理員日志': {
'handlers': ['default', 'console'],
'level': 'DEBUG',
},
},
}
core : src.py 核心代碼 (主要的業(yè)務功能，就是一些主功能)
func_dic={
'1':login,
'2':register,
'3':shopping,
'4':transfer,
'5':pay
}
def run():
while True:
print("""
0 退出
1 登錄
2 注冊
3 購物
4 轉賬
5 支付
""")
choice =input('請輸入操作>>>: ').strip()
if choice == '0':break
if choice in func_dic:
func_dic[choice]()
else:
print('輸出的指令不存在,請重新輸入')
PS：就是一個首頁的功能，軟件相關功能所有的集合文件
db ： 調用數(shù)據(jù)接口的模塊
lib? ： 自定義的模塊
項目中共用的功能，主功能需要調用的功能等模塊
common.py(可以將日志模塊和裝飾器寫這個文件內)
import time
from conf import settings #從conf文件夾內導入setting模塊
def logger(msg):
with open(r'%s' %settings.log_path, 'at', encoding='utf-8') as f: #直接獲取setting模塊內的日志變量
f.write('%s %s\n' % (time.strftime('%Y-%m-%d %H:%M:%S'),msg))
log ： transaction.log(這個根據(jù)軟件來命名，沒有固定格式)
小常識：
(一)
日志功能需要調用時間模塊
import time
寫入時間功能：time.strftime('%y-%m-%d %H:%M:%S') #(這是固定格式)
(二)
項目文件夾放在頂級，建在頂級，就可以在導入模塊的時候可以用tab補全，或者彈出提示
(三)
啟動文件放在項目文件夾的根目錄下，就無需處理環(huán)境變量，因為軟件的根目錄就是當前啟動文件的文件夾(軟件的環(huán)境變量都是以執(zhí)行文件為準)
總結
以上是生活随笔為你收集整理的python软件开发文档目录_python学习之-软件开发的目录规范的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： python获取当前时间代码_pytho
- 下一篇： 菜鸟教程python位运算符_NumPy