无聊的博客
首页
历史归档
文章分类
文章标签
公益服务CSR
Linux 命令搜索引擎
订阅转换
订阅转换(EdgeOne 线路)
DoH
Socks5/HTTP验证
ProxyIP验证
其他站点
副站点 CDN 加速
主站点
副站点(Github.io)
Linux 命令搜索引擎
开发人员快速参考备忘录
主站点 CDN 加速
小游戏
俄罗斯方块
吃豆人
简单的贪吃蛇(@gamedolphin)
滑块(@gamedolphin)
顶砖块
宇宙飞船射击
神秘人 | 一个普通的干饭人🍚
0
Python 笔记
Python
思考
笔记
文档
函数文档、类型注释、内省 - Python
字数
2761
阅读时长≈
7
分钟
2025-9-27
2025-9-27
你好!我是
神秘人
-- 感谢您的支持 ---
👏欢迎光临寒舍👏
本博客作为学习用途,用于记录学习过程中的笔记,内容
可能有误
,
欢迎在评论区指正
!!
日志:
2025/7/29 添加了一些免费的工具和服务😎
2025/2/23 us.kg域名故障,已紧急修复!!
2025/1/29 无聊的博客,祝您新年快乐!!
2024/11/18 网站异常,已紧急修复!!
了解更多
目录
Python 函数的文档、类型注释与内省详解
一、函数文档字符串(Docstring)——让代码自己说话
1.1 什么是文档字符串?
1.2 为什么需要文档字符串?
1.3 文档字符串的标准格式
Google 风格(推荐初学者使用)
NumPy/SciPy 风格
也可以
1.4 如何访问和使用文档字符串?
方法1:直接访问 __doc__ 属性
方法2:使用内置函数 help()
方法3:在交互式环境中自动显示
1.5 文档字符串的存储机制
二、类型注释(Type Hints)——为动态语言增加静态保障
2.1 为什么需要类型注释?
2.2 基本类型注释语法
示例分析
2.3 类型注释的存储和访问
2.4 类型注释不强制执行!
2.5 容器类型的类型注释
基础容器类型
泛型类型注释(Python 3.9+)
兼容旧版本 Python(3.8 及以下)
2.6 默认参数的类型注释
2.7 类型注释的实际价值
三、函数内省(Introspection)——运行时的自我认知
3.1 什么是内省?
3.2 函数对象的关键属性
__name__:函数名
__doc__:文档字符串
__annotations__:类型注释
其他有用的内省属性
3.3 内省的实际应用场景
场景1:调试和日志
场景2:API 文档自动生成
场景3:类型验证装饰器
3.4 内省与反射的区别
四、综合实例:完整的函数定义
五、常见误区和最佳实践
5.1 常见误区
误区1:类型注释会强制类型检查
误区2:文档字符串可有可无
误区3:内省属性可以随意修改
5.2 最佳实践
1. 文档字符串规范
2. 类型注释策略
3. 内省的合理使用
六、总结:三个特性如何协同工作
最新发布
什么年代了!我不允许你还不会安装 Docker
2025-10-31
JDK + Hello World,搞定!
2025-10-7
掌握 Python 列表推导式
2025-9-30
使用GitHub Pages发布静态网页
2025-9-30
HTML 框架集与框架速查
2025-9-30
Tomcat 服务
2025-9-30
文档
56
笔记
54
Python
30
思考
28
教程
22
实用教程
12
Linux
9
小游戏
7
大数据
7
Hadoop
7
C
6
HTML
6
建站
5
速查表
5
热门文章
5
推荐
4
必看精选
4
职业技能大赛
3
CSS
3
题目
3
答案
3
开发
2
其他
2
文字
1
GitHub
1
Java
1
文章数:
68
建站天数:
1884 天
访问量:
访客数: