Hướng dẫn auto format code visual studio python - tự động định dạng mã visual studio python

Visual Studio Code là một công cụ chỉnh sửa mạnh mẽ cho mã nguồn Python. Biên tập viên bao gồm các tính năng khác nhau để giúp bạn làm việc hiệu quả khi viết mã. Để biết thêm thông tin về chỉnh sửa trong mã Visual Studio, hãy xem Chỉnh sửa cơ bản và điều hướng mã.

Trong tổng quan này, chúng tôi sẽ mô tả các tính năng chỉnh sửa cụ thể được cung cấp bởi tiện ích mở rộng Python, bao gồm các bước về cách tùy chỉnh các tính năng này thông qua cài đặt người dùng và không gian làm việc.

Tự động hoàn thành và Intellisense

IntelliSense là một thuật ngữ chung cho các tính năng chỉnh sửa mã liên quan đến hoàn thành mã. Hãy dành một chút thời gian để xem xét ví dụ dưới đây. Khi in được đánh máy, hãy chú ý cách Intellisense điền các tùy chọn tự động hoàn thành. Người dùng cũng được cung cấp một danh sách các tùy chọn khi họ bắt đầu nhập biến có tên là lời chào.print is typed, notice how IntelliSense populates auto-completion options. The user is also given a list of options when they begin to type the variable named greeting.

AutoComplete và Intellisense được cung cấp cho tất cả các tệp trong thư mục làm việc hiện tại. Chúng cũng có sẵn cho các gói Python được cài đặt ở các vị trí tiêu chuẩn.

Để biết thêm về Intellisense nói chung, xem Intellisense.

Mẹo: Kiểm tra tiện ích mở rộng Intellicode cho mã VS. Intellicode cung cấp một tập hợp các khả năng hỗ trợ AI cho IntelliSense trong Python, chẳng hạn như suy ra các phần hoàn chỉnh tự động có liên quan nhất dựa trên bối cảnh mã hiện tại. Để biết thêm thông tin, hãy xem Intellicode cho Câu hỏi thường gặp về mã VS.: Check out the IntelliCode extension for VS Code. IntelliCode provides a set of AI-assisted capabilities for IntelliSense in Python, such as inferring the most relevant auto-completions based on the current code context. For more information, see the IntelliCode for VS Code FAQ.

Tùy chỉnh hành vi IntelliSense

Việc cho phép toàn bộ các tính năng IntelliSense theo mặc định có thể khiến trải nghiệm phát triển của bạn cảm thấy chậm hơn, do đó, tiện ích mở rộng Python cho phép một bộ tính năng tối thiểu cho phép bạn làm việc hiệu quả trong khi vẫn có trải nghiệm hiệu suất. Tuy nhiên, bạn có thể tùy chỉnh hành vi của công cụ phân tích theo ý thích của bạn thông qua nhiều cài đặt.

Bật nhập khẩu tự động

Pylance cung cấp các đề xuất nhập khẩu tự động cho các mô -đun trong không gian làm việc và/hoặc các gói bạn đã cài đặt trong môi trường của mình. Điều này cho phép các câu lệnh nhập được tự động thêm khi bạn nhập. Nhập khẩu tự động bị tắt theo mặc định, nhưng bạn có thể kích hoạt chúng bằng cách cài đặt python.analysis.autoImportCompletions thành true trong cài đặt của bạn.

Theo mặc định, chỉ các biểu tượng/gói cấp cao nhất được đề xuất là tự động nhập. Ví dụ: bạn có thể thấy import matplotlib như một gợi ý, nhưng không phải là import matplotlib.pyplot theo mặc định. Tuy nhiên, bạn có thể tùy chỉnh hành vi này thông qua cài đặt python.analysis.packageIndexDepths (kiểm tra tài liệu Cài đặt IntelliSense để tìm hiểu thêm). Các ký hiệu do người dùng xác định (những người không đến từ các gói hoặc thư viện đã cài đặt) chỉ được nhập tự động nếu chúng đã được sử dụng trong các tệp được mở trong trình chỉnh sửa. Nếu không, chúng sẽ chỉ có sẵn thông qua sửa lỗi nhanh chóng.

Bật IntelliSense cho các vị trí gói tùy chỉnh

Để cho phép IntelliSense cho các gói được cài đặt ở các vị trí không chuẩn, hãy thêm các vị trí đó vào bộ sưu tập python.analysis.extraPaths trong tệp

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

Windows:

"python.analysis.extraPaths": [
    "C:/Program Files (x86)/Google/google_appengine",
    "C:/Program Files (x86)/Google/google_appengine/lib/flask-0.12"]

macOS/Linux:

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

