A PyCharm plugin that implements inlay parameter and type annotation hints for Python.

Daniil Kovalenko

Last update: Dec 5, 2022

Related tags

App python plugin productivity intellij python3 intellij-plugin python-plugin hints

Overview

Python Inlay Params

Quick Installation

Using IDE built-in plugin system:

Settings/Preferences > Plugins > Marketplace >
Search for "Python Inlay Params" > Install Plugin
Manually:

Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Description

This plugin (quite decently) implements inlay parameter hints for Python.
In addition, you can enable type annotation hints for variables and function return types.

Supported expressions

Pretty much any expression is supported:

dataclass and class instantiation
lambdas
decorators
function and method calls
etc.

Scroll to the demo at the bottom to see how it works.

Settings

Parameter hints

To enable/disable them entirely, follow this path:

Settings -> Editor -> Inlay Hints -> Parameter names -> Python

But you can also switch specific parts in that menu: Class hints, Function hints to enable/disable them individually. Additionally, there's an option to avoid redundant hints more aggressively, called Hide overlaps, which is used to hide a hint if a parameter name is completely overlapped by its argument.

Type annotation hints (BETA)

Partially disabled by default.
To enable/disable them entirely, follow this path:

Settings -> Editor -> Inlay Hints -> Types -> Python

There are two main options under this partition: Type annotations and Function return types.
Look at the demo screenshot below to see them in work (last section).

Demo Screenshot

You might also like...

Advent of code 2021 (unofficial) in Kotlin for Educational Plugin on Jetbrains IntelliJ IDE.

Kotlin Advent of Code 2021 (unofficial) DISCLAIMER: I am not affiliated with the official Advent of code event or website. To open this course, you ne

1 Dec 10, 2021

A plugin about embedded browser for IntelliJ IDEA.

browser English | 简体中文 This plugin provides embedded browser (based on Java Chromium Embedded Framework) support for IntelliJ IDEA. Get from Marketpla

0 Dec 15, 2021

conceptual Android audio plugin framework

AAP: Android Audio Plugin Framework disclaimer: the README is either up to date, partially obsoleted, or sometimes (but not very often) ahead of imple

42 Nov 12, 2022

ForceField - A Plugin that lets all Players in a specific radius fly away from you

