Skip to content

fix(oocana): add warnings.warn for deprecated APIs #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leavesster wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(oocana): add warnings.warn for deprecated APIs #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions oocana/oocana/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import os.path
import logging
import hashlib
import warnings

__all__ = ["Context", "HandleDefDict", "BlockJob", "BlockExecuteException"]

Expand Down Expand Up @@ -241,7 +242,15 @@ def tmp_pkg_dir(self) -> str:
@property
def pkg_dir(self) -> str:
"""Deprecated, use pkg_data_dir instead.

.. deprecated:: 0.18.0
Use :attr:`pkg_data_dir` instead.
"""
warnings.warn(
"pkg_dir is deprecated, use pkg_data_dir instead",
DeprecationWarning,
stacklevel=2
)
return self.__pkg_data_dir

@property
Expand Down Expand Up @@ -647,10 +656,16 @@ def send_warning(self, warning: str):
self.__mainframe.report(self.block_info, {"type": "BlockWarning", "warning": warning})

def send_error(self, error: str):
'''
deprecated, use error(error) instead.
consider to remove in the future.
'''
"""Send an error message.

.. deprecated:: 0.18.0
Use :meth:`error` instead.
"""
warnings.warn(
"send_error is deprecated, use error() instead",
DeprecationWarning,
stacklevel=2
)
self.error(error)

def error(self, error: str):
Expand Down
Loading