Bagikan melalui


Edit kode Python dan gunakan Intellisense

Karena Anda menghabiskan banyak waktu pengembangan di editor kode, dukungan Python di Visual Studio menyediakan fungsionalitas untuk membantu Anda menjadi lebih produktif. Fitur termasuk penyorotan sintaks IntelliSense, pelengkapan otomatis, bantuan tanda tangan, penimpaan metode, pencarian, dan navigasi.

Editor kode terintegrasi dengan jendela Interaktif di Visual Studio. Saat Anda bekerja, mudah untuk bertukar kode antara dua jendela. Untuk informasi selengkapnya, lihat Tutorial Langkah 3: Gunakan jendela REPL Interaktif dan Gunakan jendela Interaktif - Kirim ke perintah Interaktif.

Kerangka membantu Anda tetap fokus pada bagian tertentu dari kode Anda. Untuk dokumentasi umum tentang mengedit kode di Visual Studio, lihat Fitur editor kode.

Browser Objek Visual Studio memungkinkan Anda memeriksa kelas Python yang ditentukan dalam setiap modul dan fungsi yang ditentukan dalam kelas tersebut. Anda dapat mengakses fitur ini pada menu Tampilan atau dengan menggunakan pintasan keyboard Ctrl+Alt+J.

Menggunakan fitur IntelliSense

IntelliSense menyediakan penyelesaian, bantuan tanda tangan, info cepat, dan pewarnaan kode. Visual Studio 2017 versi 15.7 dan yang lebih baru juga mendukung petunjuk jenis.

Untuk meningkatkan performa, IntelliSense di Visual Studio 2017 versi 15.5 dan yang lebih lama bergantung pada database penyelesaian yang dihasilkan untuk setiap lingkungan Python dalam proyek Anda. Anda mungkin perlu me-refresh database jika Anda menambahkan, menghapus, atau memperbarui paket. Status database ditampilkan di jendela Lingkungan Python (pendamping Penjelajah Solusi) pada tab IntelliSense . Untuk informasi selengkapnya, lihat Referensi jendela lingkungan.

Visual Studio 2017 versi 15.6 dan yang lebih baru menggunakan cara yang berbeda untuk menyediakan penyelesaian IntelliSense yang tidak bergantung pada database.

Penyelesaian

Penyelesaian muncul sebagai pernyataan, pengidentifikasi, dan kata lain yang dapat dimasukkan dengan tepat di lokasi saat ini di editor. Intellisense mengisi daftar opsi berdasarkan konteks dan filter item yang salah atau mengganggu. Penyelesaian sering dipicu dengan memasukkan pernyataan (seperti import) dan operator (termasuk titik), tetapi dapat muncul kapan saja dengan memilih pintasan keyboard Ctrl+J +Space.

Cuplikan layar yang memperlihatkan penyelesaian anggota melalui Intellisense di editor Visual Studio.

Saat daftar penyelesaian terbuka, Anda dapat mencari penyelesaian yang Anda inginkan dengan menggunakan tombol panah, mouse, atau dengan terus mengetik. Saat Anda mengetik lebih banyak huruf, daftar difilter lebih lanjut untuk menunjukkan kemungkinan penyelesaian. Anda juga dapat menggunakan pintasan seperti:

  • Ketik huruf yang tidak ada di awal nama, seperti 'uraikan' untuk menemukan 'argparse'
  • Ketik hanya huruf yang berada di awal kata, seperti 'abc' untuk menemukan 'AbstractBaseClass' atau 'air' untuk menemukan 'as_integer_ratio'
  • Lewati huruf, seperti 'b64' untuk menemukan 'base64'

Berikut adalah beberapa contoh:

Cuplikan layar yang memperlihatkan pelengkapan anggota dengan pemfilteran di editor Visual Studio.

Penyelesaian anggota muncul secara otomatis saat Anda mengetik periode setelah variabel atau nilai, bersama dengan metode dan atribut dari jenis potensial. Jika variabel bisa lebih dari satu jenis, daftar mencakup semua kemungkinan dari semua jenis. Informasi tambahan ditampilkan untuk menunjukkan jenis mana yang mendukung setiap penyelesaian. Ketika semua jenis kemungkinan mendukung penyelesaian, tidak ada anotasi yang ditampilkan.