Đối với danh sách đầy đủ các điều khiển IntelliSense có sẵn, bạn có thể tham khảo các cài đặt phân tích mã mở rộng Python và cài đặt tự động hoàn thành.

Bạn cũng có thể tùy chỉnh hành vi chung của AutoClete và IntelliSense, thậm chí vô hiệu hóa hoàn toàn các tính năng. Bạn có thể tìm hiểu thêm trong việc tùy chỉnh IntelliSense.

Khắc phục sự cố IntelliSense

Đối với các vấn đề tự động hoàn chỉnh và IntelliSense, hãy kiểm tra các nguyên nhân sau:

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

dẫn đường

Trong khi chỉnh sửa, bạn có thể nhấp chuột phải vào các định danh khác nhau để tận dụng một số lệnh thuận tiện

• Chuyển đến Định nghĩa (F12) nhảy từ mã của bạn vào mã xác định một đối tượng. Lệnh này rất hữu ích khi bạn làm việc với các thư viện. (F12) jumps from your code into the code that defines an object. This command is helpful when you're working with libraries.

• Định nghĩa Peek (⌥f12 (Windows Alt+F12, Linux Ctrl+Shift+F10)), tương tự, nhưng hiển thị định nghĩa trực tiếp trong trình chỉnh sửa (tạo không gian trong cửa sổ Trình chỉnh sửa để tránh che khuất bất kỳ mã nào). Nhấn Escape để đóng cửa sổ Peek hoặc sử dụng X ở góc trên bên phải. (⌥F12 (Windows Alt+F12, Linux Ctrl+Shift+F10)), is similar, but displays the definition directly in the editor (making space in the editor window to avoid obscuring any code). Press Escape to close the Peek window or use the x in the upper right corner.

• Chuyển đến Tuyên bố nhảy đến điểm mà biến hoặc đối tượng khác được khai báo trong mã của bạn. jumps to the point at which the variable or other object is declared in your code.

• Tuyên bố Peek là tương tự, nhưng hiển thị khai báo trực tiếp trong trình soạn thảo. Một lần nữa, sử dụng Escape hoặc X ở góc trên bên phải để đóng cửa sổ Peek. is similar, but displays the declaration directly in the editor. Again, use Escape or the x in the upper right corner to close the Peek window.

Sửa chữa nhanh chóng

Thêm sửa lỗi nhanh chóng khi sử dụng pylance cho phép bạn nhanh chóng hoàn thành các câu lệnh nhập. Đầu tiên, bắt đầu bằng cách nhập tên gói trong trình chỉnh sửa. Bạn sẽ nhận thấy một hành động mã có sẵn để tự động hoàn thành dòng mã nguồn (miễn là bạn đã cài đặt mô -đun trong môi trường). Di chuột qua văn bản (được đánh dấu bằng một squiggle) và sau đó chọn bóng đèn hành động mã khi nó xuất hiện. Sau đó, bạn có thể chọn từ một danh sách nhập khẩu tiềm năng.

Hành động mã này cũng nhận ra một số chữ viết tắt phổ biến cho các gói Python phổ biến sau đây:

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.analysis.extraPaths": [
    "~/.local/lib/Google/google_appengine",
    "~/.local/lib/Google/google_appengine/lib/flask-0.12" ]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

Danh sách đề xuất nhập được đặt hàng với các báo cáo nhập cho các gói (hoặc mô -đun) ở trên cùng. Nó cũng sẽ bao gồm các câu lệnh cho nhiều mô -đun và/hoặc thành viên (lớp, đối tượng, v.v.) từ các gói được chỉ định.

Giống như với nhập khẩu tự động, chỉ có các biểu tượng cấp cao nhất được đề xuất theo mặc định. Bạn có thể tùy chỉnh hành vi này thông qua cài đặt python.analysis.packageIndexDepths.

Chạy lựa chọn/dòng trong thiết bị đầu cuối (repl)

Python: Chạy lựa chọn/dòng trong lệnh đầu cuối Python (Shift+Enter) là một cách đơn giản để lấy bất kỳ mã nào được chọn hoặc mã trên dòng hiện tại nếu không có lựa chọn và chạy nó trong thiết bị đầu cuối Python. Một lựa chọn/dòng chạy giống hệt nhau trong lệnh Python Terminal cũng có sẵn trên menu ngữ cảnh cho một lựa chọn trong trình soạn thảo.Python: Run Selection/Line in Python Terminal command (Shift+Enter) is a simple way to take whatever code is selected, or the code on the current line if there is no selection, and run it in the Python Terminal. An identical Run Selection/Line in Python Terminal command is also available on the context menu for a selection in the editor.

