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

Refactor compressors to be in separate files #153

Merged
merged 7 commits into from
Oct 21, 2024
Merged

Conversation

asinghvi17
Copy link
Member

@asinghvi17 asinghvi17 commented Aug 19, 2024

This PR reformats the compressors to be in a folder with separate files, and documents the "compressor API".

(Previous commits added the fletcher32 filter as a compressor, but on review that should be a filter so I'll put it in a new PR.)

Refactors each compressor into a single file and the abstract API + NoCompressor to `Compressors/Compressors.jl`.  Also adds API docs for the Compressor API in case people want to do that.

Future work may also explore making this compliant with Interfaces.jl so that we have a way to test that all compressors are compliant.
@coveralls
Copy link

coveralls commented Aug 19, 2024

Pull Request Test Coverage Report for Build 10492471554

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 51 of 55 (92.73%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-2.5%) to 86.192%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/Compressors/blosc.jl 18 19 94.74%
src/Compressors/Compressors.jl 22 25 88.0%
Totals Coverage Status
Change from base Build 8981180163: -2.5%
Covered Lines: 799
Relevant Lines: 927

💛 - Coveralls

TODO: there must be a better solution than this!
@asinghvi17
Copy link
Member Author

asinghvi17 commented Aug 19, 2024

I've implemented fletcher32 compression in this last commit, and am testing it with unit tests copied from the Python package. I'm not sure what the best way to load it in integration testing is though, so could use a hand with that!

All new filters (including fletcher32) will be in a new PR!

@asinghvi17 asinghvi17 changed the title [WIP] Add more compressors Refactor compressors to be in separate files Aug 20, 2024
@asinghvi17 asinghvi17 marked this pull request as ready for review August 20, 2024 16:31
@asinghvi17
Copy link
Member Author

That's strange - tests are all passing, but the build failed when it came time to upload the codecov data, saying the job was already closed.

@asinghvi17
Copy link
Member Author

Error: Bad response: 422 {"message":"Can't add a job to a build that is already closed. Build 10492471554 is closed. See docs.coveralls.io/parallel-builds","error":true}

(this line repeats in every log from the failed CI)

@meggart
Copy link
Collaborator

meggart commented Aug 22, 2024

Is this ready to be merged? Or do you want to fix something in the CI pipeline first?

@asinghvi17
Copy link
Member Author

Let's merge this, I'll fix the pipeline in another PR.

@meggart meggart merged commit 9a8892a into master Oct 21, 2024
5 of 10 checks passed
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.

3 participants