Python项目如何注重开发规范

jiaoxingk

于 2024-02-16 12:01:41 发布

阅读量974

点赞数 23

分类专栏： Python 文章标签： python 开发语言

本文链接：https://blog.csdn.net/xiao_a_lian/article/details/136127309

版权

Python 专栏收录该内容

25 篇文章 3 订阅

订阅专栏

引言

在进行项目开发的时候，设计到多个文件相辅相成，这个时候我们需要如何去合理规划项目文件，让项目结构更加清晰，这样以后在添加新的功能或者修改原有功能的话，就不会乱手乱脚，导出找自己的代码应该写在哪儿或者修改哪儿。

以下主要通过几个方面来介绍Python项目开发时的要求

1. 遵从PEP8

Python PEP 8规范是Python社区的一项编码风格指南，旨在使代码更加可读、易于维护和共享。PEP 8涵盖了缩进、空格、命名约定、注释、文档字符串、类和函数定义以及其他编码风格。

主要有以下几点需要注意：

注释

1.单行注释如果在代码之后，那么#与代码之间需要空两格，内容与#空一格
2.如果单行注释自成一行那么只有内容与#空一格

总而言之，在写注释的时候，# + 空格 + 内容，这样会更加清晰

print('hello,word')  # 打印hello，word

在Pycharm，快捷键ctrl + shift + L ，能够快速格式化，也就是整理格式

符号

name_list = ['11', '22', '33', '44', '55']

1.逗号后面与数据值空一格
2.在符号左右都空一格

print(1 + 2)

换行

在每行最多使用79个字符。

一行代码特别长的时候，需要换行。

建立与上面对其，如下。

# 换行后的括号里内容，不超过上一行的括号
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

命名约定

变量名可以是字母、数字、下划线的组合。不能以数字开头，也不可以用关键字来命名。

关键字就是python中具有特殊含义的符号，比如if，else等

常见的命名风格：

变量名的命名风格

下划线式（python推荐使用）

变量名中单词很多彼此使用下划线隔开

my_name = 'jiaoxingk'

驼峰体式

大驼峰

MyName = 'jiaoxingk'

小驼峰

myName = 'jiaoxingk'

在同一个编程语言中尽量固定使用一种，不要随意切换常量名的命名风格
在python中如果想表示出常量那么可以使用全大写的变量名
NAME= 'KK‘

2. 单文件

如果做一个小项目的时候，只有一个py文件，这个时候就需要注意以下几点：

要有开头的文档注释，知道这个py文件是做什么的
常量用大写表示
函数都要有注释，并且按照参数和返回值，一行一个
对模糊的代码进行注释，对一个功能块进行注释
要有主程序运行，也就是需要判断当前是否是主程序

"""
文件注释
"""

import re
import random

DB = "XXX"



def run():
    """
    这是一个函数的文档字符串，用于描述函数的功能。
    :param param1: 这是参数1
    :param param2: 这是参数2
    :return: 返回一个结果
    """

    # 对功能代码进行注释
    print(text)


if __name__ == '__main__':
    run()

3. 单可执行文件

crm
├── app.py 文件，程序的主文件（尽量精简）
├── config.py 文件，配置文件（放相关配置信息，代码中读取配置信息，如果想要修改配置，即可以在此修改，不用再去代码中逐一修改了）
├── db 文件夹，存放数据
├── files 文件夹，存放文件
├── src 包，业务处理的代码
└── utils 包，公共功能

一般常规项目，包名、文件名可以按照这种形式来，什么文件放什么内容