Skip to content

Comments

feat!: break annotator tools into separate submodule#494

Merged
jsstevenson merged 3 commits intomainfrom
annotator-module-structure
Feb 5, 2025
Merged

feat!: break annotator tools into separate submodule#494
jsstevenson merged 3 commits intomainfrom
annotator-module-structure

Conversation

@jsstevenson
Copy link
Contributor

@jsstevenson jsstevenson commented Feb 5, 2025

  • We have long bristled at the naming incongruence between vcf_annotation.py and translator.py. This makes the former consistent with the latter.
  • Anticipating the possibility that we may want to annotate other kinds of files in the future, this makes annotator a package within extras, containing a vcf module. Also breaks the CLI into a separate module.

proposed module structure:

src/ga4gh/vrs/extras
├── __init__.py
├── annotator
│   ├── __init__.py
│   ├── cli.py
│   └── vcf.py
├── decorators.py
├── object_store.py
└── translator.py

@jsstevenson jsstevenson marked this pull request as ready for review February 5, 2025 20:08
@jsstevenson jsstevenson requested review from a team as code owners February 5, 2025 20:08
@jsstevenson jsstevenson added the priority:medium Medium priority label Feb 5, 2025
@pytest.mark.vcr
def test_get_vrs_object_invalid_input(vcf_annotator, caplog):
"""Test that _get_vrs_object method works as expected with invalid input"""
# some tests are check
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think this is complete?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah not sure what happened there

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The author was assassinated mid-sentence

@jsstevenson jsstevenson merged commit 1eedb12 into main Feb 5, 2025
14 checks passed
@jsstevenson jsstevenson deleted the annotator-module-structure branch February 5, 2025 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants