Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

augur {read,write}-file #1562

Merged
merged 1 commit into from
Aug 1, 2024
Merged

augur {read,write}-file #1562

merged 1 commit into from
Aug 1, 2024

Conversation

tsibley
Copy link
Member

@tsibley tsibley commented Jul 30, 2024

Add commands to read and write files using Augur's conventions. This allows external programs to do i/o like Augur by piping from/to augur read-file or augur write-file. In some simple testing, the overhead of passing text i/o thru Python vs. not is minimal for our use cases and worth the cost of consistent compression and newline handling.

I'll be using this to allow SQLite to read/write files like Augur.

Checklist

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

Add commands to read and write files using Augur's conventions.  This
allows external programs to do i/o like Augur by piping from/to `augur
read-file` or `augur write-file`.  In some simple testing, the overhead
of passing text i/o thru Python vs. not is minimal for our use cases and
worth the cost of consistent compression and newline handling.

I'll be using this to allow SQLite to read/write files like Augur.
Copy link

codecov bot commented Jul 31, 2024

Codecov Report

Attention: Patch coverage is 71.42857% with 10 lines in your changes missing coverage. Please review.

Project coverage is 70.22%. Comparing base (2c88298) to head (54ebcf3).
Report is 127 commits behind head on master.

Files with missing lines Patch % Lines
augur/read_file.py 63.63% 8 Missing ⚠️
augur/write_file.py 84.61% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1562   +/-   ##
=======================================
  Coverage   70.22%   70.22%           
=======================================
  Files          74       76    +2     
  Lines        7952     7987   +35     
  Branches     1945     1947    +2     
=======================================
+ Hits         5584     5609   +25     
- Misses       2082     2092   +10     
  Partials      286      286           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@genehack genehack left a comment

Choose a reason for hiding this comment

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

no tests?

@tsibley
Copy link
Member Author

tsibley commented Aug 1, 2024

no tests?

Ha… yeah… I'm mostly a "tests optional" sort of person naturally. I like integration tests and unit tests for tricky or brittle behaviour, but am not a test maximalist. I've seen way too many large test suites made mostly of useless tests. But, I'll adhere to project/team expectations if Augur/we are "tests for new additions"!

@tsibley tsibley merged commit e62252f into master Aug 1, 2024
28 checks passed
@tsibley tsibley deleted the trs/read-write-file branch August 1, 2024 00:54
@genehack
Copy link
Contributor

genehack commented Aug 1, 2024

no tests?

Ha… yeah… I'm mostly a "tests optional" sort of person

Fair enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants