ImperialCollegeLondon/PyProBE

Add fuzzy string matching to pyprobe.result.Result.get() method

Offen

#304 geöffnet am 01.07.2025

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (19 Forks)auto 404
featurefrontendgood first issue

Repository-Metriken

Stars
 (51 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The pyprobe.result.Result.get() method should support fuzzy string matching to enhance usability when querying for results with approximate or similar string keys. This feature will help users retrieve values even when there are minor typos or differences in the key strings, making the method more robust and user-friendly. Consider using a library like fuzzywuzzy or Python's difflib for the implementation. Include tests and documentation for the new fuzzy matching capability.

Example. result.get("Voltage (V)") should return a "did you mean "Voltage [V]".

Contributor Guide

Research-Richtung
Untersuche die Verwendung von difflib oder fuzzywuzzy in Python, um unscharfe Übereinstimmungen zu Result.get() hinzuzufügen. Implementiere eine Methode, die bei Nichtübereinstimmung ähnliche Schlüssel vorschlägt, den bestehenden Code Mustern folgend. Aktualisiere Tests und Dokumentation.
Tech Stack
python
Domain
backend
Issue Type
Funktion
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70