Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guoquan/acls
`@cls` - Class Made Aware to Decorator
https://github.com/guoquan/acls
Last synced: 7 days ago
JSON representation
`@cls` - Class Made Aware to Decorator
- Host: GitHub
- URL: https://github.com/guoquan/acls
- Owner: guoquan
- License: mit
- Created: 2019-06-28T06:57:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-25T08:39:23.000Z (over 2 years ago)
- Last Synced: 2024-12-14T19:21:44.980Z (25 days ago)
- Language: Python
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `@cls` - Class Made Aware to Decorator
[](https://pypi.org/project/acls/)
[](https://pypi.org/project/acls/)
[](https://pypi.org/project/acls/)
[](https://pypi.org/project/acls/)
[](LICENSE)
[](https://circleci.com/gh/guoquan/acls/tree/master)
[](https://travis-ci.org/guoquan/acls)
[](https://codecov.io/gh/guoquan/acls)
The purpose of this library is to provide possibility to create decorators, especially in super classes, with current class `cls` as argument.
Everything are centered with our new `cls` module, keyword, magic, or what every you think it would be.
## Getting Started
### Installation
Install by `pip` from PyPI:
```bash
pip install acls
```
### Example
A typical snippet looks like:
```python
from functools import wraps
import cls
class Base(metaclass=cls.ClsMeta):
@cls
def decor(cls, decor_arg):
def wrap(func):
@wraps(func)
def wrapper(self):
# do something with `func`
retval = func(self)
# do something with `retval`
return retval
return wrapper
return wrap
class Extended(Base):
@cls.decor('some arg')
def func(self):
# do something
pass
```
The magic is that you can use `@cls.decor` in `Extended` class, which is inheritance from `Base`.
What is more, with in the decorator `Base.decor`, argument `cls` will be assigned with the correct current class.
In this example, it would simply be a reference to `Extended`.
This would be helpful if you want to make use of some class property here in the decorator.
## Magic
Well, there is no magic. I created a delegator in class namespace to enable both class possible to use `@cls`.
So, it is not the module `cls` as we imported on the top.
I use this to make it more consistent looking, and fool some interpreters like `pylint`.
No offense, just want to make them less noisy.
## Limitations
Unfortunately, This work is based on [customizing python class creation](https://docs.python.org/3/reference/datamodel.html#customizing-class-creation).
I have to make use of [`__prepare__`](https://www.python.org/dev/peps/pep-3115/#id11), which is [introduced](https://www.python.org/dev/peps/pep-3115/) only to [python 3](https://docs.python.org/3/reference/datamodel.html#customizing-class-creation).
That means there is no known possible backward compatibility with [python 2](https://docs.python.org/2/reference/datamodel.html#customizing-class-creation) now.
The code is tested against python 3.5+.
Please let me know if you come up with an idea how to manipulate class creation in python 2.
There are a couple of issues, with which I am talking. Contributions are welcome.
### Known issue
- [ ] relying on length of arguments and `callable()` to support optional arguments in decorator
- [ ] not compatible with `@classmethod`, or many other decorators
- [ ] make `pylint` really noisy
- [ ] no documents :see_no_evil:!
## License
[MIT License, Copyright (c) 2019 guoquan](LICENSE)