cmsdials 0.0.0__py3-none-any.whl

cmsdials-0.0.0.dist-info/METADATA

@@ -0,0 +1,356 @@
+Metadata-Version: 2.1
+Name: cmsdials
+Version: 0.0.0
+Summary: The Python api client interface to DIALS service
+Home-page: https://github.com/cms-DQM/dials-py
+Author: Gabriel Moreira
+Author-email: gabrielmscampos@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: pandas
+Provides-Extra: tqdm
+Requires-Dist: pandas (>=1.5.3) ; extra == "pandas"
+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: 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.
+
+## Installation
+
+To install dials-py, simply
+
+```bash
+$ pip install cmsdials
+```
+
+It is also possible to specify the following extras, to enable optional features:
+
+```
+pandas, tqdm
+```
+
+## Usage
+
+Before interfacing with any route you need to generate valid credentials, it is possible to authenticate trough the `device authorization flow` or using the `client secret key` of any application registered in DIALS. Note that, the device flow is an interactively authentication procedure that is possible to distinguish users in DIALS backend and the client secret flow is not interactive and is not possible to distinguish users so it should only be used for automation scripts.
+
+### Generating credentials with client secret
+
+```python
+from cmsdials.auth.secret_key import Credentials
+
+creds = Credentials(token=".....")
+```
+
+### Generating credentials with device
+
+#### Loading from AuthClient
+
+```python
+from cmsdials.auth.client import AuthClient
+from cmsdials.auth.bearer import Credentials
+
+auth = AuthClient()
+token = auth.device_auth_flow()
+creds = Credentials.from_authclient_token(token)
+```
+
+#### Loading from cached credentials file
+
+Credentials are always cached once you authenticate at least one time, calling this method without having a cached credential file will automatically trigger the AuthClient device flow.
+
+```python
+from cmsdials.auth.bearer import Credentials
+
+creds = Credentials.from_creds_file()
+```
+
+### Basic Example
+
+```python
+from cmsdials.auth.bearer import Credentials
+from cmsdials import Dials
+from cmsdials.filters import LumisectionHistogram1DFilters
+
+creds = Credentials.from_creds_file()
+dials = Dials(creds)
+
+# Getting h1d data
+data = dials.h1d.list_all(LumisectionHistogram1DFilters(me="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")
+```
+
+## Available endpoints
+
+This package interacts with DIALS api endpoints using underlying classes in `Dials` object.
+
+### Retrieving a specific object using `get`
+
+```python
+dials.dataset_index.get(dataset_id=14677060)
+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)
+
+# jetmet worskpace
+dials.ml_models_index(model_id=1)
+dials.ml_bad_lumisection(model_id=19, dataset_id=15102369, run_number=386951, ls_number=36)
+```
+
+### Retrieving a list of objects per page using `list`
+
+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.dataset_index.list()
+dials.file_index.list()
+dials.h1d.list()
+dials.h2d.list()
+dials.lumi.list()
+dials.run.list()
+dials.ml_models_index.list()
+dials.ml_bad_lumisection.list()
+```
+
+### Retrieving all available pages of a list of objects using `list_all`
+
+Note: Keep in mind that running `list_all` without any filter can take too much time, since you will be retrieving all rows in the database.
+
+```python
+dials.dataset_index.list_all()
+dials.file_index.list_all()
+dials.h1d.list_all()
+dials.h2d.list_all()
+dials.lumi.list_all()
+dials.run.list_all()
+dials.ml_models_index.list_all()
+dials.ml_bad_lumisection.list_all()
+```
+
+If you don't need all available pages but just a subset of then, it is possible to specify a `max_pages` integer parameter:
+
+```python
+dials.run.list_all(..., max_pages=5)
+```
+
+### Using filters
+
+Keep in mind that calling those methods without any filter can take a lot of time, because the underlying query will try to load the entire database table through multiple requests, then it is recommended to apply filters according to DIALS [live documentation](https://cmsdials-api.web.cern.ch/api/v1/swagger#/) using filter classes for each table:
+
+```python
+from cmsdials.filters import (
+    FileIndexFilters,
+    LumisectionHistogram1DFilters,
+    LumisectionHistogram2DFilters,
+    LumisectionFilters,
+    RunFilters,
+    MLBadLumisectionFilters
+)
+
+dials.dataset_index.list_all(DatasetIndexFilters(page_size=500))
+
+dials.file_index.list(FileIndexFilters(dataset__regex="2024B"))
+
+dials.h1d.list(LumisectionHistogram1DFilters(me="PixelPhase1/Tracks/PXBarrel/charge_PXLayer_2"))
+
+dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), max_pages=5)
+
+dials.lumi.list_all(LumisectionFilters(run_number=360392), max_pages=5)
+
+dials.run.list_all(RunFilters(run_number__gte=360392, run_number__lte=365000), max_pages=5)
+
+# jetmet workspace
+dials.ml_models_index.list_all(MLModelsIndexFilters(active=True))
+
+# jetmet workspace
+dials.ml_bad_lumis.list_all(
+    MLBadLumisectionFilters(
+        page_size=500,
+        model_id__in=[20,19],
+        dataset_id__in=[15042670],
+        run_number__in=[385801,385799,385764]
+    )
+)
+```
+
+### Dials MEs
+
+It is possible to inspect the list of ingested MEs in DIALS listing the endpoint `mes` trough the method:
+
+```python
+dials.mes.list()
+```
+
+### Automatically convert paginated results to pandas DataFrame
+
+You can enable this optional feature by installing the package with the `pandas` extra.
+
+All `Paginated` metaclasses contain the method `to_pandas` that will automatically transform the `results` attribute of the metaclass into a pandas dataframe, for example:
+
+```python
+data = dials.h1d.list_all(LumisectionHistogram1DFilters(me="PixelPhase1/Tracks/PXBarrel/charge_PXLayer_2"), max_pages=5)
+data.to_pandas()
+```
+
+### Indefinite progress bar when fetch multi-page result
+
+You can enable this optional feature by installing the package with the `tqdm` extra.
+
+Whenever you call a `list_all` method that fetches multiple pages a dynamic progress will be rendered to indicate duration and number of pages, for example:
+
+```python
+>>> dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), max_pages=5)
+Progress: 100%|█████████████████████████████████████| 5/5 [00:02<00:00,  1.70it/s]
+```
+
+The total attribute of the bar is dynamically updated while fetching the pages.
+
+## Retrying
+
+In case of an unstable connection, DNS failures or service overload it is possible to configure any `get`, `list` and  `list_all` to retry the underlying requests using native `urllib3` retry class, for example:
+
+```python
+from urllib3.util import Retry
+
+data = dials.h1d.get(dataset_id=14677060, run_number=367112, ls_number=10, me_id=1, retries=Retry(total=3, backoff_factor=0.1))
+data = dials.h1d.list(retries=Retry(total=3, backoff_factor=0.1))
+data = dials.h1d.list_all(LumisectionHistogram1DFilters(), max_pages=5, retries=Retry(total=5, backoff_factor=0.1))
+```
+
+## Resuming
+
+When listing and endpoint for a long time, you may loose connection or the server can potentially return an error. By specifying `keep_failed` and using `resume_from` you can resume from an older response object, for example:
+
+```python
+from cmsdials.auth.client import AuthClient
+from cmsdials.auth.bearer import Credentials
+from cmsdials import Dials
+from cmsdials.filters import LumisectionHistogram2DFilters
+
+auth = AuthClient()
+creds = Credentials.from_creds_file()
+dials = Dials(creds, workspace="tracker")
+
+data = dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), keep_failed=True)  # Code may broke inside this routine
+print(len(data.results))  # 100
+print(data.exc_type)
+print(data.exc_formatted)
+
+# After failing, run this again
+data = dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), keep_failed=True, resume_from=data)  # Resume from failed object
+print(len(data.results))  # 200
+```
+
+You may find it useful to resume from a partial response, i.e,
+
+```python
+data = dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), max_pages=10, keep_failed=True)  # Code may not break, however will fetch only 100 elements
+print(len(data.results))  # 100
+
+# After fetching first 100, fetch next 100
+data = dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="PXBarrel", ls_number=78, entries__gte=100), max_pages=10, keep_failed=True, resume_from=data)  # Resume from partial object
+print(len(data.results))  # 200
+```
+
+## Fetching ML certification json and ML golden-like json
+
+The following examples are testable in the `jetmet` workspace:
+
+```python
+dials.ml_bad_lumis.cert_json(
+    model_id__in=[20,19],
+    dataset_id__in=[15042670],
+    run_number__in=[385801,385799,385764]
+)
+
+dials.ml_bad_lumis.golden_json(
+    model_id__in=[20,19],
+    dataset_id__in=[15042670],
+    run_number__in=[385801,385799,385764]
+)
+```
+
+You may need to query the `ml_models_index` client to fetch the models ids you are interested and the `dataset-index` client to fetch the datasets ids. Take a look in the live documentation to check all possible filters.
+
+Attention: Those endpoints doesn't return a Pydantic model, instead they are returning a plain json response. Consequently, the method `to_pandas` doesn't work on them.
+
+## Usage with local DIALS
+
+All classes that interface the DIALS service inherits the class `BaseAPIClient` which propagate the `base_url`, `route` and `version` attributes with production values. In order to use dials-py with a local version of DIALS it is possible to overwrite those attributes when instantiating the `AuthClient` and the `Dials` client, for example:
+
+```python
+from cmsdials.auth.client import AuthClient
+from cmsdials.auth.bearer import Credentials
+from cmsdials import Dials
+from cmsdials.filters import LumisectionHistogram2DFilters
+
+DEV_URL = "http://localhost:8000/"
+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
+dials = Dials(creds, base_url=DEV_URL)
+
+dials.h2d.list_all(LumisectionHistogram2DFilters(me__regex="EEOT digi occupancy EE +", entries__gte=100, run_number__gte=360392, run_number__lte=365000), max_pages=5)
+```
+
+## Running tests
+
+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 --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).
+
+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 --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-0.0.0.dist-info/RECORD

@@ -0,0 +1,52 @@
+LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cmsdials/__init__.py,sha256=6u_9dbVho3A_mbBPPM4V35nWvsu7JvcYvb0tUruyrQs,99
+cmsdials/_version.py,sha256=lEEx5lwinUby-YNl7w-VFGUcjcibsJ9EuzgJ2W7ocrU,22
+cmsdials/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/auth/_base.py,sha256=QrWui91zrEAyIv3OmerArjhmhVCE42LwQkmJ1A3m-AQ,4155
+cmsdials/auth/bearer.py,sha256=1ELbhohDxaPaEOmjGZR-M4OMYYQsDLjinafZDE1hPEE,5027
+cmsdials/auth/client.py,sha256=FINnV2wnPm1tZpox7p405DFW4dHz0G-ZJXHAzmpekVw,3819
+cmsdials/auth/exceptions.py,sha256=h-muYmw5r0lR6jUhre4878NUCnwslO0TEOOpqa7C3W4,112
+cmsdials/auth/models.py,sha256=WMpvKIeelLHEET43PyUiS1hX8nkFZ764Z5DBSwKP0H4,425
+cmsdials/auth/secret_key.py,sha256=a5mPQInAzRYzOmIS3zfd3KYoobKDo5ti2tIFoaekfWs,1050
+cmsdials/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/dataset_index/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/dataset_index/client.py,sha256=z3tqUBhMpAQUn527vnQuNuUvXa2WSWRCjmFudaqs7es,486
+cmsdials/clients/dataset_index/models.py,sha256=ydIkAk6XuoZzQX7dFQpPOA1a0_PKtZdHyEgFBNjz530,867
+cmsdials/clients/file_index/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/file_index/client.py,sha256=ccaS42GvcakGm1XbhvqM6AUi_k__gN5Oh7KyvkxF02Y,462
+cmsdials/clients/file_index/models.py,sha256=A9PCEfnuigx9f3QCe_tURBCvbRXHUzmmGBvoK0m0M68,1022
+cmsdials/clients/h1d/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/h1d/client.py,sha256=6yoBTfQFvEgSokyiLAqACRjSVUQMFep9Bc8JM6s4t9o,600
+cmsdials/clients/h1d/models.py,sha256=KRj3LhR6s6m0_8UMbCDkcFIjCoZJr_fzzQRqNu5WHk8,1355
+cmsdials/clients/h2d/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/h2d/client.py,sha256=emz6A6XZWM3Cu9tlOka0G5fXz3V0rgYcADC8BdzAIPw,600
+cmsdials/clients/h2d/models.py,sha256=Z_ksEdzH_s60rqKZugxRGCn9S9sbl1vOuoT8drp97IA,1412
+cmsdials/clients/lumisection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/lumisection/client.py,sha256=B4UNMUSDYDmhkOartxo39vbVRTbZnIv96K-LQ8YZF3k,511
+cmsdials/clients/lumisection/models.py,sha256=4g9WQpRzwz2tpdGZHV6mrE3QDVHV6hQ8zr6BOwK1A6s,921
+cmsdials/clients/mes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/mes/client.py,sha256=BGEZUNjIEgeKJh-EVhQnG4F54G6RAgw_vQM9DzMOhJ4,369
+cmsdials/clients/mes/models.py,sha256=o-vE1GzOa4Dw7WfvH0OZSbZL0YkQrjCE17NFLMk-za8,359
+cmsdials/clients/ml_bad_lumisection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/ml_bad_lumisection/client.py,sha256=DYKobGgAqTSsHVIihIMIJkiXU0IcWvsApFea--lF0zA,1565
+cmsdials/clients/ml_bad_lumisection/models.py,sha256=BusTqfMWP6YmYRy1EHcIxyQp18NRCsm6XdS6BX5f-58,1020
+cmsdials/clients/ml_models_index/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/ml_models_index/client.py,sha256=gj4tym66fo2H4KUiIVvayp1YDZQOLvvYxISTv7C-hWg,467
+cmsdials/clients/ml_models_index/models.py,sha256=bHVkddcx3Al6t6WPcbGU_sc1oviwnJssVSPDg5Hi6jg,770
+cmsdials/clients/oms_proxy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/oms_proxy/client.py,sha256=QJgyArJIrRZXEhX_0cBLvZY5AXfi-r-bzwZZOZmxznI,1577
+cmsdials/clients/oms_proxy/models.py,sha256=Y3eskDRbY7dY0wTS6m2BLIal1uOyCwfpOm_MBcf2dLo,288
+cmsdials/clients/run/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/clients/run/client.py,sha256=5kidUA_LfDPfIuvM7RaI-cUpWG74lCmkytt_tkYxlWs,419
+cmsdials/clients/run/models.py,sha256=mK0lnrSyM-gRtfYKbKjI75zkXdHK1Qh3wyKkH4g4dYo,732
+cmsdials/cmsdials.py,sha256=uyRiWe-jhPdSHfCu5zx_LBKM_TK6udRQ4-OiIElzsKc,1542
+cmsdials/filters.py,sha256=UOdPvGaIXavU4eYGPuB08jEQQPK5rr1LWk9qqIbiZTM,872
+cmsdials/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cmsdials/utils/_json.py,sha256=_WKrpyIKh2ASr5IGGBGC5z2RlpxifQh2ZRk7H0JxzlQ,671
+cmsdials/utils/api_client.py,sha256=bvfPaFVRSSTEAufY5h4tXB6WILEA-11lSUn0JFES0hc,7557
+cmsdials/utils/base_model.py,sha256=4FprxXfjGgNn55WVlqU_ed9lgxwXExVXkLBac5P0uJc,940
+cmsdials/utils/logger.py,sha256=rD_dY0arc-sU7z7vvzC0_kCwe-3T3VQd3OP2ZBDlEkk,146
+cmsdials-0.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cmsdials-0.0.0.dist-info/METADATA,sha256=NsvDuu-KGRHBZlG74FMOpU0LZm47FGNARdLr9uEEr5I,13624
+cmsdials-0.0.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+cmsdials-0.0.0.dist-info/RECORD,,

cmsdials-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: true
+Tag: py3-none-any