Python脚本必加代码:99%的程序员都忽视了这个细节!

2024-05-26 11:12

本文主要是介绍Python脚本必加代码:99%的程序员都忽视了这个细节!,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在这里插入图片描述

文章目录

  • 一、初识 if __name__ == '__main__'
  • 二、__name__ 和 __main__ 是什么?
  • 三、实战讲解
  • 四、实际应用场景
    • 测试代码
    • 提高代码可重用性
    • 避免不必要的执行
  • 五、深入理解和更多用法
    • 使用 argparse 解析命令行参数
    • 使用 unittest 进行单元测试
    • 使用 multiprocessing 创建子进程
  • 六、结语

今天,我要和大家聊聊一个在Python编程中看似不起眼,但其实非常关键的小技巧——if __name__ == '__main__'

一、初识 if name == ‘main

让我们先来看看这个神奇的代码行:

if __name__ == '__main__':# 这里是程序的主入口main()

这行代码,虽然简单,却蕴含着Python编程的精髓。它的作用是确保某些代码块只在模块作为主程序运行时执行,而不是在被其他模块导入时执行。

二、namemain 是什么?

  • __name__ 变量

    每个Python模块都有一个内置属性__name__,它的值就是模块的名字。如果模块是被导入的,那么__name__通常是模块的文件名,不包括路径和文件扩展名。

  • __main__

    当一个模块被直接运行时,Python会将特殊变量__name__赋值为'__main__'。这意味着,如果你运行一个脚本文件,__name__将被设置为'__main__'。而如果该模块是被导入的,那么__name__将被设置为模块的名字。

三、实战讲解

在这里插入图片描述

示例 1:没有 if __name__ == '__main__'

假设我们有以下代码:

# example.py
print("This will always be executed")
def main():print("This will also be executed")
main()

当你运行example.py

$ python example.py
This will always be executed
This will also be executed

现在,如果我们创建另一个脚本来导入example.py

# test_import.py
import example

运行test_import.py

$ python test_import.py
This will always be executed
This will also be executed

可以看到,不论是直接运行example.py,还是通过test_import.py导入,example.py里的所有代码都会被执行。这显然不是我们想要的结果。

示例 2:使用 if __name__ == '__main__'

我们来改进一下example.py

# example.py
print("This will always be executed")
def main():print("This will be executed only if run directly")
if __name__ == '__main__':main()

再次运行example.py

$ python example.py
This will always be executed
This will be executed only if run directly

然后运行test_import.py

$ python test_import.py
This will always be executed

我们发现,当example.py被导入时,main()函数不会被执行。这样就达到了区分直接运行和导入执行的目的。

四、实际应用场景

在这里插入图片描述

测试代码

在开发过程中,我们经常需要测试代码段。通过if __name__ == '__main__',我们可以方便地在模块底部添加测试代码,而不用担心它们在模块被导入时执行:

# math_functions.py
def add(a, b):return a + b
def subtract(a, b):return a - b
if __name__ == '__main__':print("Testing add function:")print(add(1, 2))  # Should output 3print("Testing subtract function:")print(subtract(5, 3))  # Should output 2

提高代码可重用性

很多时候,我们编写的脚本不仅仅是一次性运行的工具,而是需要被其他模块调用的函数库。if __name__ == '__main__'可以保证模块在导入时不会执行测试代码或其他非必要代码,提高代码的可重用性。

避免不必要的执行

当我们有一段需要耗时或影响全局状态的代码时,避免在导入时执行就显得尤为重要:

# data_analysis.py
import pandas as pd
def load_data(filepath):data = pd.read_csv(filepath)return data
if __name__ == '__main__':filepath = 'data.csv'data = load_data(filepath)print(data.head())

在导入data_analysis.py时,不会自动加载数据文件,只有调用模块的相应方法才会加载数据,避免了不必要的资源占用。

五、深入理解和更多用法

使用 argparse 解析命令行参数

在写脚本工具时,常常需要解析命令行参数。我们可以结合if __name__ == '__main__'来实现这一功能:

# script.py
import argparse
def main():parser = argparse.ArgumentParser(description="A sample command-line tool")parser.add_argument('name', type=str, help='Your name')args = parser.parse_args()print(f'Hello, {args.name}!')
if __name__ == '__main__':main()

通过命令行运行脚本:

$ python script.py Alice
Hello, Alice!

使用 unittest 进行单元测试

在模块中添加单元测试,用if __name__ == '__main__'来运行测试:

# test_math_functions.py
import unittest
from math_functions import add, subtract
class TestMathFunctions(unittest.TestCase):def test_add(self):self.assertEqual(add(1, 2), 3)def test_subtract(self):self.assertEqual(subtract(5, 3), 2)
if __name__ == '__main__':unittest.main()

运行测试:

$ python test_math_functions.py

使用 multiprocessing 创建子进程

当我们需要并行处理时,使用 multiprocessing 模块时也需要注意if __name__ == '__main__'的使用:

# parallel_script.py
import multiprocessing
def worker(num):print(f'Worker: {num}')
if __name__ == '__main__':jobs = []for i in range(5):p = multiprocessing.Process(target=worker, args=(i,))jobs.append(p)p.start()

如果不加if __name__ == '__main__',在Windows系统上运行会导致无限递归创建子进程,最终导致崩溃。

六、结语

if __name__ == '__main__'是Python中一个简单却非常重要的习惯用法,它不仅可以让我们的代码更加清晰和模块化,还能避免许多潜在的问题和错误。

通过本文的多个示例,相信大家对if __name__ == '__main__'的理解更加深入,并能在实际开发中灵活运用。

原文:https://mp.weixin.qq.com/s/-ckOrOBkY8f7V8ltkOyxLQ

这篇关于Python脚本必加代码:99%的程序员都忽视了这个细节!的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1004300

相关文章

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

Python办公自动化实战之打造智能邮件发送工具

《Python办公自动化实战之打造智能邮件发送工具》在数字化办公场景中,邮件自动化是提升工作效率的关键技能,本文将演示如何使用Python的smtplib和email库构建一个支持图文混排,多附件,多... 目录前言一、基础配置:搭建邮件发送框架1.1 邮箱服务准备1.2 核心库导入1.3 基础发送函数二、

Python包管理工具pip的升级指南

《Python包管理工具pip的升级指南》本文全面探讨Python包管理工具pip的升级策略,从基础升级方法到高级技巧,涵盖不同操作系统环境下的最佳实践,我们将深入分析pip的工作原理,介绍多种升级方... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中反转字符串的常见方法小结

《Python中反转字符串的常见方法小结》在Python中,字符串对象没有内置的反转方法,然而,在实际开发中,我们经常会遇到需要反转字符串的场景,比如处理回文字符串、文本加密等,因此,掌握如何在Pyt... 目录python中反转字符串的方法技术背景实现步骤1. 使用切片2. 使用 reversed() 函

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v