mp-api 0.46.1rc8__tar.gz → 0.46.2__tar.gz

{mp_api-0.46.1rc8 → mp_api-0.46.2}/.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
           cache: pip
 
       - name: Install dependencies

{mp_api-0.46.1rc8 → mp_api-0.46.2}/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
 
     - uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: 3.12
 
     - name: Install dependencies
       run: |
@@ -36,20 +36,24 @@ jobs:
 
   docs:
     runs-on: ubuntu-latest
+
     needs:
       - deploy
 
+    env:
+      PYTHON_VERSION: 3.12
+
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements/requirements-ubuntu-latest_py3.11_extras.txt
+          pip install -r requirements/requirements-ubuntu-latest_py${{ env.PYTHON_VERSION }}_extras.txt
           pip install -e .
 
       - name: Build

{mp_api-0.46.1rc8 → mp_api-0.46.2}/.github/workflows/testing.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.12", "3.13", "3.14"]
 
     runs-on: ${{ matrix.os }}
 
@@ -43,16 +43,6 @@ jobs:
         if: matrix.os == 'windows-latest'
         run: echo "SSL_CERT_FILE=$(python -m certifi)" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
 
-      - name: Format API key name (Linux/MacOS)
-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
-        run: |
-          echo "API_KEY_NAME=$(echo ${{ format('MP_API_KEY_{0}_{1}', matrix.os, matrix.python-version) }} | awk '{gsub(/-|\./, "_"); print}' | tr '[:lower:]' '[:upper:]')" >> $GITHUB_ENV
-
-      - name: Format API key name (Windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          echo "API_KEY_NAME=$(echo ${{ format('MP_API_KEY_{0}_{1}', matrix.os, matrix.python-version) }} | awk '{gsub(/-|\./, "_"); print}' | tr '[:lower:]' '[:upper:]')" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
-
       - name: Lint with mypy
         shell: bash -l {0}
         run: python -m mypy mp_api/
@@ -60,7 +50,7 @@ jobs:
       - name: Test with pytest
         if: always()
         env:
-          MP_API_KEY: ${{ secrets[env.API_KEY_NAME] }}
+          MP_API_KEY: ${{ secrets.MP_API_KEY_UBUNTU_LATEST_3_12 }}
           # MP_API_ENDPOINT: https://api-preview.materialsproject.org/
         run: |
           pytest -n auto -x --cov=mp_api --cov-report=xml

{mp_api-0.46.1rc8 → mp_api-0.46.2}/.github/workflows/upgrade_dependencies.yml

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

{mp_api-0.46.1rc8 → mp_api-0.46.2}/.pre-commit-config.yaml

@@ -6,24 +6,24 @@ ci:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.15.12
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]
 
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 26.3.1
     hooks:
       - id: black
 
   - repo: https://github.com/asottile/blacken-docs
-    rev: "1.16.0"
+    rev: "1.20.0"
     hooks:
       - id: blacken-docs
         additional_dependencies: [black>=23.7.0]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
       - id: check-case-conflict
       - id: check-symlinks
@@ -34,7 +34,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.2
     hooks:
       - id: codespell
         stages: [pre-commit, commit-msg]

