Coverage for python/lsst/verify/metadata/ldf.py : 80%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of verify.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21__all__ = ['get_ldf_env']
23from datetime import datetime, timezone
24import os
27def get_ldf_env():
28 """Gather metadata entries from LSST Data Facility environment.
30 Returns
31 -------
32 prov : `dict`
33 Dictionary of metadata items obtained from the LDF environment.
34 Fields are:
36 - ``'date'``: ISO8601-formatted current datetime.
37 - ``'dataset'``: the name of the dataset processed.
38 - ``'dataset_repo_url'``: a reference URL with information about the
39 dataset.
40 - ``run_id``: ID of the run in the LDF environment.
41 - ``run_id_url``: a reference URL with information about the run.
42 - ``version_tag``: the version of the LSST stack used.
44 Examples
45 --------
46 This metadata is intended to be inserted into a job's metadata:
48 >>> from lsst.verify import Job
49 >>> job = Job()
50 >>> job.meta.update(get_ldf_env())
51 """
53 return {
54 'date': datetime.now(timezone.utc).isoformat(),
55 'dataset': os.getenv('DATASET', 'unknown'),
56 'dataset_repo_url': os.getenv('DATASET_REPO_URL',
57 'https://example.com'),
58 'run_id': os.getenv('RUN_ID', 'unknown'),
59 'run_id_url': os.getenv('RUN_ID_URL', 'https://example.com'),
60 'version_tag': os.getenv('VERSION_TAG', 'unknown')
61 }