python函数支持哪些参数类型_如何记录python函数参数类型？

I know that the parameters can be any object but for the documentation it is quite important to specify what you would expect.

First is how to specify a parameter types like these below?

str (or use String or string?)

int

list

dict

function()

tuple

object instance of class MyClass

Second, how to specify params that can be of multiple types like a function that can handle a single parameter than can be int or str?

Please use the below example to demonstrate the syntax needed for documenting this with your proposed solution. Mind that it is desired to be able to hyperlink reference to the "Image" class from inside the documentation.

def myMethod(self, name, image):

"""

Does something ...

name String: name of the image

image Image: instance of Image Class or a string indicating the filename.

Return True if operation succeeded or False.

"""

return True

Note, you are welcome to suggest the usage of any documentation tool (sphinx, oxygen, ...) as long it is able to deal with the requirements.

Update:

It seams that there is some kind of support for documenting parameter types in doxygen in. general. The code below works but adds an annoying $ to the param name (because it was initially made for php).

@param str $arg description

@param str|int $arg description

解决方案

There is a better way. We use

def my_method(x, y):

"""

my_method description

@type x: int

@param x: An integer

@type y: int|string

@param y: An integer or string

@rtype: string

@return: Returns a sentence with your variables in it

"""

return "Hello World! %s, %s" % (x,y)

That's it. In the PyCharm IDE this helps a lot. It works like a charm ;-)

python函数支持哪些参数类型_如何记录python函数参数类型？相关推荐

不显示参数名_第51p，万能参数与返回值，Python中函数的返回值
大家好,我是杨数Tos,这是<从零基础到大神>系列课程的第51篇文章,第三阶段的课程:Python进阶知识:详细讲解Python中的函数(四)====>函数的参数与返回值(下篇). ...
python函数定义中参数列表里的参数是_详解Python函数中参数带星号是什么意思
函数的参数使用除了常规的位置参数和关键字参数外,还支持可变个数的函数参数,这种支持可变个数的参数方法称为参数收集,对应的参数称为收集参数. 一.参数收集的定义 Python的函数支持可变不定数量的参数 ...
中boxplot函数的参数设置_如何在Python中生成图形和图表
在本章中,我们将学习如何在Python中生成图形和图表,同时将使用函数和面向对象的方法来可视化数据. Python中常用的一些可视化数据包括以下几种. Matplotlib. Seaborn. ggp ...
len函数python返回值类型_简单介绍Python中的len()函数的使用
01状态机介绍游戏中的状态机一般都是有限状态机,简写为FSM(有限状态机),简称状态机,是表示有限个状态以及在这些状态之间的转移和动作等行为的数学模型. 状态机的每一个状态至少需要有以下三个操作: ...
python中是什么类型_浅谈python中的变量默认是什么类型
浅谈python中的变量默认是什么类型 1.type(变量名),输出的结果就是变量的类型: 例如 >>> type(6) 2.在Python里面变量在声明时,不需要指定变量的类型,变 ...
pythonnamedtuple定义类型_详解Python中namedtuple的使用
namedtuple是Python中存储数据类型,比较常见的数据类型还有有list和tuple数据类型.相比于list,tuple中的元素不可修改,在映射中可以当键使用. namedtuple: na ...
python 判断类型_青少年之Python编程课程安排lt;第一季gt;
第一章开启Python之旅 1. 你将了解什么是Python 2. 在电脑上安装并简单使用Python 3. 开始通过Python与计算机进行交流(编程) 第二章变量 1. ...
python用可变参数求积_流畅的python读书笔记-第八章-对象引用、可变性和垃圾回收...
对象不是个盒子 class Gizmo: def __init__(self): print('Gizmo id: %d' % id(self)) x = Gizmo() print(x) y = G ...
python不支持以下哪种数据类型_下列数据类型中, Python不支持的是()。_学小易找答案...
[判断题]a={},type(a)结果是 . (5.0分) [简答题]内造型设计 [填空题]水分子之间存在着质子的传递作用,称为水的作用,这个作用的平衡常数在25度时等于 . [填空题]len('3 ...
python 类初始化参数校验_如何规避python参数的初始化次数？
我们在内存不足的时候,除了增加内存的可用度,可以进行一个清理内存的初始化操作,当然这种是最后迫不得已的选择.我们在python中也有需要用到初始化的地方,鉴于参数和函数的关系密不可分,本篇我们会简单的 ...

python函数支持哪些参数类型_如何记录python函数参数类型？

python函数支持哪些参数类型_如何记录python函数参数类型？相关推荐

最新文章

热门文章