python - 什么是“好的python代码”，这如何满足准则？

Question

Closed. This question is opinion-based。它当前不接受答案。
                            
                        
                    
                
                            
                                
                
                        
                            
                        
                    
                        
                            想改善这个问题吗？更新问题，以便 editing this post用事实和引用来回答。
                        
                        12个月前关闭。
                                                                                            
                
        
刚开始时，我一直在听说编写好的代码和编写不好的代码。毕竟，如果它运行并完成了0个问题的工作，那还不够吗？您可以以此为例吗？我用我所知道的知识和必须学习的知识工作，因此我确信可以将其拆开。除了PEP8和东西之外，什么是好代码？

import random
    def cownbull():
"""This one generates a non repeating random number"""
        def cownbull2():
    """This one is running the game due to local variable problems; keyboard 
                                                          almost thrown"""
            print(num2guess, 'is the generated number')
            print("Let's play a game of Cowbull!")  # explanation
            print("I will generate a number, and you have to guess the 
            numbers one digit at a time.")
            print("For every number in the wrong place, you get a cow. For 
            every one in the right place, you get a bull.")
            print("The game ends when you get 4 bulls!")
            print("There are no repeated digits")
            guesses = 0
            cow = 0
            bull = 0
            while True:
                print("cows:", cow,'|','bulls:',bull,'|','guesses:',guesses)
                cow = 0
                bull = 0
                user = input('Guess a four digit number: ')
                if len(user) >4:
                    print('type four digits!')
                    cownbull()
                guesses = guesses + 1

                for x in user:
                    for y in str(num2guess):
                        if x == y:
                            if user.index(x, 0, 4) ==
                                            str(num2guess).index(y, 0, 4):
                            bull += 1
                                if bull == 4:
                                    print('Nice game!')
                                    cownbull()
                            else:
                                cow += 1
                        else:
                            pass
        num2guess = random.randint(1000, 9999)
        count = 0
        while count < 4:
            for i in str(num2guess):
                count = count + 1
                print(i)
                str2guess = str(num2guess)
                print(str2guess.count(i))
            if str2guess.count(i) != 1:
                print('calculating new number....')
                cownbull()
            else:
                cownbull2()


cownbull()

最佳答案

毕竟，如果它运行并完成了0个问题的工作，那不是
  足够？


好家伙

不，甚至没有。这让我和几乎所有其他软件开发人员都感到困扰。
让我们来看一个经常发生的情况。

您编写了一个程序，它“有效”。但是，您的代码很糟糕。然后其他人必须努力。你猜怎么了？我开始研究一堆复制粘贴的垃圾，非Python代码，然后全部重做，假设我什至可以解开有人设法将0条评论和逻辑思路集中在一起的科学怪人逻辑。这不是针对您的代码的，而是针对其在“狂野”中发生的程度。

它是难以管理的，尤其是当需要添加它时，如果您在6个月后使用您刚刚编写的代码打开编辑器，您甚至会知道它的作用吗？然后，以这种方式进行编码的人们期望其他开发人员能够使用其“功能”代码。还不够好。



有些代码库是人们多年不使用的代码库，后来又变成了遗留的代码库，这些代码库是怪异的（看着您COBOL），只有少数人知道任何事情，而下一个开发人员或团队无法管理在合理的程度上。

这是一个非常简单的情况。您可能有100行。当成千上万这样阅读时会发生什么？当您有一个完整的开发人员团队，每个团队都在推动代码，执行不同的分支，合并等操作时，会发生什么情况。软件开发非常复杂，并且存在各种实践来最大程度地减少错误，开发人员之间的流畅度并限制复杂性/错误代码。



干净的代码是很少有人掌握的一种艺术形式。

Zen of Python

Clean Code-如果成本问题，您可能会在其他地方或在您的图书馆（或取决于地区的等效记录）中找到此文件。我强烈建议您阅读某种形式的有关干净编码的书。这将大开眼界。


  除了PEP8和东西之外，什么是好代码？


在一个句子中，我应该能够打开编辑器，将您的代码读为一堆简单的逻辑-多亏了Python，这与英语句子几乎完全相同-自上而下地不停顿，“是的，这就是我的期望”

您会引起人们对某些设计模式的争论，例如测试驱动的开发或行为驱动的，而这些都有很多优点和用例。但是，这纯粹是集中在代码读取方式的语义上。编写代码本身的技巧。



我会立即重构您自己的代码中的内容，并考虑“代码气味”


注释：“”“由于局部变量问题，该游戏正在运行；键盘几乎抛出了”“”。


尽管这样的评论很可爱，但它们并没有帮助。您只想在需要代码的地方输入简短的简短注释，以便输入代码库的人和您自己。


嵌套函数如下：有时使用闭包。这不是其中的一个。
冗余定义和逻辑：仅在需要时在需要时使用它。
常规重组和压缩代码。您的新产品，现在还不是真的，但是它们会随着时间而来。因此，我不会太挑剔了。
Docstrings：在实际的代码库中，doc字符串用于命名功能，如名称所示。参数，返回值，期望值等。甚至可以使用库来从中生成完整的文档页面，例如sphinx
向后兼容性：适用于需要旧有支持的大型代码库。如果您访问几乎所有公共存储库，都会发现一个compat.py，可以在版本之间进行导入。




面向对象的语言：

通常，我们可以说一些有关面向对象语言的干净代码的事情。

顾名思义，面向对象的语言以“对象”的定义为中心。在python中，这些将是您的类。

在python 2中（也可以在python 3中使用“旧样式”）：

class ClassName(object):
    ....

在python 3：

class ClassName:
    ....

多态与继承

在这里，您的类用于封装对象及其方法/属性。此外，面向对象的语言固有地提供了多态性。

多态性允许您提供以多种形式起作用的接口。该名称本身从希腊词根“ poly”（意为许多）和“ morphism”（意为形态）的含义暗示了这一点。

假设我建立了一个类来描述动物及其属性。我可以为every.single.type.of.animal建立一个新的类。或者，提供常用方法和属性，并在必要时覆盖它们。这是 practical example of the animal kingdom

在适当的时候，多态是一种编写清晰代码的绝妙方法。同样，对于继承。



建筑模块

面向对象语言的强大功能之一是能够将事物分解为“构建块”，以便说出来并将它们混合在一起以提供混合功能。

但是，当您编写大量这些代码并将它们捆绑在一起以生成更高功能的对象，然后需要进行更改或要在其他地方使用它时，会发生什么？

您是否必须经过或带走整个面向对象的动物园？我认为这不是很干净，并且对开发人员感到沮丧。谨慎使用此编程方法。

就我个人而言，我喜欢它，因为我非常喜欢Django Web框架，并且喜欢使用mixins以及这里和那里的一些技巧的灵活性。因此，我个人倾向于这种类型的编程。



用Python编写干净代码的总结：

执行上述操作，精通多态性和继承性，遵循Zen，了解如何在不破坏可读性的情况下分解事物并使内容简洁，并正确地编写代码。这是干净代码的90％。其余的正在磨练手艺。

关于python - 什么是“好的python代码”，这如何满足准则？ ，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/53789140/

上一篇：python - Scrapy 获取跨多行和嵌套元素内的文本

下一篇：python - 使用 while 循环的龙格库塔算法

相关文章：

python - 如何告诉 python scrapy 移动到下一个起始 URL

python - XHR 请求 URL 在尝试解析其内容时说不存在

python - 在终端中停止从 Python 启动的程序

python - 我如何要求 Tkinter 与 distutils？

python - Keras 中的多个输出

python pygame 背景图像随屏幕大小变化

python - Elasticsearch - 不需要完全匹配

python - 什么是 DynamicClassAttribute 以及如何使用它？

python - 在 CPanel 中使用 Python 在 Django 管理面板中加载静态文件

python - 使用乘法和减法加密和解密图像

Answer 1

毕竟，如果它运行并完成了0个问题的工作，那不是
  足够？


好家伙

不，甚至没有。这让我和几乎所有其他软件开发人员都感到困扰。
让我们来看一个经常发生的情况。

您编写了一个程序，它“有效”。但是，您的代码很糟糕。然后其他人必须努力。你猜怎么了？我开始研究一堆复制粘贴的垃圾，非Python代码，然后全部重做，假设我什至可以解开有人设法将0条评论和逻辑思路集中在一起的科学怪人逻辑。这不是针对您的代码的，而是针对其在“狂野”中发生的程度。

它是难以管理的，尤其是当需要添加它时，如果您在6个月后使用您刚刚编写的代码打开编辑器，您甚至会知道它的作用吗？然后，以这种方式进行编码的人们期望其他开发人员能够使用其“功能”代码。还不够好。



有些代码库是人们多年不使用的代码库，后来又变成了遗留的代码库，这些代码库是怪异的（看着您COBOL），只有少数人知道任何事情，而下一个开发人员或团队无法管理在合理的程度上。

这是一个非常简单的情况。您可能有100行。当成千上万这样阅读时会发生什么？当您有一个完整的开发人员团队，每个团队都在推动代码，执行不同的分支，合并等操作时，会发生什么情况。软件开发非常复杂，并且存在各种实践来最大程度地减少错误，开发人员之间的流畅度并限制复杂性/错误代码。



干净的代码是很少有人掌握的一种艺术形式。

Zen of Python

Clean Code-如果成本问题，您可能会在其他地方或在您的图书馆（或取决于地区的等效记录）中找到此文件。我强烈建议您阅读某种形式的有关干净编码的书。这将大开眼界。


  除了PEP8和东西之外，什么是好代码？


在一个句子中，我应该能够打开编辑器，将您的代码读为一堆简单的逻辑-多亏了Python，这与英语句子几乎完全相同-自上而下地不停顿，“是的，这就是我的期望”

您会引起人们对某些设计模式的争论，例如测试驱动的开发或行为驱动的，而这些都有很多优点和用例。但是，这纯粹是集中在代码读取方式的语义上。编写代码本身的技巧。



我会立即重构您自己的代码中的内容，并考虑“代码气味”


注释：“”“由于局部变量问题，该游戏正在运行；键盘几乎抛出了”“”。


尽管这样的评论很可爱，但它们并没有帮助。您只想在需要代码的地方输入简短的简短注释，以便输入代码库的人和您自己。


嵌套函数如下：有时使用闭包。这不是其中的一个。
冗余定义和逻辑：仅在需要时在需要时使用它。
常规重组和压缩代码。您的新产品，现在还不是真的，但是它们会随着时间而来。因此，我不会太挑剔了。
Docstrings：在实际的代码库中，doc字符串用于命名功能，如名称所示。参数，返回值，期望值等。甚至可以使用库来从中生成完整的文档页面，例如sphinx
向后兼容性：适用于需要旧有支持的大型代码库。如果您访问几乎所有公共存储库，都会发现一个compat.py，可以在版本之间进行导入。




面向对象的语言：

通常，我们可以说一些有关面向对象语言的干净代码的事情。

顾名思义，面向对象的语言以“对象”的定义为中心。在python中，这些将是您的类。

在python 2中（也可以在python 3中使用“旧样式”）：

class ClassName(object):
    ....

在python 3：

class ClassName:
    ....

多态与继承

在这里，您的类用于封装对象及其方法/属性。此外，面向对象的语言固有地提供了多态性。

多态性允许您提供以多种形式起作用的接口。该名称本身从希腊词根“ poly”（意为许多）和“ morphism”（意为形态）的含义暗示了这一点。

假设我建立了一个类来描述动物及其属性。我可以为every.single.type.of.animal建立一个新的类。或者，提供常用方法和属性，并在必要时覆盖它们。这是 practical example of the animal kingdom

在适当的时候，多态是一种编写清晰代码的绝妙方法。同样，对于继承。



建筑模块

面向对象语言的强大功能之一是能够将事物分解为“构建块”，以便说出来并将它们混合在一起以提供混合功能。

但是，当您编写大量这些代码并将它们捆绑在一起以生成更高功能的对象，然后需要进行更改或要在其他地方使用它时，会发生什么？

您是否必须经过或带走整个面向对象的动物园？我认为这不是很干净，并且对开发人员感到沮丧。谨慎使用此编程方法。

就我个人而言，我喜欢它，因为我非常喜欢Django Web框架，并且喜欢使用mixins以及这里和那里的一些技巧的灵活性。因此，我个人倾向于这种类型的编程。



用Python编写干净代码的总结：

执行上述操作，精通多态性和继承性，遵循Zen，了解如何在不破坏可读性的情况下分解事物并使内容简洁，并正确地编写代码。这是干净代码的90％。其余的正在磨练手艺。