【问题标题】:How to include overlength URLs in python comments如何在 python 注释中包含超长 URL
【发布时间】:2012-10-15 07:00:07
【问题描述】:

在创建 python 代码并保持PEP8 style guide 时,在注释中引用长 URL 时将行长度限制为 79 个字符可能会遇到麻烦:

def foo():
    # see http://stackoverflow.com/questions/13062540/replacing-text-using-regular-expression-in-python-with-named-parameters
    do_something()

在实际代码中,当 URL 注释与代码左侧的空白缩进区域重叠时,这看起来很难看。有没有办法以更好的方式处理这个问题,而我仍然能够轻松地复制和粘贴 URL 以将其放入网络浏览器?

【问题讨论】:

  • 我认为 url 缩短器是解决这种情况的好方法。您甚至可以为您的编辑器找到自动缩短器(例如,有许多适用于 emacs 的现成解决方案)。
  • 在 StackOverflow 链接的情况下,如果您单击问题下方的“共享”,SO 将生成一个简短的永久链接 url。由于 URL 的描述性较差,我发现在链接周围的评论中添加更多关于链接用途的解释很有用。否则(对于非 SO 链接),我认为最好的选择是暂停 PEP8 并简单地粘贴长 URL。您可以使用 URL 缩短器,但 1) 删除了有用的信息,2) 引入了额外的、不必要的单点故障(也就是说 bit.ly 或任何其他缩短器将在 20 年内出现?)

标签: python url comments


【解决方案1】:

在许多可能的方法中,在关闭引号后在行尾使用 \

url = "http://stackoverflow" \
      ".com"

response = urllib2.urlopen(url)
print response.read()

如果您将诸如 url 之类的字段拆分为多行并希望以更简单的方式将其复制回来,请使用多行字符串,即在开始和结束时用 3 个双引号将整个 url 括起来。然后它们可以跨越任意数量的行。

编辑:我写了多行 cmets,它在 cmets 中提出并已修复

【讨论】:

  • 当然,当我想在代码中使用 URL 时。但是当我有一个很长的 URL 作为评论,并且我希望能够非常轻松地复制和粘贴(而不将 URL 部分放在一起),那么你的方法将行不通。请参阅我更新的问题。
  • 之前不清楚。我想你可以在这种情况下简单地使用多行 cmets,即“””这是一个多行注释,它会产生许多这样的行“”“”
  • 这不是多行comment,而是多行string。大不同!
  • 呃,是的,我猜他提到在 cmets 的上下文中使用它,所以我在 flow 中写了这个术语。将编辑。但它确实起到了作用。
猜你喜欢
  • 1970-01-01
  • 2014-12-11
  • 1970-01-01
  • 2022-10-02
  • 2012-01-24
  • 2013-04-10
  • 2019-10-14
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多