New python library for deferred loading

[etrombly]

I recently added lazyloader from tensorflow to freecad. The pull was merged so it's available on master. If your workbench is importing a module that is a little slow, you can defer loading until first usage. This really helps with workbench loading times. Here's how you use it:

Code: Select all

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")

[vocx]

Code: Select all

numpy = LazyLoader("numpy", globals(), "numpy")
whatever = LazyLoader("module", globals(), "module.whatever")

I'm not sure of these two calls.

Can you do this as well?

Code: Select all

whatever = LazyLoader("module.whatever", globals(), "module.whatever")

The first argument must be a module, is this right? The third argument seems to be whatever object you are importing, that is, the module itself, a class, or variable, or what?

[etrombly]

The first variable is the package or module name, the second variable is the parents globals, the third variable is the package or package and submodule. You can't pull in functions though, it has to be a package or module. I actually haven't tried it the way you called it, with module.whatever as the first variable, the examples had it how I showed it. You'd have to try to see if it works that way.

[Kunda1]

The first variable is the package or module name, the second variable is the parents globals, the third variable is the package or package and submodule. You can't pull in functions though, it has to be a package or module. I actually haven't tried it the way you called it, with module.whatever as the first variable, the examples had it how I showed it. You'd have to try to see if it works that way.

Can we get some documentation on this neat new functionality ?

[etrombly]

Sure, where do you think it should go? The wiki?

[Kunda1]

Sure, where do you think it should go? The wiki?

I think so. Do you have wiki access ?

[etrombly]

No, I just started contributing recently.

[vocx]

Can we get some documentation on this neat new functionality ?

I'm not sure what sort of additional documentation you need. The usage is pretty much what is described in the first post. And this is already documented in the source code, in src/3rdParty/lazy_loader/__init__.py

Essentially we just need to change the first and third arguments and that's all there is to it to defer the import of that particular module.

[Kunda1]

I'm not sure what sort of additional documentation you need. The usage is pretty much what is described in the first post. And this is already documented in the source code, in src/3rdParty/lazy_loader/__init__.py

Instead of devs digging through the code to learn that we're experimenting with this third party lib, we can mention it's existence and a short synopsis of what it does and how to use it. Perhaps link to the code itself? (ideally we could link to the generated API documentation).

[etrombly]

Added it to the extra python modules page of the wiki, it's at the bottom. https://wiki.freecadweb.org/Extra_python_modules