Skip to content

py2sambvca v1.2.0

Compare
Choose a tag to compare
@JacksonBurns JacksonBurns released this 18 Apr 01:22
· 108 commits to main since this release
2eb14bb

What's Changed

This update to py2sambvca includes significant quality of life improvements for the codebase, as well as a complete backend re-write to enable the addition of a multitude of useful functions:

  • README now contains better examples
  • All functions interfacing with the output of py2sambvca now use a single internal get_regex function
  • Tests now cover 96% of the codebase
  • import has been dramatically simplified
  • All results from SambVca are readily accessible through getters and class attributes.

This minor version maintains complete backwards compatibility with previous versions of py2sambvca.

New Functions

Running is now simple with the single line run() function.

All values for the total complex, quadrants, and octants are available through getters:

Total Values:

  • get_free_volume()
  • get_buried_volume()
  • get_exact_volume()
  • get_total_volume()
  • get_percent_buried_volume()
  • get_percent_free_volume()
  • get_percent_total_volume()

Quadrant Values:

  • get_quadrant_free_volume()
  • get_quadrant_buried_volume()
  • get_quadrant_total_volume()
  • get_quadrant_percent_buried_volume()
  • get_quadrant_percent_free_volume()

Octant Values:

  • get_octant_free_volume()
  • get_octant_buried_volume()
  • get_octant_total_volume()
  • get_octant_percent_buried_volume()
  • get_octant_percent_free_volume()

Results can also be accessed through a general getter method: get(), get_quadrant_result(), and get_octant_result().

All results can also be directly accessed through dictionaries, returned from a call to run() or parse_output() and available through p2s.total_results, p2s.quadrant_results, and p2s.octant_results.

In case there is something else you are looking for, you can use a general purpose get_regex() function to return the line containing a pattern.

PR's and Changelog

Full Changelog: v1.1.0...v1.2.0