bloomberg / bloomberg/python-comdb2

Type Checking for Class Row Factory

Ouverte
#60 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
29
Forks
28
Merge moyen
11 h 25 min
PR mergées (30 j)
2

Description

As described in Issue #42 there was a proposed solution for having a Class Row Factory. Alongside the conversations happened there, there was a concern regarding type checking for the attributes of the class and output returned by the database. There doesn't seem to be a way to enforce type checking hence an extra `__post_init__` method would be required within the class to enforce type checking. This can be overlooked by a lot of developers and can lead to a lot of type mismatches.

## Solution
Define a Base class that our dataclasses can inherit. The Base class can have all the required methods for the validation etc.

The updated use of it can be described it here. The solution has been implemented on the PR #57
```
>>> from dataclasses import dataclass
>>> from comdb2.dataclasses.class_row_factory import BaseRowFactoryClass
...
>>> @dataclass
>>> class ABC(BaseRowFactoryClass):
>>> x: int
>>> y: int

...
>>> conn.row_factory = ClassRowFactory(ABC)
>>> row = conn.cursor().execute("select 1 as x, 2 as y").fetchone()
>>> print(row)
<>
>>> print(row.x)
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Examinez d’abord Issue #42 et PR #57, puisque la solution proposée y est décrite. Inspectez ensuite comdb2.dataclasses.class_row_factory et comparez l’exemple BaseRowFactoryClass avec le problème de vérification des types mentionné. La tâche est terminée lorsqu’il est confirmé que le PR traite complètement la validation des attributs de dataclass et de la sortie de la base de données.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
databases
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.