大名鼎鼎的Requests库用了什么编码风格?

简介: Requests 的代码库使用 PEP-8 编码风格。除了 PEP-8 中列出的标准外,我们还有一些指导原则:• 如果方便的话,行长(Line-length)可超过 79 个字符,达到 100 个字符。• 如果换行会导致严重的不方便,则行长可以超过 100 个字符。• 除非在字符串中出现单引号,否则始终使用单引号字符串(例如,'#flatearth')。

Requests 的代码库使用 PEP-8 编码风格。

除了 PEP-8 中列出的标准外,我们还有一些指导原则:

  • 如果方便的话,行长(Line-length)可超过 79 个字符,达到 100 个字符。
  • 如果换行会导致严重的不方便,则行长可以超过 100 个字符。
  • 除非在字符串中出现单引号,否则始终使用单引号字符串(例如,'#flatearth')。

此外,PEP-8 推荐的用于连续行的编码风格毫无一点品味,绝不允许在 Requests 代码库使用:

# 与开局定界符对齐
foo = long_function_name(var_one, var_two,
                         var_three, var_four)
复制代码

No。千万别。请。

文档字符串(docstrings)应遵循以下语法:

def the_earth_is_flat():
    """NASA divided up the seas into thirty-three degrees."""
    pass
def fibonacci_spiral_tool():
    """With my feet upon the ground I lose myself / between the sounds
    and open wide to suck it in. / I feel it move across my skin. / I'm
    reaching up and reaching out. / I'm reaching for the random or
    whatever will bewilder me. / Whatever will bewilder me. / And
    following our will and wind we may just go where no one's been. /
    We'll ride the spiral to the end and may just go where no one's
    been.
    Spiral out. Keep going...
    """
    pass
复制代码

所有函数、方法和类都要求包含 docstrings 。除了对象数据模型方法(例如,__repr__),这些是此规则的例外。

Thanks for helping to make the world a better place!

资料来源(译注:即 Requests 的开发者指南):t.cn/E5VgNJF

(译文完)

K 神的这篇文章很短,实际上,这只是摘自 Requests 的开发者指南的一小部分。

但是,关于灵活设定行长的部分,我举双手双脚赞同。如果你所在的公司有“清白盒”的优良传统(不仅指Python),那你极有可能遇到被迫换行的麻烦,而实际上才仅仅刚刚超出了几个字符。那时候,你就会明白,这 3 条灵活规则的好处了。

另外,关于连续行的部分,PEP-8 相关内容在:t.cn/Rq4mxOo

PEP-8 反对的是如下写法:

# Arguments on first line forbidden when not using vertical alignment.
# 不使用垂直对齐的参数禁止在第一行上
foo = long_function_name(var_one, var_two,
    var_three, var_four)
复制代码

PEP-8 推荐的写法是垂直地将换行的参数对齐起始的参数:

# 与开局定界符对齐
foo = long_function_name(var_one, var_two,
                         var_three, var_four)
复制代码

K 神反对了 PEP-8 推荐的写法。在我看来,任何有品味的人,都会反对以上的两种写法。

即使一个方法的参数超级多,超出了 100 个字符,我本人也是极不情愿换行的。所以,K 神的说法深得我心。

关于代码风格,没有绝对完全一致的标准。本文也不想引起争论。不过,我认同 K 神设定的规则,因为一种与主流不同的审美倾向,值得发现它的同类。



目录
相关文章
|
Web App开发 数据采集 JSON
Python实现urllib3和requests库使用 | python爬虫实战之五
本节介绍了urllib3库和requests库中的一些方法的使用。
Python实现urllib3和requests库使用 | python爬虫实战之五
|
4月前
|
API 开发者 Python
揭秘Python网络请求的幕后英雄:requests与urllib的恩怨情仇
【9月更文挑战第10天】在Python的网络请求领域,urllib与requests犹如武林中的两大高手,各自展现了独特的魅力。urllib作为标准库成员,自Python诞生以来便承担着网络请求的任务,以其稳定性和全面性著称。然而,其复杂的API让不少开发者望而却步。
31 2
|
6月前
|
数据采集 JSON API
Python网络请求高手养成记:requests、urllib库助你驰骋网络海洋
【7月更文挑战第31天】在 Python 的世界里, requests 和 urllib 是处理网络请求的核心库。requests 以简洁的 API 赢得了开发者的心, 让 GET/POST 请求变得简单。urllib 作为标准库一部分, 提供更底层的功能, 但使用较为繁琐。实战中, 发送 GET 请求时, requests 几行代码即可完成, 而 urllib 需要更多代码和手动异常处理。对于 POST 请求, requests 同样简洁, 直接传递数据; urllib 则需手动编码数据和设置方法。
52 1
|
8月前
|
JSON API 数据格式
Python测试架构requests-mock
【4月更文挑战第19天】
116 1
|
8月前
|
UED 开发者 Python
Python中使用`requests`库进行重定向与超时控制的技术详解
【4月更文挑战第12天】在Web开发中,处理HTTP重定向和请求超时是常见的需求。`requests`库作为Python中处理HTTP请求的利器,提供了丰富的功能来满足这些需求。本文将详细探讨如何在Python中使用`requests`库进行重定向处理和超时控制。
|
8月前
PythonWeb开发基础(四 & 完)Response使用及wsgify装饰器
🌾 Response使用及wsgify装饰器 1、Response的使用 前面一节我们知道了,使用webob的Request模块可以很方便地对请求进行解析。而接下来要介绍的Response模块,就可以方便地对响应进行封装:
50 0
|
JSON 数据格式 Python
Python网络请求中级篇:深入理解Requests库的使用
在Python网络请求初级篇中,我们了解了Requests库基础的使用方式,包括如何发起GET和POST请求,如何解析JSON响应以及如何处理异常。在本文中,我们将深入理解Requests库,包括如何发送带参数的请求,如何处理Cookies,如何使用Session对象以及如何设置请求头。
|
JSON 网络安全 数据格式
网络请求轻松搞定:玩转Python中requests函数的实用技巧
网络请求轻松搞定:玩转Python中requests函数的实用技巧
132 0
|
XML 人工智能 JavaScript
基于Python Requests的数据驱动的HTTP接口测试(二)
基于Python Requests的数据驱动的HTTP接口测试(二)
156 0
基于Python Requests的数据驱动的HTTP接口测试(二)
|
测试技术 BI Python
基于Python Requests的数据驱动的HTTP接口测试(一)
基于Python Requests的数据驱动的HTTP接口测试(一)
165 0
基于Python Requests的数据驱动的HTTP接口测试(一)