您当前的位置:首页 > 电脑百科 > 程序开发 > 语言 > Python

四个工具帮你轻松将python项目发布到生产环境

时间:2023-11-21 14:08:36  来源:微信公众号  作者:小白玩转Python

构建良好的软件遵循特定规则并强制执行行业标准,同时需要考虑:依赖关系、代码质量、工作流程、凭据。但这些如何反映在现实代码库中呢?在这篇文章中,我将向您展示我在Python/ target=_blank class=infotextkey>Python项目中设置的4个工具,以便简化开发工作流程并强制执行一些优秀实践。

四个工具帮你轻松将python项目发布到生产环境

 

1. Poetry

 

当我开始一个新项目时,我通常使用Poetry来管理依赖关系并创建一个全新的虚拟环境。这在不同项目依赖于相同包的不同版本时非常有用。

 

Poetry是一个很好的工具,因为它在解析依赖关系方面速度很快。它还通过用户友好的CLI易于使用,并有助于快速打包和分发您的代码。

 

以下是如何使用Poetry启动新项目的方法:

poetry init

四个工具帮你轻松将python项目发布到生产环境

一旦你按下yes,就会创建一个pyproject.toml文件,用于包含项目的 metadata。这个文件可以提交到Git,并与您的同事共享,以重现相同的环境。项目设置完成后,您可以使用add命令添加依赖项。示例:

poetry add pandas

四个工具帮你轻松将python项目发布到生产环境

您还可以分组依赖项。例如,您可以将black和isort添加为开发依赖项到dev组。示例:

poetry add black --group dev

四个工具帮你轻松将python项目发布到生产环境

如果再次查看pyproject.toml文件,我们将注意到依赖项的两个单独部分:

四个工具帮你轻松将python项目发布到生产环境

 

为什么这有用呢?

 

分组使您能够轻松管理不同环境的依赖关系。例如,如果您有开发和测试依赖项,您可能希望在生产设置中安装项目库时忽略它们。这是如何做到的:

poetry install --without dev,test

 

依赖项安装在哪里?

 

Poetry为每个项目创建一个虚拟环境。它位于隐藏的.venv文件夹中。您可以使用poetry shell命令激活它,并访问其特定的二进制文件(python、pip、black等)。更多功能可以查看官方文档以了解更多信息。

 

2. Pre-commit hooks

 

如果您是Python开发人员,您可能经常会遇到这样的情况:您的团队成员具有不同的编码风格,这使得代码库不一致。结果,这导致错误,降低了生产力,并使协作困难。pre-commit hooks就可以解决这个问题,它在每次提交之前自动运行的脚本,用于检查您的代码是否存在错误。

 

在我的项目中,我通常会在我的预提交配置中添加这些脚本:

  • black — 用于格式化代码
  • pydoctyle — 确保代码文档符合google的标准
  • pycln — 用于删除未使用的导入
  • trAIling-whitespace — 用于删除额外的空格
  • unitest — 用于运行单元测试和检测破坏性更改

 

要配置这些首先需要安装pre-commit包:

pip install pre-commit
或者
poetry add pre-commit

然后,您需要在名为.pre-commit-configuration.yaml的YAML文件中进行定义。以下是我通常使用的一个:

repos:
-   repo: https://Github.com/psf/black
    rev: '23.1.0'
    hooks:
    -   id: black
        args: [--config=pyproject.toml]

-   repo: https://github.com/pycqa/pydocstyle
    rev: '6.3.0'
    hooks:
    -   id: pydocstyle
        args: ['.']

-   repo: https://github.com/hadialqattan/pycln
    rev: 'v2.1.5'
    hooks:
    -   id: pycln
        args: ['.']

-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: 'v4.4.0'
    hooks:
    -   id: trailing-whitespace

-   repo: local
    hooks:
    -   id: unittest
        name: run unit tests
        language: system
        pass_filenames: false
        entry: poetry run coverage run -m pytest

现在你可以使用 install 命令进行安装:

pre-commit install

另外,如果您尝试提交没有文档的代码,您将收到此错误,不会提交任何内容到git。

四个工具帮你轻松将python项目发布到生产环境

这将迫使您修复代码,然后再次提交。

 

3. Makefiles

 

Makefile将一系列shell命令分组在一个快捷方式(也称为目标)下。想象一下,每次更新代码时都必须运行以下单元测试命令:

poetry run coverage run -m pytest
poetry run coverage report
poetry run coverage html

那不是很繁琐吗?使用Makefile,您可以将这三个命令分组在一个 test 目标下。现在,您只需运行make test,而不是输入这三行,这避免了不必要的代码输入或记住复杂的指令。

四个工具帮你轻松将python项目发布到生产环境

Makefile还有助于简化其他任务,如:

  • 安装依赖项
  • 设置环境变量
  • 运行脚本
  • 构建和推送Docker镜像
  • 构建文档
  • 为代码添加样式

 

以下是我在我的一个开源项目中使用的Makefile示例:

