# Lazy-Imports
[](https://github.com/telekom/lazy-imports/blob/main/LICENSE)
[](https://github.com/telekom/lazy-imports/blob/main/CODE_OF_CONDUCT.md)
[](https://www.python.org)
[](https://pypi.python.org/pypi/lazy-imports)
<br/>
[](https://github.com/telekom/lazy-imports/actions/workflows/pytest.yml)
[](https://github.com/telekom/lazy-imports/actions/workflows/static_checks.yml)
[](https://github.com/telekom/lazy-imports/issues)
This is a Python tool to support lazy imports.
Likewise, the actual initialization of the module does not occur until usage time
to postpone `ModuleNotFoundError`s to the time of the actual usage of the module.
This is useful when using various optional dependencies which might not all be
installed or which have high load times and/or ressource consumption.
## Table of Contents
- [Maintainers](#maintainers)
- [Installation](#installation)
- [Usage & Example for LazyImporter](#usage--example-for-lazyimporter)
- [Usage & Example for try_import](#usage--example-for-try_import)
- [Support and Feedback](#support-and-feedback)
- [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities)
- [Contribution](#contribution)
- [Code of Conduct](#code-of-conduct)
- [Licensing](#licensing)
## Maintainers
[](https://www.welove.ai/)
<br/>
This project is maintained by the [One Conversation](https://www.welove.ai/)
team of [Deutsche Telekom AG](https://www.telekom.com/).
It is based on
[`_LazyModule`](https://github.com/huggingface/transformers/blob/e218249b02465ec8b6029f201f2503b9e3b61feb/src/transformers/file_utils.py#L1945)
from [HuggingFace](https://huggingface.co/) and
[`try_import()`](https://github.com/optuna/optuna/blob/1f92d496b0c4656645384e31539e4ee74992ff55/optuna/_imports.py#L89)
from the [Optuna framework](https://optuna.readthedocs.io/).
Many thanks to HuggingFace for
[your consent](https://github.com/huggingface/transformers/issues/12861#issuecomment-886712209)
and to Optuna for
[your consent](https://github.com/optuna/optuna/issues/2776#issuecomment-874614137)
to publish it as a standalone package 🤗 ♥.
## Installation
Lazy-Imports is available at [the Python Package Index (PyPI)](https://pypi.org/project/lazy-imports/).
It can be installed with pip:
```bash
$ pip install lazy-imports
```
## Usage & Example for LazyImporter
A good and easy to understand example of how to use Lazy-Imports can be found in the
[`__init__.py` file of the HPOflow package](https://github.com/telekom/HPOflow/blob/1b26f3b86cad607dd89a31fa9135256d956948cb/hpoflow/__init__.py).
It is printed here:
```python
import sys
from typing import TYPE_CHECKING
from lazy_imports import LazyImporter
from hpoflow.version import __version__
_import_structure = {
"mlflow": [
"normalize_mlflow_entry_name",
"normalize_mlflow_entry_names_in_dict",
"check_repo_is_dirty",
],
"optuna": ["SignificanceRepeatedTrainingPruner"],
"optuna_mlflow": ["OptunaMLflow"],
"optuna_transformers": ["OptunaMLflowCallback"],
"utils": ["func_no_exception_caller"],
}
# Direct imports for type-checking
if TYPE_CHECKING:
from hpoflow.mlflow import ( # noqa: F401
check_repo_is_dirty,
normalize_mlflow_entry_name,
normalize_mlflow_entry_names_in_dict,
)
from hpoflow.optuna import SignificanceRepeatedTrainingPruner # noqa: F401
from hpoflow.optuna_mlflow import OptunaMLflow # noqa: F401
from hpoflow.optuna_transformers import OptunaMLflowCallback # noqa: F401
from hpoflow.utils import func_no_exception_caller # noqa: F401
else:
sys.modules[__name__] = LazyImporter(
__name__,
globals()["__file__"],
_import_structure,
extra_objects={"__version__": __version__},
)
```
## Usage & Example for try_import
`try_import` is a context manager that can wrap imports of optional packages to defer
exceptions. This way you don't have to import the packages every time you call a function,
but you can still import the package at the top of your module. The context manager
defers the exceptions until you actually need to use the package.
You can see an example below:
```python
from lazy_imports import try_import
with try_import() as optional_package_import: # use try_import as a context manager
import optional_package # optional package that might not be installed
# other non optional functions here
def optional_function(): # optional function that uses the optional package
optional_package_import.check() # check if the import was ok or raise a meaningful exception
optional_package.some_external_function() # use the optional package here
```
## Support and Feedback
The following channels are available for discussions, feedback, and support requests:
- [open an issue in our GitHub repository](https://github.com/telekom/lazy-imports/issues/new/choose)
- [send an e-mail to our open source team](mailto:opensource@telekom.de)
## Reporting Security Vulnerabilities
This project is built with security and data privacy in mind to ensure your data is safe.
We are grateful for security researchers and users reporting a vulnerability to us, first.
To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities
can be assured, please follow the below guideline.
**Please do not report security vulnerabilities directly on GitHub.
GitHub Issues can be publicly seen and therefore would result in a direct disclosure.**
Please address questions about data privacy, security concepts,
and other media requests to the [opensource@telekom.de](mailto:opensource@telekom.de) mailbox.
## Contribution
Our commitment to open source means that we are enabling - in fact encouraging - all interested
parties to contribute and become part of our developer community.
Contribution and feedback is encouraged and always welcome. For more information about how to
contribute, as well as additional contribution information, see our
[Contribution Guidelines](https://github.com/telekom/lazy-imports/blob/main/CONTRIBUTING.md).
## Code of Conduct
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/)
as our code of conduct. Please see the details in our
[Contributor Covenant Code of Conduct](https://github.com/telekom/lazy-imports/blob/main/CODE_OF_CONDUCT.md).
All contributors must abide by the code of conduct.
## Licensing
Copyright (c) 2021 [Philip May](https://may.la/), [Deutsche Telekom AG](https://www.telekom.com/)<br/>
Copyright (c) 2020, 2021 [The HuggingFace Team](https://huggingface.co/)<br/>
Copyright (c) 2018 Preferred Networks, Inc.
Licensed under the [Apache License, Version 2.0](https://github.com/telekom/lazy-imports/blob/main/LICENSE) (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": "https://github.com/telekom/lazy-imports",
"name": "lazy-imports",
"maintainer": "Philip May",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "import imports lazy",
"author": "Philip May",
"author_email": "philip.may@t-systems.com",
"download_url": "https://files.pythonhosted.org/packages/70/74/f9c3c59876a7423d0a152f6f8e95ef27e24d3802deec81ab293c93f9edc3/lazy_imports-0.3.1.tar.gz",
"platform": null,
"description": "# Lazy-Imports\n\n[](https://github.com/telekom/lazy-imports/blob/main/LICENSE)\n[](https://github.com/telekom/lazy-imports/blob/main/CODE_OF_CONDUCT.md)\n[](https://www.python.org)\n[](https://pypi.python.org/pypi/lazy-imports)\n<br/>\n[](https://github.com/telekom/lazy-imports/actions/workflows/pytest.yml)\n[](https://github.com/telekom/lazy-imports/actions/workflows/static_checks.yml)\n[](https://github.com/telekom/lazy-imports/issues)\n\nThis is a Python tool to support lazy imports.\nLikewise, the actual initialization of the module does not occur until usage time\nto postpone `ModuleNotFoundError`s to the time of the actual usage of the module.\nThis is useful when using various optional dependencies which might not all be\ninstalled or which have high load times and/or ressource consumption.\n\n## Table of Contents\n\n- [Maintainers](#maintainers)\n- [Installation](#installation)\n- [Usage & Example for LazyImporter](#usage--example-for-lazyimporter)\n- [Usage & Example for try_import](#usage--example-for-try_import)\n- [Support and Feedback](#support-and-feedback)\n- [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities)\n- [Contribution](#contribution)\n- [Code of Conduct](#code-of-conduct)\n- [Licensing](#licensing)\n\n## Maintainers\n\n[](https://www.welove.ai/)\n<br/>\nThis project is maintained by the [One Conversation](https://www.welove.ai/)\nteam of [Deutsche Telekom AG](https://www.telekom.com/).\nIt is based on\n[`_LazyModule`](https://github.com/huggingface/transformers/blob/e218249b02465ec8b6029f201f2503b9e3b61feb/src/transformers/file_utils.py#L1945)\nfrom [HuggingFace](https://huggingface.co/) and\n[`try_import()`](https://github.com/optuna/optuna/blob/1f92d496b0c4656645384e31539e4ee74992ff55/optuna/_imports.py#L89)\nfrom the [Optuna framework](https://optuna.readthedocs.io/).\nMany thanks to HuggingFace for\n[your consent](https://github.com/huggingface/transformers/issues/12861#issuecomment-886712209)\nand to Optuna for\n[your consent](https://github.com/optuna/optuna/issues/2776#issuecomment-874614137)\nto publish it as a standalone package \ud83e\udd17 \u2665.\n\n## Installation\n\nLazy-Imports is available at [the Python Package Index (PyPI)](https://pypi.org/project/lazy-imports/).\nIt can be installed with pip:\n\n```bash\n$ pip install lazy-imports\n```\n\n## Usage & Example for LazyImporter\n\nA good and easy to understand example of how to use Lazy-Imports can be found in the\n[`__init__.py` file of the HPOflow package](https://github.com/telekom/HPOflow/blob/1b26f3b86cad607dd89a31fa9135256d956948cb/hpoflow/__init__.py).\nIt is printed here:\n\n```python\nimport sys\nfrom typing import TYPE_CHECKING\n\nfrom lazy_imports import LazyImporter\n\nfrom hpoflow.version import __version__\n\n\n_import_structure = {\n \"mlflow\": [\n \"normalize_mlflow_entry_name\",\n \"normalize_mlflow_entry_names_in_dict\",\n \"check_repo_is_dirty\",\n ],\n \"optuna\": [\"SignificanceRepeatedTrainingPruner\"],\n \"optuna_mlflow\": [\"OptunaMLflow\"],\n \"optuna_transformers\": [\"OptunaMLflowCallback\"],\n \"utils\": [\"func_no_exception_caller\"],\n}\n\n# Direct imports for type-checking\nif TYPE_CHECKING:\n from hpoflow.mlflow import ( # noqa: F401\n check_repo_is_dirty,\n normalize_mlflow_entry_name,\n normalize_mlflow_entry_names_in_dict,\n )\n from hpoflow.optuna import SignificanceRepeatedTrainingPruner # noqa: F401\n from hpoflow.optuna_mlflow import OptunaMLflow # noqa: F401\n from hpoflow.optuna_transformers import OptunaMLflowCallback # noqa: F401\n from hpoflow.utils import func_no_exception_caller # noqa: F401\nelse:\n sys.modules[__name__] = LazyImporter(\n __name__,\n globals()[\"__file__\"],\n _import_structure,\n extra_objects={\"__version__\": __version__},\n )\n```\n\n## Usage & Example for try_import\n\n`try_import` is a context manager that can wrap imports of optional packages to defer\nexceptions. This way you don't have to import the packages every time you call a function,\nbut you can still import the package at the top of your module. The context manager\ndefers the exceptions until you actually need to use the package.\nYou can see an example below:\n\n```python\nfrom lazy_imports import try_import\n\nwith try_import() as optional_package_import: # use try_import as a context manager\n import optional_package # optional package that might not be installed\n\n# other non optional functions here\n\ndef optional_function(): # optional function that uses the optional package\n optional_package_import.check() # check if the import was ok or raise a meaningful exception\n\n optional_package.some_external_function() # use the optional package here\n```\n\n## Support and Feedback\n\nThe following channels are available for discussions, feedback, and support requests:\n\n- [open an issue in our GitHub repository](https://github.com/telekom/lazy-imports/issues/new/choose)\n- [send an e-mail to our open source team](mailto:opensource@telekom.de)\n\n## Reporting Security Vulnerabilities\n\nThis project is built with security and data privacy in mind to ensure your data is safe.\nWe are grateful for security researchers and users reporting a vulnerability to us, first.\nTo ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities\ncan be assured, please follow the below guideline.\n\n**Please do not report security vulnerabilities directly on GitHub.\nGitHub Issues can be publicly seen and therefore would result in a direct disclosure.**\n\nPlease address questions about data privacy, security concepts,\nand other media requests to the [opensource@telekom.de](mailto:opensource@telekom.de) mailbox.\n\n## Contribution\n\nOur commitment to open source means that we are enabling - in fact encouraging - all interested\nparties to contribute and become part of our developer community.\n\nContribution and feedback is encouraged and always welcome. For more information about how to\ncontribute, as well as additional contribution information, see our\n[Contribution Guidelines](https://github.com/telekom/lazy-imports/blob/main/CONTRIBUTING.md).\n\n## Code of Conduct\n\nThis project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/)\nas our code of conduct. Please see the details in our\n[Contributor Covenant Code of Conduct](https://github.com/telekom/lazy-imports/blob/main/CODE_OF_CONDUCT.md).\nAll contributors must abide by the code of conduct.\n\n## Licensing\n\nCopyright (c) 2021 [Philip May](https://may.la/), [Deutsche Telekom AG](https://www.telekom.com/)<br/>\nCopyright (c) 2020, 2021 [The HuggingFace Team](https://huggingface.co/)<br/>\nCopyright (c) 2018 Preferred Networks, Inc.\n\nLicensed under the [Apache License, Version 2.0](https://github.com/telekom/lazy-imports/blob/main/LICENSE) (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": "",
"summary": "Tool to support lazy imports",
"version": "0.3.1",
"split_keywords": [
"import",
"imports",
"lazy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30054c61bea2b48804893ae1466cf5add2bea3449ea065009d7e5df0ee0e6a58",
"md5": "bd5d4d62e23449fa0a801deaf0dea257",
"sha256": "149500cb1015726f5148155989386b30b425dfd7e48fd156385eb1c9e23887dd"
},
"downloads": -1,
"filename": "lazy_imports-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd5d4d62e23449fa0a801deaf0dea257",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12383,
"upload_time": "2023-01-10T21:04:45",
"upload_time_iso_8601": "2023-01-10T21:04:45.909841Z",
"url": "https://files.pythonhosted.org/packages/30/05/4c61bea2b48804893ae1466cf5add2bea3449ea065009d7e5df0ee0e6a58/lazy_imports-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7074f9c3c59876a7423d0a152f6f8e95ef27e24d3802deec81ab293c93f9edc3",
"md5": "78bd3934ea85acefbe8baa4c061962fc",
"sha256": "636624104bf45b09761323e06292927832aca067c3c199e5de483738789aeb21"
},
"downloads": -1,
"filename": "lazy_imports-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "78bd3934ea85acefbe8baa4c061962fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15761,
"upload_time": "2023-01-10T21:04:47",
"upload_time_iso_8601": "2023-01-10T21:04:47.195105Z",
"url": "https://files.pythonhosted.org/packages/70/74/f9c3c59876a7423d0a152f6f8e95ef27e24d3802deec81ab293c93f9edc3/lazy_imports-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-10 21:04:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "telekom",
"github_project": "lazy-imports",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lazy-imports"
}
JSON
