开始一个 Python 项目前要准备什么 - RebuildBlog - Day1

在有了一定的学习和工作经验之后，决定重写我之前的博客。

项目地址：https://github.com/FesonX/RebuildBlog
第一天的代码可以 checkout 这个 commit

4d48cc734e042fb531b0e625cbc09fab3b4e8409

配置 PyCharm

定制 Python 文件头部

定制完文件头部会有种真正拥有这份代码的感觉，配置路径如下：

截屏2020-05-18 下午11.39.46.png

Pycharm Python 模板支持识别以下变量

${PROJECT_NAME} - the name of the current project.
${NAME} - the name of the new file which you specify in the New File dialog box during the file creation.
${USER} - the login name of the current user.
${DATE} - the current system date.
${TIME} - the current system time.
${YEAR} - the current year.
${MONTH} - the current month.
${DAY} - the current day of the month.
${HOUR} - the current hour.
${MINUTE} - the current minute.
${PRODUCT_NAME} - the name of the IDE in which the file will be created.
${MONTH_NAME_SHORT} - the first 3 letters of the month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL} - full name of a month. Example: January, February, etc.

可以自由选择组合的变量，定制自己的模板，以下是我的模板示例：

# -*- coding:utf-8 _*-  
""" 
@file: ${NAME}.py 
@time: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
@author:FesonX 
@contact: fesonx@foxmail.com
@site: github.com/FesonX 
@software: ${PRODUCT_NAME} 
"""

虚拟环境配置

配置加速镜像源

根据清华源的配置指引，先确认你的 pip 版本是否大于 10.0

$ pip --version
# 显示示例
pip 19.0.3 from /path/to/pip (python 3.7)

配置为默认源

pip install pip -U
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

验证配置效果
找一个库如 SQLAlchemy，看看安装输出的网址是不是清华源

$ pip install sqlalchemy
Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple
Collecting sqlalchemy
  Downloading https://pypi.tuna.tsinghua.edu.cn/packages/b9/9f/326aaeda67ccbc9765551da7f9359f1bc5b33ecd3552b0c47233f94b801f/SQLAlchemy-1.3.17-cp37-cp37m-macosx_10_14_x86_64.whl (1.2 MB)
     |████████████████████████████████| 1.2 MB 543 kB/s 
Installing collected packages: sqlalchemy
Successfully installed sqlalchemy-1.3.17

配置 Git

利用Git 做版本管理可以方便回溯所有更改，写 ReleaseNote 时也可以轻松定位修改，以下配置参照初次运行 Git 前的配置

配置用户信息

这是在版本控制系统中，用来识别你的信息，--global 参数设置为全局有效
示例

git config --global user.name "FesonX" 
git config --global user.email "fesonx@foxmail.com"

为项目添加 .gitigonore

Github 官方提供了一系列的 gitignore 模板，非常全面，建立一个项目时，可以先复制一份，避免误提交如 pyc、虚拟环境文件夹 *env 等内容到项目中。

之所以说它全面，是因为它除了考虑到 Python 常见的非代码文件，还把一些知名的 Python 框架非代码或敏感文件都囊括在内。如 Flask 用于存储敏感配置的 instance 文件夹，Celery 的 pid 文件，Django 的本地配置文件，以及常用的虚拟环境文件夹等。

当然，定制化的需求还请参照 Git Ignore 文档(英文)

目前 PyCharm(2019.3.4) 已经支持从 gitignore 中识别文件夹或文件，方便检查忽略文件的正则有没有填写错误。

PyCharm Git Ignore

项目结构

第一版的项目结构如下，所有的 app 注册和创建行为都在 src/__init__.py 下完成。后续还将单独添加路由注册入口、路由逻辑控制器等，也将放在 src 目录下，目前先不进行创建。

├── instance
│   └── config.py
└── src
    ├── __init__.py 
    ├── models.py   
    ├── statics
    └── templates
├── app.py
├── config.py

src 相当于一个包，也可以参照 Django 以 app 作为文件夹管理单元，Flask 官方提供了项目结构的示例，参见：Project Layout

为博客项目创建 MySQL 用户和数据库

单独创建博客用户，方便管理，也避免其他信息从服务器泄露. 密码可以使用 uuidgen 命令从命令行生成，或者通过 Python uuid 库生成

-- 创建数据库
create database rebuild_blog;
-- 创建用户
create user blog_admin identified by 'pwd';
-- 授权
grant all privileges on rebuild_blog.* to blog_admin@'%' identified by 'pwd';

密码生成示例：

from uuid import uuid4
password = str(uuid4())
password.replace('-', '') # Optional
>> 'bad93261324d4b6081f2be4a965b506a'

创建完毕后，为 Flask 项目添加服务器连接配置，建议放在 instance 文件夹下。数据库配置具体参见SQLAlchemy Engine Configuration

# 使用 mysql-client 作为驱动
SQLALCHEMY_DATABASE_URI = 'mysql+mysqldb://blog_admin:pwd@localhost:3306/rebuild_blog'

接下来，就是设计数据库模型了。