module-qc-database-tools 2.11.2__tar.gz → 2.12.0rc0__tar.gz

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/.zenodo.json

@@ -1,8 +1,8 @@
 {
   "description": " general python tool for interfacing with databases during module QC tests for the ATLAS ITk project",
   "license": "MIT",
-  "title": "atlas-itk-pixel-modules/mqdbt: v2.11.2",
-  "version": "v2.11.2",
+  "title": "atlas-itk-pixel-modules/mqdbt: v2.12.0rc0",
+  "version": "v2.12.0rc0",
   "upload_type": "software",
   "creators": [
     {
@@ -80,7 +80,7 @@
   "related_identifiers": [
     {
       "scheme": "url",
-      "identifier": "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tree/v2.11.2",
+      "identifier": "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/-/tree/v2.12.0rc0",
       "relation": "isSupplementTo"
     }
   ]

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/CITATION.cff

@@ -54,6 +54,6 @@ keywords:
 license:
 - mit
 message: If you use this software, please cite it using the metadata from this file.
-title: 'atlas-itk-pixel-modules/mqdbt: v2.11.2'
+title: 'atlas-itk-pixel-modules/mqdbt: v2.12.0rc0'
 type: software
-version: v2.11.2
+version: v2.12.0rc0

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: module-qc-database-tools
-Version: 2.11.2
+Version: 2.12.0rc0
 Summary: Python wrapper to interface with LocalDB and Production DB for common tasks for pixel modules.
 Project-URL: Homepage, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools
 Project-URL: Bug Tracker, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/issues
 Project-URL: Source, https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools
-Project-URL: Documentation, https://atlas-itk-pixel-mqdbt.docs.cern.ch/v2.11/
+Project-URL: Documentation, https://atlas-itk-pixel-mqdbt.docs.cern.ch/v2.12/
 Author-email: Jay Chan <jay.chan@cern.ch>
 Maintainer-email: Giordon Stark <kratsg@gmail.com>, Elisabetta Pianori <elisabetta.pianori@cern.ch>, Lingxin Meng <lingxin.meng@cern.ch>
 License: Copyright (c) 2022 ATLAS ITk Pixel Modules
@@ -63,7 +63,7 @@ Requires-Dist: typing-extensions>=4.0; python_version < '3.10'
 Requires-Dist: urllib3<2,>=1.26.20; 'el7.x86_64' in platform_release
 Description-Content-Type: text/markdown
 
-# Module QC Database Tools v2.11.2
+# Module QC Database Tools v2.12.0rc0
 
 The package to regisiter ITkPixV1.1 modules, and generate YARR configs from ITk
 production database using `itkdb` API.

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/README.md

@@ -1,4 +1,4 @@
-# Module QC Database Tools v2.11.2
+# Module QC Database Tools v2.12.0rc0
 
 The package to regisiter ITkPixV1.1 modules, and generate YARR configs from ITk
 production database using `itkdb` API.

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/docs/history.md

@@ -12,6 +12,12 @@ and this project adheres to
 
 **_Changed:_**
 
+- Default chip template and configs paths (!167)
+  - Change variables to `chip_template_path` and `default_chip_config_path`
+  - Move default paths to the `Chip` class
+  - Propagate the `chip_template_path` and `default_chip_config_path` from CLI
+    through `Module` to `Chip` class
+
 **_Added:_**
 
 **_Fixed:_**

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/docs/install.md

@@ -90,7 +90,7 @@ package.
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install -U pip
-$ python -m pip install -U pip module-qc-database-tools==2.11.2
+$ python -m pip install -U pip module-qc-database-tools==2.12.0rc0
 ```
 
 ### via uv
@@ -99,7 +99,7 @@ $ python -m pip install -U pip module-qc-database-tools==2.11.2
 $ python -m venv venv
 $ source venv/bin/activate
 $ python -m pip install uv
-$ uv pip install module-qc-database-tools==2.11.2
+$ uv pip install module-qc-database-tools==2.12.0rc0
 ```
 
 # Usage

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/pyproject.toml

@@ -62,7 +62,7 @@ classifiers = [
 Homepage = "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools"
 "Bug Tracker" = "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools/issues"
 Source = "https://gitlab.cern.ch/atlas-itk/pixel/module/module-qc-database-tools"
-"Documentation" = "https://atlas-itk-pixel-mqdbt.docs.cern.ch/v2.11/"
+"Documentation" = "https://atlas-itk-pixel-mqdbt.docs.cern.ch/v2.12/"
 
 [project.scripts]
 module-qc-database-tools = "module_qc_database_tools.cli:app"

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/src/module_qc_database_tools/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.11.2'
-__version_tuple__ = version_tuple = (2, 11, 2)
+__version__ = version = '2.12.0rc0'
+__version_tuple__ = version_tuple = (2, 12, 0, 'rc0')
 
 __commit_id__ = commit_id = None

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/src/module_qc_database_tools/cli/generate_yarr_config.py

@@ -29,10 +29,10 @@ app = typer.Typer(context_settings=CONTEXT_SETTINGS)
 def main(
     serial_number: str = OPTIONS["serial_number"],
     chip_template_path: Path = typer.Option(
-        (module_qc_database_tools.data / "YARR" / "chip_template.json").resolve(),
+        None,
         "--ch",
         "--chipTemplate",
-        help="Default chip template from which the chip configs are generated.",
+        help=f"Path to default chip template from which the chip configs are generated. If nothing is specified here, the default is {module_qc_database_tools.data}/YARR/chip_template.json specified in the 'Chip' class.",
         exists=True,
         file_okay=True,
         readable=True,
@@ -110,9 +110,9 @@ def main(
     ),
     config_hw: Path = OPTIONS["config_hw"],
     default_chip_config_path: Path = typer.Option(
-        (module_qc_database_tools.data / "YARR" / "default_chip_config.json").resolve(),
+        None,
         "--default-chip-config",
-        help="Default chip config values from which the chip config are generated.",
+        help=f"Path to default chip config values from which the chip config are generated. If nothing is specified here, default is {module_qc_database_tools.data}/YARR/default_chip_config.json set in the 'Chip' class.",
         exists=True,
         file_okay=True,
         readable=True,
@@ -164,11 +164,6 @@ def main(
         )
         layer_config = layer
 
-    chip_template = json.loads(chip_template_path.read_text()) if not localdb else None
-    default_chip_config = (
-        json.loads(default_chip_config_path.read_text()) if not localdb else None
-    )
-
     to_generate = []
 
     for suffix in modes:
@@ -183,12 +178,12 @@ def main(
             f"{module.name}_{layer_config}{'_' + suffix if suffix else ''}.json"
         )
         generated_configs = module.generate_config(
-            chip_template,
-            default_chip_config,
-            layer_config,
-            dp_port.value,
+            layer_config=layer_config,
+            dp_port=dp_port.value,
             suffix=suffix,
             version=version,
+            chip_template_path=chip_template_path,
+            default_chip_config_path=default_chip_config_path,
             speed=speed,
             reverse=reverse,
             felix=felix,

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/src/module_qc_database_tools/core.py

@@ -7,6 +7,7 @@ import logging
 import math
 import sys
 from pathlib import Path
+from typing import Optional
 
 import pandas as pd
 import pymongo.database
@@ -16,6 +17,7 @@ from module_qc_data_tools.utils import (
     get_chip_type_from_serial_number,
 )
 
+import module_qc_database_tools
 from module_qc_database_tools.chip_config_api import ChipConfigAPI
 from module_qc_database_tools.typing_compat import ModuleType
 from module_qc_database_tools.utils import (
@@ -154,12 +156,12 @@ class Module:
 
     def generate_config(
         self,
-        chip_template,
-        default_chip_config,
         layer_config,
         dp_port: DPPort,
         suffix,
         version,
+        chip_template_path: Optional[Path] = None,  # noqa: UP045
+        default_chip_config_path: Optional[Path] = None,  # noqa: UP045
         speed=1280,
         reverse=False,
         felix=False,
@@ -193,14 +195,12 @@ class Module:
             try:
                 configs["chips"].append(
                     chip.generate_config(
-                        copy.deepcopy(
-                            chip_template
-                        ),  # NB: make sure we copy as Chip::generate_config modifies this in-place
-                        copy.deepcopy(default_chip_config),
-                        self.chip_type,
-                        chip_index,
-                        layer_config,
-                        self.module_type,
+                        chip_template_path=chip_template_path,
+                        default_chip_config_path=default_chip_config_path,
+                        chip_type=self.chip_type,
+                        chip_index=chip_index,
+                        layer_config=layer_config,
+                        module_type=self.module_type,
                         suffix=suffix,
                         speed=speed,
                         version=version,
@@ -244,6 +244,12 @@ class Chip:
             "getComponent",
             json={"component": serial_number, "noEosToken": no_eos_token},
         )
+        self.chip_template_path = (
+            module_qc_database_tools.data / "YARR" / "chip_template.json"
+        ).resolve()
+        self.default_chip_config_path = (
+            module_qc_database_tools.data / "YARR" / "default_chip_config.json"
+        ).resolve()
         self.attachments = list(self.chip["attachments"])
         self.test_run = None
 
@@ -331,13 +337,13 @@ class Chip:
 
     def generate_config(
         self,
-        chip_template,
-        default_chip_config,
         chip_type,
         chip_index,
         layer_config,
         module_type,
         suffix="",
+        chip_template_path: Optional[Path] = None,  # noqa: UP045
+        default_chip_config_path: Optional[Path] = None,  # noqa: UP045
         version="latest",
         speed=1280,
         sensor_vendor=None,
@@ -347,6 +353,26 @@ class Chip:
         """
         Generate chip config.
         """
+        if not chip_template_path:
+            chip_template_path = self.chip_template_path
+        if not default_chip_config_path:
+            default_chip_config_path = self.default_chip_config_path
+        ## check that chip config files exist at function call
+        if not (chip_template_path.is_file() and default_chip_config_path.is_file()):
+            log.error(
+                "%s or %s does not exist! Please check!",
+                chip_template_path,
+                default_chip_config_path,
+            )
+            sys.exit()
+        ## TODO schema check?
+        chip_template = json.loads(chip_template_path.read_text())
+        default_chip_config = json.loads(default_chip_config_path.read_text())
+        chip_template = copy.deepcopy(
+            chip_template
+        )  # NB: make sure we copy as Chip::generate_config modifies this in-place
+        default_chip_config = copy.deepcopy(default_chip_config)
+
         try:
             chip_template = {chip_type: chip_template.get("chip_type")}
         except KeyError:
@@ -932,12 +958,12 @@ class LocalModule:
     # Keywords default_chip_config, speed, reverse and clear_chip_config needed to match the non-localDB module generate_config function
     def generate_config(
         self,
-        chip_template,
-        default_chip_config,
         layer_config,
         dp_port: DPPort,
         suffix,
         version,
+        chip_template_path,
+        default_chip_config_path,
         speed=1280,
         reverse=False,
         felix=False,
@@ -954,8 +980,8 @@ class LocalModule:
         )
         log.debug(
             "Unused variables: chip template: %s, default chip config: %s, speed: %i MHz, reverse orientation: %s, clear chip config: %s",
-            chip_template,
-            default_chip_config,
+            chip_template_path,
+            default_chip_config_path,
             speed,
             reverse,
             clear_chip_config,

{module_qc_database_tools-2.11.2 → module_qc_database_tools-2.12.0rc0}/tbump.toml

@@ -1,5 +1,5 @@
 [version]
-current = "2.11.2"
+current = "2.12.0rc0"
 
 # Example of a semver regexp.
 # Make sure this matches current_version before
@@ -17,7 +17,7 @@ regex = '''
 
 [git]
 # The current version will get updated when tbump is run
-message_template = "Bump version: 2.11.2 → {new_version}"
+message_template = "Bump version: 2.12.0rc0 → {new_version}"
 tag_template = "v{new_version}"
 
 # For each file to patch, add a [[file]] config