LinearTapeFileSystem / LinearTapeFileSystem/ltfs

ltfs_ordered_copy QoL features (type annotations, etc.)

Offen
#548 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
C
Sterne
352
Forks
110
Ø Merge
2 Std. 50 Min.
Gemergte PRs (30 T.)
2

Beschreibung

Is your feature request related to a problem? Please describe.
Not a problem per se, rather a minor inconvenience (and offer for contribution): the ltfs_ordered_copy script lacks several "creature comforts"/conveniences found in modern python modules (e.g.: type annotations) - I assume this is with a view to maximising compatibility.

Describe the solution you'd like
Without knowing the appetite of the maintainers for breaking compatibility with older python versions (and/or introducing an entirely new script with greater minimum python version requirements - messy IMHO), the following solutions could be considered:

  • (non-breaking) a low-friction solution for type annotations specifically would be a stub file.
  • (non-breaking) adding docstrings (optionally with an established style, e.g.: numpy) aids readability.
  • (breaking) if a (new) minimum version can be established, various other readability improvements enabled by in-language features (e.g.: f-strings, more concise/readable variants of standard library functions (such as those in pathlib)) could be implemented.

Describe alternatives you've considered
The above are three "alternatives" (non-mutually-exclusive) I've considered; a fourth would be "do nothing". I personally plan to utilise some of the classes within my own work, so will likely invest effort "modernising" regardless - while I could hypothetically maintain a fork of this entire repository for the sake of one script, this overhead is a disincentive, and realistically other users are unlikely to stumble across such a fork; including modernising updates in the upstream makes this work available to a broader user base.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das Skript ltfs_ordered_copy zu finden und die vom Repository unterstützten Python-Versionen zu prüfen. Prüfe die vorgeschlagenen Alternativen – Stub-Dateien, Docstrings oder neuere Sprachfunktionen – und bestätige die Kompatibilitätspräferenz der Maintainer, bevor du den Arbeitsumfang festlegst. Als erledigt gilt, wenn ein vereinbarter, abgegrenzter Modernisierungsumfang umgesetzt ist, ohne nicht spezifizierte Kompatibilitätsänderungen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
cli
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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