Skip to content

v1.3.0-beta

Choose a tag to compare

@joshduran joshduran released this 28 May 16:43
· 24 commits to master since this release

This release refactors a lot of the OPUS file code to be a bit more modular and separated into a larger number of files to improve clarity. While the release is labeled as beta, it is generally a stable release. This release supports a new report data type, and the beta is used to reflect the fact that the report functionality is still in flux and could potentially undergo breaking changes after feedback from users. The rest of the code should be considered stable.

New Features to OPUSFIle:

  • New Report and ReportTable classes introduced to provide access to report data stored in opus files.
  • Add table of contents (toc) feature to FileDirectory class to provide summary of blocks in the file and where they are stored in the OPUSFile class (useful for debugging and exploring file contents).
  • Blocks that have an error while parsing are stored in parse_error_blocks attribute to improve error handling for unexpected block characteristics.

Changes:

  • Introduced new BlockType class which is basically a tuple with some integrated convenience functions.
  • Documented warnings for depreciated functions (integrated into BlockType now): get_type_code_label, get_block_type_label,
  • Refactored OPUSFile class into a larger number of files to make it more clear which classes depend on each other, and make it quicker to find the code of interest.

To-Do before "Stable" Release:

  • Verify Report class is structured in a useful way (from user feedback)
  • Update documentation to explain some of the new features, including how to access data in Report.