01-Python脚本的标准开头示例

分类: Python3基础

Python脚本的标准开头示例

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""
This is a sample Python script.

This script demonstrates a standard Python file header, including:
- A shebang line for specifying the interpreter.
- An encoding declaration.
- A docstring describing the module.
"""

# Import necessary modules
import sys
import os

def main():
    """Main function to execute the script."""
    print("Hello, World!")

if __name__ == "__main__":
    main()

1、Shebang行:#!/usr/bin/env python3
    这行代码告诉操作系统使用python3解释器来运行脚本。env命令会在用户的PATH环境变量中查找python3。
   
2、编码声明:# -*- coding: utf-8 -*-
    指定源文件使用UTF-8编码。虽然在Python 3中默认编码是UTF-8,但显式声明编码仍然是个好习惯。
    
3、模块文档字符串:
    用三个双引号括起来的字符串,描述模块或脚本的功能。这对于理解和维护代码非常有帮助。
    
4、导入语句:
    import sys和import os是导入标准库模块的示例。根据脚本的需要,可以导入其他模块。
    
5、主函数:
    定义一个main()函数来封装脚本的主要逻辑。这有助于提高代码的可读性和可维护性。
    
6、条件执行:
    if __name__ == "__main__":确保当脚本被直接执行时,main()函数会被调用。而当脚本被作为模块导入时,main()函数不会自动执行。
    
 这种结构使得脚本更加模块化、易于理解和维护。根据具体需求,你可以在此基础上添加更多的功能和逻辑
1、__name__ 变量:
    在Python中,每个模块都有一个内置变量__name__。当一个模块被直接运行时,__name__ 被设置为字符串 "__main__"。
    当一个模块被另一个模块导入时,__name__ 被设置为该模块的名称。

2、条件判断:
    if __name__ == "__main__": 这行代码用于检查当前模块是否是主程序。
    如果条件为 True(即该模块是被直接运行的),那么缩进的代码块就会被执行。
    如果条件为 False(即该模块是被导入的),那么缩进的代码块就不会被执行。

3main() 函数:
    通常,main() 函数被定义为一个包含脚本主要逻辑的函数。
    通过在 if __name__ == "__main__": 条件块中调用 main(),可以确保当脚本被直接运行时,main() 中的代码会被执行。
    
使用场景
    脚本执行: 当你编写一个Python脚本并希望直接运行它时,可以使用这个结构来定义入口点。
    模块重用: 当你希望同一个Python文件既可以作为主程序运行,又可以作为模块被导入时,这个结构非常有用。这样,导入该模块的其他脚本不会执行模块中的测试代码或示例代码。
    这种结构使得Python代码更加模块化和可重用,是Python编程中的一个最佳实践。

shell脚本结构的示例

#!/bin/bash
# -*- coding: utf-8 -*-

# This is a sample Bash script.
#
# This script demonstrates a standard Bash file header, including:
# - A shebang line for specifying the interpreter.
# - An encoding declaration (though not strictly necessary in Bash, included for consistency).
# - A comment describing the script.

# Function to print a message
main() {
    echo "Hello, World!"
}

# Check if the script is being run as the main program
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
    main
fi
解释
1Shebang (#!/bin/bash):
  指定脚本使用的解释器是 Bash。
2、编码声明 (# -*- coding: utf-8 -*-):
  虽然在 Bash 脚本中不需要指定编码(默认是 UTF-8),但为了和 Python 脚本保持一致,这里也加上了。
3、注释:
  用 # 开头的注释描述脚本的功能和结构。
4、主函数 (main):
5、定义一个 main 函数,类似 Python 脚本中的 main 函数。
6、脚本入口检查:
  使用 [[ "${BASH_SOURCE[0]}" == "${0}" ]] 判断当前脚本是否作为主程序运行。
  如果是,则调用 main 函数。
posted @   爱折腾的大臭臭  阅读(3)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· DeepSeek “源神”启动!「GitHub 热点速览」
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· DeepSeek R1 简明指南:架构、训练、本地部署及硬件要求
· 2 本地部署DeepSeek模型构建本地知识库+联网搜索详细步骤
01-Python脚本的标准开头示例
Python脚本的标准开头示例shell脚本结构的示例
点击右上角即可分享
微信分享提示