REF/FIX: more lazily load the happi container registry

klauer commented 2 years ago

Description

Load the happi container registry on the first access and not on import
Add documentation about the registry
Add type hints for the registry
Add a companion __setitem__ for the ability to externally add items to the container registry.
- That is, registry[name] = ContainerClass

Motivation and Context

Fixes scenario where a module including a happi container also attempts to import from happi (as @tangkong found)

How Has This Been Tested?

We don't really have a test suite for the registry
It's tested implicitly through the client/CLI tests

Where Has This Been Documented?

This PR text.

Screenshots

tangkong commented 2 years ago

This seems to break happi container-registry for me. I'll keep looking into it though

klauer commented 2 years ago

This seems to break happi container-registry for me. I'll keep looking into it though

This was a bug in the CLI code, reaching into the internals instead of using public API. (f60804d) Apparently this is also uncovered in the test suite?

tangkong commented 2 years ago

~~I just arrived at that too. We can tackle both in a separate PR. I'll throw up an issue~~

nvm you're too quick for me

ZLLentz commented 2 years ago

I only saw the one thing- I think this is a very positive change

pcdshub / happi