Using the dashboard
Kite ships with a Sidebar which contains a dashboard you can use to look up information while you code. In this article, you'll learn about what the dashboard provides and how to use it.
Searching for information
You can search for Python identifiers using the search bar up top. The dashboard will autocomplete search suggestions for you based on the most popular search terms that match your current query.
You can use the arrow keys and enter to navigate the search results. You can also select search results using the mouse.
The dashboard can also automatically search for information as you code, based on the current position of your cursor in the editor. To enable this, click on the “Enable Autosearch” button to the right of the search bar.
You can click on the same button to toggle autosearch off/on afterwards.
The dashboard will also automatically suggest that you turn on autosearch if it detects that you're using an identifier that it recognizes.
You can turn on autosearch or hide the notification. If you choose “Hide”, no more notifications like this will appear anymore.
Note: Autosearch only works when your code is completely indexed, which may take several minutes if you are running Kite for the first time. Refer to the editor integration guides to learn more about checking the status of Kite.
The dashboard shows several pieces of information about an identifier.
This is the full name of the identifier, as well as the type of the value the identifier refers to. You may also navigate through the history of viewed identifiers using the arrow icons on the very right.
Type specific information (2)
The information displayed here depends on the type of the identifier. In the example above, since
json.dumps is a function, this area will display the function signature as well as popular calling patterns. If the identifier refers to a module, we show the top members of that module.
Likewise, if the identifier refers to a type, the dashboard will show the top attributes of the type.
The dashboard will also show documentation for the identifier if available.
Code examples (4)
The dashboard will also show curated code examples for the identifier if available. You can click on the title of a code example to see the example in its entirety, as well as other related code examples.
There are a number of known issues with the dashboard that we're working to fix:
- Manual searching currently only works for identifiers from 3rd party packages (as opposed to identifiers defined in your own codebase)
- There is currently no way to list all the members of a module or attributes of a type
- There is currently no way to list all the code examples related to an identifier