Python开发规范及文件命名

2023-05-16

Python开发规范

常用目录

目录名	作用
log	日志目录
conf	配置目录
core	核心代码
libs/modules	第三方库
docs	文档库
README	帮助文档
bin	启动入口,存放可执行文件
tests	存放测试代码

常用的文件命名

目录名	作用
main.py	主逻辑
setup.py	安装程序打包部署 setuptools 百度就有教程
requirements.txt	插件及目录版本控制 pip freeze 直接打印应用的包
README.md	帮助文档

README说明文档结构

[x] 1.软件定位，软件的基本功能
[x] 2.运行代码方法：安装环境、启动命令等
[x] 3.简要使用说明
[x] 4.代码目录结构说明
[x] 5.常见问题说明

conf.py 配置文档

项目中哪个模块用到这个配置文件直接通过import conf 这种形式在代码中使用

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

Python开发规范及文件命名的相关文章

钉钉机器人定点执行制作流程

一钉钉机器人的实现主要分为三个步骤 xff1a 1 钉钉群机器人制作 xff1b 2 钉钉群机器人接口开发 xff1b 3 服务器shell脚本与计划任务编写二钉钉群机器人的制作进入要添加机器人的目标群后到这里群机器人已经添加完成
HiveQL：查询（五）

select field from table select from sogou 20111230 limit 3 select from sogou sogou 20111230 limit 3 可以在别的数据库下 xff0c sele
Linux 学习笔记（四）

grup引导文件 root 64 localhost 桌面 vim boot grub grub conf default 61 0 timeout 61 5 splashimage 61 hd0 0 grub splash xpm gz
MySQL 常用sql语句

1 navicat讲解 1 安装navicat xff0c 破解软件 2 Access denied for user 39 root 39 64 192 168 48 10 using password YES 的解决办法如下 xff1a
搭建vsftp虚拟用户

一 xff1a 基本知识 1 xff1a 虚拟用户 xff1a 与系统无关联 xff0c 不能登入系统 xff0c 只能访问FTP服务器 2 xff1a vsftp的服务进程是vsftpd 3 xff1a vsftpd的配置文件是 etc
Mysql: Access denied for user 'root'@192.168.48.10(using password:YES)

Access denied for user 39 root 39 64 192 168 48 10 using password YES 的解决办法如下 xff1a mysql gt GRANT ALL PRIVILEGES ON TO
根据日期判断当前是周几

span class token comment 64 method 根据日期判断今天周几 64 param date 日期格式为字符串2018 01 01 span span class token keyword function sp
if、while、for及break、continue终止循环操作

if while for及break continue终止循环操作吃了一次while与if的亏 xff0c 让程序陷入死循环 xff0c 现在来分享总结一下 xff0c 顺便说说终止循环的操作 1 if 条件判断 if 通常用与条件判断
键盘轴知识（点触式、线性式、段落式）

文章目录点触式线性式段落式轴命名简介点触式线性式段落式点触式线性式和段落式是机械键盘轴的三种常见触发方式 xff0c 它们的区别主要在于按键触发的方式和手感表现上点触式 xff1a 点触式轴是指按下按键时需要先克服一定的阻
word里面公式自动编号和按章节自动编号

众所周知 xff0c word里面实现公式的排版 xff0c 确实是一件很难的事情传统做法就是通过公式的居中 xff0c 然后手写编号 xff0c 不断地进行enter 43 空格键来实现编号对齐右侧这种做法即使浪费了大量的时间经理也仅
树莓派3B+squid3搭建http代理服务器

欢迎移步博主小站 xff1a 白亮吖雅黑丫小站树莓派3B 43 squid3搭建http代理服务器树莓派3B 43 squid3搭建http代理服务器1 安装squid32 配置squid3 打开squid3配置文件修改配置文件 3
FreeRTOS记录（一、熟悉开发环境以及CubeMX下FreeRTOS配置）

目录 1 STM32CubeMX下配置第一个FreeRTOS工程问题1 为什么不能使用System tick 分析问题2 为什么选择CMSIS v1 分析 2 STM32CubeMX中 FreeRTOS 的配置说明2 1 Config Pa
嵌入式常用总线协议记录（I2C，SPI, Modbus 485, CAN...）

常用的总线协议 xff0c I2C xff0c SPI xff0c CAN xff0c MODBUS RTU485 xff0c 随笔记录 xff0c 除了CAN总线 xff0c 其他都用过无数次了 xff0c 有时间再补一补把 xff0c
FreeRTOS记录（二、FreeRTOS任务API认识和源码简析）

在了解了基本的环境和框架之后 xff0c 对FreeRTOS 的任务 xff0c 消息队列 xff0c 信号量 xff0c 事件 xff0c 软件定时器这些基础的功能部分也得有个认识这篇文章主要介绍了一下关于任务的API以及源码的简单分
FreeRTOS记录（三、RTOS任务调度原理解析_Systick、PendSV、SVC）

RTOS的任务调度原理和所使用的内核中断寄存器息息相关文中截图大多是 Cortex M3与Cortex M4权威指南翻译版本里面的内容需要对内核有一定的了解 xff0c 本文尽量用简单的描述表达清楚虽然是FreeRTOS的记录 x
自己画一块ESP32-C3 的开发板（立创EDA）（PCB到手）

记录一下第一次使用立创EDA第一次设计ESP C3的开发板添加立创EDA导入AD库说明 xff0c 基本完成原理图设计 2021 11 11 开始画PCB xff0c 更新部分PCB进度 2021 11 14 原理图部分调整 xff0c
嵌入式RTOS的任务栈和系统栈

对于初学者来说 xff0c 对于RTOS经常提到的任务栈和我们裸机编程说的栈经常傻傻分不清楚虽然我其他博文在有些地方提到过他们的区别 xff0c 但还是单独写一篇文章描述一下 xff0c 本文以FreeRTOS为例更新一下 RT Thr
RT-Thread记录（一、RT-Thread 版本、RT-Thread Studio开发环境及配合CubeMX开发快速上手）

距离完成 FreeRTOS 的记录也有一段时间了 xff0c 除了最近在测试的ESP32 C3 xff0c 也该记录一下 RT Thread 期间几个月时间关于 RT Thread 的项目有好几个 xff0c 感觉最近 RT Thread
RT-Thread记录（三、RT-Thread 线程操作函数及线程管理与FreeRTOS的比较）

前2课讲完了RT Thread开发环境 xff0c 启动流程 xff0c 启动以后当然是开始跑线程了 xff0c 那么自然我们得学会如何创建线程以及线程的有关操作目录前言一 RT Thread线程操作函数1 1 动态创建线程1 2 静态
C++std::stack容器适配器未提供 begin() 和 end() 成员函数，无法使用范围 for 循环（auto）来遍历栈（has no member named ‘begin’）

文章目录 C 43 43 std stack容器适配器无法使用范围 for 循环来遍历栈为什么vector和deque之类能用范围 for 循环遍历 xff0c stack却不行 xff1f 如何遍历栈元素 xff1f C 43 43 st

随机推荐

分享一款实用的太阳能充电电路（室内光照可用）

随着物联网的发展 xff0c 很多智能电子设备都朝着低功耗方向发展 xff0c 光能 xff0c 风能 xff0c 机械能等不同的自然能源都能被利用起来作为电子设备的能量来源 xff0c 本文要分享一款太阳能充电电路目录前言一电路原型
聊聊电源自动切换电路（常用自动切换电路总结）

聊过电源转化 xff0c 太阳能充电 xff0c 今天得聊聊电源自动切换电路 xff0c 实际中需要使用并且用过 xff0c 那就来记录总结一下目录前言一最简单的二极管1 1 都是5V电源1 2 带电池电源1 3 小结二 MOS管切
全面认识MOS管，一篇文章就够了

基础知识中 MOS 部分迟迟未整理 xff0c 实际分享的电路中大部分常用电路都用到了MOS管 xff0c 今天势必要来一篇文章 xff0c 彻底掌握mos管 xff01 更新 xff1a 为什么常在MOS管GS并联电阻 xff1f 更新
【导航】FreeRTOS学习专栏目录【快速跳转】

本文是矜辰所致的 FreeRTOS记录专栏的内容导航 xff0c 结合自己的学习应用过程的总结记录目录前言一环境篇二内核篇三应用篇前言本专栏 FreeRTOS 的学习是以 STM32 平台为主 xff0c 使用 STM32
嵌入式Linux 开篇大吉

大家好 xff0c 我是矜辰所致 xff0c 从去年开始计划写博文的时候就已经在考虑嵌入式 Linux xff0c 但是在此之前花了快一年的时间整理了自己的一些笔记和心得 xff0c 最后也就是以文章形式呈现给大家的这些博文发现在如今的C
ESP32-C3 学习测试蓝牙篇（五、添加 characteristic）

前面的蓝牙部分都是基础说明 xff0c 示例分析 xff0c 本文就来改他一改目录前言一示例更换说明gatt server service table 二示例测试2 1 广播包2 1 1 设备名称 2 2 服务与特征值2 3 读写操
嵌入式 Linux 入门（一、Linux 基本介绍及文件结构）

嵌入式 Linux入门第一课 xff0c 嵌入式 linux 基础说明以及 Linux 文件结构目录前言一嵌入式 Linux 基础1 1 Linux 简介1 2 Linux 与 windows1 3 Linux 版本选择1 4 何为
嵌入式 Linux 入门环境篇（六、搭建 TFTP 环境）

嵌入式 Linux入门环境篇第六课 xff0c 搭建 TFTP 环境 by 矜辰所致前言上文我们学习了 NFS 共享文件夹的环境搭建与使用 xff0c 本文讲解网络文件共享的另外一种方式 xff1a TFTP 嵌入式 Linux
FreeRTOS使用 — 合理使用内存 “ 任务中创建任务 ”

前言在我们学习 RTOS 的过程中 xff0c 很多朋友都不会遇到内存不够的问题 xff0c 因为大部分的开发板使用的芯片对学习来说 xff0c 内存足够大所以基本上很多人学会了基本功能 xff0c 到了实际工作中使用 xff0c 往
STM32L0 ADC使用HAL库关于校准问题的说明

STM32 系列 ADC校准问题说明前言最近是有一个产品用到了ADC xff0c 使用的是STM32L051 芯片 xff0c 使用 STM32CubeMX 生成的代码 xff0c 本来以为简简单单 xff0c 但是在调用 HAL AD
C++右值引用（左值表达式、右值表达式、左值引用）移动语义、完美转发（std::forward）prvalue（pure rvalue, 纯右值）xvalue（eXpiring value, 将亡值）

文章目录什么是左值和右值 xff1f xff08 右值不能被取地址 xff09 右值分为纯右值和将亡值prvalue xff08 pure rvalue 纯右值 xff09 xvalue xff08 eXpiring value 将亡值
常用运放电路总结记录

前言上一篇文章我们复习了一下运放的基本知识 xff0c 尽量的用简单的描述带大家去理解运算放大器 xff1a 带你理解运算放大器对于运放的使用 xff0c 存在着一些经典常用的应用电路 xff0c 这个其实网络上已经有大量的文章做记录总
单片机 0~10V 输出电路的实现

聊聊单片机实现 0 10V 输出电路的几种方案 by 矜辰所致更新测试结果 xff0c 文中电路全部完成测试 xff0c 都是可行电路 2023 5 目录前言一 MCU 的 DAC二 PWM 加滤波电路2 1 PWM 输出 DAC2 2
STM32 系列 DAC的介绍与使用

STM32网上资料多 xff0c 对自己来说基本的使用也是很简单的 xff0c 我的STM32专栏并没有什么系统的基础教学 xff0c 基本上是某个项目用到了 xff0c 或者产品使用过程出过问题才会来记录一下 xff0c 正好用到了 D
ES 基础之 Kibana 查询语法

排序查询 post article span class token operator span search span class token string 34 query 34 span span class token string
Fiddler 使用手册

好久没更新了额 windows系统上的抓包神器 xff0c 可惜 Mac上没有 xff0c 所以平时我用的 Charles 基本功能相差很小网页抓包记住 xff1a 配置完后都需要重启 HTTPS 按照提示安装 SSL 证书设置抓包
数据库扫描 sqlmap

简介 sqlmap是一个开源的渗透测试工具 xff0c 可以用来进行自动化检测 xff0c 利用SQL注入漏洞 xff0c 获取数据库服务器的权限它具有功能强大的检测引擎针对各种不同类型数据库的渗透测试的功能选项 xff0c 包括获取数
端口扫描：NMAP | Masscan

NMAP nmap是港口扫描仪的合法王位 xff0c 而今天仍然是最通用的选择 xff0c 最早是Linux下的网络扫描和嗅探工具包可以扫描主机端口并且识别端口所对应的协议 xff0c 以及猜测操作系统 Ping扫描 xff08 sP
逆向APP - 某医药 App 样本逆向解密实战

样本某医药app xff0c 难度两颗星适合新手练习研究版本 xff1a 202010026 登陆随便输一个错误的账号密码 xff1a 17283828172 密码 123456789 method POST path user
Python开发规范及文件命名

Python开发规范常用目录目录名作用log日志目录conf配置目录core核心代码libs modules第三方库docs文档库README帮助文档bin启动入口存放可执行文件tests存放测试代码常用的文件命名目录名作用mai

Python开发规范及文件命名

Python开发规范

常用目录

常用的文件命名

README说明文档结构

conf.py 配置文档

Python开发规范及文件命名 的相关文章

随机推荐

热门标签

Python开发规范及文件命名的相关文章