lance-format/lance

Python: fix broken fragment APIs

Open

#1 006 ouverte le 22 juin 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)Rust (695 forks)github user discovery
A-pythongood first issue

Métriques du dépôt

Stars
 (6 582 stars)
Métriques de merge PR
 (Merge moyen 6j 1h) (219 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez les classes d'API de fragments (LanceFragment, FragmentMetadata) et leurs méthodes pour identifier les types de retour et les indications de type incohérents. Déterminez le type de retour correct pour chaque méthode et assurez la cohérence. Mettez ensuite à jour les indications de type et refactorisez le code.
Stack technique
python
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Pythonmypy
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60