cmsdials 1.1.0__tar.gz → 1.3.0__tar.gz

{cmsdials-1.1.0 → cmsdials-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmsdials
-Version: 1.1.0
+Version: 1.3.0
 Summary: The Python api client interface to DIALS service
 Home-page: https://github.com/cms-DQM/dials-py
 Author: Gabriel Moreira
@@ -107,11 +107,11 @@ This package interacts with DIALS api endpoints using underlying classes in `Dia
 ### Retrieving a specific object using `get`
 
 ```python
-dials.file_index.get(id=3386119397)
-dials.h1d.get(id=1)
-dials.h2d.get(id=1)
-dials.lumi.get(dataset_id=14677060, run_number=367094, ls_number=1)
-dials.run.get(dataset_id=14677060, run_number=367094)
+dials.file_index.get(dataset_id=14677060, file_id=3393809397)
+dials.h1d.get(dataset_id=14677060, run_number=367112, ls_number=10, me_id=1)
+dials.h1d.get(dataset_id=14677060, run_number=367112, ls_number=10, me_id=96)
+dials.lumi.get(dataset_id=14677060, run_number=367112, ls_number=10)
+dials.run.get(dataset_id=14677060, run_number=367112)
 ```
 
 ### Retrieving a list of objects per page using `list`
@@ -230,3 +230,9 @@ SECRET_KEY=... pytest tests
 
 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).
 
+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
+```
+

{cmsdials-1.1.0 → cmsdials-1.3.0}/README.md

@@ -80,11 +80,11 @@ This package interacts with DIALS api endpoints using underlying classes in `Dia
 ### Retrieving a specific object using `get`
 
 ```python
-dials.file_index.get(id=3386119397)
-dials.h1d.get(id=1)
-dials.h2d.get(id=1)
-dials.lumi.get(dataset_id=14677060, run_number=367094, ls_number=1)
-dials.run.get(dataset_id=14677060, run_number=367094)
+dials.file_index.get(dataset_id=14677060, file_id=3393809397)
+dials.h1d.get(dataset_id=14677060, run_number=367112, ls_number=10, me_id=1)
+dials.h1d.get(dataset_id=14677060, run_number=367112, ls_number=10, me_id=96)
+dials.lumi.get(dataset_id=14677060, run_number=367112, ls_number=10)
+dials.run.get(dataset_id=14677060, run_number=367112)
 ```
 
 ### Retrieving a list of objects per page using `list`
@@ -202,3 +202,9 @@ SECRET_KEY=... pytest tests
 ```
 
 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).
