lance-format/lance

Python: fix broken fragment APIs

Open

#1.006 geöffnet am 22. Juni 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (695 Forks)github user discovery
A-pythongood first issue

Repository-Metriken

Stars
 (6.582 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 1h) (219 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Überprüfen Sie die Fragment API Klassen (LanceFragment, FragmentMetadata) und ihre Methoden, um inkonsistente Rückgabetypen und Type Hints zu identifizieren. Bestimmen Sie den korrekten Rückgabetyp für jede Methode und stellen Sie Konsistenz her. Aktualisieren Sie dann die Type Hints und refaktorieren Sie den Code.
Tech Stack
python
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Pythonmypy
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60