Skip to content

v1.0.0

Compare
Choose a tag to compare
@jettisonjoe jettisonjoe released this 23 Aug 23:57
· 452 commits to master since this release

Release Notes

Package Structure

We made some pretty big changes to package structure both to make things more intuitive and to rectify some potentially annoying name collisions. In particular:

  • ‘user_input’ was moved into ‘util’.
  • ‘conf’ was moved into ‘util’.
  • ‘exe’ was renamed to ‘core’.
  • ‘test_record’ was moved into ‘core’.
  • ‘station_api’ was moved into ‘core’.
  • ‘measurements’ was moved into ‘core’.
  • ‘monitors’ was moved into ‘core’.
  • ‘history’ was moved into ‘core’.
  • ‘io’ was renamed to ‘output’.
  • ‘io.output’ was renamed to ‘output.callbacks’.
  • ‘io.frontend’ was renamed to ‘output.web_gui’.
  • ‘names’ was removed.

Test script imports will need to be updated to reflect the new package structure. Additionally, we no longer recommend using *-style imports (as we used to with ‘names’). Instead, we recommend ‘import openhtf as htf’ for a better balance between explicitness and terseness.

Pylint Compliance

We updated our Python style throughout the code base to match with Google’s public Python style guide. We also updated our pylintrc to reflect this change. As part of this, many method names changed from camelCase to snake_case. For example:

test.Execute() → test.execute()
test.AttachFromFile(...) → test.attach_from_file(...)
some_measurement.InRange(...) → some_measurement.in_range(...)

And so on. Test scripts should be audited and updated to the new style, as any uses of the old camelCase methods will now break.

Frontend rewrite

There's a new frontend! Check it out.