Use a single `path` argument (and deprecate `pn_dir` and `file_name`)

Offen
#534 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Refactoring
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python

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.

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 path argument
  • Deprecate pn_dir and file_name
  • Remove any logic that automatically retrieves files from remote servers.
Vorherrschende Sprache
Jupyter Notebook
Sterne
853
Forks
322
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus MIT-LCP/wfdb-python

Alle Issues in MIT-LCP/wfdb-python

Ähnliche Issues

Weitere Issues zu Backend & API Design

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.