Easy plugin for open-close class objects
Project description
open-close-mixin
About
Easy pluggable Mixin (and decorators) for objects that may benefit from open-close dynamics.
Installing
You can simply install it using pip as follows:
$ pip install open-close-mixin
Usage
You may import an OpenCloseMixin
along some other decorators from the package root and use them further on to create your own class with open and close dynamics!
>>> from open_close_mixin import OpenCloseMixin, always
>>> class Foo(OpenCloseMixin):
>>> # only while open, that's default behaviour
>>> def run_when_open(self):
>>> print("The instance is open so I was able to run")
>>>
>>> @always
>>> def run_always(self):
>>> print("I am ALWAYS able to run, whether the instance is open or not")
>>>
>>> f = Foo()
>>> f.open()
>>> f.run_always()
I am ALWAYS able to run, whether the instance is open or not
>>>
>>> f.run_when_open()
The instance is open so I was able to run
>>>
>>> f.close()
>>> f.run_always()
I am ALWAYS able to run, whether the instance is open or not
>>>
>>> f.run_when_open()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/home/alberto/Projects/personal/open-close-mixin/open_close_mixin/decorators.py", line 27, in wrapper
raise exception from None
ValueError: The instance is not open and the method "Foo.run_when_open" cannot run under such condition.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
open-close-mixin-1.1.1.tar.gz
(4.1 kB
view hashes)
Built Distribution
Close
Hashes for open_close_mixin-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f382c1c1cd594034ff5aaa699ed8c2016598446b3bd0846bed4e2e57505dcf3e |
|
MD5 | af507df0bf79437f08c14a067484c611 |
|
BLAKE2b-256 | 041d8dcd7e7137169a3662bf807bf78bc13eb8e97c8e640e092ee40fdaff040f |