Skip to content

Conf Edit

conf_edit

cctbx_start

Attributes

logger module-attribute 

logger = getLogger(__name__)

Functions

is_valid_yaml 

is_valid_yaml(file_path)
Source code in scripts/conf_edit.py 
18
19
20
21
22
23
24
25
26
27
28
def is_valid_yaml(file_path):
    try:
        with open('/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf_temp.yml', 'r') as file:
            yaml.safe_load(file)
        return True
    except yaml.YAMLError as e:
        logging.error(f"Error in YAML file: {e}")
        return False
    except FileNotFoundError:
        logging.error(f"Error: File not found: /reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf_temp.yml")
        return False

main 

main(args)

Main entry point allowing external calls Entry point for console_scripts Args: args ([str]): command line parameter list

Source code in scripts/conf_edit.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def main(args):
    """
    Main entry point allowing external calls
    Entry point for console_scripts
    Args:
      args ([str]): command line parameter list
    """
    args = parse_args(args)
    exp = args.experiment

    if exp is None:
        ws_url = "https://pswww.slac.stanford.edu/ws/lgbk"
        resp = requests.get(
            ws_url + "/lgbk/ws/activeexperiment_for_instrument_station",
            {"instrument_name": 'mfx', "station": 0})
        exp_input = resp.json().get("value", {}).get("name")
    else:
        exp_input = exp

    if exp is not None:
        update_yaml(exp_input)

    else:
        logging.warning('No change requested to conf.yml')

parse_args 

parse_args(args)

Parse command line parameters

Args: args ([str]): command line parameters as list of strings

Returns: :obj:argparse.Namespace: command line parameters namespace

Source code in scripts/conf_edit.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def parse_args(args):
    """Parse command line parameters

    Args:
      args ([str]): command line parameters as list of strings

    Returns:
      :obj:`argparse.Namespace`: command line parameters namespace
    """
    parser = argparse.ArgumentParser(
        description="startup script for cctbx on iana."
    )
    parser.add_argument(
        "--experiment",
        "-e",
        dest="experiment",
        default=None,
        help="Enter -e to specify experiment number",
    )

    return parser.parse_args(args)

run 

run()

Entry point for console_scripts

Source code in scripts/conf_edit.py 
93
94
95
def run():
    """Entry point for console_scripts"""
    main(sys.argv[1:])

update_yaml 

update_yaml(exp)
Source code in scripts/conf_edit.py 
31
32
33
34
35
36
37
38
39
40
41
def update_yaml(exp):
    logging.info("Updating yaml file")
    with open("/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf.yml") as istream:
        ymldoc = yaml.safe_load(istream)
        ymldoc['experiment'] = exp

    with open("/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf_temp.yml", "w") as ostream:
        yaml.dump(ymldoc, ostream, default_flow_style=False, sort_keys=False)

    if is_valid_yaml('/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf_temp.yml'):
        os.rename('/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf_temp.yml', '/reg/g/pcds/pyps/apps/hutch-python/mfx/alt_conf.yml')