Deferred review findings from the CLI and download PR series

Abierto
#173 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
python
Área
cli

Línea de trabajo

Start by reading the cited CLI and download PRs (#167–#172) and structural issues #159, #161, #162, #163; the findings span viral stores, exit statuses, shared options, and data commands. Check which findings remain relevant after those issues, then address a narrowly scoped item and verify its behavior with the relevant CLI tests. Several findings are explicitly superseded or folded into other work, so the issue does not define one standalone completion target.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

Code review of the CLI and download PR series (#167–#172) raised findings that were deliberately not fixed there. They are pre-existing gaps, pathological states, or cleanups that the structural issues (#159, #161, #162) will make easier or unnecessary. The blocking findings (regressions, data loss, false claims) were fixed in the PRs.

Viral stores (#170): mostly superseded once #159 moves collections onto VersionedDatasetRegistry

  • datacache.bundle_store is imported although DataCache doesn't export it (the import is isolated in _bundle_store() with a clear error). The durable fix is to export BundleStore and a diagnose/repair hook from DataCache.
  • _store_problem checks stores with rules that can differ from DataCache's own BundleStore checks, for example on stray .datacache-* files or a hard-linked or FIFO marker.
  • A future-dated stray entry under bundles/ sets the names of later bundles, and prune skips it.
  • select_viral_references copies from the collection bundle outside the collection lock, so a concurrent explicit prune_viral_references(keep=1) can delete its source mid-copy.
  • The store marker is written without fsync, and prune_viral_references reimplements prune_bundles.
  • prune_viral_references only reaches the current bundle version and index schema.
  • A damaged selection is hashed twice before it is rebuilt.
  • Replaced bundles are kept until an explicit prune (about 10 MB per refresh, by design).

Exit statuses (#172)

  • --reference and --asset on search-reference commands are checked separately, so a valid but mismatched pair exits 1 instead of 2.
  • Restricted-terms checks are duplicated per command (require_terms). A TermsNotAccepted(ValueError) raised by download_chain and fetch_data and mapped by ArgumentParser.fail would cover every caller.
  • Registry-file wrapping is duplicated in catalog_cli and dataset_cli, and ASSET=PATH parsing in catalog_cli, genomes_cli and download_cli (fold into #162 and #163).
  • Some option values are still validated only by library code and exit 1, as docs/cli.md says.

Shared options (#171)

  • share_cache_root must be called by hand at the end of each group's parser setup; a subcommand added after the call loses the option. --registry still works only before the subcommand.

Data commands (#168, #169)

  • A repair leaves the damaged DataCache generation on disk until the cache is pruned (documented).
  • _show writes its own truncation footer next to print_table's.
  • The focused commands (data catalog, data dataset, …) still need --force to repair a damaged install (#162 turns them into data fetch aliases).
Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
10 h 11 min
PR fusionados (30 d)
51

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de openvax/orfdata

Todos los issues de openvax/orfdata

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.