QuLab 2.5.3__cp311-cp311-macosx_10_9_universal2.whl → 2.5.5__cp311-cp311-macosx_10_9_universal2.whl

{QuLab-2.5.3.dist-info → QuLab-2.5.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: QuLab
-Version: 2.5.3
+Version: 2.5.5
 Summary: contral instruments and manage data
 Author-email: feihoo87 <feihoo87@gmail.com>
 Maintainer-email: feihoo87 <feihoo87@gmail.com>

{QuLab-2.5.3.dist-info → QuLab-2.5.5.dist-info}/RECORD

@@ -1,19 +1,19 @@
 qulab/__init__.py,sha256=XnSePkDDgfbmEpu5uXK6spygxaqVt9emMubHYKIjSwc,244
 qulab/__main__.py,sha256=fjaRSL_uUjNIzBGNgjlGswb9TJ2VD5qnkZHW3hItrD4,68
 qulab/dicttree.py,sha256=tRRMpGZYVOLw0TEByE3_2Ss8FdOmzuGL9e1DWbs8qoY,13684
-qulab/fun.cpython-311-darwin.so,sha256=_o-zs9ZbzrQF7jkAceBocsxaqiLmkVdxeL3qAaCCHp0,126848
+qulab/fun.cpython-311-darwin.so,sha256=ksCyegtDBabox5ZGHXdheGRIRlYmyLwahz1lmdcIeWk,126848
 qulab/typing.py,sha256=5xCLfrp1aZpKpDy4p2arbFszw2eK3hGUjZa-XSvC_-8,69
-qulab/version.py,sha256=Znn1LprC8WFThPHcZ2uVYHDtCMP4LIy30e8v1CDWFvU,21
+qulab/version.py,sha256=MDur6AV_Dwa0PNW31e6addEkEKMAh_dHbKFdazRMbHo,21
 qulab/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 qulab/cli/commands.py,sha256=tgDIkkeIoasQXAifJZ6NU8jDgpNgb2a-B0C4nF0evrE,559
 qulab/cli/config.py,sha256=SdNmWzweWAdyk8M2oKYhMxnkaJ0qIayPlsLGCNlVqME,3108
 qulab/executor/__init__.py,sha256=LosPzOMaljSZY1thy_Fxtbrgq7uubJszMABEB7oM7tU,101
-qulab/executor/cli.py,sha256=5rbAOnG8Me46qeWh9LbutE3zIcPD-MZVqmYoWUY4l3o,6674
-qulab/executor/load.py,sha256=OZmE_Pj2XcHzRDw5-1lF-ZDoMVqpaR-dWXf1K39ThXQ,12925
-qulab/executor/schedule.py,sha256=4D8o68Cx6vCkpSTMHzULTwuuq1tS8unc2n8WdBA9oB0,12013
-qulab/executor/storage.py,sha256=s1xrI4bPTnyM4Nj0CkPxr3NdmnSp18LKnwm-ZoxR-Q0,7191
+qulab/executor/cli.py,sha256=ZGnQdUFZmU812gsnqbKhaJzwWLdoPt42CukPbZ7Yv8k,6684
+qulab/executor/load.py,sha256=t48vZQVAViIwGBPnoRbfBafv5jSR4ix3z4pkvyGyX-w,17759
+qulab/executor/schedule.py,sha256=DCZmqtNzrvsA1wOTxEldI22n6UWlHtxEx6QKsHn1S8k,13344
+qulab/executor/storage.py,sha256=u7uAmZU8D-pvd6UNek1zzxbUBIZQpftSiXdag6hlkG8,7533
 qulab/executor/transform.py,sha256=AazWdlkEoOBaUJpTYsT5J4f0RanzCEeo-ThwEg8BB4Y,1262
-qulab/executor/utils.py,sha256=RNDEo17M-n_tge7uLITHxmoNNYSTm9OES75wQygR8dM,4065
+qulab/executor/utils.py,sha256=VZ_VPYT2MFIfrCtfEW1I7T4NKFIbOvfVac8Sv377MTY,4221
 qulab/monitor/__init__.py,sha256=nTHelnDpxRS_fl_B38TsN0njgq8eVTEz9IAnN3NbDlM,42
 qulab/monitor/__main__.py,sha256=w3yUcqq195LzSnXTkQcuC1RSFRhy4oQ_PEBmucXguME,97
 qulab/monitor/config.py,sha256=fQ5JcsMApKc1UwANEnIvbDQZl8uYW0tle92SaYtX9lI,744
@@ -93,9 +93,9 @@ qulab/visualization/plot_seq.py,sha256=UWTS6p9nfX_7B8ehcYo6UnSTUCjkBsNU9jiOeW2ca
 qulab/visualization/qdat.py,sha256=ZeevBYWkzbww4xZnsjHhw7wRorJCBzbG0iEu-XQB4EA,5735
 qulab/visualization/rot3d.py,sha256=lMrEJlRLwYe6NMBlGkKYpp_V9CTipOAuDy6QW_cQK00,734
 qulab/visualization/widgets.py,sha256=6KkiTyQ8J-ei70LbPQZAK35wjktY47w2IveOa682ftA,3180
-QuLab-2.5.3.dist-info/LICENSE,sha256=PRzIKxZtpQcH7whTG6Egvzl1A0BvnSf30tmR2X2KrpA,1065
-QuLab-2.5.3.dist-info/METADATA,sha256=3Q3eK40_NlhnO2IeI2Ok-tPG7aEkDMQWj88cKwErDR0,3698
-QuLab-2.5.3.dist-info/WHEEL,sha256=K10eKSN6_vzvMOgXxWbVOQNR7Orfl6gBTCpCI8bcYx4,114
-QuLab-2.5.3.dist-info/entry_points.txt,sha256=b0v1GXOwmxY-nCCsPN_rHZZvY9CtTbWqrGj8u1m8yHo,45
-QuLab-2.5.3.dist-info/top_level.txt,sha256=3T886LbAsbvjonu_TDdmgxKYUn939BVTRPxPl9r4cEg,6
-QuLab-2.5.3.dist-info/RECORD,,
+QuLab-2.5.5.dist-info/LICENSE,sha256=PRzIKxZtpQcH7whTG6Egvzl1A0BvnSf30tmR2X2KrpA,1065
+QuLab-2.5.5.dist-info/METADATA,sha256=yaWVrSEOko53q9lByNffnVDYleUm9__SuZM8Rld3NdQ,3698
+QuLab-2.5.5.dist-info/WHEEL,sha256=K10eKSN6_vzvMOgXxWbVOQNR7Orfl6gBTCpCI8bcYx4,114
+QuLab-2.5.5.dist-info/entry_points.txt,sha256=b0v1GXOwmxY-nCCsPN_rHZZvY9CtTbWqrGj8u1m8yHo,45
+QuLab-2.5.5.dist-info/top_level.txt,sha256=3T886LbAsbvjonu_TDdmgxKYUn939BVTRPxPl9r4cEg,6
+QuLab-2.5.5.dist-info/RECORD,,

qulab/executor/cli.py

@@ -83,7 +83,7 @@ def create(workflow, code):
     deps = find_unreferenced_workflows(code)
 
     with open(fname, 'w') as f:
-        f.write(workflow_template(list(deps)))
+        f.write(workflow_template(workflow, list(deps)))
     click.echo(f'{workflow} created')
 
 

qulab/executor/load.py

@@ -11,6 +11,7 @@ import warnings
 from importlib.util import module_from_spec, spec_from_file_location
 from pathlib import Path
 from types import ModuleType
+from typing import Any
 
 from loguru import logger
 
@@ -107,7 +108,8 @@ def verify_calibrate_method(module: WorkflowType):
 def verify_check_method(module: WorkflowType):
     if not hasattr(module, 'check'):
         warnings.warn(
-            f"Workflow {module.__file__} does not have 'check' function")
+            f"Workflow {module.__file__} does not have 'check' function, it will be set to 'calibrate' function"
+        )
     else:
         if not can_call_without_args(module.check):
             raise AttributeError(
@@ -120,6 +122,93 @@ def verify_check_method(module: WorkflowType):
             )
 
 
+def verify_dependence_key(workflow: str | tuple[str, dict[str, Any]]
+                          | tuple[str, str, dict[str, Any]]):
+    if isinstance(workflow, str):
+        return
+    if not isinstance(workflow, tuple) or len(workflow) not in [2, 3]:
+        raise ValueError(f"Invalid workflow: {workflow}")
+
+    if len(workflow) == 2:
+        file_name, mapping = workflow
+        if not Path(file_name).exists():
+            raise FileNotFoundError(f"File not found: {file_name}")
+    elif len(workflow) == 3:
+        template_path, target_path, mapping = workflow
+        if not Path(template_path).exists():
+            raise FileNotFoundError(f"File not found: {template_path}")
+        if not isinstance(target_path, (Path, str)) or target_path == '':
+            raise ValueError(f"Invalid target_path: {target_path}")
+        if not isinstance(target_path, (Path, str)):
+            raise ValueError(f"Invalid target_path: {target_path}")
+        if Path(target_path).suffix != '.py':
+            raise ValueError(
+                f"Invalid target_path: {target_path}. Only .py file is supported"
+            )
+    else:
+        raise ValueError(f"Invalid workflow: {workflow}")
+
+    if not isinstance(mapping, dict):
+        raise ValueError(f"Invalid mapping: {mapping}")
+
+    for key, value in mapping.items():
+        if not isinstance(key, str):
+            raise ValueError(
+                f"Invalid key: {key}, should be str type and valid identifier")
+        if not key.isidentifier():
+            raise ValueError(f"Invalid key: {key}, should be identifier")
+        try:
+            pickle.dumps(value)
+        except Exception as e:
+            raise ValueError(
+                f"Invalid value: {key}: {value}, should be pickleable") from e
+    return
+
+
+def verify_depends(module: WorkflowType):
+    if not hasattr(module, 'depends'):
+        return
+
+    deps = []
+
+    if callable(module.depends):
+        if not can_call_without_args(module.depends):
+            raise AttributeError(
+                f"Workflow {module.__file__} 'depends' function should not have any parameters"
+            )
+        deps = list(module.depends())
+    elif isinstance(module.depends, (list, tuple)):
+        deps = module.depends
+    else:
+        raise AttributeError(
+            f"Workflow {module.__file__} 'depends' should be a callable or a list"
+        )
+    for workflow in deps:
+        verify_dependence_key(workflow)
+
+
+def verify_entries(module: WorkflowType):
+    if not hasattr(module, 'entries'):
+        return
+
+    deps = []
+
+    if callable(module.entries):
+        if not can_call_without_args(module.entries):
+            raise AttributeError(
+                f"Workflow {module.__file__} 'entries' function should not have any parameters"
+            )
+        deps = list(module.entries())
+    elif isinstance(module.entries, (list, tuple)):
+        deps = module.entries
+    else:
+        raise AttributeError(
+            f"Workflow {module.__file__} 'entries' should be a callable or a list"
+        )
+    for workflow in deps:
+        verify_dependence_key(workflow)
+
+
 def is_workflow(module: ModuleType) -> bool:
     try:
         verify_calibrate_method(module)
@@ -218,14 +307,15 @@ def load_workflow_from_file(file_name: str,
     module.__mtime__ = (base_path / path).stat().st_mtime
 
     if hasattr(module, 'entries'):
+        verify_entries(module)
         return module
 
     if not hasattr(module, '__timeout__'):
         module.__timeout__ = None
 
     if not hasattr(module, 'depends'):
-        module.depends = lambda: [[]]
-
+        module.depends = lambda: []
+    verify_depends(module)
     verify_calibrate_method(module)
     verify_check_method(module)
 
@@ -355,18 +445,50 @@ def load_workflow(workflow: str | tuple[str, dict],
 
 def get_dependents(workflow: WorkflowType,
                    code_path: str | Path) -> list[WorkflowType]:
-    return [
-        load_workflow(n, code_path, mtime=workflow.__mtime__)
-        for n in workflow.depends()
-    ]
+    if callable(getattr(workflow, 'depends', None)):
+        if not can_call_without_args(workflow.depends):
+            raise AttributeError(
+                f'Workflow {workflow.__workflow_id__} "depends" function should not have any parameters'
+            )
+        return [
+            load_workflow(n, code_path, mtime=workflow.__mtime__)
+            for n in workflow.depends()
+        ]
+    elif isinstance(getattr(workflow, 'depends', None), (list, tuple)):
+        return [
+            load_workflow(n, code_path, mtime=workflow.__mtime__)
+            for n in workflow.depends
+        ]
+    elif getattr(workflow, 'entries', None) is None:
+        return []
+    else:
+        raise AttributeError(
+            f'Workflow {workflow.__workflow_id__} "depends" should be a callable or a list'
+        )
 
 
 def get_entries(workflow: WorkflowType,
                 code_path: str | Path) -> list[WorkflowType]:
-    return [
-        load_workflow(n, code_path, mtime=workflow.__mtime__)
-        for n in workflow.entries()
-    ]
+    if callable(getattr(workflow, 'entries', None)):
+        if not can_call_without_args(workflow.entries):
+            raise AttributeError(
+                f'Workflow {workflow.__workflow_id__} "entries" function should not have any parameters'
+            )
+        return [
+            load_workflow(n, code_path, mtime=workflow.__mtime__)
+            for n in workflow.entries()
+        ]
+    elif isinstance(getattr(workflow, 'entries', None), (list, tuple)):
+        return [
+            load_workflow(n, code_path, mtime=workflow.__mtime__)
+            for n in workflow.entries
+        ]
+    elif getattr(workflow, 'entries', None) is None:
+        return []
+    else:
+        raise AttributeError(
+            f'Workflow {workflow.__workflow_id__} "entries" should be a callable or a list'
+        )
 
 
 def make_graph(workflow: WorkflowType, graph: dict, code_path: str | Path):
@@ -383,5 +505,7 @@ def make_graph(workflow: WorkflowType, graph: dict, code_path: str | Path):
         for w in get_dependents(workflow, code_path):
             graph[workflow.__workflow_id__].append(w.__workflow_id__)
             make_graph(w, graph=graph, code_path=code_path)
+    if graph[workflow.__workflow_id__] == []:
+        del graph[workflow.__workflow_id__]
 
     return graph

qulab/executor/schedule.py

@@ -1,4 +1,5 @@
 import functools
+import pickle
 import uuid
 from datetime import datetime, timedelta
 from pathlib import Path
@@ -15,6 +16,27 @@ class CalibrationFailedError(Exception):
     pass
 
 
+def is_pickleable(obj) -> bool:
+    try:
+        pickle.dumps(obj)
+        return True
+    except:
+        return False
+
+
+def veryfy_analyzed_result(result: Result, script: str, method: str):
+    if not isinstance(result, Result):
+        raise TypeError(f'"{script}" : "{method}" must return a Result object')
+    if not is_pickleable(result.parameters):
+        raise TypeError(
+            f'"{script}" : "{method}" return not pickleable data in .parameters'
+        )
+    if not is_pickleable(result.other_infomation):
+        raise TypeError(
+            f'"{script}" : "{method}" return not pickleable data in .other_infomation'
+        )
+
+
 def check_state(workflow: WorkflowType, code_path: str | Path,
                 state_path: str | Path) -> bool:
     """
@@ -73,9 +95,11 @@ def call_analyzer(node,
                   plot=False) -> Result:
     if check:
         result = node.check_analyze(result, history=history)
+        veryfy_analyzed_result(result, node.__workflow_id__, "check_analyze")
         result.fully_calibrated = False
     else:
         result = node.analyze(result, history=history)
+        veryfy_analyzed_result(result, node.__workflow_id__, "analyze")
         result.fully_calibrated = True
         if plot:
             call_plot(node, result)
@@ -122,6 +146,10 @@ def check_data(workflow: WorkflowType, code_path: str | Path,
         logger.debug(
             f'Checking "{workflow.__workflow_id__}" with "check" method ...')
         data = workflow.check()
+        if not is_pickleable(data):
+            raise TypeError(
+                f'"{workflow.__workflow_id__}" : "check" return not pickleable data'
+            )
         result = Result()
         result.data = data
         #save_result(workflow.__workflow_id__, result, state_path)
@@ -147,6 +175,10 @@ def check_data(workflow: WorkflowType, code_path: str | Path,
             f'Checking "{workflow.__workflow_id__}" with "calibrate" method ...'
         )
         data = workflow.calibrate()
+        if not is_pickleable(data):
+            raise TypeError(
+                f'"{workflow.__workflow_id__}" : "calibrate" return not pickleable data'
+            )
         result = Result()
         result.data = data
         save_result(workflow.__workflow_id__, result, state_path)
@@ -172,6 +204,10 @@ def calibrate(workflow: WorkflowType, code_path: str | Path,
 
     logger.debug(f'Calibrating "{workflow.__workflow_id__}" ...')
     data = workflow.calibrate()
+    if not is_pickleable(data):
+        raise TypeError(
+            f'"{workflow.__workflow_id__}" : "calibrate" return not pickleable data'
+        )
     result = Result()
     result.data = data
     save_result(workflow.__workflow_id__, result, state_path)

qulab/executor/storage.py

@@ -3,6 +3,7 @@ import pickle
 import uuid
 from dataclasses import dataclass, field
 from datetime import datetime, timedelta
+from functools import lru_cache
 from pathlib import Path
 from typing import Any, Literal
 
@@ -181,36 +182,42 @@ def get_heads(base_path: str | Path) -> Path | None:
 def create_index(name: str,
                  base_path: str | Path,
                  context: str,
-                 width: int,
+                 width: int = -1,
                  start: int = 0):
-    path = Path(base_path) / "index" / f"{name}.seq"
-    if path.exists():
-        with open(path, "r") as f:
-            index = int(f.read())
+
+    path = Path(base_path) / "index" / name
+    if width == -1:
+        width = len(context)
     else:
-        index = start
-    path.parent.mkdir(parents=True, exist_ok=True)
-    with open(path, "w") as f:
-        f.write(str(index + 1))
+        width = max(width, len(context))
 
-    path = Path(base_path) / "index" / f"{name}.width"
-    with open(path, "w") as f:
-        f.write(str(width))
+    if path.with_suffix('.width').exists():
+        width = int(path.with_suffix('.width').read_text())
+        index = int(path.with_suffix('.seq').read_text())
+    else:
+        index = start
+    if width < len(context):
+        raise ValueError(
+            f"Context '{context}' is too long, existing width of '{name}' is {width}."
+        )
+    if not path.with_suffix('.width').exists():
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.with_suffix('.width').write_text(str(width))
 
-    path = Path(base_path) / "index" / f"{name}.idx"
-    with open(path, "a") as f:
+    path.with_suffix('.seq').write_text(str(index + 1))
 
+    with path.with_suffix('.idx').open("a") as f:
         f.write(f"{context.ljust(width)}\n")
 
     return index
 
 
+@lru_cache(maxsize=4096)
 def query_index(name: str, base_path: str | Path, index: int):
-    path = Path(base_path) / "index" / f"{name}.width"
-    with open(path, "r") as f:
-        width = int(f.read())
-    path = Path(base_path) / "index" / f"{name}.idx"
-    with open(path, "r") as f:
+    path = Path(base_path) / "index" / name
+    width = int(path.with_suffix('.width').read_text())
+
+    with path.with_suffix('.idx').open("r") as f:
         f.seek(index * (width + 1))
         context = f.read(width)
     return context.rstrip()
@@ -219,5 +226,8 @@ def query_index(name: str, base_path: str | Path, index: int):
 def get_result_by_index(
     index: int, base_path: str | Path = get_config_value("data", Path)
 ) -> Result | None:
-    path = query_index("result", base_path, index)
-    return load_result(path, base_path)
+    try:
+        path = query_index("result", base_path, index)
+        return load_result(path, base_path)
+    except:
+        return None

qulab/executor/utils.py

@@ -30,7 +30,7 @@ def dependent_tree(node: str, code_path: str | Path) -> dict[str, list[str]]:
     return tree
 
 
-def workflow_template(deps: list[str]) -> str:
+def workflow_template(workflow: str, deps: list[str]) -> str:
     return f"""def VAR(s): pass  # 没有实际作用，只是用来抑制编辑器的警告。
 
 import numpy as np
@@ -47,7 +47,7 @@ def depends():
 
 
 def calibrate():
-    logger.info(f"run {{__name__}}")
+    logger.info(f"running {workflow} ...")
 
     # calibrate 是一个完整的校准实验，如power Rabi，Ramsey等。
     # 你需要足够的扫描点，以使得后续的 analyze 可以拟合出合适的参数。
@@ -58,10 +58,11 @@ def calibrate():
     for i in x:
         y.append(np.sin(i))
 
+    logger.info(f"running {workflow} ... finished!")
     return x, y
 
 
-def analyze(result: Result, history: Result | None) -> Result:
+def analyze(result: Result, history: Result | None = None) -> Result:
     \"\"\"
     分析校准结果。
 
@@ -93,7 +94,7 @@ def analyze(result: Result, history: Result | None) -> Result:
 
 
 def check():
-    logger.info(f"check {{__name__}}")
+    logger.info(f"checking {workflow} ...")
 
     # check 是一个快速检查实验，用于检查校准是否过时。
     # 你只需要少数扫描点，让后续的 check_analyze 知道参数是否漂移，数据
@@ -105,10 +106,11 @@ def check():
     for i in x:
         y.append(np.sin(i))
 
+    logger.info(f"checking {workflow} ... finished!")
     return x, y
 
 
-def check_analyze(result: Result, history: Result) -> Result:
+def check_analyze(result: Result, history: Result | None = None) -> Result:
     \"\"\"
     分析检查结果。
 

qulab/version.py

@@ -1 +1 @@
-__version__ = "2.5.3"
+__version__ = "2.5.5"