Mã VS tự động loại bỏ các phần dựa trên dòng không trống đầu tiên của lựa chọn, chuyển tất cả các dòng khác còn lại khi cần thiết.

Mã nguồn chạy trong thiết bị đầu cuối/replin được tích lũy cho đến khi phiên bản hiện tại của thiết bị đầu cuối được đóng lại.

Lệnh mở thiết bị đầu cuối Python nếu cần thiết; Bạn cũng có thể mở môi trường REP tương tác trực tiếp bằng lệnh Python: Start Repress. (Khởi động ban đầu có thể mất một vài khoảnh khắc đặc biệt nếu câu lệnh đầu tiên bạn chạy là

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

Khi sử dụng đầu tiên của Python: Run Lựa chọn/Line trong lệnh Python Terminal, mã VS có thể gửi văn bản đến lần phát lại trước khi môi trường đó đã sẵn sàng, trong trường hợp đó, lựa chọn hoặc dòng không chạy. Nếu bạn bắt gặp hành vi này, hãy thử lại lệnh khi tải lại hoàn tất.Python: Run Selection/Line in Python Terminal command, VS Code may send the text to the REPL before that environment is ready, in which case the selection or line isn't run. If you come across this behavior, try the command again when the REPL has finished loading.

Định dạng

Định dạng làm cho mã dễ đọc hơn bởi con người. Nó áp dụng các quy tắc và quy ước cụ thể cho khoảng cách dòng, bên trong, khoảng cách xung quanh các nhà khai thác, v.v. Bạn có thể xem một ví dụ trên trang Autopep8. Hãy nhớ rằng, định dạng không ảnh hưởng đến chức năng của chính mã.

Lớp lót giúp ngăn ngừa lỗi bằng cách phân tích mã cho các lỗi cú pháp, phong cách và chức năng chung và thực tiễn lập trình độc đáo. Mặc dù có một chút chồng chéo giữa định dạng và lót, hai khả năng là bổ sung.

Tiện ích mở rộng Python hỗ trợ định dạng mã nguồn bằng AutopeP8 (mặc định), Đen hoặc YAPF.

Cài đặt định dạng chung

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

Cài đặt đặc trưng cho Formatter

Các cài đặt sau đây áp dụng cho các định dạng riêng lẻ. Phần mở rộng Python tìm kiếm định dạng trong trình thông dịch đã chọn. Để sử dụng một định dạng ở một vị trí khác, chỉ định vị trí đó trong cài đặt đường dẫn tùy chỉnh thích hợp. Các lệnh

"python.sortImports.args": ["-rc", "--atomic"],

Lưu ý: Theo mặc định, không thể cài đặt định dạng màu đen khi môi trường Python 2 hoạt động. Cố gắng làm như vậy có thể hiển thị thông báo "Black Formatter chưa được cài đặt. Cài đặt?". Nếu bạn cố gắng cài đặt màu đen để đáp ứng, một thông báo khác xuất hiện nói rằng "không thể tìm thấy một phiên bản thỏa mãn yêu cầu của Black 'Không tìm thấy phân phối phù hợp nào cho màu đen.": By default, the Black formatter can't be installed when a Python 2 environment is active. Attempting to do so may display the message "Formatter black is not installed. Install?". If you try to install Black in response, another message appears saying "Could not find a version that satisfies the requirement black' No matching distribution found for black."

Để giải quyết vấn đề này và sử dụng định dạng màu đen với Python 2, trước tiên hãy cài đặt màu đen trong môi trường Python 3. Sau đó đặt cài đặt

"python.sortImports.args": ["-rc", "--atomic"],

1 thành vị trí cài đặt đó.

Khi sử dụng các đối số tùy chỉnh, mỗi phần tử cấp cao nhất của chuỗi đối số được phân tách bằng không gian trên dòng lệnh phải là một mục riêng biệt trong danh sách Args. Ví dụ:

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

Trong ví dụ thứ hai, phần tử cấp cao nhất

"python.sortImports.args": ["-rc", "--atomic"],

Xử lý sự cố định dạng

Nếu định dạng không thành công, hãy kiểm tra các nguyên nhân có thể sau:

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

"python.sortImports.args": ["-rc", "--atomic"],

Lưu ý: Nếu bạn không tìm thấy định dạng ưa thích của mình được liệt kê ở trên, bạn có thể thêm hỗ trợ thông qua tiện ích mở rộng. Mẫu tiện ích mở rộng Python giúp dễ dàng tích hợp các công cụ Python mới vào mã VS.: If you don't find your preferred formatter listed above, you can add support via an extension. The Python Extension Template makes it easy to integrate new Python tools into VS Code.

Tái cấu trúc

Phần mở rộng Python thêm các chức năng tái cấu trúc sau: Trích xuất biến, phương thức trích xuất, đổi tên mô -đun và nhập khẩu.Extract Variable, Extract Method, Rename Module, and Sort Imports.

Trích xuất tất cả các lần xuất hiện tương tự của văn bản đã chọn trong phạm vi hiện tại và thay thế nó bằng một biến mới.

Bạn có thể gọi lệnh này bằng cách chọn dòng mã bạn muốn trích xuất như một biến. Sau đó chọn ánh sáng-bulb được hiển thị bên cạnh nó.

Trích xuất tất cả các lần xuất hiện tương tự của biểu thức hoặc khối được chọn trong phạm vi hiện tại và thay thế nó bằng một cuộc gọi phương thức.

Bạn có thể gọi lệnh này bằng cách chọn các dòng mã bạn muốn trích xuất làm phương thức. Sau đó chọn ánh sáng-bulb được hiển thị bên cạnh nó.

Đổi tên mô -đun

Sau khi một tệp/mô -đun Python được đổi tên, Pylance có thể tìm thấy tất cả các trường hợp có thể cần được cập nhật và cung cấp cho bạn bản xem trước tất cả các thay đổi.

Để tùy chỉnh tài liệu tham khảo nào cần được cập nhật, bạn có thể chuyển đổi các hộp kiểm tại dòng hoặc từ cấp độ tệp trong bản xem xét lại. Khi bạn đã thực hiện các lựa chọn của mình, bạn có thể chọn Áp dụng tái cấu trúc hoặc loại bỏ việc tái cấu trúc.Refactor Preview. Once you've made your selections, you can select Apply Refactoring or Discard Refactoring.

Sắp xếp nhập khẩu

Sắp xếp Nhập khẩu sử dụng gói ISORT để hợp nhất nhập khẩu cụ thể từ cùng một mô -đun thành một câu lệnh

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

"python.formatting.autopep8Args": ["--max-line-length", "120", "--experimental"],
"python.formatting.yapfArgs": ["--style", "{based_on_style: chromium, indent_width: 2}"],
"python.formatting.blackArgs": ["--line-length", "100"]

Được viện dẫn bởi:

• Nhấp chuột phải vào trình chỉnh sửa và chọn Sắp xếp nhập (không cần lựa chọn)Sort Imports (no selection is required)
• Bảng màu lệnh (⇧⌘p (Windows, Linux Ctrl+Shift+P)), sau đó là Python Refactor: Sắp xếp nhập khẩu⇧⌘P (Windows, Linux Ctrl+Shift+P)), then Python Refactor: Sort Imports
• Gán phím tắt cho lệnh python.analysis.autoImportCompletions3

