+
+# Audit import events? Note: this runs early in the lifetime of the
+# process (assuming that import bootstrap happens early); config has
+# (probably) not yet been loaded or parsed the commandline. Also,
+# some things have probably already been imported while we weren't
+# watching so this information may be incomplete.
+#
+# Also note: move bootstrap up in the global import list to catch
+# more import events and have a more complete record.
+IMPORT_INTERCEPTOR = None
+for arg in sys.argv:
+ if arg == '--audit_import_events':
+ IMPORT_INTERCEPTOR = ImportInterceptor()
+ sys.meta_path.insert(0, IMPORT_INTERCEPTOR)
+
+
+def dump_all_objects() -> None:
+ """Helper code to dump all known python objects."""
+
+ messages = {}
+ all_modules = sys.modules
+ for obj in object.__subclasses__():
+ if not hasattr(obj, '__name__'):
+ continue
+ klass = obj.__name__
+ if not hasattr(obj, '__module__'):
+ continue
+ class_mod_name = obj.__module__
+ if class_mod_name in all_modules:
+ mod = all_modules[class_mod_name]
+ if not hasattr(mod, '__name__'):
+ mod_name = class_mod_name
+ else:
+ mod_name = mod.__name__
+ if hasattr(mod, '__file__'):
+ mod_file = mod.__file__
+ else:
+ mod_file = 'unknown'
+ if IMPORT_INTERCEPTOR is not None:
+ import_path = IMPORT_INTERCEPTOR.find_importer(mod_name)
+ else:
+ import_path = 'unknown'
+ msg = f'{class_mod_name}::{klass} ({mod_file})'
+ if import_path != 'unknown' and len(import_path) > 0:
+ msg += f' imported by {import_path}'
+ messages[f'{class_mod_name}::{klass}'] = msg
+ for x in sorted(messages.keys()):
+ logger.debug(messages[x])
+ print(messages[x])
+
+
+def initialize(entry_point):
+ """
+ Remember to initialize config, initialize logging, set/log a random
+ seed, etc... before running main. If you use this decorator around
+ your main, like this::
+
+ import bootstrap
+
+ @bootstrap.initialize
+ def main():
+ whatever
+
+ if __name__ == '__main__':
+ main()
+
+ You get:
+
+ * The ability to break into pdb on unhandled exceptions,
+ * automatic support for :file:`config.py` (argument parsing)
+ * automatic logging support for :file:`logging.py`,
+ * the ability to enable code profiling,
+ * the ability to enable module import auditing,
+ * optional memory profiling for your program,
+ * ability to set random seed via commandline,
+ * automatic program timing and reporting,
+ * more verbose error handling and reporting,
+
+ Most of these are enabled and/or configured via commandline flags
+ (see below).
+ """
+
+ @functools.wraps(entry_point)