doc

Author: RobertCraigie

src/openai/_resources_proxy.py

@@ -7,6 +7,20 @@
 
 
 class ResourcesProxy(LazyProxy[Any]):
+    """A proxy for the `openai.resources` module.
+
+    This is used so that we can lazily import `openai.resources` only when
+    needed *and* so that users can just import `openai` and reference `openai.resources`
+
+    e.g.
+
+    ```py
+    import openai
+
+    completions: openai.resources.chat.Completions
+    ```
+    """
+
     _loaded = None
 
     @override
@@ -15,8 +29,8 @@ def __load__(self) -> Any:
             return self._loaded
 
         import importlib
-        mod = importlib.import_module('openai.resources')
-        self._loaded = mod
+
+        self._loaded = mod = importlib.import_module("openai.resources")
         return mod