lance-format/lance

Python: fix broken fragment APIs

Open

#1,006 opened on Jun 22, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Rust (695 forks)github user discovery
A-pythongood first issue

Repository metrics

Stars
 (6,582 stars)
PR merge metrics
 (Avg merge 6d 1h) (219 merged PRs in 30d)

Description

The APIs around getting and manipulating fragments are inconsistent with their return types.

In many cases, the type hint is wrong. For example, LanceFragment.create() claims to return LanceFragment (which would make sense), but instead returns _FragmentMetadata. Also odd that _FragmentMetadata has an underscore even though it is part of a public API.

We should refactor this to be consistent. Would also be nice to start enforcing the type hints with mypy.

Contributor guide

Research direction
Examine the fragment API classes (LanceFragment, FragmentMetadata) and their methods to identify inconsistent return types and type hints. Determine the correct return type for each method and ensure consistency. Then update the type hints and refactor the code to match.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
Pythonmypy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60