Cuplikan layar yang memperlihatkan penyelesaian anggota pada beberapa jenis di editor Visual Studio.

Secara bawaan, anggota "dunder" (anggota yang dimulai dan diakhiri dengan garis bawah ganda) tidak terlihat. Secara umum, anggota tersebut tidak boleh diakses secara langsung. Jika Anda perlu menggunakan dunder, ketik garis bawah ganda di depan untuk menambahkan penyelesaian ini ke daftar.

Cuplikan layar yang memperlihatkan jenis pelengkapan anggota dunder private di editor Visual Studio.

Pernyataan import dan from ... import menampilkan daftar modul yang dapat diimpor. Pernyataan ini from ... import menghasilkan daftar yang mencakup anggota yang dapat diimpor dari modul yang ditentukan.

Cuplikan layar yang memperlihatkan impor dan penyelesaian impor di editor Visual Studio.

Pernyataan raise dan except menampilkan daftar kelas yang kemungkinan besar merupakan tipe kesalahan. Daftar mungkin tidak menyertakan semua pengecualian yang ditentukan pengguna, tetapi membantu Anda menemukan pengecualian bawaan yang sesuai dengan cepat:

Cuplikan layar yang memperlihatkan penyelesaian pengecualian di editor Visual Studio.

Memilih simbol @ at memulai dekorator dan menampilkan dekorator potensial. Banyak dari item ini tidak dapat digunakan sebagai dekorator. Periksa dokumentasi pustaka untuk menentukan dekorator mana yang akan digunakan.

Cuplikan layar yang memperlihatkan penyelesaian dekorator di editor Visual Studio.

Untuk informasi selengkapnya, lihat Opsi - hasil penyelesaian.

Ketik petunjuk

Petunjuk jenis tersedia di Visual Studio 2017 versi 15.7 dan yang lebih baru.

