cmsdials 1.5.0__tar.gz → 1.7.0__tar.gz

{cmsdials-1.5.0 → cmsdials-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmsdials
-Version: 1.5.0
+Version: 1.7.0
 Summary: The Python api client interface to DIALS service
 Home-page: https://github.com/cms-DQM/dials-py
 Author: Gabriel Moreira
@@ -18,14 +18,17 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Provides-Extra: pandas
 Provides-Extra: tqdm
 Requires-Dist: pandas (>=1.5.3) ; extra == "pandas"
-Requires-Dist: pydantic (>=1,<2)
+Requires-Dist: pydantic (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: tqdm (>=4.66.1) ; extra == "tqdm"
-Requires-Dist: typing-extensions (>=3.6.6,<4.6.0)
-Requires-Dist: urllib3 (>=2.2.3,<3.0.0)
+Requires-Dist: urllib3 (>=1.26.16,<2.0.0)
 Project-URL: Repository, https://github.com/cms-DQM/dials-py
 Description-Content-Type: text/markdown
 
+![Build Status](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/pipeline.svg)
+![Coverage](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/coverage.svg)
+[![PyPI version](https://badge.fury.io/py/cmsdials.png)](https://badge.fury.io/py/cmsdials)
+
 # dials-py
 
 The Python api client interface to DIALS service.
@@ -322,7 +325,7 @@ dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="EEOT digi occupancy
 The repository has some tests written to make sure DIALS responses are compatible with pydantic metaclasses, you can use pytest to run all tests but you need to specify a secret key to authenticate non-interactively against DIALS api:
 
 ```bash
-SECRET_KEY=... pytest tests
+SECRET_KEY=... pytest tests --cov=cmsdials --cov-report=xml --cov-report=term --cov-report=html
 ```
 
 The secret key is an api client enabled secret key and can be obtained from the applications portal, any api client secret key whitelisted in DIALS can be used. The interactive authentication flow should be tested manually, an example for this can be found in [this line](/tests/integration/test_auth_client.py#L33).
@@ -330,6 +333,24 @@ The secret key is an api client enabled secret key and can be obtained from the
 If testing against a local version of DIALS you need to specify the BASE_URL:
 
 ```bash
-SECRET_KEY=... BASE_URl=http://localhost:8000 pytest tests
+SECRET_KEY=... BASE_URL=http://localhost:8000 pytest tests --cov=cmsdials --cov-report=xml --cov-report=term --cov-report=html
+```
+
+### Tox
+
+Tox is pre-configured in `pyproject.toml`, so you can run the following to test against multiple python versions locally:
+
+```bash
+SECRET_KEY=... poetry run tox
 ```
 
+**[asdf](https://asdf-vm.com/) users**
+
+tox requires multiple versions of Python to be installed. Using `asdf`, you have multiple versions installed, but they aren’t normally exposed to the current shell. You can use the following command to expose multiple versions of Python in the current directory:
+
+```bash
+asdf set python 3.12.9 3.11.10 3.10.13 3.9.19
+```
+
+This will use `3.12.9` by default (if you just run `python`), but it will also put `python3.11`, `python3.10` and `python3.9` symlinks in your path so you can run those too (which is exactly what tox is looking for).
+

{cmsdials-1.5.0 → cmsdials-1.7.0}/README.md

@@ -1,3 +1,7 @@
+![Build Status](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/pipeline.svg)
+![Coverage](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/coverage.svg)
+[![PyPI version](https://badge.fury.io/py/cmsdials.png)](https://badge.fury.io/py/cmsdials)
+
 # dials-py
 
 The Python api client interface to DIALS service.
@@ -294,7 +298,7 @@ dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="EEOT digi occupancy
 The repository has some tests written to make sure DIALS responses are compatible with pydantic metaclasses, you can use pytest to run all tests but you need to specify a secret key to authenticate non-interactively against DIALS api:
 
 ```bash
-SECRET_KEY=... pytest tests
+SECRET_KEY=... pytest tests --cov=cmsdials --cov-report=xml --cov-report=term --cov-report=html
 ```
 
 The secret key is an api client enabled secret key and can be obtained from the applications portal, any api client secret key whitelisted in DIALS can be used. The interactive authentication flow should be tested manually, an example for this can be found in [this line](/tests/integration/test_auth_client.py#L33).
@@ -302,5 +306,23 @@ The secret key is an api client enabled secret key and can be obtained from the
 If testing against a local version of DIALS you need to specify the BASE_URL:
 
 ```bash
-SECRET_KEY=... BASE_URl=http://localhost:8000 pytest tests
+SECRET_KEY=... BASE_URL=http://localhost:8000 pytest tests --cov=cmsdials --cov-report=xml --cov-report=term --cov-report=html
+```
+
+### Tox
+
+Tox is pre-configured in `pyproject.toml`, so you can run the following to test against multiple python versions locally:
+
+```bash
+SECRET_KEY=... poetry run tox
 ```
+
+**[asdf](https://asdf-vm.com/) users**
+
+tox requires multiple versions of Python to be installed. Using `asdf`, you have multiple versions installed, but they aren’t normally exposed to the current shell. You can use the following command to expose multiple versions of Python in the current directory:
+
+```bash
+asdf set python 3.12.9 3.11.10 3.10.13 3.9.19
+```
+
+This will use `3.12.9` by default (if you just run `python`), but it will also put `python3.11`, `python3.10` and `python3.9` symlinks in your path so you can run those too (which is exactly what tox is looking for).

cmsdials-1.7.0/cmsdials/__init__.py

@@ -0,0 +1,5 @@
+from ._version import __version__
+from .cmsdials import Dials
+
+
+__all__ = ["__version__", "Dials"]

cmsdials-1.7.0/cmsdials/_version.py

@@ -0,0 +1 @@
+__version__ = "1.7.0"

{cmsdials-1.5.0 → cmsdials-1.7.0}/cmsdials/auth/bearer.py

@@ -126,7 +126,7 @@ class Credentials(BaseCredentials):
     def cache_credentials(self) -> None:
         fpath = self._handle_creds_filepath(self.cache_dir)
         with open(fpath, "w") as filebuffer:
-            json.dump(self._token.dict(), filebuffer, cls=TokenEncoder)
+            json.dump(self._token.model_dump(), filebuffer, cls=TokenEncoder)
 
     def refresh(self) -> None:
         token: Token = self.client.refresh_token(self.token_type, self.token, self.refresh_token)

{cmsdials-1.5.0 → cmsdials-1.7.0}/cmsdials/auth/client.py

@@ -25,6 +25,7 @@ class AuthClient(BaseAPIClient):
             url=endpoint_url,
             headers={
                 "accept": "application/json",
+                "User-Agent": self._build_user_agent()
             },
             timeout=self.default_timeout,
         )
@@ -39,6 +40,7 @@ class AuthClient(BaseAPIClient):
             headers={
                 "accept": "application/json",
                 "Content-Type": "application/json",
+                "User-Agent": self._build_user_agent()
             },
             json={"device_code": device_code},
             timeout=self.default_timeout,
@@ -65,6 +67,7 @@ class AuthClient(BaseAPIClient):
                 "accept": "application/json",
                 "Content-Type": "application/json",
                 "Authorization": f"{token_type} {access_token}",
+                "User-Agent": self._build_user_agent()
             },
             json={"refresh_token": refresh_token},
             timeout=self.default_timeout,

{cmsdials-1.5.0 → cmsdials-1.7.0}/cmsdials/clients/oms_proxy/client.py

@@ -23,7 +23,10 @@ class OMSProxyClient(BaseAPIClient):
         self.creds = creds
 
     def _build_headers(self) -> dict:
-        base = {"accept": "application/json"}
+        base = {
+            "accept": "application/json",
+            "User-Agent": self._build_user_agent()
+        }
         self.creds.before_request(base)
         return base
 

{cmsdials-1.5.0 → cmsdials-1.7.0}/cmsdials/utils/api_client.py

@@ -1,13 +1,16 @@
+import sys
 from importlib import util as importlib_util
 from traceback import format_exc
 from typing import Optional
-from urllib.parse import parse_qs, urlparse
 from warnings import warn
 
+import requests
+from pydantic import AnyUrl
 from requests import Response, Session
 from requests.adapters import DEFAULT_RETRIES, HTTPAdapter
 from requests.exceptions import HTTPError
 
+from .._version import __version__
 from ..auth._base import BaseCredentials
 from ..utils.logger import logger
 
@@ -51,6 +54,12 @@ class BaseAPIClient:
             ret = s.get(*args, **kwargs)
         return ret
 
+    @staticmethod
+    def _build_user_agent():
+        py_version = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+        req_version = requests.__version__
+        return f"dials-py/{__version__} (python/{py_version}, python-requests/{req_version})"
+
     @property
     def api_url(self):
         return self.base_url + self.route + self.version
@@ -75,7 +84,10 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
         self.workspace = workspace
 
     def _build_headers(self) -> dict:
-        base = {"accept": "application/json"}
+        base = {
+            "accept": "application/json",
+            "User-Agent": self._build_user_agent()
+        }
         if self.workspace is not None:
             base["Workspace"] = self.workspace
         self.creds.before_request(base)
@@ -138,13 +150,13 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
         keep_failed: bool = False,
         resume_from=None,
     ):
-        next_string: Optional[str] = None
+        next_string: Optional[AnyUrl] = None
         results = []
         is_last_page = False
 
         if resume_from is not None:
             results = resume_from.results
-            next_string = resume_from.next
+            next_string: AnyUrl = resume_from.next
             if next_string is None and len(results):
                 warn(
                     "resume_from.next is None while resume_from.result is not empty, doing nothing.",
@@ -160,8 +172,8 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
             progress = tqdm(desc="Progress", total=1)
 
         while is_last_page is False:
-            next_token = parse_qs(urlparse(next_string).query).get("next_token") if next_string else None
-            curr_filters = self.filter_class(**filters.dict())
+            next_token = dict(next_string.query_params()).get("next_token") if next_string else None
+            curr_filters = self.filter_class(**filters.model_dump())
             curr_filters.next_token = next_token
             try:
                 response = self.list(curr_filters, retries=retries)
@@ -186,7 +198,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
                     exc_formatted=exc_formatted,
                 )
             results.extend(response.results)
-            next_string = response.next
+            next_string: AnyUrl = response.next
             is_last_page = next_string is None
             total_pages += 1
             max_pages_reached = max_pages and total_pages >= max_pages

{cmsdials-1.5.0 → cmsdials-1.7.0}/cmsdials/utils/base_model.py

@@ -16,7 +16,7 @@ class OBaseModel(BaseModel):
     def cleandict(self):
         return {
             key: ",".join(str(v) for v in value) if isinstance(value, (list, tuple)) else value
-            for key, value in self.dict().items()
+            for key, value in self.model_dump().items()
             if value is not None
         }
 

{cmsdials-1.5.0 → cmsdials-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmsdials"
-version = "1.5.0"
+version = "1.7.0"
 description = "The Python api client interface to DIALS service"
 authors = ["Gabriel Moreira <gabrielmscampos@gmail.com>"]
 readme = "README.md"
@@ -19,17 +19,18 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.9"
 requests = "^2.31.0"
-pydantic = "<2, >=1"
-typing-extensions = "<4.6.0, >=3.6.6"
+urllib3 = "^1.26.16"
+pydantic = "^2.8.2"
 pandas = {version = ">=1.5.3", optional = true}
 tqdm = {version = ">=4.66.1", optional = true}
-urllib3 = "^2.2.3"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.6.2"
 ruff = "^0.4.2"
 notebook = "^7.1.3"
 pytest = "^8.2.0"
+pytest-cov = "^6.0.0"
+tox = "^4.24.1"
 
 [tool.poetry.extras]
 pandas = ["pandas"]
@@ -130,6 +131,19 @@ lines-after-imports = 2
 "**/{tests,docs}/*" = ["E402", "F403", "F405", "S", "N802"]
 "**/*test*.py" = ["E402", "F403", "F405", "S", "N802"]
 
+[tool.poetry-dynamic-versioning]
+enable = false
+
+[tool.tox]
+requires = ["tox>=4.24"]
+env_list = ["py39", "py310", "py311", "py312"]
+
+[tool.tox.env_run_base]
+description = "Run test under {base_python}"
+commands = [["pytest", "tests"]]
+passenv = ["SECRET_KEY", "BASE_URL"]
+allowlist_externals = ["pytest"]
+
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"

cmsdials-1.5.0/cmsdials/__init__.py

@@ -1,4 +0,0 @@
-from .cmsdials import Dials
-
-
-__all__ = ["Dials"]