Generalimport
Handle all your optional dependencies with a single call!
Install / Use
/learn @ManderaGeneral/GeneralimportREADME
Handle all your optional dependencies with a single call!
<details> <summary><h2>Table of Contents</h2></summary> <pre> <a href='#generalimport'>generalimport</a> ├─ <a href='#Dependency-Diagram-for-ManderaGeneral'>Dependency Diagram for ManderaGeneral</a> ├─ <a href='#Installation-showing-dependencies'>Installation showing dependencies</a> ├─ <a href='#Information'>Information</a> ├─ <a href='#Examples'>Examples</a> │ ├─ <a href='#Minimal-Example'>Minimal Example</a> │ ├─ <a href='#Tests-Showcase'>Tests Showcase</a> │ ├─ <a href='#Recommended-Setup'>Recommended Setup</a> │ └─ <a href='#How-It-Works'>How It Works</a> ├─ <a href='#Attributes'>Attributes</a> └─ <a href='#Contributions'>Contributions</a> </pre> </details> <details open> <summary><h2>Dependency Diagram for ManderaGeneral</h2></summary>flowchart LR
0([import]) --> 3([file])
0([import]) --> 2([library])
1([tool]) --> 2([library])
3([file]) --> 4([packager])
2([library]) --> 4([packager])
2([library]) --> 3([file])
click 0 "https://github.com/ManderaGeneral/generalimport"
click 1 "https://github.com/ManderaGeneral/generaltool"
click 2 "https://github.com/ManderaGeneral/generallibrary"
click 3 "https://github.com/ManderaGeneral/generalfile"
click 4 "https://github.com/ManderaGeneral/generalpackager"
style 0 stroke:#482
| pip install | generalimport |
|:------------------|:------------------|
| No dependencies | ✔️ |
| Package | Ver | Latest Release | Python | Platform | Cover | |:-----------------------------------------------------------------|:-------------------------------------------------|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------|:--------| | generalimport | 0.5.2 | 2024-01-24 07:20 CET | 3.8, 3.9, 3.10, 3.11, 3.12 | Windows, Ubuntu | 97.2 % |
</details> <details open> <summary><h2>Examples</h2></summary> <details open> <summary><h3>Minimal Example</h3></summary>Call generalimport before importing any optional dependencies.
from generalimport import generalimport
generalimport("notinstalled")
from notinstalled import missing_func # No error
missing_func() # Error occurs here
MissingDependencyException: Optional dependency 'notinstalled' was used but it isn't installed.
Imports fail when they are used, not imported.
This means you don't need to keep checking if the package is installed before importing it. Simply import your optional package and use it like you would any package and let it fail wherever it fails, with a nice error message.
</details> <details> <summary><h3>Tests Showcase</h3></summary>The beauty of this package is that the error raised isn't just any exception.
It has two base classes: unittest.case.SkipTest and _pytest.outcomes.Skipped (If available).
This means that if a test method uses an uninstalled optional package then that test is automatically skipped. This means no more manual skip decorators for optional dependencies!
from generalimport import generalimport
generalimport("optional_uninstalled_package")
from optional_uninstalled_package import missing_func
from unittest import TestCase
class MyTest(TestCase):
def test_missing_func(self):
self.assertEqual(3, missing_func(1, 2))
Ran 1 test in 0.002s
OK (skipped=1)
Skipped: Optional dependency 'optional_uninstalled_package' was used but it isn't installed.
Put this in your __init__.py file to affect all imports inside the folder __init__.py resides in.
from generalimport import generalimport
generalimport("your", "optional", "dependencies")
generalimport("*") makes it handle all names (If missing of course)
:warning: generalimport("*")._scope = None disables the scope
- Makes it handle missing imports anywhere
- For example it will override
pandasinternal custom optional dependency handling
- When
generalimportis instantiated it creates a new importer forsys.meta_path. - This importer will return 'fake' modules for matching names and scope.
- The scope ensures only your own imports are faked.
- The fake module will recursively return a FakeModule instance when asked for an attribute.
- When used in any way (__call__, __add__, __str__ etc) it raises
generalimport.MissingDependencyException. - This exception has the 'skip-exceptions' from
unittestandpytestas bases, which means that tests will automatically be skipped.
Issue-creation, discussions and pull requests are most welcome!
</details> <sup> Generated 2024-01-24 07:20 CET for commit <a href='https://github.com/ManderaGeneral/generalimport/commit/master'>master</a>. </sup> </details