"Ketik petunjuk" dalam Python 3.5+ (PEP 484 (python.org) adalah sintaks anotasi untuk fungsi dan kelas yang menunjukkan jenis argumen, nilai pengembalian, dan atribut kelas. IntelliSense menampilkan petunjuk jenis saat Anda mengarahkan mouse ke atas panggilan fungsi, argumen, dan variabel yang memiliki anotasi tersebut.

Dalam contoh berikut, Vector kelas dinyatakan sebagai jenis List[float], dan scale fungsi berisi petunjuk jenis untuk argumen dan nilai pengembaliannya. Arahkan mouse ke panggilan fungsi tersebut untuk melihat petunjuk jenis.

Tangkapan layar yang memperlihatkan cara menggerakkan kursor ke atas panggilan fungsi untuk mengungkapkan petunjuk tipe.

Dalam contoh berikutnya, Anda dapat melihat bagaimana atribut anotasi dari kelas Employee muncul di popup penyelesaian IntelliSense untuk atribut:

Cuplikan layar yang memperlihatkan penyelesaian IntelliSense untuk kelas dengan petunjuk jenis.

Ini juga berguna untuk memvalidasi petunjuk tipe di seluruh proyek Anda karena kesalahan biasanya tidak muncul sampai waktu eksekusi. Untuk tujuan ini, Visual Studio mengintegrasikan alat Mypy standar industri melalui perintah menu konteks Python>Run Mypy di Penjelajah Solusi:

Cuplikan layar yang memperlihatkan perintah linting yang tersedia untuk proyek Python di Penjelajah Solusi.

Menjalankan perintah akan meminta Anda untuk menginstal paket Mypy, jika diperlukan. Visual Studio kemudian menjalankan Mypy untuk memvalidasi petunjuk jenis di setiap file Python dalam proyek. Kesalahan muncul di jendela Daftar Kesalahan Visual Studio. Memilih item di jendela menavigasi ke baris yang sesuai dalam kode Anda.

Sebagai contoh sederhana, definisi fungsi berikut berisi petunjuk jenis untuk menunjukkan bahwa input argumen adalah jenis str, sedangkan panggilan ke fungsi tersebut mencoba meneruskan bilangan bulat:

def commas_to_colons(input: str):
    items = input.split(',')
    items = [x.strip() for x in items]
    return ':'.join(items)

commas_to_colons(1)

Menggunakan perintah Jalankan Mypy pada kode ini menghasilkan kesalahan berikut:

Cuplikan layar yang memperlihatkan contoh hasil petunjuk jenis validasi Mypy.

Nota

Untuk versi Python sebelum 3.5, Visual Studio juga menampilkan petunjuk jenis yang Anda berikan melalui file stub Typeshed (.pyi). Anda dapat menggunakan file stub saat Anda tidak ingin menyertakan petunjuk jenis langsung dalam kode Anda atau untuk membuat petunjuk jenis untuk pustaka yang tidak menggunakannya secara langsung. Untuk informasi selengkapnya, lihat Membuat stub untuk modul Python di wiki proyek Mypy.

Visual Studio saat ini tidak mendukung petunjuk jenis dalam komentar.

Bantuan tanda tangan

Saat menulis kode yang memanggil fungsi, bantuan tanda tangan muncul saat Anda mengetik tanda kurung (pembuka . Ini menampilkan dokumentasi dan informasi parameter yang tersedia. Anda dapat mengakses bantuan tanda tangan dengan pintasan keyboard Ctrl+Shift+Space di dalam panggilan fungsi. Informasi yang ditampilkan tergantung pada string dokumentasi dalam kode sumber fungsi, tetapi menyertakan nilai default apa pun.

Cuplikan layar yang memperlihatkan bantuan tanda tangan di editor Visual Studio.

Petunjuk / Saran

Untuk menonaktifkan bantuan tanda tangan, bukaOpsi>Alat>Editor> TeksPython>Umum. Kosongkan kotak centang penyelesaian pernyataan>informasi parameter.

Info cepat

Mengarahkan kursor ke pengidentifikasi menampilkan tooltip Info Cepat. Bergantung pada identifier, Info Cepat mungkin menampilkan nilai atau jenis potensial, dokumentasi yang tersedia, jenis pengembalian yang tersedia, dan lokasi definisi.

Cuplikan layar yang memperlihatkan informasi tampilan Info Cepat di editor Visual Studio.

Pewarnaan kode

Pewarnaan kode menggunakan informasi dari analisis kode ke variabel warna, pernyataan, dan bagian lain dari kode Anda. Variabel yang merujuk ke modul atau kelas mungkin ditampilkan dalam warna yang berbeda dari fungsi atau nilai lainnya. Nama parameter mungkin muncul dalam warna yang berbeda dari variabel lokal atau global. Secara default, fungsi tidak ditampilkan dalam huruf tebal.

Cuplikan layar yang memperlihatkan pewarnaan kode dan sintaks di editor Visual Studio.

Untuk mengkustomisasi warna, bukaOpsi>Alat>Font dan Warna>. Di daftar Tampilkan item , ubah entri Python yang diinginkan:

Cuplikan layar yang memperlihatkan opsi Font dan Warna di Visual Studio.

Sisipkan cuplikan kode

Cuplikan kode adalah fragmen kode yang dapat disisipkan ke dalam file Anda dengan menggunakan pintasan keyboard dan memilih Tab. Anda juga dapat menggunakan perintah Edit>IntelliSense>Sisipkan Cuplikan dan Mengelilingi Dengan, pilih Python, lalu pilih cuplikan yang diinginkan.

Misalnya, class adalah pintasan untuk cuplikan kode yang menyisipkan definisi kelas. Anda melihat cuplikan muncul di daftar pelengkapan otomatis saat Anda mengetik class:

Cuplikan layar yang memperlihatkan cuplikan kode untuk pintasan kelas.

Memilih Tab menghasilkan kelas lainnya. Anda kemudian dapat mengetikkan nama dan daftar dasar, berpindah di antara bidang yang disorot dengan Tab, dan pilih Enter untuk mulai mengetik isi.

Cuplikan layar yang memperlihatkan sorotan pada area cuplikan kode untuk Anda selesaikan.

Saat Anda menggunakan perintah menu Edit>IntelliSense Sisipkan Cuplikan Kode>, Anda terlebih dahulu memilih Python, lalu memilih cuplikan yang diinginkan:

Cuplikan layar yang memperlihatkan cara memilih cuplikan kode melalui perintah Sisipkan Cuplikan Kode.

Perintah Edit>IntelliSense>Surround With menempatkan pilihan saat ini di editor teks di dalam elemen struktural yang dipilih. Misalkan Anda memiliki sepotong kode seperti contoh berikut:

sum = 0
for x in range(1, 100):
    sum = sum + x

Memilih kode ini dan memilih perintah Surround With menampilkan daftar cuplikan yang tersedia. Memilih def dari daftar cuplikan menempatkan kode yang dipilih dalam definisi fungsi. Anda dapat menggunakan tombol Tab untuk menavigasi antara nama fungsi dan argumen yang disorot:

Cuplikan layar yang memperlihatkan cara menggunakan perintah Surround With untuk cuplikan kode.

Memeriksa cuplikan yang tersedia

Anda dapat melihat cuplikan kode yang tersedia di Code Snippets Manager. Akses fitur ini dari Tools>Code Snippets Manager dan pilih Python sebagai bahasa:

Cuplikan layar yang memperlihatkan Code Snippets Manager di Visual Studio.

Untuk membuat cuplikan Anda sendiri, lihat Panduan: Membuat cuplikan kode.

Jika Anda menulis cuplikan kode hebat yang ingin Anda bagikan, jangan ragu untuk mempostingnya dalam inti dan beri tahu kami. Kami mungkin dapat menyertakannya dalam rilis Visual Studio di masa mendatang.

Dukungan Python di Visual Studio menyediakan beberapa cara untuk menavigasi dengan cepat dalam kode Anda, termasuk pustaka yang kode sumbernya tersedia. Anda dapat menemukan pustaka dengan kode sumber untuk bilah navigasi, dan perintah Masuk Ke Definisi, Navigasi Ke, serta Temukan Semua Referensi. Anda juga dapat menggunakan Browser Objek Visual Studio.

Bilah navigasi ditampilkan di bagian atas setiap jendela editor dan menyertakan daftar definisi dua tingkat. Dropdown kiri berisi kelas tingkat atas dan definisi fungsi dalam file saat ini. Menu dropdown kanan menampilkan daftar definisi dalam cakupan yang diperlihatkan di sebelah kiri. Saat Anda berpindah-pindah di editor, daftar diperbarui untuk menampilkan konteks Anda saat ini, dan Anda juga dapat memilih entri dari daftar ini untuk melompat langsung.

cuplikan layar yang memperlihatkan Bilah Navigasi di editor Visual Studio.

Petunjuk / Saran

Untuk menyembunyikan bilah navigasi, bukaOpsi>Alat>Editor> TeksPython>Umum dan hapusbilah Navigasi>.

Buka Definisi

Perintah Masuk Ke Definisi dengan cepat melompat dari penggunaan pengidentifikasi (seperti nama fungsi, kelas, atau variabel), ke lokasi definisi kode sumber. Untuk memanggil perintah, klik kanan pengidentifikasi dan pilih Buka Definisi atau letakkan tanda sisipan di pengidentifikasi dan pilih F12. Perintah ini berfungsi di seluruh kode dan pustaka eksternal tempat kode sumber tersedia. Jika kode sumber pustaka tidak tersedia, Buka Definisi melompat ke pernyataan yang relevan import untuk referensi modul atau menampilkan kesalahan.

Cuplikan layar yang memperlihatkan perintah Buka Definisi di Visual Studio.

Pergi ke

Perintah Edit> Buka (Ctrl+) menampilkan kotak pencarian di editor tempat Anda dapat mengetik string apa pun dan melihat kemungkinankecocokan dalam kode Anda yang menentukan fungsi, kelas, atau variabel yang berisi string tersebut. Fitur ini menyediakan kemampuan yang sama seperti Masuk Ke Definisi tetapi tanpa harus menemukan penggunaan pengidentifikasi.

Untuk menavigasi ke definisi pengidentifikasi tersebut, klik dua kali nama apa pun atau pilih nama dengan tombol panah diikuti dengan Enter.

Cuplikan layar yang memperlihatkan perintah Buka di Visual Studio.

Temukan Semua Referensi

Fitur Temukan Semua Referensi adalah cara yang berguna untuk menemukan di mana pengidentifikasi tertentu ditentukan dan digunakan, termasuk impor dan penugasan. Untuk memanggil perintah, klik kanan pengidentifikasi dan pilih Temukan Semua Referensi, atau letakkan tanda sisipan di pengidentifikasi dan pilih Shift+F12. Mengklik dua kali item dalam daftar menavigasi ke lokasinya.

Cuplikan layar yang memperlihatkan hasil Temukan Semua Referensi di Visual Studio.