代码规范_autopep8代码格式化工具

一、什么是Autopep8

---

Autopep8是一个将python代码自动编排的一个工具，它使用pep8工具来决定代码中的那部分需要被排版，Autopep8可以修复大部分pep8工具中报告的排版问题。

很多人都知道  Ctrl+Alt+L 也可以排版， 但是我要告诉你，快捷键只是可以简单的排版。

跟Autopep8是无法相比的。 

安装Autopep8:

pip install autopep8

二、Autopep8的使用

安装完成之后，打开pycharm，创建一个新的python文件，  demo.py 将一下代码放入文件中。

def example1():
    some_tuple = (1, 2, 3, 'a')
    some_variable = {
        'long': 'Long code lines should be wrapped within 79 characters.',
        'other': [math.pi, 100, 200, 300, 9876543210,'This is a long string that goes on'],
        'more': { 'inner': 'This whole logical line should be wrapped.',some_tuple: [ 1,20, 300, 40000,500000000,60000000000000000]}}
    return (some_tuple, some_variable)

def example2(): return ('' in {'f': 2}) in {'has_key() is deprecated': True};

class Example3(object):
    def __init__(self, bar):
        # Comments should have a space after the hash.
        if bar:
            bar += 1
            bar = bar * bar
        else:
            some_string = """
                       Indentation in multiline strings should not be touched.Only actual code should be reindented.
"""

这几行代码看上去是不是很乱，   接下来就要使用：Autopep8模块了

打开cmd找到demo.py的文件的上级目录，

然后输入以下命令：

autopep8 --in-place --aggressive --aggressive file.py

file.py   是你的demo.py

输入命令，按回车执行成功是不返回的， 执行完成之后就可以了，在次打开文件就可以看到变化了。

import math


def example1():
    some_tuple = (1, 2, 3, 'a')
    some_variable = {
        'long': 'Long code lines should be wrapped within 79 characters.',
        'other': [
            math.pi,
            100,
            200,
            300,
            9876543210,
            'This is a long string that goes on'],
        'more': {
            'inner': 'This whole logical line should be wrapped.',
            some_tuple: [
                1,
                20,
                300,
                40000,
                500000000,
                60000000000000000]}}
    return some_tuple, some_variable


def example2(): return ('' in {'f': 2}) in {'has_key() is deprecated': True}


class Example3(object):
    def __init__(self, bar):
        # Comments should have a space after the hash.
        if bar:
            bar += 1
            bar = bar * bar
        else:
            some_string = """
                       Indentation in multiline strings should not be touched.Only actual code should be reindented.
"""

三、在Pycharm中配置使用

执行完Autopep8之后代码是不是看上去简洁多了。

有人会说，没写一个函数就执行一遍命令， 是不是有点麻烦啊， 是的， 有有点麻烦， 但是pycharm是可以配置的， 配置过程如下：

1： File --->  Settings  --->  Tools  --->   External Tools

打开之后，可以看见窗体左上角有一个 + 号， 点击+号添加。

Name: 名称可以随意

Program: autopep8        # 前提必须先安装
Arguments: --in-place --aggressive --aggressive $FilePath$
Working directory: $ProjectFileDir$

Advanced Options

Outputfilters:

$FILE_PATH$:$LINE$:$COLUMN$:.*

以上配置完成之后点击  OK 保存即可。

快捷使用：

Tools    --->    External Tools  --->   Autopep8       鼠标点击一下即可。