DOCKER_IMAGE := ahmedbesbes/cowriter
VERSION := $(shell git describe --always --dirty --long)

ifneq (,$(wildcard ./.env))
    include .env
    export
endif

run-cowriter: 
 @poetry run python -m src.main

run-cowriter-job: 
 @poetry run python -m src.job

run-web-agent: 
 @rm -rf db/ && poetry run python -m src.actions.web_searcher 

build-image:
 @docker build . -t $(DOCKER_IMAGE):$(VERSION)

push-docker-image-to-artifact-registry:
 @gcloud builds submit --tag gcr.io/$(PROJECT_ID)/run_cowriter_job

lint:
 @poetry run black .

test: 
 @poetry run coverage run -m pytest
 @poetry run coverage report
 @poetry run coverage html

Makefiles通常易于阅读和理解,清晰地显示了项目的不同部分是如何组织的,以及它们如何相互依赖。这对于新团队成员入职或一段时间后重访自己的项目尤其有帮助。

 

4. python-dotenv

 

作为开发人员,我使用Python构建依赖于凭据和敏感设置的应用程序。以下是这些凭据的一些示例:

  • 用于访问第三方服务的API密钥
  • 密码和凭据
  • 标志
  • 域名或URL

⚠️ 这些凭据不应该硬编码或版本化在您的脚本中。一种安全的良好实践是将它们加载为环境变量。

import os
api_key = os.environ.get("API_KEY")

为了避免每次都使用shell命令导出环境变量,您可以使用Python dotenv包:

  • pip install python-dotenv
  • 创建一个包含键值对凭据的.env文件

四个工具帮你轻松将python项目发布到生产环境

  • 将.env添加到.gitignore,以防止Git提交它
  • 使用python-dotenv模块将设置加载到您的Python文件中

四个工具帮你轻松将python项目发布到生产环境

 

结论

 

我希望您发现这些工具有助于更好地构建Python项目的结构,并自动化繁琐和重复的任务。



