cmsdials 0.3.0__tar.gz → 0.4.0__tar.gz

{cmsdials-0.3.0 → cmsdials-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmsdials
-Version: 0.3.0
+Version: 0.4.0
 Summary: The Python api client interface to DIALS service
 Home-page: https://github.com/cms-DQM/dials-py
 Author: Gabriel Moreira
@@ -82,6 +82,14 @@ dials = Dials(creds, nthreads=2)
 data = dials.h1d.list_all(LumisectionHistogram1DFilters(title="PixelPhase1/Tracks/PXBarrel/charge_PXLayer_2"), max_pages=5)
 ```
 
+### Workspace
+
+Users are automatically routed to a workspace based on e-groups, but it is possible to overwrite this configuration and inspect data from others workspaces:
+
+```python
+dials = Dials(creds, workspace="jetmet", nthreads=2)
+```
+
 ## Available endpoints
 
 This package interacts with DIALS api endpoints using underlying classes in `Dials` object.
@@ -89,7 +97,6 @@ This package interacts with DIALS api endpoints using underlying classes in `Dia
 ### Retrieving a specific object using `get`
 
 ```python
-dials.bad_file_index.get(id=1)
 dials.file_index.get(id=1)
 dials.h1d.get(id=1)
 dials.h2d.get(id=1)
@@ -102,7 +109,6 @@ dials.run.get(id=1)
 It is possible to get a list of entries from those endpoint using the `list` and `list_all` methods, the `list` method will fetch only one page and the `list_all` will fetch all available pages:
 
 ```python
-dials.bad_file_index.list()
 dials.file_index.list()
 dials.h1d.list()
 dials.h2d.list()
@@ -113,7 +119,6 @@ dials.run.list()
 ### Retrieving all available pages of a list of objects using `list_all`
 
 ```python
-dials.bad_file_index.list_all()
 dials.file_index.list_all()
 dials.h1d.list_all()
 dials.h2d.list_all()
@@ -133,7 +138,6 @@ Keep in mind that calling those methods without any filter can take a lot of tim
 
 ```python
 from cmsdials.filters import (
-    BadFileIndexFilters,
     FileIndexFilters,
     LumisectionHistogram1DFilters,
     LumisectionHistogram2DFilters,
@@ -141,7 +145,6 @@ from cmsdials.filters import (
     RunFilters
 )
 
-dials.bad_file_index.list(BadFileIndexFilters(path_contains="ZeroBias"))
 
 dials.file_index.list(FileIndexFilters(page="10"))
 
@@ -173,7 +176,7 @@ from cmsdials import Dials
 from cmsdials.filters import LumisectionHistogram2DFilters
 
 DEV_URL = "http://localhost:8000/"
-DEV_CACHE_DIR = ".cache-dev
+DEV_CACHE_DIR = ".cache-dev"
 
 auth = AuthClient(base_url=DEV_URL)
 creds = Credentials.from_creds_file(cache_dir=DEV_CACHE_DIR, client=auth)  # Make sure to specify the auth client with overwritten values, using another cache_dir is recommended

{cmsdials-0.3.0 → cmsdials-0.4.0}/README.md

@@ -59,6 +59,14 @@ dials = Dials(creds, nthreads=2)
 data = dials.h1d.list_all(LumisectionHistogram1DFilters(title="PixelPhase1/Tracks/PXBarrel/charge_PXLayer_2"), max_pages=5)
 ```
 
+### Workspace
+
+Users are automatically routed to a workspace based on e-groups, but it is possible to overwrite this configuration and inspect data from others workspaces:
+
+```python
+dials = Dials(creds, workspace="jetmet", nthreads=2)
+```
+
 ## Available endpoints
 
 This package interacts with DIALS api endpoints using underlying classes in `Dials` object.
@@ -66,7 +74,6 @@ This package interacts with DIALS api endpoints using underlying classes in `Dia
 ### Retrieving a specific object using `get`
 
 ```python
-dials.bad_file_index.get(id=1)
 dials.file_index.get(id=1)
 dials.h1d.get(id=1)
 dials.h2d.get(id=1)
@@ -79,7 +86,6 @@ dials.run.get(id=1)
 It is possible to get a list of entries from those endpoint using the `list` and `list_all` methods, the `list` method will fetch only one page and the `list_all` will fetch all available pages:
 
 ```python
-dials.bad_file_index.list()
 dials.file_index.list()
 dials.h1d.list()
 dials.h2d.list()
@@ -90,7 +96,6 @@ dials.run.list()
 ### Retrieving all available pages of a list of objects using `list_all`
 
 ```python
-dials.bad_file_index.list_all()
 dials.file_index.list_all()
 dials.h1d.list_all()
 dials.h2d.list_all()
@@ -110,7 +115,6 @@ Keep in mind that calling those methods without any filter can take a lot of tim
 
 ```python
 from cmsdials.filters import (
-    BadFileIndexFilters,
     FileIndexFilters,
     LumisectionHistogram1DFilters,
     LumisectionHistogram2DFilters,
@@ -118,7 +122,6 @@ from cmsdials.filters import (
     RunFilters
 )
 
-dials.bad_file_index.list(BadFileIndexFilters(path_contains="ZeroBias"))
 
 dials.file_index.list(FileIndexFilters(page="10"))
 
@@ -150,7 +153,7 @@ from cmsdials import Dials
 from cmsdials.filters import LumisectionHistogram2DFilters
 
 DEV_URL = "http://localhost:8000/"
-DEV_CACHE_DIR = ".cache-dev
+DEV_CACHE_DIR = ".cache-dev"
 
 auth = AuthClient(base_url=DEV_URL)
 creds = Credentials.from_creds_file(cache_dir=DEV_CACHE_DIR, client=auth)  # Make sure to specify the auth client with overwritten values, using another cache_dir is recommended

cmsdials-0.4.0/cmsdials/clients/file_index/models.py

@@ -0,0 +1,36 @@
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import AnyUrl, BaseModel, Field
+
+from ...utils.base_model import OBaseModel
+
+
+class FileIndex(BaseModel):
+    file_id: int
+    file_size: int
+    era: str = Field(..., max_length=5)
+    campaign: str = Field(..., max_length=15)
+    primary_dataset: str = Field(..., max_length=50)
+    creation_date: datetime
+    last_modification_date: datetime
+    logical_file_name: str
+    status: str = Field(..., max_length=15)
+    err_trace: Optional[str] = Field(..., max_length=5000)
+
+
+class PaginatedFileIndexList(BaseModel):
+    count: int
+    next: Optional[AnyUrl]
+    previous: Optional[AnyUrl]
+    results: List[FileIndex]
+
+
+class FileIndexFilters(OBaseModel):
+    page: Optional[str] = None
+    min_size: Optional[int] = None
+    era: Optional[str] = None
+    campaign: Optional[str] = None
+    primary_dataset: Optional[str] = None
+    logical_file_name: Optional[str] = None
+    status: Optional[str] = None

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/clients/h1d/models.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 from typing import List, Optional
 
 from pydantic import AnyUrl, BaseModel, Field
@@ -7,18 +6,16 @@ from ...utils.base_model import OBaseModel
 
 
 class LumisectionHistogram1D(BaseModel):
-    id: int
-    ls_number: int
+    hist_id: int
+    file_id: int
     run_number: int
-    date: datetime
+    ls_id: int
     title: str = Field(..., max_length=220)
-    entries: int
-    data: list[float]
     x_min: float
     x_max: float
-    x_bin: int
-    source_data_file: int
-    lumisection: int
+    x_bin: float
+    entries: int
+    data: list[float]
 
 
 class PaginatedLumisectionHistogram1DList(BaseModel):
@@ -29,16 +26,18 @@ class PaginatedLumisectionHistogram1DList(BaseModel):
 
 
 class LumisectionHistogram1DFilters(OBaseModel):
-    ls_number: Optional[int] = None
-    lumisection_id: Optional[int] = None
-    max_ls_number: Optional[int] = None
-    max_run_number: Optional[int] = None
-    min_entries: Optional[int] = None
-    min_ls_number: Optional[int] = None
-    min_run_number: Optional[int] = None
     page: Optional[str] = None
     run_number: Optional[int] = None
+    ls_number: Optional[int] = None
+    ls_id: Optional[int] = None
     title: Optional[str] = None
+    min_run_number: Optional[int] = None
+    max_run_number: Optional[int] = None
+    min_ls_number: Optional[int] = None
+    max_ls_number: Optional[int] = None
     title_contains: Optional[str] = None
+    min_entries: Optional[int] = None
     era: Optional[str] = None
-    dqmio_filepath_contains: Optional[str] = None
+    campaign: Optional[str] = None
+    primary_dataset: Optional[str] = None
+    file_id: Optional[int] = None

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/clients/h2d/models.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 from typing import Optional
 
 from pydantic import AnyUrl, BaseModel, Field
@@ -7,24 +6,19 @@ from ...utils.base_model import OBaseModel
 
 
 class LumisectionHistogram2D(BaseModel):
-    id: int
-    ls_number: int
+    hist_id: int
+    file_id: int
     run_number: int
-    date: datetime
+    ls_id: int
     title: str = Field(..., max_length=220)
-    entries: int
-    data: list[list[float]]
     x_min: float
     x_max: float
-    x_bin: int
-    y_max: float
+    x_bin: float
     y_min: float
-    y_bin: int
-    source_data_file: int = Field(
-        ...,
-        description="Source data file that the specific Histogram was read from, if any",
-    )
-    lumisection: int
+    y_max: float
+    y_bin: float
+    entries: int
+    data: list[float]
 
 
 class PaginatedLumisectionHistogram2DList(BaseModel):
@@ -35,16 +29,18 @@ class PaginatedLumisectionHistogram2DList(BaseModel):
 
 
 class LumisectionHistogram2DFilters(OBaseModel):
-    ls_number: Optional[int] = None
-    lumisection_id: Optional[int] = None
-    max_ls_number: Optional[int] = None
-    max_run_number: Optional[int] = None
-    min_entries: Optional[int] = None
-    min_ls_number: Optional[int] = None
-    min_run_number: Optional[int] = None
     page: Optional[str] = None
     run_number: Optional[int] = None
+    ls_number: Optional[int] = None
+    ls_id: Optional[int] = None
     title: Optional[str] = None
+    min_run_number: Optional[int] = None
+    max_run_number: Optional[int] = None
+    min_ls_number: Optional[int] = None
+    max_ls_number: Optional[int] = None
     title_contains: Optional[str] = None
+    min_entries: Optional[int] = None
     era: Optional[str] = None
-    dqmio_filepath_contains: Optional[str] = None
+    campaign: Optional[str] = None
+    primary_dataset: Optional[str] = None
+    file_id: Optional[int] = None

cmsdials-0.4.0/cmsdials/clients/lumisection/client.py

@@ -0,0 +1,9 @@
+from ...utils.api_client import BaseAuthorizedAPIClient
+from .models import Lumisection, LumisectionFilters, PaginatedLumisectionList
+
+
+class LumisectionClient(BaseAuthorizedAPIClient):
+    data_model = Lumisection
+    pagination_model = PaginatedLumisectionList
+    filter_class = LumisectionFilters
+    lookup_url = "lumisection/"

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/clients/lumisection/models.py

@@ -1,5 +1,4 @@
-from datetime import datetime
-from typing import List, Optional
+from typing import Optional
 
 from pydantic import AnyUrl, BaseModel
 
@@ -7,11 +6,10 @@ from ...utils.base_model import OBaseModel
 
 
 class Lumisection(BaseModel):
-    id: int
+    ls_id: int
     ls_number: int
-    date: datetime
-    oms_zerobias_rate: Optional[float]
-    run: int
+    th1_count: int
+    th2_count: int
 
 
 class PaginatedLumisectionList(BaseModel):
@@ -22,14 +20,10 @@ class PaginatedLumisectionList(BaseModel):
 
 
 class LumisectionFilters(OBaseModel):
+    page: Optional[str] = None
+    run_number: Optional[int] = None
     ls_number: Optional[int] = None
-    max_ls_number: Optional[int] = None
-    max_run_number: Optional[int] = None
     min_ls_number: Optional[int] = None
+    max_ls_number: Optional[int] = None
     min_run_number: Optional[int] = None
-    page: Optional[str] = None
-    run_number: Optional[int] = None
-
-
-class ConfiguredMEs(BaseModel):
-    mes: List[str]
+    max_run_number: Optional[int] = None

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/clients/run/models.py

@@ -1,21 +1,13 @@
-from datetime import datetime
 from typing import Optional
 
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic import AnyUrl, BaseModel
 
 from ...utils.base_model import OBaseModel
 
 
 class Run(BaseModel):
     run_number: int
-    run_date: Optional[datetime]
-    year: Optional[int]
-    period: Optional[str] = Field(..., max_length=1)
-    date: datetime
-    oms_fill: Optional[int]
-    oms_lumisections: Optional[int]
-    oms_initial_lumi: Optional[float]
-    oms_end_lumi: Optional[float]
+    ls_count: int
 
 
 class PaginatedRunList(BaseModel):
@@ -26,6 +18,6 @@ class PaginatedRunList(BaseModel):
 
 
 class RunFilters(OBaseModel):
+    page: Optional[str] = None
     max_run_number: Optional[int] = None
     min_run_number: Optional[int] = None
-    page: Optional[str] = None

cmsdials-0.4.0/cmsdials/cmsdials.py

@@ -0,0 +1,19 @@
+from typing import Optional
+
+from .auth._base import BaseCredentials
+from .clients.file_index.client import FileIndexClient
+from .clients.h1d.client import LumisectionHistogram1DClient
+from .clients.h2d.client import LumisectionHistogram2DClient
+from .clients.lumisection.client import LumisectionClient
+from .clients.run.client import RunClient
+
+
+class Dials:
+    def __init__(
+        self, creds: BaseCredentials, workspace: Optional[str] = None, nthreads: Optional[int] = None, *args, **kwargs
+    ) -> None:
+        self.file_index = FileIndexClient(creds, workspace, nthreads, *args, **kwargs)
+        self.h1d = LumisectionHistogram1DClient(creds, workspace, nthreads, *args, **kwargs)
+        self.h2d = LumisectionHistogram2DClient(creds, workspace, nthreads, *args, **kwargs)
+        self.lumi = LumisectionClient(creds, workspace, nthreads, *args, **kwargs)
+        self.run = RunClient(creds, workspace, nthreads, *args, **kwargs)

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/filters.py

@@ -1,4 +1,3 @@
-from .clients.bad_file_index.models import BadFileIndexFilters
 from .clients.file_index.models import FileIndexFilters
 from .clients.h1d.models import LumisectionHistogram1DFilters
 from .clients.h2d.models import LumisectionHistogram2DFilters
@@ -6,7 +5,6 @@ from .clients.lumisection.models import LumisectionFilters
 from .clients.run.models import RunFilters
 
 __all__ = [
-    "BadFileIndexFilters",
     "FileIndexFilters",
     "LumisectionHistogram1DFilters",
     "LumisectionHistogram2DFilters",

{cmsdials-0.3.0 → cmsdials-0.4.0}/cmsdials/utils/api_client.py

@@ -38,15 +38,29 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
     filter_class = None
     lookup_url = None
 
-    def __init__(self, creds: BaseCredentials, nthreads: Optional[int] = None, *args: str, **kwargs: str) -> None:
+    def __init__(
+        self,
+        creds: BaseCredentials,
+        workspace: Optional[str] = None,
+        nthreads: Optional[int] = None,
+        *args: str,
+        **kwargs: str,
+    ) -> None:
         super().__init__(*args, **kwargs)
         self.creds = creds
+        self.workspace = workspace
         self.nthreads = nthreads or 1
 
+    def __build_headers(self) -> dict:
+        base = {"accept": "application/json"}
+        if self.workspace is not None:
+            base["Workspace"] = self.workspace
+        self.creds.before_request(base)
+        return base
+
     def get(self, id: str):
         endpoint_url = self.api_url + self.lookup_url + str(id) + "/"
-        headers = {"accept": "application/json"}
-        self.creds.before_request(headers)
+        headers = self.__build_headers()
         response = requests.get(endpoint_url, headers=headers)
 
         try:
@@ -61,8 +75,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
     def list(self, filters=None):
         filters = filters or self.filter_class()
         endpoint_url = self.api_url + self.lookup_url
-        headers = {"accept": "application/json"}
-        self.creds.before_request(headers)
+        headers = self.__build_headers()
         response = requests.get(endpoint_url, headers=headers, params=filters.cleandict())
 
         try:

{cmsdials-0.3.0 → cmsdials-0.4.0}/pyproject.toml

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

cmsdials-0.3.0/cmsdials/clients/bad_file_index/client.py

@@ -1,9 +0,0 @@
-from ...utils.api_client import BaseAuthorizedAPIClient
-from .models import BadFileIndex, BadFileIndexFilters, PaginatedBadFileIndexList
-
-
-class BadFileIndexClient(BaseAuthorizedAPIClient):
-    data_model = BadFileIndex
-    pagination_model = PaginatedBadFileIndexList
-    filter_class = BadFileIndexFilters
-    lookup_url = "bad-file-index/"

cmsdials-0.3.0/cmsdials/clients/bad_file_index/models.py

@@ -1,30 +0,0 @@
-from datetime import datetime
-from typing import List, Optional
-
-from pydantic import AnyUrl, BaseModel, Field
-
-from ...utils.base_model import OBaseModel
-
-
-class BadFileIndex(BaseModel):
-    id: int
-    file_path: str = Field(..., description="Path where the file is stored", max_length=255)
-    data_era: str = Field(..., description="The era that the data refers to (e.g. 2018A)", max_length=7)
-    st_size: float = Field(..., description="The data file's size in bytes")
-    st_ctime: datetime = Field(..., description="Time of files's last status change in filesystem")
-    st_itime: datetime = Field(..., description="Time when file was indexed in database")
-    err: str = Field(..., description="Error message", max_length=255)
-
-
-class PaginatedBadFileIndexList(BaseModel):
-    count: int
-    next: Optional[AnyUrl]
-    previous: Optional[AnyUrl]
-    results: List[BadFileIndex]
-
-
-class BadFileIndexFilters(OBaseModel):
-    era: Optional[str] = None
-    min_size: Optional[float] = None
-    page: Optional[str] = None
-    path_contains: Optional[str] = None

cmsdials-0.3.0/cmsdials/clients/file_index/models.py

@@ -1,44 +0,0 @@
-from datetime import datetime
-from typing import List, Optional
-
-from pydantic import AnyUrl, BaseModel, Field
-
-from ...utils.base_model import OBaseModel
-
-
-class FileIndex(BaseModel):
-    id: int
-    file_uuid: str = Field(..., description="ROOT TFile UUID", max_length=36)
-    file_path: str = Field(..., description="Path where the file is stored", max_length=255)
-    data_era: str = Field(..., description="The era that the data refers to (e.g. 2018A)", max_length=7)
-    n_entries: int = Field(
-        ...,
-        description="Total number of entries contained in this histogram file",
-    )
-    n_entries_ingested: int = Field(
-        ...,
-        description="Number of histogram entries that have been extracted from the file",
-    )
-    st_size: float = Field(..., description="The data file's size in bytes")
-    st_ctime: datetime = Field(..., description="Time of files's last status change in filesystem")
-    st_itime: datetime = Field(..., description="Time when file was indexed in database")
-    status: str = Field(
-        ...,
-        description="Indicate the processing status of run-histogram within the file",
-        max_length=9,
-    )
-
-
-class PaginatedFileIndexList(BaseModel):
-    count: int
-    next: Optional[AnyUrl]
-    previous: Optional[AnyUrl]
-    results: List[FileIndex]
-
-
-class FileIndexFilters(OBaseModel):
-    era: Optional[str] = None
-    min_size: Optional[float] = None
-    page: Optional[str] = None
-    path_contains: Optional[str] = None
-    status: Optional[str] = None

cmsdials-0.3.0/cmsdials/clients/lumisection/client.py

@@ -1,20 +0,0 @@
-import requests
-
-from ...utils.api_client import BaseAuthorizedAPIClient
-from .models import ConfiguredMEs, Lumisection, LumisectionFilters, PaginatedLumisectionList
-
-
-class LumisectionClient(BaseAuthorizedAPIClient):
-    data_model = Lumisection
-    pagination_model = PaginatedLumisectionList
-    filter_class = LumisectionFilters
-    lookup_url = "lumisection/"
-
-    def configured_mes(self):
-        endpoint_url = self.api_url + self.lookup_url + "configured-mes/"
-        headers = {"accept": "application/json"}
-        self.creds.before_request(headers)
-        response = requests.get(endpoint_url, headers=headers)
-        response.raise_for_status()
-        response = response.json()
-        return ConfiguredMEs(**response)

cmsdials-0.3.0/cmsdials/cmsdials.py

@@ -1,19 +0,0 @@
-from typing import Optional
-
-from .auth._base import BaseCredentials
-from .clients.bad_file_index.client import BadFileIndexClient
-from .clients.file_index.client import FileIndexClient
-from .clients.h1d.client import LumisectionHistogram1DClient
-from .clients.h2d.client import LumisectionHistogram2DClient
-from .clients.lumisection.client import LumisectionClient
-from .clients.run.client import RunClient
-
-
-class Dials:
-    def __init__(self, creds: BaseCredentials, nthreads: Optional[int] = None, *args, **kwargs) -> None:
-        self.bad_file_index = BadFileIndexClient(creds, nthreads, *args, **kwargs)
-        self.file_index = FileIndexClient(creds, nthreads, *args, **kwargs)
-        self.h1d = LumisectionHistogram1DClient(creds, nthreads, *args, **kwargs)
-        self.h2d = LumisectionHistogram2DClient(creds, nthreads, *args, **kwargs)
-        self.lumi = LumisectionClient(creds, nthreads, *args, **kwargs)
-        self.run = RunClient(creds, nthreads, *args, **kwargs)