madpah/serializable

PyLance does not appreciate @serializable.serializable_class

Open

#8 opened on Jun 15, 2023

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)Python (5 forks)auto 404
help wanted

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

Inadvertantly opened this ticket half way through writing the subject.

PyLance thinks that serializable.serializable_class decorated classes are untyped. I'm unsure if there is a proper way to resolve type based issues. The "fix" seems to be to have one undecorated class and one decorated class that references the former: i.e. "MyThing" and "SerializableMyThing" in order to allow for casting in individual programs.

Looking forward to some insight on this. CycloneDX-Python-Lib makes use of this library and it can be a bit cumbersome to work with classes provided by that library. Attempting to cast falls into the same trap.

Contributor guide

Research direction
Investigate PyLance's type checking for decorated classes. Check if @serializable.serializable class returns a class or modifies the class in a way that hides type information. Explore adding type stubs or using typing.cast to provide type hints.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonType Hints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40