Use a single `path` argument (and deprecate `pn_dir` and `file_name`)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 853
- Forks
- 322
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Currently the WFDB API uses 2 arguments to specify the location of files: pn_dir and file_name. This is confusing for users and confusing for developers (e.g. see: https://github.com/MIT-LCP/wfdb-python/pull/523/files).
I think the reason for having two arguments is to support auto-detection of files (e.g. get locally if local and if not get from the PhysioNet servers). This kind of behaviour doesn't seem like a good idea. If WFDB is retrieving a remote file, it should be explicit.
My preference would be to:
- Introduce a new
pathargument - Deprecate
pn_dirandfile_name - Remove any logic that automatically retrieves files from remote servers.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die WFDB-API-Einstiegspunkte nachzuverfolgen, die pn_dir und file_name akzeptieren, und ermittle anschließend die Logik, die Dateien automatisch von PhysioNet-Servern abruft. Definiere die betroffenen Aufrufe und das Kompatibilitätsverhalten, bevor du sie änderst. Als abgeschlossen gilt die Arbeit, wenn ein einzelnes path-Argument unterstützt wird, die älteren Argumente als veraltet markiert sind und der implizite Abruf aus der Ferne entfernt wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- backend-api-design
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100