Implemented contains for BoundingBox containing other BoundingBox

[MicahGale]

Description

This is a quality of life feature request that tests if things are inside of a BoundingBox. Originally the goal was to have if point in box and if other_box in box. Turns out since #2759, if point in box has been implemented.

This PR does the following:

• Implement checking if a bounding box is inside of another: if other_box in box
• Implements length enforcement for points so: [1]*100 in box gives a helpful error.
• Implements type checking so if "foo" in box gives a helpful error.
• Adds two unit tests to test the __contains__ function for BoundingBox to test it's accuracy, and the other tests it's error handling.

It is unclear if this should be explicitly documented for users or not.

Fixes #2896

Checklist

• I have performed a self-review of my own code
• I have followed the style guidelines for Python source files (if applicable)
• I have made corresponding changes to the documentation (if applicable)
• I have added tests that prove my fix is effective or that my feature works (if applicable)

[MicahGale]

@shimwell, do you want to look at this since it seems like you did the initial implementation for this.

[shimwell]

This looks like a useful feature to me. I've made a few comments for consideration but nothing major

I would recommend one more test that checks a bounding box is in another bounding box when the first bounding box is only partly within. This would return false.

[MicahGale]

Ok that test was added. I also added one for one of the vertices being coincident because the objects were right there.

[shimwell]

A nice PR that improves on the existing contains method to supports bounding boxes, includes tests, doc strings updates, pep8 formatting. All looks good to me and I'm happy to merge this one in. Many thanks for this improved method

Will merge Tuesday afternoon (UK time) if there are no objections.

[MicahGale]

Thanks @shimwell.

[paulromano]

I'd like to take a look at this before we merge. Sorry to delay! Will get a review in asap