ForceField A Plugin to not get annoyed of other Players Commands /forcefield [Pl

2 Oct 13, 2022

MineJS is a scripting plugin for the Bukkit!

Mine.js(W-I-P) Minecraft Bukkit Scripting with JS by Netherald How to apply? Download Paper or Bungee Version. and put it to plugins folder. Script fo

9 Dec 14, 2022

Loco-strings-sync - A custom Gradle Plugin useful to sync loco string resources to local projects

loco-strings-sync A custom Gradle Plugin useful to sync loco string resources to

1 Feb 14, 2022

A plugin for Termux to use native Android GUI components from CLI applications.

Termux:GUI This is a plugin for Termux that enables command line programs to use the native android GUI. In the examples directory you can find demo v

345 Jan 1, 2023

PluginScan - Minecraft plugin anti-malware scanner

PluginScan - Minecraft plugin anti-malware scanner PluginScan is a cross-platform java executable analyzer designed to detect malware and other malici

15 Dec 21, 2022

simple-flank is a Gradle plugin to use Flank in Android projects with no configuration needed

simple-flank simple-flank is a new gradle plugin with a clear focus: make the setup as simple as possible. Applied to any application or library modul

8 May 10, 2022

Comments

Ignore union type hints if expression is BinaryExpression or ConditionalExpression and one of the part of expression is empty LiteralExpression
When we have code like

def __init__(self, value: List[str] = None): value = value or []

In this case we get type hint List[str] | list | None which is not valid expression
bug
opened by Divaltor 1
Implement type hints tests
To dive deeper into the type hints and refactor their code as we need, tests have become essential. This PR implements them.

Progress

[x] Adjust the CI/CD to run tests automatically

[x] Implement function return types tests

[x] Implement variables types tests

enhancement
opened by WhiteMemory99 0
$Add hints reference resolving by click with Cmd\Control$

Add hints reference resolving by click with Cmd\Control

Other IDE's (IntelliJ IDEA, Rider, etc) support for browsing of type by click on it by CMD\Control + Left Mouse Click combination. Need to recreate this functionality in this plugin
enhancement

opened by Divaltor 0
$Implement hide\collapse feature for inlay hints$

Implement hide\collapse feature for inlay hints

Sometimes we have unreadable hints like on screenshot below. Need to implement collapsable hints, fortunately, such support is available in Plugin SDK

enhancement research

opened by Divaltor 0

Releases(v0.3.1)

v0.3.1(Oct 2, 2022)
Fixed

TypedDict subclasses being displayed as a regular dict in type hints

Several bugs around async functions with type hints

Other minor type hints corrections

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.3.1.zip(86.39 KB)
v0.3.0(Sep 25, 2022)
Added

Type hints now support async functions [#15]

Made type hints clickable, Ctrl+LMB to open the object reference [#17]

Changed

Parameter hints rewritten - now more reliable, with complete syntax coverage, including chained calls support.

Fixed

Redundant parameter hints for names that start with "__" or 1 character long

Display of unnecessary type hints [#16]

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.3.0.zip(91.54 KB)
v0.2.1(Sep 23, 2022)
Added

Support for 2022.3

More Python syntax covered with parameter hints

Changed

Reduced the amount of parameter hints to make them more relevant and valuable, a new settings option included

Fixed

Star (*) and Slash (/) parameters were breaking the hints order

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.2.1.zip(77.00 KB)
v0.2.0(Jul 29, 2022)
Added

Detail plugin settings that let you disable parameter hints selectively

Introduce new inlay hints - optional type annotations for variables and functions return types [#6]

Changed

Drop support for build 212 and below due to changes in the plugin

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.2.0.zip(76.62 KB)
v0.1.4(Jul 20, 2022)
Changed

Lower minimal build requirement to 2021.2

Fixed

Hints not showing when there's one positional parameter with **kwargs

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.1.4.zip(6.35 KB)
v0.1.3(Jul 19, 2022)
Changed

Hide the hints that are 1 character long

Don't show hints in call expressions that take a single parameter (except for *args)

Fixed

Hints showing when placing a positional argument after keyword ones

Hints for classes that use __new__, like datetime.datetime

Arguments with the same name as the parameter, but in a different case, were still displayed

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.1.3.zip(6.38 KB)
v0.1.2(Jul 18, 2022)
Fixed

**kwargs parameter being shown in certain situations

Class hints based on their attributes were shown incorrectly

Fix hints display for calls with unpacking

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.1.2.zip(6.30 KB)
v0.1.1(Jul 17, 2022)
Fixed

Wrong hints behavior with some classes, related to the __init__ inheritance logic

Wrong hint ordering when a positional argument is passed after keyword arguments

Messed up parameter ordering when unpacking is in the call expression

Source code(tar.gz)
Source code(zip)
Python.Inlay.Params-0.1.1.zip(6.16 KB)
v0.1.0(Jul 15, 2022)
Added

Initial plugin release

Source code(tar.gz)
Source code(zip)
Python-Inlay-Params-0.1.0.jar(5.84 KB)

Owner

Daniil Kovalenko

Python/Kotlin Developer

GitHub https://plugins.jetbrains.com/plugin/19538

Text to Speech Project for Spring Boot and Kotlin, Auth Server, Python with Fast API (gTTS)

TTS-App Text to Speech Project for Spring Boot and Kotlin, Auth Server, Python with Fast API (gTTS) Python의 gTTS lib를 활용하여 텍스트를 음성으로 변환하는 서비스를 구현해봅니다.

7 Jan 7, 2022

A Python native extension written in Kotlin Native

Kotlin Python Ext This is a proof of concept for a Python extension in Kotlin. It is recommended to read the Official Python C API Documentation befor

20 Jun 22, 2022

This is an example for running a Python library (mishkal) in Android using chaquopy

chaquopy-mishkal This is an example for running a Python library (mishkal) in Android using chaquopy Code All the code that has been added to run the

2 Oct 10, 2022

Bandicoot an open-source python toolbox to analyze mobile phone metadata

bandicoot is Python toolbox to analyze mobile phone metadata. It provides a complete, easy-to-use environment for data-scientist to analyze mobile phone metadata. With only a few lines of code, load your datasets, visualize the data, perform analyses, and export the results.

Computational Privacy Group @ Imperial College London

231 Sep 12, 2022

Android application that implements location and network related Android APIs

Location and network data collection Location and network data collection with Android's telephonyManager class. Introduction Technologies Android's A

0 Oct 31, 2021

This projects implements Github User search with Android Pagination 3 Library

GithubUser Search An Android App that lists the github users sorted by most followers Resources GitHub API Building Clone the git repository Build ./g

3 Oct 12, 2022

A news application through which you can learn and browse all the news that interests you by choosing the country and type of news with the ability to browse and add some news to your favorites

MY-NEWS-Android A news application through which you can learn and browse all the news that interests you by choosing the country and type of news wit

0 Nov 11, 2021

A PyCharm plugin that implements inlay parameter and type annotation hints for Python.

Related tags

Overview

Python Inlay Params

Quick Installation

Description

Supported expressions

Settings

Parameter hints

Type annotation hints (BETA)

Demo Screenshot

You might also like...

Advent of code 2021 (unofficial) in Kotlin for Educational Plugin on Jetbrains IntelliJ IDE.

A plugin about embedded browser for IntelliJ IDEA.

conceptual Android audio plugin framework

ForceField - A Plugin that lets all Players in a specific radius fly away from you

MineJS is a scripting plugin for the Bukkit!

Loco-strings-sync - A custom Gradle Plugin useful to sync loco string resources to local projects

A plugin for Termux to use native Android GUI components from CLI applications.

PluginScan - Minecraft plugin anti-malware scanner

simple-flank is a Gradle plugin to use Flank in Android projects with no configuration needed

Comments

Ignore union type hints if expression is BinaryExpression or ConditionalExpression and one of the part of expression is empty LiteralExpression

Implement type hints tests

Progress

Add hints reference resolving by click with Cmd\Control

Implement hide\collapse feature for inlay hints

Releases(v0.3.1)

v0.3.1(Oct 2, 2022)

Fixed

v0.3.0(Sep 25, 2022)

Added

Changed

Fixed

v0.2.1(Sep 23, 2022)

Added

Changed

Fixed

v0.2.0(Jul 29, 2022)

Added

Changed

v0.1.4(Jul 20, 2022)

Changed

Fixed

v0.1.3(Jul 19, 2022)

Changed

Fixed

v0.1.2(Jul 18, 2022)

Fixed

v0.1.1(Jul 17, 2022)

Fixed

v0.1.0(Jul 15, 2022)

Added

Owner

Daniil Kovalenko

Text to Speech Project for Spring Boot and Kotlin, Auth Server, Python with Fast API (gTTS)

A Python native extension written in Kotlin Native

This is an example for running a Python library (mishkal) in Android using chaquopy

Bandicoot an open-source python toolbox to analyze mobile phone metadata

Android application that implements location and network related Android APIs

This projects implements Github User search with Android Pagination 3 Library

A news application through which you can learn and browse all the news that interests you by choosing the country and type of news with the ability to browse and add some news to your favorites

A Android Web IDE supports code auto-completion and highlight, plugin (Supports Html, Css, JS, Json, Php etc)

Warning on new versions available even when using Kotlin-DSL plugin.

A Modular Firebase plugin (Android) for godot