{mp_api-0.46.1rc8 → mp_api-0.46.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mp-api
-Version: 0.46.1rc8
+Version: 0.46.2
 Summary: API Client for the Materials Project
 Author-email: The Materials Project <feedback@materialsproject.org>
 License-Expression: BSD-3-Clause-LBNL
@@ -13,25 +13,36 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pymatgen!=2024.2.20,>=2022.3.7
+Requires-Dist: pymatgen>2024.2.20
 Requires-Dist: typing-extensions>=3.7.4.1
 Requires-Dist: requests>=2.23.0
 Requires-Dist: monty>=2024.12.10
-Requires-Dist: emmet-core<0.86.5,>=0.86.4rc1
+Requires-Dist: emmet-core<0.87.2,>=0.87.0
 Requires-Dist: boto3
 Requires-Dist: orjson<4,>=3.10
 Requires-Dist: pyarrow>=20.0.0
-Requires-Dist: deltalake>=1.4.0
+Requires-Dist: deltalake<1.6.0,>=1.4.0
 Provides-Extra: mcp
 Requires-Dist: fastmcp; extra == "mcp"
 Provides-Extra: server
 Requires-Dist: flask; extra == "server"
+Provides-Extra: contribs
+Requires-Dist: boltons; extra == "contribs"
+Requires-Dist: bravado; extra == "contribs"
+Requires-Dist: filetype; extra == "contribs"
+Requires-Dist: ipython; extra == "contribs"
+Requires-Dist: json2html; extra == "contribs"
+Requires-Dist: pint>=0.25.0; extra == "contribs"
+Requires-Dist: pyIsEmail; extra == "contribs"
+Requires-Dist: requests-futures; extra == "contribs"
+Requires-Dist: swagger-spec-validator; extra == "contribs"
+Requires-Dist: cachetools; extra == "contribs"
+Requires-Dist: pymongo; extra == "contribs"
 Provides-Extra: all
 Requires-Dist: custodian; extra == "all"
-Requires-Dist: emmet-core[all]<0.86.5,>=0.86.4rc1; extra == "all"
+Requires-Dist: emmet-core[all]<0.87.2,>=0.87.0; extra == "all"
 Requires-Dist: fastmcp; extra == "all"
 Requires-Dist: flask; extra == "all"
-Requires-Dist: mpcontribs-client>=5.10; extra == "all"
 Provides-Extra: test
 Requires-Dist: pre-commit; extra == "test"
 Requires-Dist: pytest; extra == "test"
@@ -46,6 +57,7 @@ Requires-Dist: mypy-extensions; extra == "test"
 Requires-Dist: typing-extensions; extra == "test"
 Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: types-requests; extra == "test"
+Requires-Dist: types-tqdm; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Dynamic: license-file

{mp_api-0.46.1rc8 → mp_api-0.46.2}/docs/conf.py

@@ -6,6 +6,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+from __future__ import annotations
+
 project = "mp-api"
 copyright = "2022, The Materials Project"
 author = "The Materials Project"

{mp_api-0.46.1rc8 → mp_api-0.46.2}/mp_api/_test_utils.py

@@ -4,6 +4,8 @@
 
 from __future__ import annotations
 
+from enum import Enum
+
 try:
     import pytest
 except ImportError as exc:
@@ -86,19 +88,64 @@ def client_search_testing(
             assert doc[alt_name_dict.get(param, param)] is not None
 
 
-def client_pagination(search_method: Callable, id_name: str):
-    page_1 = search_method(_page=1, chunk_size=NUM_DOCS, fields=[id_name])
-    page_2 = search_method(_page=2, chunk_size=NUM_DOCS, fields=[id_name])
+def client_pagination(
+    search_method: Callable, id_name: str, additional_fields: list[str] | None = None
+) -> None:
+    """Test pagination on an endpoint.
+
+    Args:
+    search_method (Callable) : Client search method to use
+    id_name (str) : the name of a field which uniquely indexes a series of documents
+    additional_fields (list of str) : Optional other fields to retrieve.
+
+    Raises:
+    AssertionError if pagination does not result in unique sets of documents
+    """
+    fields = [id_name, *(additional_fields or [])]
+    page_1 = search_method(_page=1, chunk_size=NUM_DOCS, fields=fields)
+    page_2 = search_method(_page=2, chunk_size=NUM_DOCS, fields=fields)
     assert all(len(results) == NUM_DOCS for results in (page_1, page_2))
     assert {str(getattr(doc, id_name)) for doc in page_1}.intersection(
         {str(getattr(doc, id_name)) for doc in page_2}
     ) == set()
 
 
-def client_sort(search_method: Callable, sort_fields: str | Sequence[str]):
+def client_sort(
+    search_method: Callable,
+    sort_fields: str | Sequence[str],
+    aux_query: dict[str, Any] | None = None,
+    default_fields: tuple[str, ...] = ("deprecated", "material_id"),
+):
+    """Test sorting on an endpoint.
+
+    Args:
+    search_method (Callable) : Client search method to use
+    sort_fields (str or Sequence of str) : fields to sort on
+    aux_query (dict) : auxiliary query needed to filter documents
+    default_fields (list): default fields to return
+
+    Raises:
+    AssertionError if sorting in ascending or descending order does not work.
+    """
+
+    def _normalize(doc, field: str):
+        v = getattr(doc, field)
+        # serialize enums
+        return v.value if isinstance(v, Enum) else v
+
+    user_query = {
+        k: v
+        for k, v in (aux_query or {}).items()
+        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, chunk_size=NUM_DOCS, fields=[sort_field]
+            _page=1,
+            _sort_fields=sort_field,
+            chunk_size=NUM_DOCS,
+            fields=[sort_field, *default_fields],
+            **user_query,
         )
         desc = search_method(
             _page=1,
@@ -108,12 +155,12 @@ def client_sort(search_method: Callable, sort_fields: str | Sequence[str]):
         )
 
         idxs = list(range(NUM_DOCS))
-        assert sorted(idxs, key=lambda idx: getattr(asc[idx], sort_field)) == idxs
+        assert sorted(idxs, key=lambda idx: _normalize(asc[idx], sort_field)) == idxs
 
         assert (
             sorted(
                 idxs,
-                key=lambda idx: getattr(desc[idx], sort_field),
+                key=lambda idx: _normalize(desc[idx], sort_field),
                 reverse=True,
             )
             == idxs

{mp_api-0.46.1rc8 → mp_api-0.46.2}/mp_api/client/__init__.py

@@ -1,4 +1,5 @@
 """Primary MAPI module."""
+
 from __future__ import annotations
 
 import logging

mp_api-0.46.2/mp_api/client/contribs/__init__.py

@@ -0,0 +1,16 @@
+"""Pull in core MPContribs client features."""
+
+from __future__ import annotations
+
+from mp_api.client.contribs._types import Attachment, Table
+from mp_api.client.contribs.client import ContribsClient
+from mp_api.client.contribs.settings import MPCC_SETTINGS
+from mp_api.client.core.exceptions import MPContribsClientError
+
+__all__ = [
+    "ContribsClient",
+    "MPContribsClientError",
+    "MPCC_SETTINGS",
+    "Table",
+    "Attachment",
+]

mp_api-0.46.2/mp_api/client/contribs/_logger.py

@@ -0,0 +1,97 @@
+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
+
+
+class CustomLoggerAdapter(logging.LoggerAdapter):
+    """Adapter for logger to enable prefixing."""
+
+    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")
+        return f"[{prefix}] {msg}" if prefix else msg, kwargs
+
+
+def get_logger(name: str = "mp_api.client.contribs") -> CustomLoggerAdapter:
+    """Get the default MPContribs logger.
+
+    Args:
+        name (str) : name of the logger
+    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.
+
+        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]