Python代码整洁之道（⼀）
很多新⼿在开始学⼀门新的语⾔的时候，往往会忽视⼀些不应该忽视的细节，⽐如变量命名和函数命名以及注释等⼀些内容的规范性，久⽽久之养成了⼀种习惯。对此呢，我特意收集了⼀些适合所有学习 Python 的⼈，代码整洁之道。
写出 Pythonic 代码
谈到规范⾸先想到就是 Python 有名的 PEP8 代码规范⽂档，它定义了编写Pythonic代码的最佳实践。可以在上查看。但是真正去仔细研究学习这些规范的朋友并不是很多，对此呢这篇⽂章摘选⼀些⽐较常⽤的代码整洁和规范的技巧和⽅法，下⾯让我们⼀起来学习吧！
命名linux中的openssl是什么
所有的编程语⾔都有变量、函数、类等的命名约定，以美之称的 Python 当然更建议使⽤命名约定。接下来就针对类、函数、⽅法等等内容进⾏学习。
变量和函数
使⽤⼩写字母命名函数和变量，并⽤下划线分隔单词，提⾼代码可读性。
变量的声明
names = "Python" #变量名
namejob_title = "Software Engineer" #带有下划线的变量名
populated_countries_list = [] #带有下划线的变量名
还应该考虑在代码中使⽤⾮ Python 内置⽅法名，如果使⽤ Python 中内置⽅法名请使⽤⼀个或两个下划线()。
_books = {}# 变量名私有化
__dict = []# 防⽌python内置库中的名称混淆
那如何选择是⽤_还是__呢？
如果不希望外部类访问该变量，应该使⽤⼀个下划线（_）作为类的内部变量的前缀。如果要定义的私有变量名称是 Python 中的关键字如dict 就要使⽤(__)。
函数的声明
def get_data():
pass
def calculate_tax_data():
pass
函数的声明和变量⼀样也是通过⼩写字母和单下划线进⾏连接。
当然对于函数私有化也是和声明变量类似。
def _get_data():
pass
函数的开头使⽤单下划线，将其进⾏私有化。对于使⽤ Pyton 中的关键字来进⾏命名的函数
要使⽤双下划线。
def __path():
pass
除了遵循这些命名规则之外，使⽤清晰易懂的变量名和很重要。
函数名规范
# Wrong Way
def get_user_info(id):
db = get_db_connection()
user = execute_query_for_user(id)
return user
# Right way
def get_user_by(user_id):
db = get_db_connection()
user = execute_user_query(user_id)
return user
这⾥，第⼆个函数 get_user_by 确保使⽤相同的参数来传递变量，从⽽为函数提供正确的上下⽂。第⼀个函数 get_user_info 就不怎么不明确了，因为参数 id 意味着什么这⾥我们不能确定，它是⽤户 ID，还是⽤户付款ID或任何其他 ID？这种代码可能会对使⽤你的API的其他开发⼈员造成混淆。为了解决这个问题，我在第⼆个函数中更改了两个东西; 我更改了函数名称以及传递的参数名称，这使代码可读性更⾼。
作为开发⼈员，你有责任在命名变量和函数时仔细考虑，要写让⼈能够清晰易懂的代码。
当然也⽅便⾃⼰以后去维护。
类的命名规范
类的名称应该像⼤多数其他语⾔⼀样使⽤驼峰⼤⼩写。
class UserInformation:
def get_user(id):
db = get_db_connection()
user = execute_query_for_user(id)
return user
常量的命名规范
通常应该⽤⼤写字母定义常量名称。
TOTAL = 56
TIMOUT = 6
MAX_OVERFLOW = 7
函数和⽅法的参数
函数和⽅法的参数命名应遵循与变量和⽅法名称相同的规则。因为类⽅法将self作为第⼀个关键字参数。所以在函数中就不要使⽤ self 作为关键字作为参数，以免造成混淆 .
def calculate_tax(amount, yearly_tax):
passs
class Player:
def get_total_score(self, player_name):
pass
关于命名⼤概就强调这些，下⾯让我们看看表达式和语句中需要的问题。
代码中的表达式和语句
users = [
{"first_name":"Helen", "age":39},
{"first_name":"Buck", "age":10},
{"first_name":"anni", "age":9}
]
users = sorted(users, key=lambda user: user["first_name"].lower())
prototype是什么牌子这段代码有什么问题?
乍⼀看并不容易理解这段代码，尤其是对于新开发⼈员来说，因为 lambdas 的语法很古怪，所以不容易理解。虽然这⾥使⽤ lambda 可以节省⾏，然⽽，这并不能保证代码的正确性和可读性。同时这段代码⽆法解决字典缺少键出现异常的问题。
让我们使⽤函数重写此代码，使代码更具可读性和正确性; 该函数将判断异常情况，编写起来要简单得多。
users = [
{"first_name":"Helen", "age":39},
{"first_name":"Buck", "age":10},
{"name":"anni", "age":9}
]
def get_user_name(users):
"""Get name of the user in lower case"""
return users["first_name"].lower()
def get_sorted_dictionary(users):
"""Sort the nested dictionary"""
if not isinstance(users, dict):csocket类
raise ValueError("Not a correct dictionary")
if not len(users):
raise ValueError("Empty dictionary")
users_by_name = sorted(users, key=get_user_name)
return users_by_name
如您所见，此代码检查了所有可能的意外值，并且⽐起以前的单⾏代码更具可读性。单⾏代码虽然看起来很酷节省了⾏，但是会给代码添加很多复杂性。但是这并不意味着单⾏代码就不好这⾥提出的⼀点是，如果你的单⾏代码使代码变得更难阅读，那么就请避免使⽤它，记住写代码不是为了炫酷的，尤其在项⽬组中。
让我们再考虑⼀个例⼦，你试图读取 CSV ⽂件并计算 CSV ⽂件处理的⾏数。下⾯的代码展⽰使代码可读的重要性，以及命名如何在使代码可读中发挥重要作⽤。
import csv
with open("employee.csv", mode="r") as csv_file:
csv_reader = csv.DictReader(csv_file)
line_count = 0
for row in csv_reader:
if line_count == 0:
print(f'Column names are {", ".join(row)}')
line_count += 1
print(f'\t{row["name"]} salary: {row["salary"]}'
f'and was born in {row["birthday month"]}.')
line_count += 1
print(f'Processed {line_count} lines.')
将代码分解为函数有助于使复杂的代码变的易于阅读和调试。
这⾥的代码在 with 语句中执⾏多项操作。为了提⾼可读性，您可以将带有 process salary 的代码从 CSV ⽂件中提取到另⼀个函数中，以降低出错的可能性。
import csv
with open("employee.csv", mode="r") as csv_file:
csv_reader = csv.DictReader(csv_file)
line_count = 0
process_salary(csv_reader)
def process_salary(csv_reader):
"""Process salary of user from csv file."""
for row in csv_reader:
if line_count == 0:
print(f'Column names are {", ".join(row)}')
line_count += 1
print(f'\t{row["name"]} salary: {row["salary"]}'
f'and was born in {row["birthday month"]}.')
line_count += 1
print(f'Processed {line_count} lines.')
代码是不是变得容易理解了不少呢。
在这⾥，创建了⼀个帮助函数，⽽不是在with语句中编写所有内容。这使读者清楚地了解了函数的实际作⽤。如果想处理⼀个特定的异常或者想从CSV⽂件中读取更多的数据，可以进⼀步分解这个函数，以遵循单⼀职责原则，⼀个函数⼀做⼀件事。这个很重要
return语句的类型尽量⼀致
如果希望函数返回⼀个值，请确保该函数的所有执⾏路径都返回该值。但是，如果期望函数只是在不返回值的情况下执⾏操作，则 Python 会隐式返回 None 作为函数的默认值。
先看⼀个错误⽰范
def calculate_interest(principle, time rate):
if principle > 0:
return (principle * time * rate) / 100
def calculate_interest(principle, time rate):
if principle < 0:
return
return (principle * time * rate) / 100ChaPTER 1 PyThonIC ThInkIng
正确的⽰范应该是下⾯这样
def calculate_interest(principle, time rate):
if principle > 0:
return (principle * time * rate) / 100
else:
return None
def calculate_interest(principle, time rate):
if principle < 0:
return None
return (principle * time * rate) / 100ChaPTER 1 PyThonIC ThInkIng
还是那句话写易读的代码，代码多写点没关系，可读性很重要。
使⽤ isinstance() ⽅法⽽不是 type() 进⾏⽐较
当⽐较两个对象类型时，请考虑使⽤ isinstance() ⽽不是 type，因为 isinstance() 判断⼀个对象是否为另⼀个对象的⼦类是 true。考虑这样⼀个场景：如果传递的数据结构是dict 的⼦类，⽐如 orderdict。type() 对于特定类型的数据结构将失败；然⽽，isinstance() 可以将其识别出它是 dict 的⼦类。
错误⽰范
user_ages = {"Larry": 35, "Jon": 89, "Imli": 12}
type(user_ages) == dict:
正确选择
Do this:user_ages = {"Larry": 35, "Jon": 89, "Imli": 12}
if isinstance(user_ages, dict):
⽐较布尔值
在Python中有多种⽅法可以⽐较布尔值。
错误⽰范
if is_empty = False
if is_empty == False:
if is_empty is False:
正确⽰范
is_empty = False
if is_empty
简历模板word下载使⽤⽂档字符串
Docstrings可以在 Python 中声明代码的功能的。通常在⽅法，类和模块的开头使⽤。 docstring是该对象的__doc__特殊属性。
Python 官⽅语⾔建议使⽤“”三重双引号“”来编写⽂档字符串。你可以在 PEP8 官⽅⽂档中到这些实践。下⾯让我们简要介绍⼀下在Python 代码中编写 docstrings 的⼀些最佳实践。
⽅法中使⽤docstring
def get_prime_number():
"""Get list of prime numbers between 1 to 100.""""
关于docstring的格式的写法，⽬前存在多种风格，但是这⼏种风格都有⼀些统⼀的标准。
即使字符串符合⼀⾏，也会使⽤三重引号。当你想要扩展时，这种注释⾮常有⽤。‘
三重引号中的字符串前后不应有任何空⾏
使⽤句点（.）结束docstring中的语句
类似地，可以应⽤ Python 多⾏ docstring 规则来编写多⾏ docstring。在多⾏上编写⽂档字符串是⽤更
具描述性的⽅式记录代码的⼀种⽅法。你可以利⽤ Python 多⾏⽂档字符串在 Python 代码中编写描述性⽂档字符串，⽽不是在每⼀⾏上编写注释。
多⾏的docstring
def call_weather_api(url, location):
"""Get the weather of specific location.
Calling weather api to check for weather by using weather api and
location. Make sure you provide city name only, country and county
names won't be accepted and will throw exception if not found the
city name.
:param url:URL of the api to get weather.
:type url: str
:param location:Location of the city to get the weather.
:type location: str
:return: Give the weather information of given location.
:rtype: str"""
说⼀下上⾯代码的注意点
第⼀⾏是函数或类的简要描述
每⼀⾏语句的末尾有⼀个句号
⽂档字符串中的简要描述和摘要之间有⼀⾏空⽩
如果使⽤ Python3.6 可以使⽤类型注解对上⾯的docstring以及参数的声明进⾏修改。
def call_weather_api(url: str, location: str) -> str:
"""Get the weather of specific location.
Calling weather api to check for weather by using weather api and
location. Make sure you provide city name only, country and county
names won't be accepted and will throw exception if not found the
city name.
"""
怎么样是不是简洁了不少，如果使⽤ Python 代码中的类型注解，则不需要再编写参数信息。
关于类型注解(type hint)的具体⽤法可以参考我之前写的【⽂字连接】.
模块级别的docstring
⼀般在⽂件的顶部放置⼀个模块级的 docstring 来简要描述模块的使⽤。
这些注释应该放在在导包之前，模块⽂档字符串应该表明模块的使⽤⽅法和功能。
如果觉得在使⽤模块之前客户端需要明确地知道⽅法或类，你还可以简要地指定特定⽅法或类。
python基础代码100例"""This module contains all of the network related requests.
This module will check for all the exceptions while making the network
calls and raise exceptions for any unknown exception.
Make sure that when you use this module,
you handle these exceptions in client code as:
NetworkError exception for network calls.
NetworkNotFound exception if network not found.
"""
import urllib3
import json
在为模块编写⽂档字符串时，应考虑执⾏以下操作：
对当前模块写⼀个简要的说明
video splitter中文
如果想指定某些对读者有⽤的模块，如上⾯的代码，还可以添加异常信息，但是注意不要太详细。
NetworkError exception for network calls.
NetworkNotFound exception if network not found.
将模块的docstring看作是提供关于模块的描述性信息的⼀种⽅法，⽽不需要详细讨论每个函数或类具体操作⽅法。类级别的docstring
类docstring主要⽤于简要描述类的使⽤及其总体⽬标。让我们看⼀些⽰例，看看如何编写类⽂档字符串
单⾏类docstring
class Student:
"""This class handle actions performed by a student."""
def __init__(self):
pass
这个类有⼀个⼀⾏的 docstring，它简要地讨论了学⽣类。如前所述，遵守了所以⼀⾏docstring 的编码规范。
多⾏类docstring
class Student:
"""Student class information.
This class handle actions performed by a student.
This class provides information about student full name, age,
roll-number and other information.
Usage:
import student
student = student.Student()
<_name()
>>> 678998
"""
def __init__(self):
pass
这个类 docstring 是多⾏的; 我们写了很多关于 Student 类的⽤法以及如何使⽤它。
函数的docstring
函数⽂档字符串可以写在函数之后，也可以写在函数的顶部。
def is_prime_number(number):
"""Check for prime number.
Check the given number is prime number
or not by checking against all the numbers
less the square root of given number.
:param number:Given number to check for prime
:type number: int
:return: True if number is prime otherwise False.
:rtype: boolean
"""
如果我们使⽤类型注解对其进⼀步优化。
def is_prime_number(number: int)->bool:
"""Check for prime number.
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论