自动将文档重新格式化以尊重右边距

问题描述：

通常，我编辑文档字符串并找到我的编辑将线条的宽度推过所需的右边距。因此，在我的文档字符串再次被接受之前，可能需要重新格式化此编辑下面的许多行文本。
什么是自动解决这个问题的简单而安全的方法？自动将文档重新格式化以尊重右边距

例如：

class WellDocumentedClass: 
    """The first line of this is <72 characters wide. And is above lots| 
    more text. Lorem ipsum dolor sit amet, consectetur adipiscing elit.| 
    et mauris ac eros placerat auctor. Mauris mollis est scelerisse | 
    accumsan dapibus. Ut imperdiet suscipit lacinia. Maecenas volutpat | 
    iaculis malesuada. Sed venenatis ipsum gravida molestolaoreet. Fuse| 
    facilisis neque nec mauris maximus rutrum. Suspendisse at vestibulo| 
    orci, ut feugiat odio. Aliquam erat volutpat. Nulla accumsan justo | 
    ligula, at imperdiet quam ultrices non. Cras vitae vehicula ligula.| 
    Quisque quam massa, dignissim in volutpat in, mattis eu urna.  | 
    """ 
    pass

哦，不！我意外地从第一行中省略了“docstring”这个词。它的格式非常完美！

class WellDocumentedClass: 
    """The first line of this docstring is <72 characters wide. And is |above lots 
    more text. Lorem ipsum dolor sit amet, consectetur adipiscing elit.| 
    et mauris ac eros placerat auctor. Mauris mollis est scelerisse | 
    accumsan dapibus. Ut imperdiet suscipit lacinia. Maecenas volutpat | 
    iaculis malesuada. Sed venenatis ipsum gravida molestolaoreet. Fuse| 
    facilisis neque nec mauris maximus rutrum. Suspendisse at vestibulo| 
    orci, ut feugiat odio. Aliquam erat volutpat. Nulla accumsan justo | 
    ligula, at imperdiet quam ultrices non. Cras vitae vehicula ligula.| 
    Quisque quam massa, dignissim in volutpat in, mattis eu urna.  | 
    """ 
    pass

Argh。时间使用我的鼠标和按下输入很多...除非...你在这样的时刻做什么？

答

您可以通过创建一个（相对）简单的插件，在崇高的文本3实现这一点：

工具菜单 - >开发 - >新建插件...
选择所有与以下

import sublime 
import sublime_plugin 
import textwrap 


class WrapTextCommand(sublime_plugin.TextCommand): 
    def run(self, edit, width=0): 
     # use the narrowest ruler from the view if no width specified, or default to 72 if no rulers are enabled 
     width = width or next(iter(self.view.settings().get('rulers', [])), 72) 
     new_sel = list() 
     # loop through the selections in reverse order so that the selection positions don't move when the selected text changes size 
     for sel in reversed(self.view.sel()): 
      # make sure the leading indentation is selected, for `dedent` to work properly 
      sel = sel.cover(self.view.line(sel.begin())) 
      # determine how much indentation is at the first selected line 
      indentation_amount = self.view.indentation_level(sel.begin()) * self.view.settings().get('tab_size', 4) 
      # create a wrapper that will keep that indentation 
      wrapper = textwrap.TextWrapper(drop_whitespace=True, width=width, initial_indent=' ' * indentation_amount, subsequent_indent=' ' * indentation_amount) 
      # unindent the selected text before then reformatting the text to fill the available (column) space 
      text = wrapper.fill(textwrap.dedent(self.view.substr(sel))) 
      # replace the selected text with the rewrapped text 
      self.view.replace(edit, sel, text) 
      # resize the selection to match the new wrapped text size 
      new_sel.append(sublime.Region(sel.begin(), sel.begin() + len(text))) 
     self.view.sel().clear() 
     self.view.sel().add_all(new_sel)

保存它，该文件夹中ST建议（Packages/User/），就像这样wraptext.py
创建键绑定来调用新的换行功能：

{ "keys": ["alt+."], "command": "wrap_text" },

享受

答

在pycharm，标记文档字符串，然后单击Edit -> Fill Paragraph

自动将文档重新格式化以尊重右边距

相关推荐