一个简单的步骤让你的 Python 代码更干净

于 2024-09-29 11:57:27 发布
阅读量318 收藏 4
点赞数 4
分类专栏： Python学习 Python Python入门 文章标签： python 开发语言 Python基础 Python爬虫 Python学习 编程 学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_86168842/article/details/142632350
版权
Python 同时被 3 个专栏收录
149 篇文章 0 订阅
订阅专栏
Python入门
122 篇文章 0 订阅
订阅专栏
Python学习
65 篇文章 0 订阅
订阅专栏

说起来容易做起来难，我们都知道代码可读性非常重要，但是写的时候总是随心所欲，不考虑类型提示、import 排序、PEP8 规范。今天分享一个小技巧，通过一个简单的步骤就可以让你的 Python 代码更干净。

如果你正在学习Python并且找不到方向的话可以试试我这一份学习方法+籽料呀！ 点击 领取（不要米米）

这就是 pre-commit：

可以让你的代码提交之前自动检查是否符合你想要的规范。

使用之前，先 pip 安装一下：

pip install pre-commit

然后在项目的根目录下创建两个文件：.pre-commit-config.yaml 和 pyproject.toml。

.pre-commit-config.yaml 文件内容如下：

exclude: _pb2\.py$
repos:
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black
        args: [--skip-string-normalization]
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: check-docstring-first
      - id: check-json
      - id: check-merge-conflict
      - id: check-yaml
      - id: debug-statements
      - id: end-of-file-fixer
      - id: trailing-whitespace
      - id: requirements-txt-fixer
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.9.0
    hooks:
      - id: python-check-mock-methods
      - id: python-use-type-annotations
  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: "v0.910"
    hooks:
      - id: mypy
        args:
          [
            --ignore-missing-imports,
            --warn-no-return,
            --warn-redundant-casts,
            --disallow-incomplete-defs,
          ]
        additional_dependencies: [types-all]
  - repo: https://github.com/PyCQA/isort
    rev: 5.9.3
    hooks:
      - id: isort
        args: [--profile, black, --filter-files]

这里面配置了 black、mypy、check-docstring-first、isort 等工具，id 就是对应的工具，可以说这个配置文件基本上就够用了。

在 .pre-commit-config.yaml 文件中，我们可以指定将使用哪些挂钩，在 pyproject.toml 中，我们可以为这些单独的钩子指定参数。

pyproject.toml 文件内容如下：

[tool.black]
line-length = 88
target-version = ["py38"]

[tool.isort]
profile = "black"
multi_line_output = 3

这里配置了 black 和 isort 的相关配置。

然后执行在项目的根目录执行 pre-commit install 命令，就可以安装 pre-commit 插件。

然后每次更新代码，提交代码时，这些钩子都会触发，会自动执行如下操作：

  1. 排序 import

  2. PEP8 的格式代码

  3. 检查您的 yaml 和 json 文件的正确性

  4. 类型检查（如果你使用了类型提示）

最后

你可以将这两个文件拷贝到自己的项目根目录中，然后执行一次 pre-commit install，这样每次提交代码的时候，都是干净的代码，是不是很方便？

如果你是准备学习Python或者正在学习（想通过Python兼职），下面这些你应该能用得上： 【点击这里】领取！

 

包括：Python激活码+安装包、Python web开发，Python爬虫，Python数据分析，人工智能、自动化办公等学习教程。带你从零基础系统性的学好Python！

① Python所有方向的学习路线图，清楚各个方向要学什么东西

② 100多节Python课程视频，涵盖必备基础、爬虫和数据分析

③ 100多个Python实战案例，学习不再是只会理论

④ 华为出品独家Python漫画教程，手机也能学习

⑤ 历年互联网企业Python面试真题,复习时非常方便****

