revpi/revpimodio2
1
0
Fork 0
mirror of https://github.com/naruxde/revpimodio2.git synced 2025-11-08 22:03:53 +01:00
Code Issues Packages Releases Wiki Activity

refactor: Show deprecation warning on root context manager

Browse Source 
This context manager can delete the entire instance of ModIO when using
`with rpi:` after creating an instance of ModIO by
`rpi = revpimodio.RevPiModIO(...)`.
This commit is contained in:
Sven Sager
2024-11-07 11:24:22 +01:00
parent 579617d223
commit f3f81f3633
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/revpimodio2/modio.py
View File

@@ -208,6 +208,19 @@ class RevPiModIO(object):
self._myfh.close() self._myfh.close()
def __enter__(self): def __enter__(self):
# todo: Remove this context manager in future
warnings.warn(
"This context manager is deprecated and will be removed!\n\n"
"You should use the context manager of the IO object `with revpi.io:` "
"or with a single device `with revpi.device.my_device:`.\n\n"
"This deprecated context manager can be reproduced as follows:\n"
"```"
"revpi = revpimodio2.RevPiModIO()"
"with revpi.io:"
" ..."
"```",
DeprecationWarning,
)
if self._context_manager: if self._context_manager:
raise RuntimeError("can not use multiple context managers of same instance") raise RuntimeError("can not use multiple context managers of same instance")
if self._looprunning: if self._looprunning: