Prep 0.47.0

.github/workflows/upgrade_dependencies.yml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         os: ['ubuntu-latest']
         package: ["mp-api"]
-        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.12", "3.13", "3.14"]
     steps:
       - uses: actions/checkout@v4
         with:

README.md

@@ -2,6 +2,6 @@
 
 [![testing](https://github.com/materialsproject/api/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/materialsproject/api/actions?query=workflow%3Atesting+branch%3Amain)
 [![codecov](https://codecov.io/gh/materialsproject/api/branch/main/graph/badge.svg)](https://codecov.io/gh/materialsproject/api)
-![python](https://img.shields.io/badge/Python-3.11+-blue.svg?logo=python&logoColor=white)
+![python](https://img.shields.io/badge/Python-3.12+-blue.svg?logo=python&logoColor=white)
 
 This repository is the development environment for the new Materials Project API. A core client implementation will reside here. For information on how to use the API, please see the updated [documentation](https://docs.materialsproject.org/downloading-data/how-do-i-download-the-materials-project-database).

mp_api/_test_utils.py

@@ -46,8 +46,8 @@ def client_search_testing(
         alt_name_dict (dict[str, str]): Alternative names for parameters used in the projection and subsequent data checking
         custom_field_tests (dict[str, Any]): Custom queries for specific fields.
         sub_doc_fields (list[str]): Prefixes for fields to check in resulting data. Useful when data to be tested is nested.
-        int_bounds (tuple[int,int]) : integer bounds to use in testing int-type query arguments
-        float_bounds (tuple[float,float]) : float bounds to use in testing float-type query arguments
+        int_bounds (tuple[int, int]) : integer bounds to use in testing int-type query arguments
+        float_bounds (tuple[float, float]) : float bounds to use in testing float-type query arguments
     """
     if search_method is None:
         return
@@ -58,7 +58,8 @@ def client_search_testing(
     for entry in param_tuples:
         param = entry[0]
 
-        if param not in excluded_params + ["return"]:
+        # `db_version` selects a dataset version rather than filtering docs
+        if param not in excluded_params + ["return", "db_version"]:
             param_type = entry[1]
             q: dict[str, Any] = {"chunk_size": 1, "num_chunks": 1}
 
@@ -139,7 +140,6 @@ def _normalize(doc, field: str):
         if k not in ("_page", "_sort_fields", "chunk_size", "fields")
     }
     for sort_field in [sort_fields] if isinstance(sort_fields, str) else sort_fields:
-
         asc = search_method(
             _page=1,
             _sort_fields=sort_field,

mp_api/client/__init__.py

@@ -2,18 +2,23 @@
 
 from __future__ import annotations
 
-import logging
 import os
 from importlib.metadata import PackageNotFoundError, version
 
+from mp_api.client.core._display import (
+    _configure_from_settings,
+    enable_logging,
+    is_quiet,
+    quiet,
+)
 from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.mprester import MPRester
 
-__all__ = ["MPRestError", "MPRester"]
+__all__ = ["MPRestError", "MPRester", "enable_logging", "is_quiet", "quiet"]
 
 try:
     __version__ = version("mp_api")
 except PackageNotFoundError:  # pragma: no cover
     __version__ = os.getenv("SETUPTOOLS_SCM_PRETEND_VERSION", "")
 
-logging.getLogger(__name__).addHandler(logging.NullHandler())
+_configure_from_settings()

mp_api/client/contribs/_logger.py

@@ -1,97 +1,49 @@
+"""Logger for the MPContribs client.
+
+Records go through the `mp_api.client` logger's default handler (stderr),
+see `mp_api.client.core._display`. No handlers or level are set here: the
+level is configured once, for the whole client, with `MPRESTER_LOG_LEVEL`.
+"""
+
 from __future__ import annotations
 
 import logging
 import os
-import sys
-from io import StringIO
 
 from mp_api.client.contribs.settings import MPCC_SETTINGS
-
-
-class LogFilter(logging.Filter):
-    def __init__(self, level: int, *args, **kwargs) -> None:
-        """Start an instance of logging.Filter.
-
-        Args:
-            level (int) : logging level
-            *args : args to pass to logging.Filter
-            **kwargs : kwargs to pass to logging.Filter
-        """
-        self.level = level
-        super().__init__(*args, **kwargs)
-
-    def filter(self, record: logging.LogRecord) -> bool:
-        """Filter whether a message is logged.
-
-        Args:
-            record (logging.LogRecord) : message to test if it
-                meets threshold for logging.
-
-        Returns:
-            bool : True if message should be suppressed.
-        """
-        return record.levelno < self.level
+from mp_api.client.core._display import mp_deprecation
 
 
 class CustomLoggerAdapter(logging.LoggerAdapter):
-    """Adapter for logger to enable prefixing."""
+    """Prefix messages with the supervisor group/process, if running under supervisor."""
 
     def process(self, msg, kwargs):
-        """Prefix logging message.
-
-        Args:
-            msg (str) : logging message
-            kwargs : args to pass to logging.LoggerAdapter
-        """
-        prefix = self.extra.get("prefix")
+        prefix = self.extra.get("prefix")  # type: ignore[union-attr]
         return f"[{prefix}] {msg}" if prefix else msg, kwargs
 
 
 def get_logger(name: str = "mp_api.client.contribs") -> CustomLoggerAdapter:
-    """Get the default MPContribs logger.
+    """Get the contribs logger.
 
     Args:
-        name (str) : name of the logger
+        name (str) : logger name, a child of `mp_api.client`
+
     Returns:
         CustomLoggerAdapter
     """
     logger = logging.getLogger(name)
     process = os.environ.get("SUPERVISOR_PROCESS_NAME")
     group = os.environ.get("SUPERVISOR_GROUP_NAME")
     cfg = {"prefix": f"{group}/{process}"} if process and group else {}
-    info_handler = logging.StreamHandler(sys.stdout)
-    error_handler = logging.StreamHandler(sys.stderr)
-    info_handler.addFilter(LogFilter(logging.WARNING))
-    error_handler.setLevel(max(logging.DEBUG, logging.WARNING))
-    logger.handlers = [info_handler, error_handler]
-    logger.setLevel(MPCC_SETTINGS.CLIENT_LOG_LEVEL)
     return CustomLoggerAdapter(logger, cfg)
 
 
-MPCC_LOGGER = get_logger()
-
-
-class TqdmToLogger(StringIO):
-    logger: logging.LoggerAdapter = MPCC_LOGGER
-    level: int | str = MPCC_SETTINGS.CLIENT_LOG_LEVEL
-    buf: str = ""
-
-    def __init__(
-        self, logger: logging.LoggerAdapter = MPCC_LOGGER, level: int | None = None
-    ) -> None:
-        """Start an instance of a TQDM logger.
+if MPCC_SETTINGS.CLIENT_LOG_LEVEL is not None:
+    mp_deprecation(
+        "MPCONTRIBS_CLIENT_LOG_LEVEL is deprecated and ignored, use MPRESTER_LOG_LEVEL "
+        "(which sets the level for the whole client) instead.",
+        stacklevel=2,
+    )
 
-        Args:
-            logger (logging.Logger) : Logger to pass through
-            level (int) : logging level
-        """
-        super().__init__()
-        self.logger = logger
-        self.level = level or logging.INFO
 
-    def write(self, buf: str) -> int:
-        self.buf = buf.strip("\r\n\t ")
-        return 1
-
-    def flush(self) -> None:
-        self.logger.log(self.level, self.buf)  # type: ignore[arg-type]
+MPCC_LOGGER = get_logger()

mp_api/client/contribs/_types.py

@@ -69,7 +69,10 @@ def display(self):
             try:
                 allowed_kwargs = getfullargspec(line_chart).args
                 attrs = {k: v for k, v in self.attrs.items() if k in allowed_kwargs}
-                return self.plot(**attrs)
+                # Plot with plotly directly, rather than changing the
+                # process-wide pandas plotting backend / plotly template.
+                attrs.setdefault("template", "simple_white")
+                return line_chart(self, **attrs)
             except Exception as e:
                 MPCC_LOGGER.error(f"Can't display table: {e}")