展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > Python脚本到工程化项目转型指南

Python脚本到工程化项目转型指南

当脚本被多人调用、需日志/配置/多环境时,ifname=="__main__"会成为瓶颈,应将核心逻辑抽成模块函数或类,主脚本仅负责参数解析与执行,避免顶层副作用代码。

本文目录

    当脚本被多人调用、需日志/配置/多环境时,if name == "__main__" 会成为瓶颈,应将核心逻辑抽成模块函数或类,主脚本仅负责参数解析与执行,避免顶层副作用代码。

    Python 从脚本到工程化项目的演进路径

    脚本里直接写 if __name__ == "__main__" 还能撑多久

    当一个 Python 脚本开始被多人调用、需要加日志、要读配置、还要跑在不同环境时,if __name__ == "__main__" 就从入口变成了瓶颈。它本身没问题,但意味着所有逻辑都挤在单文件里,没法被单元测试覆盖,改一行可能影响三个调用方。

    实操建议:

    • 把核心逻辑抽成函数或类,放在 src/ 或 lib/ 下的模块中,主脚本只负责解析参数、组装依赖、触发执行
    • 避免在模块顶层写带副作用的代码(比如直接调用 requests.get() 或修改全局状态)
    • 如果脚本已承担调度职责(如定时拉数据),考虑先用 argparse 拆出子命令,为后续转成 CLI 工具打基础

    setup.py 还是 pyproject.toml?选错会卡住 CI 流程

    Python 3.12+ 新项目必须用 pyproject.toml,不是“推荐”,是工具链默认只认它。用 setup.py 会导致 pip install -e . 失败、GitHub Actions 里 build 步骤报 UnsupportedPythonVersion,甚至本地 poetry 加依赖时静默忽略你的包。

    关键差异点:

    • pyproject.toml 必须声明 [build-system],否则 pip 认不出构建后端;常见填法是 requires = ["setuptools>=45", "wheel"]
    • 包路径由 [project] 下的 packages 或 find 控制,别再手动列 src/xxx/__init__.py,用 find = {where = ["src"]} 更稳
    • 开发依赖(如 pytest、mypy)不要塞进 install_requires,该放 [project.optional-dependencies] 或独立的 dev-requirements.txt

    日志一开就满屏 INFO:root:,怎么让不同模块输出可区分又不漏错误

    直接用 print() 或 logging.info() 全局配置,会让 Flask 的请求日志和你自己的数据清洗日志混在一起,线上出问题时根本分不清谁打的 INFO。更麻烦的是,有些库(如 urllib3)默认开 DEBUG,一启用全量日志就刷屏。

    正确做法:

    • 每个模块用 logging.getLogger(__name__) 获取 logger,而不是 logging.getLogger()(后者拿到 root)
    • 在入口处统一配置 handler 和 level:root 设为 WARNING,你自己的包设为 INFO,第三方库(如 botocore)显式设为 ERROR
    • 别用 basicConfig,它只能调一次且不支持多 handler;改用 dictConfig 或显式 addHandler + setLevel

    测试跑不通,是因为没 mock datetime.now() 还是路径没加到 PYTHONPATH

    常见失败现象:ModuleNotFoundError: No module named 'myproject' 或测试里时间相关断言总失败。前者多半是项目结构没对齐 Python 导入规则,后者几乎 100% 是没冻结时间。

    两个最常漏的点:

    • 确保测试目录(如 tests/)和源码目录(如 src/)都在 Python 模块搜索路径里——CI 中用 export PYTHONPATH=$(pwd)/src:$(pwd)/tests,本地用 -m pytest 并配合 pyproject.toml 里的 [tool.pytest.ini_options] 配置 pythonpath
    • 所有涉及系统时间、网络、文件读写的操作,必须 mock。用 freezegun.freeze_time("2023-01-01") 替代手写 patch(datetime, ...);用 responses.add() 拦 HTTP 请求,别信 “这个 API 稳定所以不用 mock”

    工程化不是加一堆配置和目录,而是让每次 git push 后你知道:测试会跑、日志能查、部署不炸、别人接手时不抓瞎。最难的其实是说服自己——那个能跑通的脚本,真不该再改了。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    PixPix 网页版
    PixPix 网页版

    PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。