疯狂的超级玛丽
关注
专栏目录
python代码怎么变成软件_从Python代码到APP,你只需要一个小工具:GitHub已超6000星
weixin_39540704的博客
11-23 1709
点击上方Python知识圈，选择设为星标回复1024获取Python资料选自TowardsDataScience作者：Adrien Treuille机器之心编译参与：魔王、一鸣阅读文本大概需要 6分钟。机器学习开发者想要打造一款 App 有多难？事实上，你只需要会 Python 代码就可以了，剩下的工作都可以交给一个工具。近日，Streamlit 联合创始人 Adrien Treuille 撰文...
如何使用Python创建一个虚拟助理
weixin_73136678的博客
12-27 773
虚拟助理是基于人工智能的程序。它们是一种智能计算机程序，可以通过语音命令或文本理解人类的自然语言，并为用户执行任务。本文将指导你通过使用Python库来创建你自己的语音助手的过程。在本教程中，我将在Jetbrains的Pycharm IDE上编写代码。PyCharm是一个计算机编程的集成开发平台，重点是Python编程语言。JetBrains，一家捷克公司，建造了它。下载并安装Pycharm后，启动该程序并点击文件菜单，然后选择新项目。一个弹出的信息会问你项目的名称。
python代码太长_python代码太长
weixin_39627430的博客
11-20 496
广告关闭腾讯云11.11云上盛惠 ，精选热门产品助力上云，云服务器首年88元起，买的越多返的越多，最高返5000元！python代码缩进 python的缩进一般来说是4个空格，示例如下：class test(object):----def __init__(self):-----self.timeout = 3-----self.url = 上面代码中----表示4个空格，如果用空格键去打，又长又...
如何使用PEP8写出漂亮的Python代码
所寫即所思｜一个阿里质量人对测试的所感所悟。
02-19 872
PEP 8是关于如何编写Python代码的指南和最佳实践的文档，由Guido van Rossum、Barry Warsaw和Alyssa Coghlan于2001年撰写，其主要关注点是提高Python代码的可读性和一致性。本教程将介绍：编写符合PEP 8的Python代码理解PEP 8中所列出的指导方针背后的理由设置你的开发环境，以便你可以开始编写符合PEP 8的Python代码PEP 代表 Python 增强提案，有很多 PEP。
想让字典操作更优雅？自定义Python字典类型，简化你的代码库！
xyh2004的博客
07-19 1269
在Python中，我们可以通过继承内置的dict类来创建具有特定行为的新字典类型。这允许我们在保留标准字典的所有特性的同时，添加额外的功能或覆盖默认的行为。
如何使用VSCode调试python代码
酌沧
05-21 1902
在 Visual Studio Code (VSCode) 中进行 Python 代码调试是一个直观且功能强大的过程，借助于内置的调试支持和 Python 扩展（如 Python extension by Microsoft）。
python：将 Python 2 代码迁移到 Python 3
点点关注不迷路
03-17 621
python：将 Python 2 代码迁移到 Python 3
python源码一套前后端分离的低代码快速后台开发平台，开箱即用
05-26 672
django-vue-lyadmin 是一套前后端分离的前端后台管理框架，是适配 django-vue-lyadmin 的 python django 后台管理项目的专属框架，基于原生 vue 开发，灵活自定义，可发挥空间大。全局设置mysql数据库隔离级别为READ-COMMITTED（永久有效）：修改配置文件my.cnf 的[mysqld]中增加 transaction-isolation=Read-Committed。查询当前会话的数据库隔离级别：select @@tx_isolation;
【python】python代码打包工具cx_Freeze的介绍、原理、用法及实战案例分析
热门推荐
景天科技苑
08-19 2万+
在Python开发中，将脚本打包成独立的可执行文件是一项常见的需求，特别是在需要将程序分发给没有安装Python环境的用户时。cx_Freeze是一个流行的Python库，它可以将Python脚本及其依赖项打包成独立的可执行文件，支持多平台（如Windows、Linux和macOS）。本文将结合实际案例，详细介绍cx_Freeze的安装、配置和使用方法。
Python-一个适用于python开发的轻量级的干净的vim配置
08-10
总的来说，通过适当的配置和熟悉Vim的工作方式，你可以构建一个高效且整洁的Python开发环境，充分利用其强大的编辑能力。记住，学习和适应Vim可能需要时间，但一旦掌握了，它将成为你编程生涯中的得力助手。
Python实现封装打包自己写的代码,被python import
09-16
通过以上步骤，你不仅学会了如何封装和打包自己的Python代码，还能将其发布到本地环境，便于他人或自己的其他项目使用。这是Python开发中的基础技能，对于代码的管理和共享至关重要。不断实践和学习，你的Python编程...
Python_最小的干净代码的字节对编码BPE算法通常用于LLM标记化.zip
05-25
标题中的“Python_最小的干净代码的字节对编码BPE算法通常用于LLM标记化”揭示了我们讨论的核心主题，即使用Python实现的BPE（Byte Pair Encoding）算法，这是一种常用的自然语言处理（NLP）技术，尤其在语言模型...
hesiod：简单的python库，以干净直观的方式处理配置
02-15
hesiod是一个针对Python开发的库，其主要目的是为了简化配置管理，提供一种干净且直观的方式来处理应用程序的配置信息。在Python编程中，管理和解析配置文件往往涉及到读取环境变量、XML、JSON或INI文件等，而hesiod...
VeighNa：强大的Python开源量化交易平台
Unity打怪升级
09-26 607
VeighNa（简称 VN 或 vn.py）是一个基于 Python 的开源量化交易平台，专为量化交易爱好者和专业交易员设计。VeighNa 是由国内开发者社区推动的开源项目，旨在提供一个功能丰富、灵活且易于扩展的量化交易解决方案。该框架不仅支持多种资产类别的交易，如股票、期货、期权、加密货币等，还支持多种交易接口和协议，使得用户能够轻松进行多市场、多品种的交易策略开发和部署。
第二百五十四节 JPA教程 - JPA 多对多映射示例
2301_78772942的博客
09-27 524
第二百五十四节 JPA教程 - JPA 多对多映射示例
ubuntu安装libtorch
meng_152634的博客
09-25 705
nouveau是由第三方为NVIDIA显卡开发的一个开源3D驱动，ubuntu默认集成了nouveau驱动，安装NVIDIA驱动前必须禁用系统自带的显卡驱动nouveau，否则安装NVIDIA驱动时会报错。，一定要确定好安装的CUDA版本是否支持显卡的算力，否则安装成功也无法使用GPU加速。如果cmake版本低于3.18，会出现下面的报错，这是由于低于3.18的cmake不支持CUDA17的编译，需要更新cmake版本。因为安装的CUDA版本为12.1，这里选择最新版的CUDNN 9.4.0进行安装。
Python 高阶内容：套娃式装饰器巧妙为函数增加功能
敲代码别忘了喝上一杯凉白开。
09-23 573
装饰器是 Python 中一种非常强大且灵活的工具，能够在不修改函数本身的情况下，为函数增加额外的功能。本文介绍了装饰器的基本概念及应用，通过实例演示如何在函数执行前后添加额外操作，如鉴权、数据验证等，类似“套娃”般层层嵌套。文章还通过代码示例展示了如何定义和使用装饰器，以及如何将装饰器与实际业务逻辑结合，实现灵活的功能扩展。这种设计模式不仅可以提升代码的可读性和可维护性，还可以有效减少代码的冗余。掌握装饰器的用法，将为你的 Python 编程技巧增添更多亮点。
Python/大数据/机器识别毕业设计选题题目推荐
最新发布
初尘屿风的博客
09-27 839
基于Python和Diango在线购物商城系统+报告文档+指导搭建视频基于深度学习的人脸识别与管理系统，Python实现基于Python/机器学习链家网新房数据可视化及预测系统Python豆瓣电影情感分析推荐系统+爬虫+可视化，过滤算法基于python的django框架生鲜商城管理系统设计与实现基于Python的Flask微博话题舆情分析可视化系统设计基于Python豆瓣电影数据可视化分析系统+毕业论文+指导搭建视频基于Python天气预报数据可视化分析系统+毕业论文基于Python的深度学习音乐推荐系统+
可以用python代码写一个真空吸尘器基于模型的Agent代理吗
05-26
当然可以！实现一个基于模型的真空吸尘器代理需要用到强化学习的知识，以下是一个简单的实现示例： 首先，需要安装 OpenAI Gym 和 TensorFlow 等相关依赖库。 接下来，定义一个代理类，这个代理类将用于训练智能体和执行动作。在这个类中，我们需要定义以下方法： - `__init__(self, env)`: 初始化函数，其中 env 是我们要训练的环境对象。 - `act(self, state)`: 根据状态执行动作的函数，该函数接收当前状态 state 作为输入，并返回智能体要执行的动作。 - `learn(self, state, action, reward, next_state, done)`: 根据当前状态、动作、奖励、下一个状态和是否结束的标志学习智能体的函数。 以下是一个可能的实现示例： ```python import gym import tensorflow as tf class VacuumAgent: def __init__(self, env): self.env = env self.model = tf.keras.models.Sequential([ tf.keras.layers.Dense(32, input_shape=(env.observation_space.shape[0],), activation='relu'), tf.keras.layers.Dense(16, activation='relu'), tf.keras.layers.Dense(env.action_space.n, activation='softmax') ]) self.optimizer = tf.optimizers.Adam(lr=0.001) def act(self, state): action_probs = self.model.predict(state) action = tf.random.categorical(action_probs, 1)[0, 0] return action.numpy() def learn(self, state, action, reward, next_state, done): with tf.GradientTape() as tape: action_probs = self.model(state, training=True) log_probs = tf.math.log(tf.reduce_sum(action_probs * tf.one_hot(action, self.env.action_space.n), axis=1)) loss = -log_probs * reward if done: loss += 0.1 * tf.math.log(tf.reduce_sum(action_probs, axis=1)) grads = tape.gradient(loss, self.model.trainable_variables) self.optimizer.apply_gradients(zip(grads, self.model.trainable_variables)) ``` 在上面的代码中，我们定义了一个基于神经网络的模型，并使用随机策略选择动作。在 learn 函数中，使用策略梯度方法对模型进行训练。 接下来，我们需要定义一个环境类，用于模拟真空吸尘器的操作。在这个类中，我们需要定义以下方法： - `__init__(self, room_size)`: 初始化函数，其中 room_size 是房间的大小，用于初始化房间状态。 - `reset(self)`: 重置房间状态，返回初始状态。 - `step(self, action)`: 执行指定动作，返回下一个状态、奖励和是否结束的标志。 以下是一个可能的实现示例： ```python class VacuumEnv(gym.Env): def __init__(self, room_size): self.room_size = room_size self.observation_space = gym.spaces.Box(low=0, high=1, shape=(room_size,)) self.action_space = gym.spaces.Discrete(2) self.state = np.zeros(room_size) for i in range(room_size): if np.random.rand() < 0.5: self.state[i] = 1 def reset(self): self.state = np.zeros(self.room_size) for i in range(self.room_size): if np.random.rand() < 0.5: self.state[i] = 1 return self.state def step(self, action): if action == 0: reward = -1 else: if self.state.sum() == 0: reward = 1 else: reward = 0 self.state = np.roll(self.state, -1) self.state[self.room_size-1] = 0 done = (self.state.sum() == 0) return self.state, reward, done, {} ``` 在上面的代码中，我们定义了一个简单的房间环境，并实现了真空吸尘器的操作。当真空吸尘器执行动作 0 时，会获得负奖励；当执行动作 1 时，会获得正奖励（如果房间已经干净）或零奖励（如果房间还有灰尘）。 最后，我们可以使用以下代码来训练我们的代理： ```python env = VacuumEnv(10) agent = VacuumAgent(env) for i in range(1000): state = env.reset() done = False while not done: action = agent.act(state) next_state, reward, done, _ = env.step(action) agent.learn(state, action, reward, next_state, done) state = next_state ``` 在上面的代码中，我们使用简单的 for 循环进行训练，每次循环都重置环境，并执行若干个动作，直到环境结束。在每个步骤中，我们调用代理的 act 方法来获取要执行的动作，并调用 learn 方法来学习智能体的行为。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值