python / python/mypy

Error when using TypeVar in type annotation for @property

Open
#16,539 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

from typing import TypeVar, Generic
from pyspark.sql import DataFrame
import pandas as pd
AnyDataFrame = TypeVar('AnyDataFrame', pd.DataFrame, DataFrame)

class OutputA(Generic[AnyDataFrame]):

    @property
    def original_data(self) -> AnyDataFrame:
        return self._original_data

    @original_data.setter
    def original_data(self, value: AnyDataFrame) -> None:
        self._original_data = value

I get mypy error: Need type annotation for "_original_data" [var-annotated]

I have to add the annotation as below to solve the error, why?

    @original_data.setter
    def original_data(self, value: AnyDataFrame) -> None:
        self._original_data: AnyDataFrame = value

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported Python snippet with mypy and inspect how the property getter, setter, TypeVar, and Generic class are analyzed. Read the diagnostic path for the unannotated _original_data attribute; done when the behavior is explained or the issue is narrowed to a reproducible type-checking defect.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.