相关疑难解决方法(0)

在Python中,我想在我的代码中编写一个多行dict.有几种方法可以格式化它.以下是我能想到的一些内容:

1. mydict = { "key1": 1,
              "key2": 2,
              "key3": 3, }
   

   Run Code Online (Sandbox Code Playgroud)

2. mydict = { "key1": 1,
              "key2": 2,
              "key3": 3,
            }
   

   Run Code Online (Sandbox Code Playgroud)

3. mydict = {
       "key1": 1,
       "key2": 2,
       "key3": 3,
   }
   

   Run Code Online (Sandbox Code Playgroud)

我知道上面的任何一个在语法上都是正确的,但我认为Python dicts有一个首选的缩进和换行样式.它是什么？

注意:这不是语法问题.以上所有(据我所知)有效的Python语句并且彼此等效.

我目前从Python开始,我有一个强大的PHP背景,在PHP中我习惯使用javadoc作为文档模板.

我想知道它是否javadoc有它作为docstringPython文档的位置.这里有既定的惯例和/或官方的guildelines？

例如,这样的东西太精巧,不适合Python的思维方式,或者我应该尽量简洁？

"""
replaces template place holder with values

@param string timestamp     formatted date to display
@param string priority      priority number
@param string priority_name priority name
@param string message       message to display

@return string formatted string
"""

如果我有点过于详尽,我应该选择这样的东西(大多数文档不通过该__doc__方法打印)？

# replaces template place holder with values
#    
# @param string timestamp     formatted date to display
# @param string priority      priority number
# @param string priority_name priority name
# @param string message …

我已经添加了关于在软件包之间设置Sphinx文档链接的文档

intersphinx_mapping = {'python': ('http://docs.python.org/2', None),
                       'numpy': ('http://docs.scipy.org/doc/numpy/', None),
                       'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
                       'matplotlib': ('http://matplotlib.sourceforge.net/', None)}

到我的conf.py,但似乎无法获得除Python本身以外的任何项目的链接.例如

:term:`svg graphics <matplotlib:svg>`

只需将我带到索引页面,而不添加预期的#term-svg锚点,我甚至无法找到词汇表scipy或找出如何确定包所支持的:ref:s或:term:s.

我在哪里可以找到如何指定目标指令:ref:S和:term:S IN numpy,scipy和matplotlib？

就此而言,我如何链接到Sphinx本身？添加

intersphinx_mapping['sphinx'] = ('http://sphinx-doc.org/', None)

和

:ref:`Intersphinx <intersphinx>`

不起作用.

有没有办法如何在sphinx文档中自动显示变量var1和var2及其init-values？

class MyClass:
    """    
    Description for class
    """

    def __init__(self, par1, par2):
       self.var1 = par1 * 2
       self.var2 = par2 * 2

    def method(self):
       pass

有时Python中的函数可能接受灵活类型的参数.或者它可以返回灵活类型的值.现在我不记得现在这样一个功能的一个很好的例子,因此我在下面用玩具示例展示这样的功能可能是什么样子.

我想知道如何使用Sphinx文档表示法为这些函数编写文档字符串.在下面的示例中,参数可以是str或int.同样,它可能会返回str或int.

我给出了一个示例文档字符串(两者都是默认的Sphinx表示法以及Sphinx拿破仑扩展所理解的Google表示法).我不知道这是否是记录灵活类型的正确方法.

Sphinx默认表示法:

def add(a, b):
    """Add numbers or concatenate strings.

    :param int/str a: String or integer to be added
    :param int/str b: String or integer to be added
    :return: Result
    :rtype: int/str
    """
    pass

狮身人面像拿破仑谷歌记号:

def add2(a, b):
    """Add numbers or concatenate strings.

    Args:
      a (int/str): String or integer to be added
      b (int/str): String or integer to be added

    Returns:
      int/str: Result
    """
    pass

在文档字符串中表达多个类型的参数或返回值的正确方法是什么？

有没有办法评论函数的参数,使它们被pydoc库识别？

即pydoc的文档字符串是什么？