Record-model and measurement helpers are private but imported across modules (_species, _contig, _Record)
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
- 45/100
- Tipo de issue
- Refactorización
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- backend, developer-experience
Línea de trabajo
Start with the cited helpers in orfdata/model.py, orfdata/measurements.py, and the listed source adapter modules at revision d8ab958; trace their imports across the package. The issue suggests public names and documentation for shared helpers, plus consolidating GTF exon grouping. Done means shared helpers no longer rely on cross-module private imports, with tests covering the affected public behavior; the issue does not name specific tests.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
Core ORFdata helpers are written as _private functions and then imported across the package: 50 distinct _names at 91 import sites in 27 modules. #161 covers the resource-kind modules (viral_panel, liftover, genomes, catalog._BUNDLED/_installed/_plan), and #180 moves datasets._datacache/_digest/_installed_path into a public orfdata.cache. This issue covers the rest, mostly the record model and the measurement records, which no open issue or PR touches. Because of the underscore, these shared contracts carry no stability promise, and several (_species, _identifier, _metadata) have no docstring. One of them, _species, only aliases a public function.
Evidence
Read at d8ab958.
orfdata/model.py:227-228_species(value)isreturn canonical_species(value), an alias of a public function. It is imported bycatalog.py:28,genomes.py:43,liftover.py:238,322andproteome.py:2135.liftover.py:172imports a_speciesfromcataloginstead, which is the same object re-exported.orfdata/model.py:219_contig(contig comparison key) is imported by six modules:catalog.py:28,proteome.py:28,rna.py:189,_structure.py:131,liftover.py:75,128andsources/riborf_native.py:11.model._id_forms,_versioned,_exon_layout,_layout_offset,_same_assembly,_merge,_rna_layout,_layout_blocksand_transcript_matchare imported bycatalog.py,proteome.pyandrna.py.orfdata/measurements.py:72class _Recordsuppliesto_dict/from_dictfor 13 public classes, includingSourceAsset,DatasetManifestandMeasurementinmeasurements.py,CatalogManifest(catalog_manifest.py:12),SearchReferenceSpec(search_reference.py:17),ReferenceMapping(reference_mapping.py:19) andAssayPair(pairing.py:49).measurements._identifier(:47) and_metadata(:52) are imported, between them, bycatalog_manifest.py,reference_mapping.py,search_reference.py,pairing.pyanddataset.py.- Source adapters import each other's internals:
sources/riborf.py:48importsncorf_mammals._blocksand_transcripts, andsources/riborf_native.py:15-16importsncorf_mammals._ATTRIBUTE,_blocks,riborf._parsedand_rows.
Suggested fix
- Replace
_specieswith direct calls tocanonical_species, and delete the alias. - Make
_Record,_identifierand_metadatapublic and documented, for exampleorfdata.measurements.Record,require_identifierandfreeze_metadata, or move them into a smallorfdata.recordsmodule. - Give the shared transcript-layout helpers in
model.py(_contig,_exon_layout,_layout_offset,_versioned,_id_forms) public names and numpy docstrings. - Move the GTF exon grouping that
riborf,riborf_nativeandncorf_mammalsshare into one public helper (see the GTF reader issue).
- 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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openvax/orfdata
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 42/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
openvax/orfdata#194 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
Los mantenedores suelen responder en 1 día
Todos los issues de openvax/orfdata
Issues similares
-
[Bug]: DoubleMLData.from_arrays checks the treatment d with force_all_x_finite instead of force_all_d_finitePosiblemente ocupada @leninworld la tomó hoy. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
DoubleML/doubleml-for-py#471 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
python-pillow/Pillow#10590 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
BUG: ZarrTrace fails in init_trace for models with datetime coordinates (object dtype coord array)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 2 días