Python学习之路-函数-文档字符串

简介: 开发者学堂课程,了解Python语言的基本特性、编程环境的搭建、语法基础、算法基础等,了解Python的基本数据结构,对Python的网络编程与Web开发技术具备初步的知识,了解常用开发框架的基本特性,以及Python爬虫的基础知识。课程地址:https://developer.aliyun.com/learning/course/601/detail/8729

help()函数是Python中的内置函数

通过help()函数可以查询python中函数的用法

语法:help(函数对象)

比如获取 print 的函数用法,注意是直接输入对象

help(print)

得到了print函数的详细用法

image.png

我们试一下自定义的函数,看看可不可以获取到用法

deffn(a,b,c):
return10help(fn)

image.png

函数的结构显示出来了,因为在定义函数时没有写说明,所以运行出来的结果没有上面的 print 后面跟的说明,怎么加上说明呢。


文档字符串(doc str)

在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明,当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明

其实直接在函数的第一行写一个字符串就是文档,但是一般我们会使用三重引号,我们这个长字符串是可以跨行写,这是文档字符串的示例,可以写 函数的作用 函数的参数 ,参数 a  的作用是什么,类型是什么,默认值等等。

deffn(a:int,b:float,c:str='hello')->int:
'''    这是一个字符串    函数的作用。。。。。。    函数的参数:        a:作用,类型,默认值。。。。。        b:作用,类型,默认值。。。。。        c:作用,类型,默认值。。。。。    '''return10help(fn)

image.png

我可以在 a 后面写一个:int  在  b 后面:bool  在 c 后面加入: str

这样通过它我能看出来需要什么类型,但是注意

这只是一个描述,没有其他任何作用,没有强制性。这时候在看文档字符串,能看出来什么类型了,更加清晰。

Fn(a:int, b:bool, c:str)

假如 c 有默认值,有默认值可以直接写 c:str = ‘hello’  默认值就是 hello

也可以在后面写一个  -> str:

这表示函数的返回值是一个字符串,str 是 int,返回值就是整型

相关文章
|
4天前
|
Python
python获取字符串()里面的字符
在Python中,如果你想获取字符串中括号(比如圆括号`()`、方括号`[]`或花括号`{}`)内的字符,你可以使用正则表达式(通过`re`模块)或者手动编写代码来遍历字符串并检查字符。 这里,我将给出使用正则表达式的一个例子,因为它提供了一种灵活且强大的方式来匹配复杂的字符串模式。 ### 使用正则表达式 正则表达式允许你指定一个模式,Python的`re`模块可以搜索字符串以查找匹配该模式的所有实例。 #### 示例:获取圆括号`()`内的内容 ```python import re def get_content_in_parentheses(s): # 使用正则表达
58 36
|
2天前
|
Python
python第三方库-字符串编码工具 chardet 的使用(python3经典编程案例)
这篇文章介绍了如何使用Python的第三方库chardet来检测字符串的编码类型,包括ASCII、GBK、UTF-8和日文编码的检测示例。
25 6
|
4天前
|
Python
[oeasy]python035_根据序号得到字符_chr函数_字符_character_
本文介绍了Python中的`ord()`和`chr()`函数。`ord()`函数通过字符找到对应的序号,而`chr()`函数则根据序号找到对应的字符。两者互为逆运算,可以相互转换。文章还探讨了单双引号在字符串中的作用,并解释了中文字符和emoji也有对应的序号。最后总结了`ord()`和`chr()`函数的特点,并提供了学习资源链接。
14 4
|
7天前
|
Java Python
全网最适合入门的面向对象编程教程:50 Python函数方法与接口-接口和抽象基类
【9月更文挑战第18天】在 Python 中,虽无明确的 `interface` 关键字,但可通过约定实现类似功能。接口主要规定了需实现的方法,不提供具体实现。抽象基类(ABC)则通过 `@abstractmethod` 装饰器定义抽象方法,子类必须实现这些方法。使用抽象基类可使继承结构更清晰、规范,并确保子类遵循指定的方法实现。然而,其使用应根据实际需求决定,避免过度设计导致代码复杂。
|
10天前
|
Python
全网最适合入门的面向对象编程教程:Python函数方法与接口-函数与方法的区别和lamda匿名函数
【9月更文挑战第15天】在 Python 中,函数与方法有所区别:函数是独立的代码块,可通过函数名直接调用,不依赖特定类或对象;方法则是与类或对象关联的函数,通常在类内部定义并通过对象调用。Lambda 函数是一种简洁的匿名函数定义方式,常用于简单的操作或作为其他函数的参数。根据需求,可选择使用函数、方法或 lambda 函数来实现代码逻辑。
|
23天前
|
Python
python 函数
【9月更文挑战第4天】python 函数
37 5
|
9天前
|
Unix 编译器 C语言
[oeasy]python034_计算机是如何认识abc的_ord函数_字符序号_ordinal_
[oeasy]python034_计算机是如何认识abc的_ord函数_字符序号_ord
12 0
|
1月前
|
IDE API 开发工具
|
4月前
|
IDE 开发工具 开发者
Python函数说明文档:编写清晰易懂的文档字符串
Python函数说明文档:编写清晰易懂的文档字符串
54 1
|
4月前
|
Python
Python 的编码规范和最佳实践: 解释 Python 的文档字符串(docstring)是什么?如何编写好的文档字符串?
【4月更文挑战第16天】Python docstrings是注释,用于说明代码功能。放置于对象定义前,用三引号包围。遵循PEP 257,使用reStructuredText格式,确保简洁、完整、准确。例如: ```markdown ```python def add(a, b): """ 计算两数之和。 参数: a -- 第一加数 b -- 第二加数 返回: 和 """ return a + b ``` ```
61 0