معرفی شرکت ها
autoload-module-1.7.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Python Autoload Module
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | autoload-module-1.7.2 |
| نام | autoload-module |
| نسخه کتابخانه | 1.7.2 |
| نگهدارنده | ['Hiroki Miyaji'] |
| ایمیل نگهدارنده | ['nukoprogramming@gmail.com'] |
| نویسنده | Hiroki Miyaji |
| ایمیل نویسنده | nukoprogramming@gmail.com |
| آدرس صفحه اصلی | https://github.com/hiroki0525/autoload_module |
| آدرس اینترنتی | https://pypi.org/project/autoload-module/ |
| مجوز | MIT |
# autoload_module
[](https://badge.fury.io/py/autoload-module)
[](https://github.com/hiroki0525/autoload_module/actions/workflows/test.yml)
[](https://pepy.tech/project/autoload-module)
<img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="MIT License image">
This library will give you comfortable Python metaprogramming.
The following is a plain example.
- Directory
```
project/
├ example.py
└ validator/
├ validator_a.py
├ validator_b.py
└ validator_c.py
```
- example.py
```python
from autoload import ModuleLoader
input = "foo bar baz"
loader = ModuleLoader()
# Automatically import modules and return class objects
validator_classes = loader.load_classes("validator")
try:
# initialize and execute method
[clazz().validate(input) for clazz in validator_classes]
except:
print("input is invalid!!")
```
## Install
```
pip install autoload-module
```
## Usage
### Constructor
```
ModuleLoader(
base_path: Optional[str] = None,
strict: bool = False
)
```
The ModuleLoader can be generated with no parameters.
In that case, the instance has the absolute path where
it was initialized.
- Directory
```
/usr/local/src/project/
├ example.py
└ validator/
├ validator_a.py
├ validator_b.py
└ validator_c.py
```
- example.py
```python
from autoload import ModuleLoader
# The instance has '/usr/local/src/project/'
loader = ModuleLoader()
# load modules in the directory; '/usr/local/src/project/validator/'
validator_classes = loader.load_classes("validator")
```
If you want to change the base path, you must generate the ModuleLoader with an absolute path parameter.
```python
loader = ModuleLoader('/user/local/src/custom')
```
About strict parameter, please see [here](#NOTE) .
You can also create global setting and initialize singleton object.
```python
from autoload import ModuleLoader
import os
# global setting
ModuleLoader.set_setting(base_path=os.getcwd(), strict=True)
loader_a = ModuleLoader()
loader_b = ModuleLoader()
print(loader_a.base_path)
# -> /Users/user1/abc
print(loader_b.base_path)
# -> /Users/user1/abc
# singleton setting
ModuleLoader.set_setting(singleton=True)
loader_c = ModuleLoader()
loader_d = ModuleLoader()
loader_e = ModuleLoader('/test')
assert loader_c is loader_d # OK
assert loader_c is loader_e # OK
# The base_path is '/Users/user1/abc'
assert loader_c.base_path is loader_e.base_path # OK
```
### Methods
#### load_classes
```
load_classes(
src: str,
excludes: Iterable[str] = (),
recursive: bool = False,
) -> Tuple[Type]:
```
This method read the Python package or module and return the tuple of class objects.
- Directory
```
pkg/
├ example.py
├ __init__.py
├ config.yaml
└ main/
├ validator_a.py
├ validator_b.py
├ validator_c.py
└ sub/
├ validator_d.py
└ validator_e.py
```
- validator_a.py
```python
class ValidatorA:
def validate(self):
print("validateA!!")
```
- example.py
```python
loader = ModuleLoader()
# Automatically read modules without '__init__.py', not py file, and this file.
# return the tuple of ValidateA, ValidatorB, and ValidatorC class objects
validator_classes = loader.load_classes("main")
# initialize and execute method
[clazz().validate() for clazz in validator_classes]
# -> validateA!!
# -> validateB!!
# -> validateC!!
```
You can also load only specific modules using `excludes` variable or `load_config` decorator as below.
```python
# Pattern1: 'excludes'
# 'excludes' is a iterable object like tuple, list.
# You must specify module names in 'excludes'.
validator_classes = loader.load_classes("main", ["validator_a"])
[clazz().validate() for clazz in validator_classes]
# -> validateB!!
# -> validateC!!
# Pattern2: 'load_config'
from autoload import load_config
@load_config(load=False)
class ValidatorA:
def validate(self):
print("validateA!!")
validator_classes = loader.load_classes("main")
[clazz().validate() for clazz in validator_classes]
# -> validateB!!
# -> validateC!!
```
This function will check directory structure recursively if you specify `recursive=True`.
```python
# 'recursive=False' is default.
# In this case, the loader will also check 'pkg/main/sub/'.
validator_classes = loader.load_classes("main", recursive=True)
[clazz().validate() for clazz in validator_classes]
# -> validateA!!
# -> validateB!!
# -> validateC!!
# -> validateD!!
# -> validateE!!
```
You can specify `src` as below.
```python
loader.load_classes("main/validator_a.py")
loader.load_classes("main.validator_a")
loader.load_classes("./main/validator_a")
loader.load_classes(".main.validator_a")
loader.load_classes("main.sub.validator_d")
loader.load_classes("./main/sub/validator_d")
loader.load_classes("../otherpkg")
loader.load_classes("..otherpkg")
```
#### load_functions
```
load_functions(
src: str,
excludes: Iterable[str] = (),
recursive: bool = False,
) -> Tuple[Callable]:
```
This method read the Python package or module and return the tuple of functions.
The usage is the same as `load_classes`.
##### NOTE
- To search class or function, **You must match the name of file, and the one of class or function.**
For example, if you named the file `test_module.py`, you must name the class `TestModule` or the function `test_module`.
When you want to customize their name, use `@load_config` decorator.
- validator_a.py
```python
from autoload import load_config
@load_config()
class CustomValidator:
def validate(self):
print("validateA!!")
```
- You can also control the order of loaded class objects using `@load_config` decorator.
- validator_a.py
```python
from autoload import load_config
# sort in ascending order
@load_config(order=1)
class ValidatorA:
def validate(self):
print("validateA!!")
```
- If you decorate some classes or functions with `@load_config`, the loader will load them.
However, initialized `strict=True`, the loader denies multiple loading as below.
- pkg/validator_a.py
```python
from autoload import load_config
# This will be loaded because of name's rule.
class ValidatorA:
def validate(self):
print("validateA!!")
# Anything goes.
@load_config(order=2)
class Foo:
pass
```
- main.py
```python
from autoload import ModuleLoader
from autoload.exception import LoaderStrictModeError
loader = ModuleLoader()
# return ValidatorA and Foo class objects.
classes = loader.load_classes("pkg")
# ModuleLoader strictly try to load a class or function object
# per a Python module on a basis of its name.
strict_loader = ModuleLoader(strict=True)
try:
classes = strict_loader.load_classes("pkg")
except LoaderStrictModeError as e:
print(e)
# -> Loader can only load a 'ValidatorA' class in validator_a module.
# -> Please check 'Foo' in validator_a module.
```
#### load_class
```
load_class(file_name: str)
```
This method read the Python file and return the class object.
- Directory
```
project/
├ example.py
└ validator.py
```
- validator.py
```python
class Validator:
def validate(self):
print("validate!!")
```
- example.py
```python
loader = ModuleLoader()
clazz = loader.load_class("validator")
clazz().validate()
# -> validate!!
```
How to specify `file_name` is the same as that of `load_classes`.
#### load_function
```
load_function(file_name: str)
```
This method read the Python file and return a function object.
The usage is the same as `load_class`.
## License
Released under the MIT license.
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7,<4.0 | Python |
نحوه نصب
نصب پکیج whl autoload-module-1.7.2:
pip install autoload-module-1.7.2.whl
نصب پکیج tar.gz autoload-module-1.7.2:
pip install autoload-module-1.7.2.tar.gz