Skip to content

Productivity Actions

This category collects BetterPy features that streamline common editing and navigation workflows, helping you move faster through everyday Python tasks.


Generate Actions

Generate class actions

Since 2026.04.13 · Maturity Stable

Use BetterPy's Generate menu entries to scaffold common Python class shapes without leaving the editor. Each action inserts the class at the caret, adds any required imports, and selects the generated class name so you can rename it immediately.

Available generators

  • dataclass inserts a plain @dataclass.
  • frozen dataclass (kw_only) inserts @dataclass(frozen=True, kw_only=True).
  • pydantic model (with config) inserts a BaseModel plus an empty ConfigDict().

How it behaves

  • The action is available from Code | Generate (⌘N / Alt+Insert) in Python files.
  • When the caret is inside a class body, the generated class is inserted into that class with matching indentation.
  • When the file is missing imports such as dataclass, BaseModel, or ConfigDict, BetterPy adds them without duplicating existing imports.
  • After insertion, BetterPy selects the generated class name and starts inline rename.

Examples

from dataclasses import dataclass


@dataclass
class NewDataclass:
    pass
from dataclasses import dataclass


@dataclass(frozen=True, kw_only=True)
class NewFrozenDataclass:
    pass
from pydantic import BaseModel, ConfigDict


class NewModel(BaseModel):
    model_config = ConfigDict()
    pass

Placement rules

If the caret is between existing statements, BetterPy inserts the generated class at that position instead of always appending it to the end of the file. That makes it practical to scaffold nested helper classes exactly where you want them.


Documentation Enhancements

Attribute Docstring in Quick Documentation

Since 2026.05.0 · Maturity Stable · Issues PY-63878

Show attribute docstrings directly in Quick Documentation when a class attribute is followed by a string literal. This brings Python's attribute-docstring convention into the standard documentation popup instead of leaving it hidden in the class body.

How to invoke

Place the caret on a class attribute and open Quick Documentation with F1 / Ctrl+Q or the usual editor documentation action.

If the next statement after the attribute is a string literal, BetterPy returns that text as the attribute's quick documentation.

Example

class Config:
    title: str
    """Primary display title"""

Quick Documentation for title shows:

Primary display title

What it supports

  • Regular class attributes.
  • Dataclass fields.
  • TypedDict fields.
  • Pydantic-style model fields.
  • Whitespace between the attribute declaration and the docstring literal.

What it deliberately avoids

  • Local variables and other non-class assignments.
  • Attributes without an immediately following string literal.
  • Non-string statements after the attribute declaration.

Notes

  • The feature is gated by the Attribute Docstring in Quick Documentation setting under Settings | BetterPy | Productivity Actions | Documentation and is enabled by default.
  • BetterPy also reuses the same attribute-docstring lookup from the enhanced dataclass quick info feature, so both views stay consistent.

Anonymous usage analytics (PostHog)

Since 2026.02 · Maturity Stable

BetterPy can send anonymous usage analytics to PostHog when the IDE allows usage statistics. The data helps prioritize feature work and catch broad product issues without collecting code, file paths, project names, or personal data.

What is collected

  • BetterPy plugin version.
  • IDE type and version.
  • Operating system and JVM version.
  • A random anonymous installation id.
  • Coarse feature-usage events, such as a feature id and action id.

What is not collected

  • Source code or snippets.
  • File paths, project names, package names, or symbol names.
  • Personal information.

How to control it

Analytics are automatically disabled when the IDE's usage statistics setting is off. You can also disable the feature from Settings | BetterPy | Privacy | Anonymous usage analytics (PostHog).

When the setting is turned off from BetterPy settings, the plugin sends a final anonymous opt-out event so opt-out rates can be measured.