Công cụ để chuyển đổi mã Python để tuân thủ PEP8

Tôi biết có những công cụ xác thực xem mã Python của bạn có tuân thủ PEP8 hay không, ví dụ: có cả dịch vụ trực tuyến và mô-đun python .

Tuy nhiên, tôi không thể tìm thấy một dịch vụ hoặc mô-đun có thể chuyển đổi tệp Python của tôi thành tệp Python hợp lệ PEP8 độc lập. Có ai biết nếu có bất kỳ?
Tôi cho rằng nó khả thi vì PEP8 là tất cả về sự xuất hiện của mã, phải không?

Thật không may "pep8 gây bão" (toàn bộ dự án) có một số tác dụng phụ tiêu cực:

• rất nhiều xung đột hợp nhất
• đổ lỗi cho git
• làm cho việc xem xét mã khó khăn

Như một sự thay thế (và cảm ơn @yp vì ý tưởng ), tôi đã viết một gói nhỏ autopep8s chỉ những dòng mà bạn đã làm việc kể từ lần cam kết / nhánh cuối cùng:

Về cơ bản, việc rời khỏi dự án tốt hơn một chút so với những gì bạn thấy :

pip install pep8radius

Giả sử bạn đã hoàn thành công việc của mình mastervà sẵn sàng cam kết:

# be somewhere in your project directory
# see the diff with pep, see the changes you've made since master
pep8radius master --diff
# make those changes
pep8radius master --diff --in-place

Hoặc để xóa các dòng mới mà bạn đã cam kết kể từ lần cam kết cuối cùng:

pep8radius --diff
pep8radius --diff --in-place

# the lines which changed since a specific commit `git diff 98f51f`
pep8radius 98f51f --diff

Về cơ bản pep8radiuslà áp dụng autopep8 cho các dòng trong đầu ra của git / hg diff (từ cam kết được chia sẻ cuối cùng ).

Script này hiện hoạt động với git và hg, nếu bạn đang sử dụng thứ gì đó khác và muốn nó hoạt động, vui lòng gửi bình luận / issue / PR !

Bạn có thể sử dụng autopep8 ! Trong khi bạn pha cho mình một tách cà phê, công cụ này vui vẻ loại bỏ tất cả những vi phạm PEP8 khó chịu mà không làm thay đổi ý nghĩa của mã.

Cài đặt nó qua pip:

pip install autopep8

Áp dụng điều này cho một tệp cụ thể:

autopep8 py_file --in-place

hoặc đối với dự án của bạn (đệ quy), tùy chọn dài dòng cung cấp cho bạn một số phản hồi về cách nó diễn ra :

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Lưu ý: Đôi khi, mặc định 100 lần vượt qua là không đủ, tôi đặt nó thành 2000 vì nó cao hợp lý và sẽ bắt tất cả trừ các tệp rắc rối nhất (nó ngừng truyền khi không tìm thấy lỗi pep8 có thể giải quyết) ...

Tại thời điểm này, tôi khuyên bạn nên kiểm tra lại và thực hiện cam kết!

Nếu bạn muốn tuân thủ PEP8 "đầy đủ" : một chiến thuật tôi đã sử dụng là chạy autopep8 như trên, sau đó chạy PEP8, sẽ in các lỗi vi phạm còn lại (tệp, số dòng và nội dung):

pep8 project_dir --ignore=E501

và thay đổi từng cái một theo cách thủ công (ví dụ: E712s - so sánh với boolean).

Lưu ý: autopep8 đưa ra một --aggressiveđối số (để "sửa chữa" những vi phạm thay đổi ý nghĩa này một cách tàn nhẫn), nhưng hãy cẩn thận nếu bạn sử dụng hung hăng, bạn có thể phải gỡ lỗi ... (ví dụ: trong numpy / pandas True == np.bool_(True)nhưng không True is np.bool_(True)!)

Bạn có thể kiểm tra xem có bao nhiêu vi phạm của từng loại (trước và sau):

pep8 --quiet --statistics .

Lưu ý: Tôi coi E501s (dòng quá dài) là một trường hợp đặc biệt vì có thể sẽ có rất nhiều trong số này trong mã của bạn và đôi khi chúng không được autopep8 sửa chữa.

Ví dụ, tôi đã áp dụng kỹ thuật này cho cơ sở mã gấu trúc .

@Andy Hayden đã trình bày tổng quan tốt về autopep8. Thêm vào đó, có một gói nữa được gọi là pep8ify cũng thực hiện điều tương tự.

Tuy nhiên, cả hai gói chỉ có thể loại bỏ các lỗi xơ vải nhưng chúng không thể định dạng mã.

little = more[3:   5]

Đoạn mã trên vẫn giữ nguyên sau khi pep8zing. Nhưng mã có vẻ chưa tốt. Bạn có thể sử dụng các định dạng như yapf , sẽ định dạng mã ngay cả khi mã tuân thủ PEP8. Đoạn mã trên sẽ được định dạng thành

little = more[3:5]

Đôi khi điều này thậm chí phá hủy định dạng thủ công của bạn. Ví dụ

BAZ = {
    [1, 2, 3, 4],
    [5, 6, 7, 8],
    [9, 10, 11, 12]
}

sẽ được chuyển đổi thành

BAZ = {[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]}

Nhưng Bạn có thể bảo nó bỏ qua một số phần.

BAZ = {
   [1, 2, 3, 4],
   [5, 6, 7, 8],
   [9, 10, 11, 12]
}  # yapf: disable

Lấy từ bài đăng trên blog cũ của tôi: Tự động PEP8 & Định dạng mã Python của bạn!

Nếu đang sử dụng eclipse + PyDev, bạn chỉ cần kích hoạt autopep8 từ cài đặt của PyDev: Windows -> Preferences -> gõ 'autopep8' vào bộ lọc tìm kiếm.

Kiểm tra "sử dụng autopep8.py để định dạng mã?" -> OK

Giờ đây, định dạng mã CTRL-SHIFT-F của eclipse sẽ định dạng mã của bạn bằng autopep8 :)

Tôi đã thực hiện nghiên cứu rộng rãi về các công cụ khác nhau cho phong cách python và mã. Có hai loại công cụ: linters - phân tích mã của bạn và đưa ra một số cảnh báo về các kiểu mã được sử dụng kém và hiển thị lời khuyên về cách khắc phục nó và bộ định dạng mã - khi bạn lưu tệp, nó sẽ định dạng lại tài liệu của bạn bằng kiểu PEP.

Bởi vì định dạng lại phải chính xác hơn - nếu nó tái tạo lại thứ gì đó mà bạn không muốn thì nó trở nên vô dụng - chúng che phủ ít phần của PEP hơn, xơ vải hiển thị nhiều hơn.

Tất cả chúng đều có các quyền khác nhau để định cấu hình - ví dụ, có thể định cấu hình pylinter trong tất cả các quy tắc của nó (bạn có thể bật / tắt mọi loại cảnh báo), màu đen hoàn toàn không thể định cấu hình.

Dưới đây là một số liên kết và hướng dẫn hữu ích:

Tài liệu:

• Quy ước về chuỗi tài liệu PEP-257: https://www.python.org/dev/peps/pep-0257/
• Gợi ý loại PEP-484: https://www.python.org/dev/peps/pep-0484
• Hướng dẫn kiểu Chromium https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Kiểu mã cho tự động kiểm tra https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Hướng dẫn phong cách mã hóa của Học viện Khan https://github.com/Khan/style-guides/blob/master/style/python.md
• Hướng dẫn về Python cho người đi nhờ xe https://docs.python-guide.org/
• Hướng dẫn kiểu Python EdX https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• Bài viết về phong cách mã trên RealPython https://realpython.com/python-pep8/

Linters (theo thứ tự phổ biến):

• mypy https://github.com/python/mypy linter để kiểm tra loại (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - một cái hay bằng cách sử dụng PEP-8, rất phổ biến. Thường được sử dụng cùng với pylint và flake8 (một cách phổ biến)
• pylint https://github.com/PyCQA/pylint rất có thể cấu hình, được hỗ trợ tích cực
• bandit https://github.com/PyCQA/bandit линтер по безопасности
• người tìm kiếm https://github.com/PyCQA/pros Inspector pylint + kiểm tra độ khó mã
• flake8 https://github.com/PyCQA/flake8 trình bao bọc pycodestyle với khả năng bật plugin. Danh sách rất lớn các plugin có thể cấu hình khác nhau. Đây là repo flake8 tuyệt vời: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - cố gắng kết hợp nhiều linters khác nhau trong một dự án (thực sự nó là một plugin flake8 kết hợp các phong cách từ một số linters khác)
• pylama https://github.com/klen/pylama đang cố gắng kết hợp 10 xơ vải khác trong một (mypy, pylint, pycodeestyle, pydocstyle и др.). Tôi có thể thấy một vấn đề duy nhất ở đây - phiên bản cũ (không có bản cập nhật trong github repo trong khoảng 10 tháng.)
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Bộ định dạng mã (theo thứ tự phổ biến):

• đen https://github.com/psf/black định dạng phổ biến nhất, được sử dụng trong một số công ty lớn. Được tạo muộn hơn yapf, nhưng đã có nhiều lần bắt đầu hơn tại GitHub
• yapf https://github.com/google/yapf Trình định dạng mã của Google
• autopep8 https://github.com/hhatto/autopep8 xây dựng dựa trên pycodestyle

Có nhiều.

Các IDE thường có một số khả năng định dạng được tích hợp sẵn. IntelliJ Idea / PyCharm cũng vậy, tương tự với plugin Python cho Eclipse, v.v.

Có những định dạng / linters có thể nhắm mục tiêu nhiều ngôn ngữ. https://coala.io là một ví dụ điển hình cho những điều đó.

Sau đó, có các công cụ mục đích duy nhất, trong số đó nhiều công cụ được đề cập trong các câu trả lời khác.

Một phương pháp cụ thể để định dạng lại tự động là phân tích cú pháp tệp thành cây AST (không bỏ nhận xét) và sau đó kết xuất nó trở lại văn bản (có nghĩa là không có gì của định dạng ban đầu được giữ nguyên). Ví dụ về điều đó sẽ là https://github.com/python/black .