ImperialCollegeLondon/PyProBE

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

Open

#304 opened on Jul 1, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (19 forks)auto 404
featurefrontendgood first issue

Repository metrics

Stars
 (51 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Investigate using Python's difflib or fuzzywuzzy to add fuzzy matching to Result.get(). Implement a method that suggests similar keys on mismatch, following existing code patterns. Update tests and documentation.
Tech stack
python
Domain
backend
Issue type
Feature
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70