Comments (7)
To check coverage locally I installed pytest-cov from https://pypi.python.org/pypi/pytest-cov and then ran:
py.test --cov pysoundfile.py
This prints a small summary on the terminal. To get a much nicer and very detailed HTML coverage report I did this:
py.test --cov pysoundfile.py --cov-report html
It can also check the coverage of the test code itself:
py.test --cov tests/ --cov-report html
from python-soundfile.
An alternative way to check the coverage is coverage.py.
coverage run --source pysoundfile.py -m py.test
coverage html
An advantage over the pytest-cov plugin is that it can check branch coverage:
coverage run --branch --source pysoundfile.py -m py.test
coverage html
from python-soundfile.
BTW, I changed my opinion regarding automated coverage reports:
We should not advertise the percentage of coverage because it is a very un-reliable metric for the quality of the code.
Therefore, automated coverage reports (e.g. after each commit) are not necessary.
I still think coverage reports are a useful tool for improving the tests, but it is sufficient to run coverage analysis locally.
We should probably add the aforementioned commands in the README file (#26).
from python-soundfile.
All of this sounds very reasonable. I agree that we don't need to advertise coverage in the README.
I think that the README should be primarily focused on getting users up to speed with the library. Coverage is probably not something a user is very concerned with (except maybe as a weak measure of code quality). I therefore think that it is unnecessary to even put the commands in the README.
Plus, we don't ship any special accomodations for coverage reports and you can use any coverage tool you like to generate coverage reports. This is another reason why we probably should not put instructions for one particular tool into the README.
This is purely my intuition talking though. We could look at a few other projects and see how they are doing it.
from python-soundfile.
OK, the README is probably the wrong place for that.
But I think it could be nice to have a section somewhere in the Sphinx documentation for potential contributors where we could mention the tools we use on the development side.
This would also serve as a reminder for me, because I tend to forget the exact command line arguments.
from python-soundfile.
Great idea!
from python-soundfile.
As we agreed that automated coverage reports are not necessary, I'm closing this issue.
Documentation of coverage tools will be done in #66.
from python-soundfile.
Related Issues (20)
- numpy is a dependency, but this is not declared HOT 3
- Feature request: Support interleaved stereo data HOT 4
- buffer_read doesn't work in basic test HOT 2
- Soundfile read/write wav is not symmetric with default arguments HOT 3
- module 'soundfile' has no attribute 'SoundFileRuntimeError' HOT 5
- Value Error: array is too big when loading .flac file
- soundfile crashes when trying to export long .ogg file HOT 1
- soundfile.LibsndfileError: Error opening <_io.BytesIO object at 0x0000022B81C21850>: Format not recognised. HOT 2
- Cannot suppress warnings when decoding mp3
- Cannot open Ogg FLAC file: unknown error in flac decoder HOT 1
- miniforge3/lib/python3.9/site-packages/soundfile.py", line 1229, in _init_virtual_io def vio_get_filelen(user_data): MemoryError: Cannot allocate write+execute memory for ffi.callback(). You might be running on a system that prevents this. For more information, see https://cffi.readthedocs.io/en/latest/using.html#callbacks
- Cannot write Ogg files over 96 seconds long at 44.1 kHz HOT 4
- soundfile.info does not work on mp3 HOT 2
- soundfile.LibsndfileError: <exception str() failed> HOT 6
- How to save left and right channel in separate files? HOT 1
- soundfile.LibsndfileError: Error : unknown error in flac decoder. HOT 2
- "Format not recognised." for m4a files HOT 2
- soundfile.LibsndfileError: Error opening <tempfile._TemporaryFileWrapper object at 0x7feadae59070>: Format not recognised. HOT 2
- Part of mp3 is loaded. HOT 2
- unknown error in flac decoder HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from python-soundfile.