Các đối số tùy chỉnh cho Isort được chỉ định trong cài đặt python.analysis.autoImportCompletions4, trong đó mỗi phần tử cấp cao nhất, được phân tách bằng các khoảng trắng trên dòng lệnh, là một mục riêng biệt trong mảng:

"python.sortImports.args": ["-rc", "--atomic"],

Để sử dụng tập lệnh Isort tùy chỉnh, hãy sử dụng cài đặt python.analysis.autoImportCompletions5 để chỉ định đường dẫn.

Các cấu hình tiếp theo có thể được lưu trữ trong tệp python.analysis.autoImportCompletions6 như được ghi lại trên cấu hình Isort.

Lưu ý: Đối với những người di chuyển từ ISORT4 sang ISORT5, một số tùy chọn CLI cờ và cấu hình đã thay đổi, hãy tham khảo Hướng dẫn nâng cấp ISORT5 của dự án.: For those migrating from isort4 to isort5, some CLI flags and config options have changed, refer to the project's isort5 upgrade guide.

Bước tiếp theo

• LINTING - Kích hoạt, định cấu hình và áp dụng các lớp lót Python khác nhau.
• Gỡ lỗi - Học cách gỡ lỗi Python cả địa phương và từ xa.
• Kiểm tra - Định cấu hình môi trường thử nghiệm và khám phá, chạy và gỡ lỗi các bài kiểm tra.
• Chỉnh sửa cơ bản - Tìm hiểu về Trình chỉnh sửa mã VS mạnh mẽ.
• Điều hướng mã - Di chuyển nhanh qua mã nguồn của bạn.
• IntelliSense - Tìm hiểu về các tính năng IntelliSense.
• Hỗ trợ Jupyter - Tìm hiểu làm thế nào để bắt đầu với Jupyter Notebooks.
• Mẫu mở rộng Python - Tạo một tiện ích mở rộng để tích hợp các công cụ Python yêu thích của bạn.

11/3/2022