Tags:python   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,不构成投资建议。投资者据此操作,风险自担。如有任何标注错误或版权侵犯请与我们联系,我们将及时更正、删除。
▌相关推荐
Python 可视化:Plotly 库使用基础
当使用 Plotly 进行数据可视化时,我们可以通过以下示例展示多种绘图方法,每个示例都会有详细的注释和说明。1.创建折线图import plotly.graph_objects as go# 示例1: 创建简单...【详细内容】
2024-04-01  Search: python  点击:(8)  评论:(0)  加入收藏
Python 办公神器:教你使用 Python 批量制作 PPT
介绍本文将介绍如何使用openpyxl和pptx库来批量制作PPT奖状。本文假设你已经安装了python和这两个库。本文的场景是:一名基层人员,要给一次比赛活动获奖的500名选手制作奖状,并...【详细内容】
2024-03-26  Search: python  点击:(15)  评论:(0)  加入收藏
Python实现工厂模式、抽象工厂,单例模式
工厂模式是一种常见的设计模式,它可以帮助我们创建对象的过程更加灵活和可扩展。在Python中,我们可以使用函数和类来实现工厂模式。一、Python中实现工厂模式工厂模式是一种常...【详细内容】
2024-03-07  Search: python  点击:(31)  评论:(0)  加入收藏
不可不学的Python技巧:字典推导式使用全攻略
Python的字典推导式是一种优雅而强大的工具,用于创建字典(dict)。这种方法不仅代码更加简洁,而且执行效率高。无论你是Python新手还是有经验的开发者,掌握字典推导式都将是你技能...【详细内容】
2024-02-22  Search: python  点击:(32)  评论:(0)  加入收藏
如何进行Python代码的代码重构和优化?
Python是一种高级编程语言,它具有简洁、易于理解和易于维护的特点。然而,代码重构和优化对于保持代码质量和性能至关重要。什么是代码重构?代码重构是指在不改变代码外部行为的...【详细内容】
2024-02-22  Search: python  点击:(32)  评论:(0)  加入收藏
Python开发者必备的八个PyCharm插件
在编写代码的过程中,括号几乎无处不在,以至于有时我们会拼命辨别哪个闭合括号与哪个开头的括号相匹配。这款插件能帮助解决这个众所周知的问题。前言在PyCharm中浏览插件列表...【详细内容】
2024-01-26  Search: python  点击:(84)  评论:(0)  加入收藏
Python的Graphlib库,再也不用手敲图结构了
Python中的graphlib库是一个功能强大且易于使用的工具。graphlib提供了许多功能,可以帮助您创建、操作和分析图形对象。本文将介绍graphlib库的主要用法,并提供一些示例代码和...【详细内容】
2024-01-26  Search: python  点击:(86)  评论:(0)  加入收藏
大语言模型插件功能在携程的Python实践
作者简介成学,携程高级安全研发工程师,关注Python/Golang后端开发、大语言模型等领域。一、背景2023年初,科技圈最火爆的话题莫过于大语言模型了,它是一种全新的聊天机器人模型,...【详细内容】
2024-01-26  Search: python  点击:(73)  评论:(0)  加入收藏
如何使用Python、Apache Kafka和云平台构建健壮的实时数据管道
译者 | 李睿审校 | 重楼在当今竞争激烈的市场环境中,为了生存和发展,企业必须能够实时收集、处理和响应数据。无论是检测欺诈、个性化用户体验还是监控系统,现在都需要接近即时...【详细内容】
2024-01-26  Search: python  点击:(46)  评论:(0)  加入收藏
Python分布式爬虫打造搜索引擎
简单分布式爬虫结构主从模式是指由一台主机作为控制节点负责所有运行网络爬虫的主机进行管理,爬虫只需要从控制节点那里接收任务,并把新生成任务提交给控制节点就可以了,在这个...【详细内容】
2024-01-25  Search: python  点击:(58)  评论:(0)  加入收藏
▌简易百科推荐
Python 可视化:Plotly 库使用基础
当使用 Plotly 进行数据可视化时,我们可以通过以下示例展示多种绘图方法,每个示例都会有详细的注释和说明。1.创建折线图import plotly.graph_objects as go# 示例1: 创建简单...【详细内容】
2024-04-01  Python技术    Tags:Python   点击:(8)  评论:(0)  加入收藏
Python 办公神器:教你使用 Python 批量制作 PPT
介绍本文将介绍如何使用openpyxl和pptx库来批量制作PPT奖状。本文假设你已经安装了python和这两个库。本文的场景是:一名基层人员,要给一次比赛活动获奖的500名选手制作奖状,并...【详细内容】
2024-03-26  Python技术  微信公众号  Tags:Python   点击:(15)  评论:(0)  加入收藏
Python实现工厂模式、抽象工厂,单例模式
工厂模式是一种常见的设计模式,它可以帮助我们创建对象的过程更加灵活和可扩展。在Python中,我们可以使用函数和类来实现工厂模式。一、Python中实现工厂模式工厂模式是一种常...【详细内容】
2024-03-07  Python都知道  微信公众号  Tags:Python   点击:(31)  评论:(0)  加入收藏
不可不学的Python技巧:字典推导式使用全攻略
Python的字典推导式是一种优雅而强大的工具,用于创建字典(dict)。这种方法不仅代码更加简洁,而且执行效率高。无论你是Python新手还是有经验的开发者,掌握字典推导式都将是你技能...【详细内容】
2024-02-22  子午Python  微信公众号  Tags:Python技巧   点击:(32)  评论:(0)  加入收藏
如何进行Python代码的代码重构和优化?
Python是一种高级编程语言,它具有简洁、易于理解和易于维护的特点。然而,代码重构和优化对于保持代码质量和性能至关重要。什么是代码重构?代码重构是指在不改变代码外部行为的...【详细内容】
2024-02-22  编程技术汇    Tags:Python代码   点击:(32)  评论:(0)  加入收藏
Python开发者必备的八个PyCharm插件
在编写代码的过程中,括号几乎无处不在,以至于有时我们会拼命辨别哪个闭合括号与哪个开头的括号相匹配。这款插件能帮助解决这个众所周知的问题。前言在PyCharm中浏览插件列表...【详细内容】
2024-01-26  Python学研大本营  微信公众号  Tags:PyCharm插件   点击:(84)  评论:(0)  加入收藏
Python的Graphlib库,再也不用手敲图结构了
Python中的graphlib库是一个功能强大且易于使用的工具。graphlib提供了许多功能,可以帮助您创建、操作和分析图形对象。本文将介绍graphlib库的主要用法,并提供一些示例代码和...【详细内容】
2024-01-26  科学随想录  微信公众号  Tags:Graphlib库   点击:(86)  评论:(0)  加入收藏
Python分布式爬虫打造搜索引擎
简单分布式爬虫结构主从模式是指由一台主机作为控制节点负责所有运行网络爬虫的主机进行管理,爬虫只需要从控制节点那里接收任务,并把新生成任务提交给控制节点就可以了,在这个...【详细内容】
2024-01-25  大雷家吃饭    Tags:Python   点击:(58)  评论:(0)  加入收藏
使用Python进行数据分析,需要哪些步骤?
Python是一门动态的、面向对象的脚本语言,同时也是一门简约,通俗易懂的编程语言。Python入门简单,代码可读性强,一段好的Python代码,阅读起来像是在读一篇外语文章。Python这种特...【详细内容】
2024-01-15  程序员不二    Tags:Python   点击:(161)  评论:(0)  加入收藏
Python语言的特点及应用场景, 同其它语言对比优势
Python语言作为一种高级编程语言,具有许多独特的特点和优势,这使得它在众多编程语言中脱颖而出。在本文中,我们将探讨Python语言的特点、应用场景以及与其他语言的对比优势。一...【详细内容】
2024-01-09    今日头条  Tags:Python语言   点击:(251)  评论:(0)  加入收藏
站内最新
站内热门
站内头条