decohints

library1.0.9pypypi✓ verified 86d ago

decohints is a Python library that provides a decorator to help IDEs like PyCharm correctly display the parameter hints for functions wrapped by other decorators. It addresses a common pain point in Python development by preserving the original function's signature for better developer experience and type checking. The current version is 1.0.9, and it maintains an active release cadence.

testing

pip install decohints

github ↗package ↗

INSTALL

IMPORT

SIG · DECOHINTS

decohints

testingpythonv1.0.9

Install

1.7s avg

Import

11ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.9 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.012s · 17.8MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 1.7s · import 0.006s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

decohints

✓ from decohints import decohints

This example demonstrates how to use `decohints` to wrap your own decorator. When `my_simple_decorator` is decorated with `@decohints`, IDEs like PyCharm will correctly show the parameter hints of the `greet` function (`name: str, age: int`) instead of the generic `*args, **kwargs`.

from functools import wraps from decohints import decohints @decohints def my_simple_decorator(msg: str = "Hello"): def _decorator(func): @wraps(func) def wrapper(*args, **kwargs): print(f"Decorator received: {msg}") return func(*args, **kwargs) return wrapper return _decorator @my_simple_decorator(msg="Decorating this!") def greet(name: str, age: int) -> str: """A function that greets someone.""" return f"Hi {name}, you are {age} years old." result = greet("Alice", 30) print(result) # In PyCharm, typing `greet(` will now show `(name: str, age: int)` hints.

Debug

Known issues

gotchaWhen applying `decohints` to your own decorators, ensure that `@decohints` is the outermost decorator (i.e., placed directly above your decorator function definition) if your decorator is already wrapped in other decorators.

fix

Place `@decohints` at the very top of your decorator definition. Example: `@decohints\n@another_decorator\ndef your_decorator(): ...`

affects: All versions

gotchaOlder versions of `decohints` (prior to 1.0.5) did not include the `py.typed` marker, which could lead to Mypy (or other static type checkers) skipping type analysis for the library or reporting 'missing library stubs' errors.

fix

Upgrade to `decohints` version 1.0.5 or newer (`pip install --upgrade decohints`). This version includes the necessary `py.typed` marker for proper static analysis.

affects: <1.0.5

Errors

Common errors & fixes

PyCharm/IDE does not show correct parameter hints (e.g., shows `*args, **kwargs` instead of actual parameters) for a function decorated by a custom decorator.

By default, Python decorators replace the decorated function with a wrapper, causing IDEs to lose the original function's signature for parameter hinting.

fix

Apply the `@decohints` decorator to your custom decorator function. For instance, if you have `def my_decorator():`, change it to `@decohints\ndef my_decorator():`.

Skipping analyzing 'decohints': module is installed, but missing library stubs or py.typed marker (Mypy error)

`decohints` versions prior to 1.0.5 did not properly signal to static type checkers that it provides type hints, leading Mypy to ignore its type information.

fix

Upgrade `decohints` to version 1.0.5 or later using `pip install --upgrade decohints`. This version includes the `py.typed` marker, enabling Mypy to correctly analyze the library.

Upgrade

Version history

1.0.9latest on PyPI · released Apr 3, 2023

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/gri-gus/decohints ↗

packagehttps://pypi.org/project/decohints/ ↗