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

--[BE] - Miscellaneous minor refactors and cleanup #2516

Merged
merged 6 commits into from
Dec 17, 2024
Merged

Conversation

jturner65
Copy link
Contributor

@jturner65 jturner65 commented Dec 8, 2024

Motivation and Context

This PR will contain various minor refactors and cleanup that I find as I complete other BE work that may be thematically orthogonal to the purpose of that work.

An important issue this PR addresses is that the python tests will currently abort if Habitat-sim is compiled with audio support. This is due to the import of habitat_sim in conftest.py causing an invalid free() unless the python quaternion library is imported first. This is discussed in this issue. Until a reason for this aberrant behavior can be determined, quaternion will be imported here so tests and examples don't fail.

NOTE : There is still an ongoing issue with running python tests with the audio subsystem enabled during compilation, where a greedy path without any action noise is perceived somehow as being a PyCapsule object; addressing that is beyond the scope of this PR.

How Has This Been Tested

locally c++ and python tests

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Dec 8, 2024
@jturner65 jturner65 requested a review from aclegg3 December 8, 2024 15:53
If not imported here and sim is compiled with audio support, python tests will abort due to the habitat_sim import causing an invalid free() error
@jturner65 jturner65 changed the title --[BE][WIP] - Miscellaneous minor refactors and cleanup --[BE] - Miscellaneous minor refactors and cleanup Dec 17, 2024
Copy link
Contributor

@aclegg3 aclegg3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yuck, but thanks for patching it and I appreciate the comments for future BE clarity. 👍

@aclegg3 aclegg3 marked this pull request as ready for review December 17, 2024 18:07
@jturner65 jturner65 merged commit 338fb2f into main Dec 17, 2024
7 checks passed
@jturner65 jturner65 deleted the BE_MiscRefactors branch December 17, 2024 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants