如何在python docstring中指定不同的返回类型
在Python中，可以使用类型提示来指定函数的返回类型。类型提示是一种静态类型检查工具，可以在代码中指定变量、函数参数和返回值的类型。在函数的docstring中，可以使用类型提示来指定不同的返回类型。
以下是在Python docstring中指定不同返回类型的示例：
def add(a: int, b: int) -> int:
"""
This function takes two integers as input and returns their sum.
Parameters:
a (int): The first integer.
b (int): The second integer.
Returns:
int: The sum of the two integers.
"""
return a + b在上面的示例中，函数add接受两个整数作为输入，并返回它们的和。在docstring中，使用类型提示来指定参数a和b的类型为int，并指定返回值的类型也为int。
对于不同的返回类型，可以根据实际情况进行指定。例如，如果函数可能返回多种类型的值，可以使用Union来指定多个类型：
from typing import Union
def divide(a: int, b: int) -> Union[int, float]:
"""
This function takes two integers as input and returns their division.
If the division is exact, it returns an integer; otherwise, it returns a float.
Parameters:
a (int): The dividend.
b (int): The divisor.
Returns:
Union[int, float]: The result of the division.
"""
if a % b == 0:
return a // b
else:
return a / b在上面的示例中，函数divide接受两个整数作为输入，并返回它们的除法结果。如果除法结果是整数，则返回int类型；否则，返回float类型。在docstring中，使用Union[int, float]来指定返回类型可以是int或float。
相关·内容
Windows 7专业版
Python: Python3.6.1-amd64.exe
pyodbc: pyodbc-4.0.16-cp36-cp36m-win_amd64.whl
Eclipse: neon.3发布版本(4.6.3)构建id: 20170314-1500
PyDev for Eclipse: 5.7.0201704111357
在通过运行pip install pyodbc-4.0.16-cp36-cp36m-win_amd64.whl安装pyodbc之后，在Eclipse中得到了未解决的导入pyodbc。因此，我在Python解释器>强制B
浏览 4提问于2017-06-16得票数 0
2回答
我不确定我是否看到了这方面的具体答案，但我有一个关于python文档字符串返回值的样式约定的问题。
考虑一下这样的功能：
def foo(ex):
output = 2*ex
return output
在PyCharm中，如果我为该函数创建了一个docstring，则如下所示：
def foo(ex):
"""
Sample text....
:param ex: description...
:return: description of return value
"""
out
浏览 5提问于2017-11-04得票数 2
我有一个功能：
def foo(path):
"""
:param path: Path to a folder
:type path: pathlib.Path
"""
new_path = path / 'tmp'
return new_path
它获取一个pathlib.Path对象，并在此路径的末尾添加“tmp”。但是PyCharm显示了一个“new_path = path / 'tmp'中的path下未解决的引用”。
很明显，如果这类变量的类型是内置的，就
浏览 1提问于2021-02-08得票数 1
回答已采纳
8回答
虽然我知道Python的鸭子类型概念，但有时我会与函数的参数类型或函数返回值的类型进行斗争。
现在，如果我自己编写函数，我确实知道类型。但是，如果有人想使用和调用我的函数，他(她)如何知道类型呢？我通常将类型信息放在函数的docstring中(比如："...the id argument should be an integer..."和"... the function will return a (string, [integer]) tuple.")
但是，在docstring中查找信息(并将其作为一个编码器放在那里)是否真的是应该完成的呢？
编辑：，而大
浏览 5提问于2011-03-17得票数 143
回答已采纳
1回答
我在函数中写了一个注释，我的IDE自动完成了如下操作：
async def some_func():
"""
:return:
"""
这是什么:返回:用于和哪里可以阅读更多关于这方面的内容？
浏览 6提问于2022-02-05得票数 1
回答已采纳
假设我有一个如下所示的类方法-
class BasePreStep:
def __init__(self, threadpool, release_manifest, service_manifest, upgrade_bundle, system_config):
如果我像下面这样添加类型提示，那么自动完成在python文件中可以正常工作。
class BasePreStep:
__metaclass__ = ABCMeta
def __init__(self, threadpool, release_manifest, service_manifest, upgr
浏览 2提问于2018-09-12得票数 1
回答已采纳
我最近研究了在Jupyter Notebook的cell中查找任何内置python library's函数的文档。有什么建议可以让我访问文档吗？我知道键盘快捷键是shift + tab，用4倍的shift + tab，整个文档和例子就会弹出来。除了捷径之外，我只是想知道通常的方式。
浏览 9提问于2017-12-05得票数 6
回答已采纳
1回答
Python矩阵方程求解方法
、、、、
我该用什么方法？
a，b是向量，或数组n维数，X是(nxn)维数。我用numpy来做这个。
我有一个
X^T X a=X^T b
矩阵向量方程X，X^T，b是已知的，问题是a。
我尝试了X^T作为X^T@X=z，并执行z^-1，然后z^-1@X^T =g并执行np.linalg.solve(g，b)。这里有基本的线性代数我做错了吗？
对于这些类型的方程是否有特定的python代码？
浏览 8提问于2022-02-14得票数 0
在Pycharm中，我希望有一个有文档的函数，它返回一个元组，这样我就可以在上面完成代码。评论的风格是Google风格。
此正确地工作：
def func():
"""
Returns:
str: something
"""
pass
键入func().正确地显示了str的方法。
但是，键入此不再有效：
def func():
"""
Returns:
(int, str): something
"""
浏览 4提问于2016-12-09得票数 16
我已经用Python编写了大约一年的代码，我刚刚在一个中遇到了一些代码，它在文件的顶部声明了一个变量：
__docformat__ = 'restructedtext en'
搜索互联网产生的 PEP文档。尽管它仍然没有清楚地解释何时/为什么要指定这个变量。
我应该在所有Python代码的顶部声明它吗？
浏览 3提问于2015-08-26得票数 10
回答已采纳
我有一个python函数，我正在用一个标准docstring来记录这个函数：
"""
Function description
Parameters
----------
p0 : numpy.ndarray, shape (...,4)
p0 description 1
p0 description 2
p1 : int, optional
p1 description
Returns
-------
Return value : my.Returnclass
"""
当我从另一个类继承这个函数并重写它时，我仍然希
浏览 6提问于2022-09-27得票数 0
回答已采纳
在python项目中，我生成autoapi文档。特殊注释出现在生成的html文件中。例如，它正在最后的html页面上工作和显示：
def do_action(self,params):
"""
This is function to do some cool stuffs.
Actually it should
"""
pass
或
...
applicationConfig = None
"""This variable hold some important data"""
浏览 0提问于2019-11-26得票数 3
回答已采纳
说“Python文档使用的标记是”。我的问题是:块注释应该如何编写才能显示多个返回值？
def func_returning_one_value():
"""Return just one value.
:returns: some value
:rtype: str
"""
def func_returning_three_values():
"""Return three values.
How do I note in reStructuredText that
浏览 0提问于2016-09-29得票数 15
我使用的是dvorak键盘，在使用<c-i>和<c-o> (向后或向前跳跃)时，我想减少伸手去按控制键的压力。我认为'，‘和'p’键在与goto菜单相结合时(例如，当首先点击'g‘时)是完美的。(对于qwerty用户来说，这意味着键盘上的“w”、“e”和“r”键位置，当从“转到”菜单点击时，将是“跳回”、“跳到最后一次编辑”和“向前跳”)。因此，…
这是我想要的：
1) :map global goto , '<c-o>' -docstring 'jump back'
浏览 2提问于2018-06-05得票数 2
我想为某些动态创建的对象提供文档(在我的程序中)，但仍然返回到使用它们的类文档。设置__doc__似乎是一种合适的方法。但是，我在Python帮助中找不到这方面的很多细节，在提供实例文档方面有什么技术问题吗？例如：
class MyClass:
"""
A description of the class goes here.
"""
a = MyClass()
a.__doc__ = "A description of the object"
print( MyClass.__doc__ )
prin
浏览 0提问于2018-05-22得票数 1
回答已采纳
在Python2.5(实际上是Jython)中，对于UnitTest TestCase类，没有SetUpClass方法，而__init__实际上是不可接受的(对self没有参考)。当我试图更改TestCase中的docstring时：
import os
fileName = os.path.split(__file__)[1]
testCaseName = os.path.splitext(fileName)[0]
setattr(__name__, '__doc__', testCaseName)
我得到了：
setattr(__name__, '__doc__&#
浏览 4提问于2011-05-01得票数 1
Pylint抛出一些文件缺少文档字符串的错误。我尝试将docstring添加到每个类、方法和函数中，但Pylint似乎也会检查文件的开头是否应该有docstring。我能以某种方式禁用它吗？
我希望在类、函数或方法中缺少docstring时得到通知，但不应该强制文件必须有docstring。
(专有源文件开头经常出现的法律术语有没有一个术语？有什么例子吗？我不知道是否可以单独发布这样一个琐碎的问题。)
浏览 2提问于2011-10-24得票数 131
回答已采纳
1回答
根据python的样式指南，标准的pep8文档字符串可能如下所示：
"""Function description
Keyword arguments:
keyword_arg_1 -- description
keyword_arg_2 -- description
"""
但是，在返回的输出数据的标准中没有看到任何内容，我认为这是函数定义的一个重要部分。也就是说，我想记录每个变量前面有一个return语句。
在python中为每个返回的函数输出提供描述和类型的好的标准方法是什么？
浏览 1提问于2018-11-01得票数 0
回答已采纳
3回答
我希望在VS代码中更改Python文档字符串中参数的颜色(或突出显示)。 我看过一些主题，但我不太明白如何使用TextMate添加自定义作用域。 在下图中，您可以看到:param:与字符串的颜色相同。我在找一种不同的/定制的颜色。 可能还会考虑突出显示返回类型，如str或dict。 我真的很感谢任何人和所有的帮助！ ?
浏览 30提问于2020-09-13得票数 1
回答已采纳
我正在学习Python，希望这里有人能帮我弄清楚一些事情。
我有以下代码：
import pandas as pd
ser = pd.Series(['01-01-2010', '02-02-2011', '03-03-2012', '04-04-2013'])
ser_ts = pd.to_datetime(ser)
ser_ts_daynum = ser_ts.dt.weekday.tolist()
ser_ts_dayname = ser_ts.dt.day_name().tolist()
print(ser_ts_d
浏览 10提问于2021-09-11得票数 1
在java中，如果搜索一个类，通常可以找到该类提供的所有可用方法。它告诉您参数和返回类型。然而，在python中，我还没有找到任何类似的东西。官方的docs.python.org有一些方法使用的例子，但有时它们似乎没有确切地提到它接受的参数是什么以及返回类型是什么。
例如，当我查看counter对象时，我无法准确地找到keys()方法所做的事情以及它返回的内容。类似地，我在get中看到了计数器类的另一种用法，但我也无法在该网站上找到它。
有没有人对与Java非常相似的文档有任何建议？如果不是，最好的方法是找出每种方法在python中所做的事情。
浏览 1提问于2019-02-03得票数 1
回答已采纳
1回答
昨天，我找到了一种方法来模拟类似于python 3(可能在python 2 ;)中的类型安全性。例如，编写以下内容：
def do_stuff(amount: int, name: str, place: str = 'London') -> list:
如果要设置不具有预期类型的参数(给出一个期望整数的字符串)，可以告诉IDE通知您。Python本身忽略了它们，这对我来说是完全没有问题的。
但是，现在我想提供一些异常，这些异常可能会在过程中抛出。我怎样才能做到这一点？不幸的是，我甚至不知道该找什么。有人能帮我吗？我希望我的IDE (PyCharm)提醒我，在某些情况下，
浏览 3提问于2016-11-03得票数 1
回答已采纳
有人能给我解释一下如何在VSCode的默认主题中自定义Python的文档字符串颜色吗？我想通过用户设置来完成，因为我想能够保存我的配置文件。
我尝试使用"editor.tokenColorCustomizations"：{}，但它影响所有字符串。
浏览 0提问于2017-10-11得票数 13
在Django-REST框架中，在ViewSet中，我在几种方法上使用了使用@action装饰器的额外路由操作。我希望每个方法都有不同的文档字符串，但显然这是行不通的。有什么想法吗？
@action(methods=['GET', 'POST', 'DELETE'])
def followers(self, request, player):
if request.method == 'GET':
"""
Get the players who follow thi
浏览 4提问于2014-05-12得票数 0
1回答
我有一个Python包，其中包含编译成.so的C代码。在我的Python代码中，我有docstring。在我的C代码中，我也有文档字符串。sphinx对C源代码中给出的文档字符串也很敏感，这样我就可以自动生成文档了吗？
浏览 2提问于2016-05-26得票数 0
回答已采纳
下面的函数(在Python中实现)的好名称是什么？
def a_function(element, a_set):
if a_set[0] == element:
return a_set[1]
if a_set[1] == element:
return a_set[0]
assert 'A' == a_function('B', ['A', 'B'])
浏览 0提问于2014-04-20得票数 2
回答已采纳
当出现时，这些元素在Python模块中声明的顺序是什么？
散列(#!/usr/bin/env python)
编码(# coding: utf-8)
未来进口(from __future__ import unicode_literals, ...)
Docstring
如果最后声明，docstring将在调用help(module)中工作吗？
浏览 2提问于2020-01-15得票数 4
回答已采纳
2回答
我想在另一个模块(例如module_2.py)的另一个模块(例如module_1.py)中添加一个类的方法的链接。我想让这个链接在狮身人面像上工作。
假设：
module_1.py
class ABC:
def foo(self):
"""
See docstring of module_2.py bar():<link to bar() in module_2.py>
"""
print("foo")
module_2.py
class XYZ:
def
浏览 5提问于2017-07-24得票数 9
我编写了这个备份实用程序，通过复制新的和修改的文件以及硬链接不变或简单移动的文件来保持增量备份。为了加快比较速度，我从以前的备份中保存了文件统计数据的记录，以避免在旧备份目录中进行迭代。从传递目标文件夹的命令行调用备份，然后是要备份的文件夹。配置选项从与备份目标相同的文件夹中的文本文件中提取。我已经为我所有的“#TODO”做了一些测试，但还不足以让我确信它特别健壮(尤其是在Windows 10以外的其他操作系统上)。到目前为止，还没有执行或打算进行备份剪枝。一个很好的起点是从命令行调用帮助：>python backup_utility.py -h
#!/usr/bin/env pytho
浏览 0提问于2022-05-03得票数 3
回答已采纳
我正在做一个web应用程序项目，它使用龙卷风作为web前端。目前，我正在编写文档并使用Pydoc将docstring添加到代码库中。
作为一个web框架，龙卷风应用程序的结构包括每个API端点都有一个处理程序类，并且每个处理程序类对于端点应该处理的每个HTTP请求方法都有一个单独的Python方法。这些Python方法总是具有get(self)、post(self)、put(self)等表单的签名，并且它们本身不带任何参数。
出于本能，我想像这样使用Pydoc：
class MyHandler(tornado.web.RequestHandler):
def get(self):
浏览 0提问于2017-02-07得票数 0
2回答
我有一个描述符，它将方法转换为类级别上的属性：
class classproperty(object):
def __init__(self, getter):
self.getter = getter
self.__doc__ = getter.__doc__
def __get__(self, instance, owner):
return self.getter(owner)
像这样使用：
class A(object):
@classproperty
def test(cls):
&#
浏览 0提问于2014-03-12得票数 4
回答已采纳
Python为从未返回值的函数提供了 TypeHint。对于一个函数来说，什么是最好的实践，它只是有时不返回一个值？
def handle_value(value: str) -> ???:
if isinstance(value, str):
return value
else:
_raise_helping_func(value)
此函数总是返回字符串或引发异常(调用引发的另一个func )。也许是：
-> Optional[str]
-> Union[str, NoReturn]
-> str
我
浏览 6提问于2020-09-22得票数 1
回答已采纳
我正在尝试将一些导入行插入到python源文件中，但理想情况下，我希望将它们放在初始文档字符串之后。假设我将文件加载到lines变量中，如下所示：
lines = open('filename.py').readlines()
如何找到行号，文档字符串的结束位置？
浏览 0提问于2008-10-01得票数 2
回答已采纳
我使用Python包来声明抽象类。在定义抽象方法时，是返回与预期类型相同的空对象，还是只返回pass
MWE：
import abc
class A(abc.ABC):
@abc.abstractmethod
def method_1(self):
"""
This abstract method should return a list
"""
pass
def method_2(self):
list_output_method
浏览 0提问于2018-09-28得票数 2
回答已采纳
2回答
在Python中，我经常生成一个泡菜文件，以保存我在编程期间所做的工作。
是否有可能将类似docstring的东西存储在泡菜中，从而解释如何产生这个泡菜，以及它的含义。
浏览 1提问于2018-11-24得票数 0
回答已采纳
2回答
在哪里放置__all__文件？
、、、、
我想知道，__all__文件中的标准位置是什么？
我的假设就在import语句下面。然而，我在任何地方都找不到明确的声明/要求。所以，总的来说，在哪里应该有__all__？
它将放在下面的示例文件中？
#!/usr/bin/env python3
"""Where to put __all__."""
from time import time
# I think it should go here: __all__ = ["Hello"]
SOME_GLOBAL = 0.0
class Hello:
def
浏览 7提问于2020-01-08得票数 7
回答已采纳
2回答
在python中使用“类型提示”符号有什么好处吗？
import sys
def parse(arg_line: int) -> str:
print (arg_line) # passing a string, returning None
if __name__ == '__main__':
parse(' '.join(sys.argv[1:]))
在我看来，它似乎使语法变得复杂，而没有提供任何实际的好处(在开发环境之外)。在此基础上：
python是否计划在语言本身中包含type约束？
拥有“类型提示”的好处是什么？我就不
浏览 3提问于2020-09-10得票数 9
回答已采纳
我有一些带有说明的python方法。例如，要测试的参数组合。在我的代码中，我使用一个解析器来解析我使用的函数的doc字符串，这样就不再需要配置文件了。我需要的信息仅包含在函数doc字符串中。我想知道这是否是一个良好和普遍的行业惯例？
更新:我有一长串实验要做，用函数表示。对于每个函数，我有一些测试用例(不同功能的测试用例不同)。当我创建函数时，将定义测试用例。我将它们放在doc字符串中，并在进行测试时解析它们。
def my_function1(param1,param2)
'''param1: 10, 20, 40, 60; param2: 5, 10, 20
浏览 2提问于2016-07-27得票数 1
回答已采纳
当我使用普通python (希望这个术语是可以理解的)时，然后键入
import IPython
IPython.start_ipython(["--pylab=qt", "--TerminalInteractiveShell.editor=scite"])
ipython控制台的启动方式如下
ipython --pylab=qt --TerminalInteractiveShell.editor=scite
但是，当我在已经运行的ipython控制台中这样做时，这是行不通的。是否有可能“重置”正在运行的ipython控制台？
编辑:我现在用自己的代码解决了我的
浏览 3提问于2014-05-30得票数 0
2回答
我刚刚开始使用Visual 2015，我非常喜欢它，特别是代码完成功能。现在，我正在编写一些简单的Python代码来在Tkinter画布上绘制一个对象：
def draw(self, can):
""" can is a Tkinter canvas on which this node will draw itself. """
can.<something>
这是Python，在实际代码中没有任何地方表明"can“将是画布，因此VS不能在我输入”can“之后自动完成或建议任何内容。我
浏览 6提问于2016-08-07得票数 4
回答已采纳
以pickle.dump()和pickle.load()函数为例。 如何指示/document/docstring是pickle.dump()接收的参数类型，还是pickle.load()返回的值的类型？ 以下是Google Style Python Docsting的一个示例。如你所见，一个普通函数的参数类型和返回类型都是静态的，并且有明确的文档记录： def function_with_types_in_docstring(param1, param2):
"""Example function with types documented in the docst
浏览 15提问于2021-08-11得票数 0
我想使用来更好地记录我的代码。
在下面的函数中，它接受一个列表作为输入，并将一个文件写入磁盘。我想知道如何将docstring中的函数输出记录为None中的函数返回类型。有会议吗？
def foo(list_of_items: list) -> None :
"""Simple function.
Parameters
----------
list_of_items : list of str
list of some texts
Returns
-------
浏览 2提问于2020-09-28得票数 4
回答已采纳
3回答
我有以下课程：
class DBManagerInterface:
@abstractmethod
def __init__(self, table_name): raise NotImplementedError
@abstractmethod
def create_table(self): raise NotImplementedError
@abstractmethod
def drop_table(self): raise NotImplementedError
class DataBaseManager(DBManagerI
浏览 3提问于2020-02-26得票数 1
回答已采纳
1回答
我在一个PyCharm项目中有以下Python代码：
class Category:
text: str
a = Category()
a.text = 1.5454654 # where is the warning?
当我试图设置一个类型错误的属性时，编辑器应该显示一个警告。下面看看下面的设置：
浏览 5提问于2020-12-30得票数 5
回答已采纳
我对python编码非常陌生。我偶然发现了这个问题，现在很困惑。为什么只有"self“属性，以及如何返回字符串列表？
def ridings_recorded(self) -> List[str]:
"""Return the ridings in which votes have been recorded in this
election.
>>> e = Election(date(2000, 2, 8))
>>> e.update_results('r1', &
浏览 3提问于2022-02-04得票数 -1
我正在使用为我的python项目提供链接。我为片地狱安装并激活了。然后我想把我的docstring样式设置为numpy。首先，我将docstring_style = "numpy"添加到tool.flakehell部分的pyproject.toml中。此外，我在docstring_style = numpy中设置了setup.cfg (由darglint使用)。当在终端中运行darglint时，一切正常，但是使用flakehell它不会检测到我的附加设置，并给出包含错误文档字符串的linting错误.
我的pyproject.toml
[tool.flakehell]
docs
浏览 0提问于2020-09-29得票数 0
因此，在Pandas中，我们可以对字符串列执行str操作，如
str_lower = df["str_col"].str.lower()
我想知道，str.lower()是如何在类中实现的(注意，它不是关于str.lower()的具体实现，而是这样的东西一般是如何在python中实现的)？
我唯一能想到的就是在这个类中定义的子类的一个方法。
class DataFrame():
class str():
def lower(self):
return [p.lower() for p in self.column
浏览 2提问于2022-05-20得票数 0
2回答
我正在使用pydoc自动构建文档。我的代码是为Python3.6编写的。
它的错误与以下错误：<type 'exceptions.SyntaxError'>: invalid syntax。每当我使用f-string时，这种情况就会发生。
，你能帮我找出原因吗？
当我运行which pydoc时，我得到：/usr/local/bin/pydoc
示例代码
下面是一些名为test.py的示例代码：
"""This is a docstring."""
def my_method():
""&#
浏览 4提问于2019-08-12得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
