From 22c8d390a5c8c412a860226f568f9dab265ee6db Mon Sep 17 00:00:00 2001 From: Eric Trombly Date: Tue, 14 Apr 2020 10:44:15 -0500 Subject: [PATCH] add docstring to __init__.py --- src/3rdParty/lazy_loader/__init__.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/3rdParty/lazy_loader/__init__.py b/src/3rdParty/lazy_loader/__init__.py index e69de29bb2..db8200b5bc 100644 --- a/src/3rdParty/lazy_loader/__init__.py +++ b/src/3rdParty/lazy_loader/__init__.py @@ -0,0 +1,13 @@ +""" +LazyLoader will defer import of a module until first usage. Usage: +from lazy_loader.lazy_loader import LazyLoader +numpy = LazyLoader("numpy", globals(), "numpy") + +or + +whatever = LazyLoader("module", globals(), "module.whatever") + +or to replicate import module as something + +something = LazyLoader("module", globals(), "module") +""" \ No newline at end of file