+
+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
+```

cmsdials-1.3.0/cmsdials/clients/file_index/client.py

@@ -0,0 +1,27 @@
+import requests
+from requests.exceptions import HTTPError
+
+from ...utils.api_client import BaseAuthorizedAPIClient
+from ...utils.logger import logger
+from .models import FileIndex, FileIndexFilters, PaginatedFileIndexList
+
+
+class FileIndexClient(BaseAuthorizedAPIClient):
+    data_model = FileIndex
+    pagination_model = PaginatedFileIndexList
+    filter_class = FileIndexFilters
+    lookup_url = "file-index/"
+
+    def get(self, dataset_id: int, file_id: int):
+        endpoint_url = f"{self.api_url}{self.lookup_url}{dataset_id}/{file_id}/"
+        headers = self._build_headers()
+        response = requests.get(endpoint_url, headers=headers, timeout=self.default_timeout)
+
+        try:
+            response.raise_for_status()
+        except HTTPError as err:
+            logger.info(f"Api raw response: {response.text}")
+            raise err
+
+        response = response.json()
+        return self.data_model(**response)

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/clients/file_index/models.py

@@ -14,7 +14,7 @@ class FileIndex(BaseModel):
     creation_date: datetime
     last_modification_date: datetime
     logical_file_name: str
-    status: str = Field(..., max_length=15)
+    status: str = Field(..., max_length=255)
     err_trace: Optional[str] = Field(..., max_length=5000)
 
 

cmsdials-1.3.0/cmsdials/clients/h1d/client.py

@@ -0,0 +1,27 @@
+import requests
+from requests.exceptions import HTTPError
+
+from ...utils.api_client import BaseAuthorizedAPIClient
+from ...utils.logger import logger
+from .models import LumisectionHistogram1D, LumisectionHistogram1DFilters, PaginatedLumisectionHistogram1DList
+
+
+class LumisectionHistogram1DClient(BaseAuthorizedAPIClient):
+    data_model = LumisectionHistogram1D
+    pagination_model = PaginatedLumisectionHistogram1DList
+    filter_class = LumisectionHistogram1DFilters
+    lookup_url = "th1/"
+
+    def get(self, dataset_id: int, run_number: int, ls_number: int, me_id: int):
+        endpoint_url = f"{self.api_url}{self.lookup_url}{dataset_id}/{run_number}/{ls_number}/{me_id}/"
+        headers = self._build_headers()
+        response = requests.get(endpoint_url, headers=headers, timeout=self.default_timeout)
+
+        try:
+            response.raise_for_status()
+        except HTTPError as err:
+            logger.info(f"Api raw response: {response.text}")
+            raise err
+
+        response = response.json()
+        return self.data_model(**response)

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/clients/h1d/models.py

@@ -6,7 +6,6 @@ from ...utils.base_model import OBaseModel, PaginatedBaseModel
 
 
 class LumisectionHistogram1D(BaseModel):
-    hist_id: int
     dataset: str = Field(..., max_length=255)
     me: str = Field(..., max_length=255)
     dataset_id: int

cmsdials-1.3.0/cmsdials/clients/h2d/client.py

@@ -0,0 +1,27 @@
+import requests
+from requests.exceptions import HTTPError
+
+from ...utils.api_client import BaseAuthorizedAPIClient
+from ...utils.logger import logger
+from .models import LumisectionHistogram2D, LumisectionHistogram2DFilters, PaginatedLumisectionHistogram2DList
+
+
+class LumisectionHistogram2DClient(BaseAuthorizedAPIClient):
+    data_model = LumisectionHistogram2D
+    pagination_model = PaginatedLumisectionHistogram2DList
+    filter_class = LumisectionHistogram2DFilters
+    lookup_url = "th2/"
+
+    def get(self, dataset_id: int, run_number: int, ls_number: int, me_id: int):
+        endpoint_url = f"{self.api_url}{self.lookup_url}{dataset_id}/{run_number}/{ls_number}/{me_id}/"
+        headers = self._build_headers()
+        response = requests.get(endpoint_url, headers=headers, timeout=self.default_timeout)
+
+        try:
+            response.raise_for_status()
+        except HTTPError as err:
+            logger.info(f"Api raw response: {response.text}")
+            raise err
+
+        response = response.json()
+        return self.data_model(**response)

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/clients/h2d/models.py

@@ -6,7 +6,6 @@ from ...utils.base_model import OBaseModel, PaginatedBaseModel
 
 
 class LumisectionHistogram2D(BaseModel):
-    hist_id: int
     dataset: str = Field(..., max_length=255)
     me: str = Field(..., max_length=255)
     dataset_id: int

cmsdials-1.3.0/cmsdials/clients/oms_proxy/client.py

@@ -0,0 +1,46 @@
+from typing import Optional
+
+import requests
+from requests.exceptions import HTTPError
+
+from ...auth._base import BaseCredentials
+from ...utils.api_client import BaseAPIClient
+from ...utils.logger import logger
+from .models import OMSFilter, OMSPage
+
+
+class OMSProxyClient(BaseAPIClient):
+    default_timeout = 30
+    lookup_url = "oms-proxy/"
+
+    def __init__(
+        self,
+        creds: BaseCredentials,
+        *args: str,
+        **kwargs: str,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self.creds = creds
+
+    def _build_headers(self) -> dict:
+        base = {"accept": "application/json"}
+        self.creds.before_request(base)
+        return base
+
+    def query(self, endpoint: str, filters: list[OMSFilter], pages: Optional[list[OMSPage]] = None):
+        headers = self._build_headers()
+        endpoint_url = self.api_url + self.lookup_url
+
+        # Format filters
+        filters = {f"filter[{_filter.attribute_name}][{_filter.operator}]": _filter.value for _filter in filters}
+        pages = {f"page[{page.attribute_name}]": page.value for page in pages} if pages and len(pages) > 0 else {}
+        params = {"endpoint": endpoint, **filters, **pages}
+
+        response = requests.get(endpoint_url, headers=headers, params=params, timeout=self.default_timeout)
+        try:
+            response.raise_for_status()
+        except HTTPError as err:
+            logger.info(f"Api raw response: {response.text}")
+            raise err
+
+        return response.json()

cmsdials-1.3.0/cmsdials/clients/oms_proxy/models.py

@@ -0,0 +1,14 @@
+from typing import Literal, Union
+
+from pydantic import BaseModel
+
+
+class OMSFilter(BaseModel):
+    attribute_name: str
+    value: Union[str, int, float]
+    operator: Literal["EQ", "NEQ", "LT", "GT", "LE", "GE", "LIKE"]
+
+
+class OMSPage(BaseModel):
+    attribute_name: str
+    value: int

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/cmsdials.py

@@ -6,6 +6,7 @@ from .clients.h1d.client import LumisectionHistogram1DClient
 from .clients.h2d.client import LumisectionHistogram2DClient
 from .clients.lumisection.client import LumisectionClient
 from .clients.mes.client import MonitoringElementClient
+from .clients.oms_proxy.client import OMSProxyClient
 from .clients.run.client import RunClient
 
 
@@ -17,3 +18,4 @@ class Dials:
         self.lumi = LumisectionClient(creds, workspace, *args, **kwargs)
         self.run = RunClient(creds, workspace, *args, **kwargs)
         self.mes = MonitoringElementClient(creds, workspace, *args, **kwargs)
+        self.oms = OMSProxyClient(creds, *args, **kwargs)

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/filters.py

@@ -3,6 +3,7 @@ from .clients.h1d.models import LumisectionHistogram1DFilters
 from .clients.h2d.models import LumisectionHistogram2DFilters
 from .clients.lumisection.models import LumisectionFilters
 from .clients.mes.models import MEFilters
+from .clients.oms_proxy.models import OMSFilter, OMSPage
 from .clients.run.models import RunFilters
 
 
@@ -13,4 +14,6 @@ __all__ = [
     "LumisectionFilters",
     "RunFilters",
     "MEFilters",
+    "OMSFilter",
+    "OMSPage",
 ]

{cmsdials-1.1.0 → cmsdials-1.3.0}/cmsdials/utils/api_client.py

@@ -10,7 +10,7 @@ from ..utils.logger import logger
 
 
 if importlib_util.find_spec("tqdm"):
-    from tqdm import tqdm
+    from tqdm.auto import tqdm
 
     TQDM_INSTALLED = True
 else:
@@ -99,13 +99,14 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
 
         raise ValueError("pagination model is None and response is not a list.")
 
-    def __list_sync(self, filters, max_pages: Optional[int] = None):
+    def __list_sync(self, filters, max_pages: Optional[int] = None, enable_progress: bool = False):
         next_token = None
         results = []
         is_last_page = False
         total_pages = 0
+        use_tqdm = TQDM_INSTALLED and enable_progress
 
-        if TQDM_INSTALLED:
+        if use_tqdm:
             progress = tqdm(desc="Progress", total=1)
 
         while is_last_page is False:
@@ -117,7 +118,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
             next_token = parse_qs(urlparse(response.next).query).get("next_token") if response.next else None
             total_pages += 1
             max_pages_reached = max_pages and total_pages >= max_pages
-            if TQDM_INSTALLED:
+            if use_tqdm:
                 if is_last_page or max_pages_reached:
                     progress.update()
                 else:
@@ -126,7 +127,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
             if max_pages_reached:
                 break
 
-        if TQDM_INSTALLED:
+        if use_tqdm:
             progress.close()
 
         return self.pagination_model(
@@ -135,7 +136,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
             results=results,  # No problem re-using last response count
         )
 
-    def list_all(self, filters, max_pages: Optional[int] = None):
+    def list_all(self, filters, max_pages: Optional[int] = None, **kwargs):
         if self.pagination_model is None:
             return self.list(filters)
-        return self.__list_sync(filters, max_pages)
+        return self.__list_sync(filters, max_pages, **kwargs)

{cmsdials-1.1.0 → cmsdials-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmsdials"
-version = "1.1.0"
+version = "1.3.0"
 description = "The Python api client interface to DIALS service"
 authors = ["Gabriel Moreira <gabrielmscampos@gmail.com>"]
 readme = "README.md"

cmsdials-1.1.0/cmsdials/clients/file_index/client.py

@@ -1,9 +0,0 @@
-from ...utils.api_client import BaseAuthorizedAPIClient
-from .models import FileIndex, FileIndexFilters, PaginatedFileIndexList
-
-
-class FileIndexClient(BaseAuthorizedAPIClient):
-    data_model = FileIndex
-    pagination_model = PaginatedFileIndexList
-    filter_class = FileIndexFilters
-    lookup_url = "file-index/"

cmsdials-1.1.0/cmsdials/clients/h1d/client.py

@@ -1,9 +0,0 @@
-from ...utils.api_client import BaseAuthorizedAPIClient
-from .models import LumisectionHistogram1D, LumisectionHistogram1DFilters, PaginatedLumisectionHistogram1DList
-
-
-class LumisectionHistogram1DClient(BaseAuthorizedAPIClient):
-    data_model = LumisectionHistogram1D
-    pagination_model = PaginatedLumisectionHistogram1DList
-    filter_class = LumisectionHistogram1DFilters
-    lookup_url = "th1/"

cmsdials-1.1.0/cmsdials/clients/h2d/client.py

@@ -1,9 +0,0 @@
-from ...utils.api_client import BaseAuthorizedAPIClient
-from .models import LumisectionHistogram2D, LumisectionHistogram2DFilters, PaginatedLumisectionHistogram2DList
-
-
-class LumisectionHistogram2DClient(BaseAuthorizedAPIClient):
-    data_model = LumisectionHistogram2D
-    pagination_model = PaginatedLumisectionHistogram2DList
-    filter_class = LumisectionHistogram2DFilters
-    lookup_url = "th2/"