Skip to content
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

Jump to bottom

QueryBuilder: Deprecate debug argument and use logger #6055

Merged
merged 1 commit into from
Jun 17, 2023
Merged

QueryBuilder: Deprecate debug argument and use logger #6055

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 27 additions & 11 deletions aiida/orm/querybuilder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
)
import warnings

from aiida.common.log import AIIDA_LOGGER
from aiida.common.warnings import warn_deprecation
from aiida.manage import get_manager
from aiida.orm.entities import EntityTypes
from aiida.orm.implementation.querybuilder import (
Expand All @@ -67,6 +69,8 @@
FilterType = Dict[str, Any] # pylint: disable=invalid-name
OrderByType = Union[dict, List[dict], Tuple[dict, ...]]

LOGGER = AIIDA_LOGGER.getChild('querybuilder')


class Classifier(NamedTuple):
"""A classifier for an entity."""
Expand Down Expand Up @@ -100,7 +104,7 @@ def __init__(
self,
backend: Optional['StorageBackend'] = None,
*,
debug: bool = False,
debug: bool | None = None,
path: Optional[Sequence[Union[str, Dict[str, Any], EntityClsType]]] = (),
filters: Optional[Dict[str, FilterType]] = None,
project: Optional[Dict[str, ProjectType]] = None,
Expand Down Expand Up @@ -160,7 +164,16 @@ def __init__(
self._tags = _QueryTagMap()

# Set the debug level
self.set_debug(debug)
if debug is not None:
warn_deprecation(
'The `debug` argument is deprecated. Configure the log level of the AiiDA logger instead.', version=3
)
else:
debug = False

with warnings.catch_warnings():
warnings.simplefilter('ignore')
self.set_debug(debug)

# Validate & add the query path
if not isinstance(path, (list, tuple)):
Expand Down Expand Up @@ -216,7 +229,6 @@ def as_dict(self, copy: bool = True) -> QueryDictType:
@property
def queryhelp(self) -> 'QueryDictType':
""""Legacy name for ``as_dict`` method."""
from aiida.common.warnings import warn_deprecation
warn_deprecation('`QueryBuilder.queryhelp` is deprecated, use `QueryBuilder.as_dict()` instead', version=3)
return self.as_dict()

Expand Down Expand Up @@ -406,7 +418,7 @@ def append(
try:
self._tags.add(tag, ormclass, cls)
except Exception as exception:
self.debug('Exception caught in append, cleaning up: %s', exception)
LOGGER.debug('Exception caught in append, cleaning up: %s', exception)
self._tags.remove(tag)
raise

Expand All @@ -429,7 +441,7 @@ def append(
if filters is not None:
self.add_filter(tag, filters)
except Exception as exception:
self.debug('Exception caught in append, cleaning up: %s', exception)
LOGGER.debug('Exception caught in append, cleaning up: %s', exception)
self._tags.remove(tag)
self._filters.pop(tag)
raise
Expand All @@ -440,7 +452,7 @@ def append(
if project is not None:
self.add_projection(tag, project)
except Exception as exception:
self.debug('Exception caught in append, cleaning up: %s', exception)
LOGGER.debug('Exception caught in append, cleaning up: %s', exception)
self._tags.remove(tag)
self._filters.pop(tag)
self._projections.pop(tag)
Expand Down Expand Up @@ -495,7 +507,7 @@ def append(
joining_value = self._path[-1]['tag']

except Exception as exception:
self.debug('Exception caught in append (part filters), cleaning up: %s', exception)
LOGGER.debug('Exception caught in append (part filters), cleaning up: %s', exception)
self._tags.remove(tag)
self._filters.pop(tag)
self._projections.pop(tag)
Expand All @@ -512,7 +524,7 @@ def append(
else:
if edge_tag in self._tags:
raise ValueError(f'The tag {edge_tag} is already in use')
self.debug('edge_tag chosen: %s', edge_tag)
LOGGER.debug('edge_tag chosen: %s', edge_tag)

# edge tags do not have an ormclass
self._tags.add(edge_tag)
Expand All @@ -529,7 +541,7 @@ def append(
if edge_project is not None:
self.add_projection(edge_tag, edge_project)
except Exception as exception:
self.debug('Exception caught in append (part joining), cleaning up %s', exception)
LOGGER.debug('Exception caught in append (part joining), cleaning up %s', exception)
self._tags.remove(tag)
self._filters.pop(tag)
self._projections.pop(tag)
Expand Down Expand Up @@ -816,7 +828,7 @@ def add_projection(self, tag_spec: Union[str, EntityClsType], projection_spec: P
"""
tag = self._tags.get(tag_spec)
_projections = []
self.debug('Adding projection of %s: %s', tag_spec, projection_spec)
LOGGER.debug('Adding projection of %s: %s', tag_spec, projection_spec)
if not isinstance(projection_spec, (list, tuple)):
projection_spec = [projection_spec] # type: ignore
for projection in projection_spec:
Expand All @@ -838,7 +850,7 @@ def add_projection(self, tag_spec: Union[str, EntityClsType], projection_spec: P
if not isinstance(val, str):
raise TypeError(f'{val} has to be a string')
_projections.append(_thisprojection)
self.debug('projections have become: %s', _projections)
LOGGER.debug('projections have become: %s', _projections)
self._projections[tag] = _projections

def set_debug(self, debug: bool) -> 'QueryBuilder':
Expand All @@ -848,6 +860,9 @@ def set_debug(self, debug: bool) -> 'QueryBuilder':

:param debug: Turn debug on or off
"""
warn_deprecation(
'`QueryBuilder.set_debug` is deprecated. Configure the log level of the AiiDA logger instead.', version=3
)
if not isinstance(debug, bool):
return TypeError('I expect a boolean')
self._debug = debug
Expand All @@ -859,6 +874,7 @@ def debug(self, msg: str, *objects: Any) -> None:

objects will passed to the format string, e.g. ``msg % objects``
"""
warn_deprecation('`QueryBuilder.debug` is deprecated.', version=3)
if self._debug:
print(f'DEBUG: {msg}' % objects)

Expand Down