Python代码规范与结构
发布日期:2022-02-14 23:02:51 浏览次数:46 分类:技术文章

本文共 979 字,大约阅读时间需要 3 分钟。

代码规范

  • 其它的一些说明
    • 对于config.py,不要在程序中直接import config写死,可通过main函数参数的形式来增加灵活性

代码效率

代码结构

    • README.rstLICENSEsetup.pyrequirements.txt# 具体模块sample/__init__.pysample/core.pysample/helpers.py#  文档docs/conf.pydocs/index.rst#  测试套件tests/test_basic.pytests/test_advanced.py
    • 模块是一个仓库的核心
      • 如果该模块内只有一个文件,可以直接将该文件放在仓库根目录
      • 模块不应该放在一个模糊的src目录或者随意的子目录
      • 任何一个带有__init__.py文件的目录均被认为是Python的包。该文件目的是收集所有包范围的定义
        from .base import LinearRegression__all__ = ['LinearRegression']
      • 面向对象编程
        • 应避免不必要的面向对象编程,可用不同的业务模块来替代
        • 当我们想将一些状态和功能粘合在一起时,自定义类是很有必要的
    • 装饰器
      • 装饰器是一个函数或类,用来装饰函数或方法
      • 相当于对被装饰函数进行嵌套
      • 注意过度嵌套
    • 重复使用命名对效率并没有提升:赋值时无论如何都要创建新的对象。避免对同一个变量名重复赋值
    • 若项目名为foo,则该项目的仓库结构如下
    Foo/|-- bin/  # 存放项目的一些可执行文件|   |-- foo||-- foo/  #  所有的源码均在此处,代码模块化,入库为main.py|   |-- tests/|   |   |-- __init__.py|   |   |-- test_main.py|   ||   |-- __init__.py|   |-- main.py||-- docs/  #  文档,包括配置文件|   |-- conf.py|   |-- abc.rst||-- setup.py|-- requirements.txt|-- README
    • 说明:对于该代码结构,我比较认可Kenneth Reitz 建议的Demo中对测试代码的放置,独立放置,而非与源码一块
  • 开源代码的仓库结构
    • pandas
      在这里插入图片描述
    • sklearn
      在这里插入图片描述

转载地址:https://blog.csdn.net/fish2009122/article/details/106618852 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:msck repair error
下一篇:算法的时间复杂度与空间复杂度

发表评论

最新留言

哈哈,博客排版真的漂亮呢~
[***.90.31.176]2024年03月30日 00时47分23秒