【问题标题】:how to abbreviate dimension following the PEP8 rules?如何按照 PEP8 规则缩写维度?
【发布时间】:2017-11-20 22:50:02
【问题描述】:

我必须添加一个创建 3D 纹理的函数。 我在整个模块中使用蜗牛壳。

我的选择是:

def texture_3d(...):
    pass

def texture_3D(...):
    pass

def texture3D(...):
    pass

函数的名称应该是什么?

我不对意见感兴趣:哪个更好看。我需要参考其他模块来了解最佳实践。

请提及至少 1 个具有类似功能的模块。

【问题讨论】:

    标签: python python-3.x naming-conventions pep8


    【解决方案1】:

    PEP 8 states 小写,单词 之间用下划线分隔函数名。现在,因为如果3d/3D 是一个实际的词,这似乎是固执己见,你会在名称texture_3d 和texture3d 之间遇到冲突(d 是小写的)。

    查看一些 numpy 函数,例如,lagval3d、laggrid3d、hermegrid3d 名称 texture3d 看起来是一个不错的选择。

    在the matplotlib docs 中搜索相似名称会产生<name>3d 和<name>_3d 之间的混合结果。

    简而言之,这两个名称似乎都被接受,基于两个主要包。归结为两者之间的个人选择。

    【讨论】:

    • numpy 和 matplotlib 都是很好的例子。我将调用函数texture3d(...)
    • 听起来 numpy 和 matplotlib 不符合 PEP 8。不是世界末日,但问题确实询问了“遵循 PEP 8”,而不是“符合 numpy 标准”
    【解决方案2】:

    也许我们可以问马,而不是仅仅依靠人类的意见? (如“从马口中得到它”。)换句话说,使用pylint。

    我修改了您的代码,使其生成的消息更少。

    ''' some information here'''
    
    def texture_3d(parameters):
        ''' a docstring'''
        return parameters
    
    def texture_3D(parameters):
        ''' a docstring'''
        return parameters
    
    def texture3D(parameters):
        ''' a docstring'''
        return parameters
    

    pylint 的结果是:

    ************* Module temp
    C:  7, 0: Invalid function name "texture_3D" (invalid-name)
    C: 11, 0: Invalid function name "texture3D" (invalid-name)
    
    ------------------------------------------------------------------
    Your code has been rated at 6.67/10 (previous run: 5.00/10, +1.67)
    

    只留下选项texture_3d。

    【讨论】:

    • pylint 很棒,我的模块已完全 linted,所以 texture_3D 和 texture3D 是你提到的非常糟糕的选择。我选择了texture3d 作为类似于numpy 和matplotlib 中的函数的名称。它也通过了 pylint 测试。
    • 好的,但这不是您的选择之一。
    【解决方案3】:

    来自PEP-8:

    方法名称和实例变量

    使用函数命名规则: 小写,单词用下划线分隔,必要时改进 可读性。

    这向我表明,您的第一个选项是三个选项中最合规的。

    【讨论】:

      【解决方案4】:

      简答:texture_3d。

      PEP-8 说 about function names:

      函数名应该是小写,单词之间用 为提高可读性所必需的下划线。

      mixedCase 仅在已经是 流行风格(例如threading.py),向后保留 兼容性。

      由于“纹理”和“3d”是两个独立的词,因此最好在它们之间添加下划线。此外,函数名应该是小写的,所以3D 是不允许的。

      【讨论】:

        猜你喜欢
        • 2012-10-31
        • 2016-05-02
        • 2021-05-25
        • 2015-07-30
        • 1970-01-01
        • 1970-01-01
        • 2020-04-24
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多