Python作为一种简洁而强大的编程语言，非常适合编写各种脚本。无论是自动化任务、数据处理还是简单的工具开发，Python脚本都能胜任。下面我将从多个角度详细介绍Python脚本的编写方法。
一、环境准备
1. 安装Python
首先需要安装Python解释器，目前最新的稳定版本是Python 3.12+。可以从Python官方网站下载对应系统的安装包。
安装时建议勾选"Add Python to PATH"选项，这样可以在命令行中直接使用 python 命令。
安装完成后，在命令行中验证安装：
# 检查Python版本
python --version
# 或者
python3 --version
2. 包管理工具(pip)
Python自带包管理工具 pip ，用于安装第三方库：
# 查看pip版本
pip --version
# 安装第三方库
pip install package_name
# 升级库
pip install --upgrade package_name
# 查看已安装的库
pip list
3. 开发环境选择
- 轻量级编辑器：
- VS Code (推荐，支持丰富插件)
- Sublime Text
- Atom
- 集成开发环境(IDE)：
- PyCharm (专业且功能强大)
- Spyder (适合数据分析)
- IDLE (Python自带简单IDE)
二、脚本基础结构
1. 脚本文件格式
Python脚本通常以 .py 为后缀名，例如 script_name.py 。
2. 基本结构示例
一个完整的Python脚本通常包含以下部分：
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
script_name.py - 脚本功能描述
作者: 你的名字
日期: 2025-06-19
版本: 1.0
"""
# 导入需要的模块
import os
import sys
import argparse
import logging
# 配置日志
logging.basicConfig(
level=logging.INFO,
format='%(asctime)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger(__name__)
# 常量定义
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
DATA_DIR = os.path.join(BASE_DIR, "data")
# 函数定义
def function1(param1, param2):
"""函数1的功能描述"""
logger.info("执行function1，参数: %s, %s", param1, param2)
# 函数逻辑
return result
class Class1:
"""类1的功能描述"""
def __init__(self, arg):
self.arg = arg
def method1(self):
"""类方法1的功能描述"""
return f"方法执行结果: {self.arg}"
# 主函数
def main():
"""主函数，脚本入口点"""
logger.info("开始执行脚本")
# 解析命令行参数
parser = argparse.ArgumentParser(description="脚本功能描述")
parser.add_argument("-i", "--input", help="输入文件路径", required=True)
parser.add_argument("-o", "--output", help="输出文件路径", default="output.txt")
parser.add_argument("-v", "--verbose", action="store_true", help="详细输出")
args = parser.parse_args()
# 根据参数调整日志级别
if args.verbose:
logger.setLevel(logging.DEBUG)
logger.debug("参数: %s", args)
# 执行主要逻辑
try:
result = function1(args.input, args.output)
logger.info("执行结果: %s", result)
except Exception as e:
logger.error("执行出错: %s", str(e))
sys.exit(1)
logger.info("脚本执行完成")
return 0
# 脚本入口
if __name__ == "__main__":
sys.exit(main())
3. 关键部分说明
- shebang行： #!/usr/bin/env python3 用于Unix/Linux系统，指定使用Python解释器执行脚本
- 编码声明： # -*- coding: utf-8 -*- 确保脚本支持中文等非ASCII字符
- 文档字符串：使用三重引号( """ )编写脚本、函数和类的文档
- 日志配置：使用Python的 logging 模块记录执行信息，便于调试和监控
- 主函数结构：将主要逻辑封装在 main() 函数中，通过 if __name__ == "__main__": 作为入口
三、脚本设计与开发
1. 功能规划
在编写脚本前，建议先明确：
- 脚本的主要功能和目标
- 输入和输出格式
- 预期的运行环境
- 可能的边界情况和异常处理
2. 模块化设计
将脚本拆分为多个功能模块，每个模块负责特定功能：
- 输入处理模块
- 数据处理模块
- 输出处理模块
- 工具函数模块
3. 常用标准库
Python标准库提供了丰富的功能，无需额外安装：
- 文件与目录操作： os , os.path , pathlib , shutil
- 数据处理： json , csv , xml , pickle
- 网络操作： socket , urllib , http
- 系统交互： subprocess , sys , argparse
- 日期与时间： datetime , time , calendar
- 并发处理： threading , multiprocessing , concurrent.futures
4. 命令行参数处理
使用 argparse 模块处理命令行参数，使脚本更灵活：
import argparse
def parse_arguments():
parser = argparse.ArgumentParser(
description='示例脚本：处理文件并生成报告',
epilog='使用示例: python script.py -i input.txt -o report.csv'
)
# 位置参数
parser.add_argument('input_file', help='输入文件路径')
# 可选参数
parser.add_argument('-o', '--output', help='输出文件路径', default='output.csv')
# 标志参数
parser.add_argument('-v', '--verbose', action='store_true', help='启用详细输出')
parser.add_argument('-q', '--quiet', action='store_true', help='静默模式')
# 带默认值的参数
parser.add_argument('-n', '--num', type=int, default=10, help='处理数量')
return parser.parse_args()
5. 错误处理
良好的错误处理使脚本更健壮：
try:
# 可能出错的代码
data = open('file.txt', 'r').read()
except FileNotFoundError:
logger.error("文件不存在: file.txt")
sys.exit(1)
except PermissionError:
logger.error("没有读取权限: file.txt")
sys.exit(1)
except Exception as e:
logger.error("发生未知错误: %s", str(e))
sys.exit(1)
else:
# 没有异常时执行
logger.info("文件读取成功")
finally:
# 无论是否有异常都会执行
logger.info("错误处理完成")
四、脚本调试与测试
1. 调试方法
- 打印调试：使用 print() 或日志输出变量值
- pdb调试器：Python内置调试器
import pdb
pdb.set_trace() # 在代码中设置断点
- IDE调试：使用PyCharm或VS Code的图形化调试功能
2. 单元测试
使用 unittest 或 pytest 框架编写测试用例：
# test_script.py
import unittest
from script import function1, Class1
class TestScriptFunctions(unittest.TestCase):
def test_function1(self):
"""测试function1的正常情况"""
result = function1(5, 3)
self.assertEqual(result, 8)
def test_function1_with_negative(self):
"""测试function1的负数情况"""
result = function1(-5, 3)
self.assertEqual(result, -2)
def test_class1_method1(self):
"""测试Class1的method1"""
obj = Class1("测试")
result = obj.method1()
self.assertEqual(result, "方法执行结果: 测试")
if __name__ == "__main__":
unittest.main()
运行测试：
python -m unittest test_script.py
3. 日志记录
合理使用日志级别：
- logging.DEBUG ：详细的调试信息
- logging.INFO ：正常运行信息
- logging.WARNING ：警告信息
- logging.ERROR ：错误信息
- logging.CRITICAL ：严重错误
五、脚本优化与性能
1. 代码优化技巧
- 列表推导式：替代传统循环
# 传统方式
squares = []
for i in range(10):
squares.append(i**2)
# 列表推导式
squares = [i** 2 for i in range(10)]
- 生成器表达式：处理大量数据时更节省内存
# 生成器表达式
even_numbers = (i for i in range(100) if i % 2 == 0)
- 使用 itertools ：高效处理迭代数据
import itertools
# 无限迭代
for i in itertools.count(1):
print(i)
if i > 10:
break
2. 性能分析
使用 timeit 模块测试代码性能：
import timeit
# 测试列表推导式和传统循环的性能
list_comp_time = timeit.timeit("[i**2 for i in range(1000)]", number=100000)
loop_time = timeit.timeit("""
squares = []
for i in range(1000):
squares.append(i**2)
""", number=100000)
print(f"列表推导式时间: {list_comp_time:.6f}秒")
print(f"传统循环时间: {loop_time:.6f}秒")
使用 cProfile 分析代码性能瓶颈：
import cProfile
import my_script
cProfile.run("my_script.main()")
3. 内存优化
- 使用生成器而非列表存储大量数据
- 及时释放不再使用的对象： del object
- 使用 weakref 模块创建弱引用，避免内存泄漏
六、脚本分发与部署
1. 打包成可执行文件
- PyInstaller：将Python脚本打包为平台独立的可执行文件
pip install pyinstaller
pyinstaller --onefile my_script.py
- cx_Freeze：另一个打包工具
pip install cx_Freeze
python setup.py bdist_msi # Windows安装包
2. 依赖管理
- 使用 requirements.txt 文件记录依赖：
pip freeze > requirements.txt
- 安装依赖：
pip install -r requirements.txt
3. 跨平台部署
- 使用 sys.platform 判断运行平台
- 避免使用特定平台的API
- 使用 pathlib 处理路径，确保跨平台兼容性
七、最佳实践与规范
1. PEP8代码规范
遵循Python官方代码规范：
- 每行代码不超过79字符
- 缩进使用4个空格
- 运算符两侧、逗号后留空格
- 类名使用驼峰式命名( ClassName )
- 函数和变量使用小写加下划线( function_name )
2. 文档编写
- 使用 doctest 在文档字符串中包含测试用例
- 使用 sphinx 生成专业文档
- 为每个函数和类编写文档字符串
3. 版本控制
使用Git进行版本控制：
# 初始化仓库
git init
# 添加文件
git add .
# 提交更改
git commit -m "初始提交"
# 推送到远程仓库
git remote add origin https://github.com/yourusername/yourproject.git
git push -u origin main
八、实战示例：文件批量重命名脚本
下面是一个实用的文件批量重命名脚本，包含了前面介绍的多个知识点：
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
batch_rename.py - 批量重命名文件
用法:
python batch_rename.py -d /path/to/directory -p "prefix_" -n "new_prefix_" -e txt
选项:
-d, --directory 要处理的目录路径
-p, --prefix 原文件名前缀
-n, --new-prefix 新文件名前缀
-e, --extension 要处理的文件扩展名
-v, --verbose 详细输出
"""
import os
import argparse
import logging
from pathlib import Path
# 配置日志
logging.basicConfig(
level=logging.INFO,
format='%(asctime)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger(__name__)
def batch_rename(directory, old_prefix, new_prefix, extension):
"""
批量重命名文件
Args:
directory: 要处理的目录路径
old_prefix: 原文件名前缀
new_prefix: 新文件名前缀
extension: 要处理的文件扩展名
Returns:
重命名的文件数量
"""
directory_path = Path(directory).resolve()
if not directory_path.exists() or not directory_path.is_dir():
logger.error(f"目录不存在: {directory}")
return 0
renamed_count = 0
for file_path in directory_path.glob(f"**/*.{extension}"):
if file_path.name.startswith(old_prefix):
new_name = file_path.name.replace(old_prefix, new_prefix, 1)
new_path = file_path.parent / new_name
try:
file_path.rename(new_path)
logger.info(f"重命名: {file_path.name} -> {new_name}")
renamed_count += 1
except Exception as e:
logger.error(f"重命名失败 {file_path.name}: {str(e)}")
return renamed_count
def main():
"""主函数"""
parser = argparse.ArgumentParser(description='批量重命名文件')
parser.add_argument('-d', '--directory', required=True, help='要处理的目录路径')
parser.add_argument('-p', '--prefix', required=True, help='原文件名前缀')
parser.add_argument('-n', '--new-prefix', required=True, help='新文件名前缀')
parser.add_argument('-e', '--extension', default='', help='要处理的文件扩展名')
parser.add_argument('-v', '--verbose', action='store_true', help='详细输出')
args = parser.parse_args()
if args.verbose:
logger.setLevel(logging.DEBUG)
logger.debug(f"参数: {args}")
logger.info(f"开始批量重命名，目录: {args.directory}, 原前缀: {args.prefix}, 新前缀: {args.new_prefix}")
try:
count = batch_rename(args.directory, args.prefix, args.new_prefix, args.extension)
logger.info(f"批量重命名完成，共重命名 {count} 个文件")
return 0
except Exception as e:
logger.error(f"执行出错: {str(e)}")
return 1
if __name__ == "__main__":
import sys
sys.exit(main())
编写Python脚本需要综合考虑功能设计、代码结构、错误处理、性能优化等多个方面。通过合理使用标准库和第三方库，可以大大提高开发效率。同时，遵循最佳实践和代码规范，有助于编写可维护、可扩展的脚本。
随着实践的增加，你会逐渐掌握更多技巧，能够根据不同需求快速编写高效的Python脚本。如果有特定领域的脚本需求（如Web自动化、数据分析等），可以进一步深入学习相关库和框架。