9 #include <framework/database/Configuration.h>
10 #include <framework/logging/Logger.h>
11 #include <framework/dataobjects/FileMetaData.h>
12 #include <framework/database/Downloader.h>
13 #include <framework/database/Database.h>
14 #include <framework/utilities/Utils.h>
15 #include <boost/python.hpp>
16 #include <framework/core/PyObjConvUtils.h>
17 #include <framework/core/PyObjROOTUtils.h>
18 #include <boost/algorithm/string.hpp>
24 #define CURRENT_DEFAULT_TAG "release-06-00-07"
26 namespace py = boost::python;
34 std::vector<std::string> extractStringList(
const py::object& obj)
36 std::vector<std::string> result;
38 py::object str(py::handle<>(PyObject_Str(item.ptr())));
39 py::extract<std::string> extract(str);
40 result.emplace_back(extract());
48 namespace Belle2::Conditions {
53 boost::python::list tmp;
54 for (
const auto& e : std::get<0>(
m_value)) { tmp.append(e); }
55 m_value.emplace<boost::python::list>(std::move(tmp));
64 std::vector<std::string> tmp = extractStringList(std::get<1>(
m_value));
65 m_value.emplace<std::vector<std::string>>(std::move(tmp));
73 [&element](std::vector<std::string>& list) {list.emplace_back(element);},
74 [&element](boost::python::list & list) {list.append(element);}
81 [&element](std::vector<std::string>& list) {list.emplace(list.begin(), element);},
82 [&element](boost::python::list & list) {list.insert(0, element);}
88 ensurePy().slice(boost::python::_, boost::python::_) = source;
129 fillFromEnv(list,
"BELLE2_CONDB_GLOBALTAG", CURRENT_DEFAULT_TAG);
130 return py::tuple(list);
141 if (inputMetadata.empty())
return;
143 std::optional<std::string> inputGlobaltags;
144 for (
const auto& metadata : inputMetadata) {
145 if (!inputGlobaltags) {
146 inputGlobaltags = metadata.getDatabaseGlobalTag();
148 if (inputGlobaltags != metadata.getDatabaseGlobalTag()) {
149 B2WARNING(
"Input files metadata contain incompatible globaltag settings, globaltag replay not possible");
156 if (inputGlobaltags and inputGlobaltags->empty()) {
157 B2WARNING(
"Input files metadata all have empty globaltag setting, globaltag replay not possible");
173 std::optional<std::string> youngest;
174 for (
const auto& metadata : inputMetadata) {
176 const std::string& release = metadata.getRelease();
177 if (release.substr(0, 8) ==
"release-" and
178 release.compare(8, 2,
"04", 2) >= 0)
181 if (!youngest or * youngest > metadata.getDate()) {
182 youngest = metadata.getDate();
185 if (youngest and youngest->compare(
"2019-12-31") < 0) {
186 B2DEBUG(30,
"Enabling legacy IP information globaltag in tag replay");
203 B2INFO(
"Global tag override is in effect: input globaltags and default globaltag will be ignored");
214 for (
const auto& tag : baseList) baseListPy.append(tag);
215 arguments[
"base_tags"] = baseListPy;
221 arguments[
"metadata"] = py::object();
224 py::list metaDataList;
226 arguments[
"metadata"] = metaDataList;
229 py::object retval = (*m_callback)(*py::tuple(), **arguments);
232 if (retval != py::object()) {
233 return extractStringList(retval);
238 if (baseList.empty()) {
240 B2FATAL(R
"(No baseline globaltags available.
241 The input files you selected don't have compatible globaltags or an empty
242 globaltag setting. As such globaltag configuration cannot be determined
245 If you really sure that it is a good idea to process these files together
246 you have to manually override the list of globaltags:
248 >>> basf2.conditions.override_globaltags()
251 B2FATAL(R
"(No default globaltags available.
252 There is no default globaltag available for processing. This usually means
253 you set the environment variable BELLE2_CONDB_GLOBALTAG to an empty value.
255 As this is unlikely to work for even the most basic functionality this is not
256 directly supported anymore. If you really want to disable any access to the
257 conditions database please configure this explicitly
259 >>> basf2.conditions.metadata_providers = []
260 >>> basf2.conditions.override_globaltags([])
266 for (
const auto& tag : baseList) { finalList.emplace_back(tag); }
272 boost::python::dict expertSettings(
const boost::python::tuple& args, boost::python::dict kwargs)
274 if (py::len(args) != 1) {
276 PyErr_SetString(PyExc_TypeError, (
"expert_settings() takes one positional argument but " +
277 std::to_string(len(args)) +
" were given").c_str());
278 py::throw_error_already_set();
280 Configuration&
self = py::extract<Configuration&>(args[0]);
287 auto checkValue = [&kwargs, &result](
const std::string & name,
auto setter,
auto getter) {
288 using value_type = decltype(getter());
289 if (kwargs.has_key(name)) {
291 py::object
object = kwargs[name];
294 }
catch (std::runtime_error&) {
295 std::stringstream error;
297 PyErr_SetString(PyExc_TypeError, error.str().c_str());
298 py::throw_error_already_set();
302 py::delitem(kwargs, py::object(name));
309 checkValue(
"save_payloads",
310 [&
self](
const std::string & path) {
self.setNewPayloadLocation(path);},
311 [&
self]() {
return self.getNewPayloadLocation();});
312 checkValue(
"download_cache_location",
313 [&
self](
const std::string & path) {
self.setDownloadCacheDirectory(path);},
314 [&
self]() {
return self.getDownloadCacheDirectory();});
315 checkValue(
"download_lock_timeout",
316 [&
self](
size_t timeout) {
self.setDownloadLockTimeout(timeout);},
317 [&
self]() {
return self.getDownloadLockTimeout();});
318 checkValue(
"usable_globaltag_states",
319 [&
self](
const auto & states) {
self.setUsableTagStates(states); },
320 [&
self]() {
return self.getUsableTagStates(); });
321 checkValue(
"connection_timeout",
322 [&downloader](
unsigned int timeout) {downloader.setConnectionTimeout(timeout);},
323 [&downloader]() {
return downloader.getConnectionTimeout();});
324 checkValue(
"stalled_timeout",
325 [&downloader](
unsigned int timeout) {downloader.setStalledTimeout(timeout);},
326 [&downloader]() {
return downloader.getStalledTimeout();});
327 checkValue(
"max_retries",
328 [&downloader](
unsigned int retries) {downloader.setMaxRetries(retries);},
329 [&downloader]() {
return downloader.getMaxRetries();});
330 checkValue(
"backoff_factor",
331 [&downloader](
unsigned int factor) { downloader.setBackoffFactor(factor);},
332 [&downloader]() {
return downloader.getBackoffFactor();});
334 if (py::len(kwargs) > 0) {
335 std::string message =
"Unrecognized keyword arguments: ";
336 auto keys = kwargs.keys();
337 for (
int i = 0; i < len(keys); ++i) {
338 if (i > 0) message +=
", ";
339 message += py::extract<std::string>(keys[i]);
341 PyErr_SetString(PyExc_TypeError, message.c_str());
342 py::throw_error_already_set();
357 py::docstring_options options(
true,
false,
false);
361 py::object expert = raw_function(expertSettings);
362 py::class_<Configuration>(
"ConditionsConfiguration", R
"DOC(
363 This class contains all configurations for the conditions database service
365 * which globaltags to use
366 * where to look for payload information
367 * where to find the actual payload files
368 * which temporary testing payloads to use
370 But for most users the only thing they should need to care about is to set the
371 list of additional `globaltags` to use.
374 Indicator whether or not the override of globaltags is enabled. If true then
375 globaltags present in input files will be ignored and only the ones given in
376 `globaltags` will be considered.
380 Reset the conditions database configuration to its original state.
383 A tuple containing the default globaltags to be used if events are generated without an input file.
386 List of globaltags to be used. These globaltags will be the ones with highest
387 priority but by default the globaltags used to create the input files or the
388 default globaltag will also be used.
390 The priority of the globaltags in this list is highest first. So the first in
391 the list will be checked first and all other globaltags will only be checked for
392 payloads not found so far.
395 By default this list contains the globaltags to be used **in addition** to
396 the ones from the input file or the default one if no input file is present.
397 If this is not desirable you need to call `override_globaltags()` to disable
398 any addition or modification of this list.
402 Append a globaltag to the end of the `globaltags` list. That means it will be
403 the lowest priority of all tags in the list.
407 Add a globaltag to the beginning of the `globaltags` list. That means it will be
408 the highest priority of all tags in the list.
410 .def("override_globaltags", overrideGTFlag)
411 .def(
"override_globaltags", overrideGTList, py::args(
"globaltags"), R
"DOC(override_globaltags(list=None)
413 Enable globaltag override. This disables all modification of the globaltag list at the beginning of processing:
415 * the default globaltag or the input file globaltags will be ignored.
416 * any callback set with `set_globaltag_callback` will be ignored.
417 * the list of `globaltags` will be used exactly as it is.
420 list (list(str) or None) if given this list will replace the current content of `globaltags`
423 it's still possible to modify `globaltags` after this call.
427 Disable global tag replay and revert to the old behavior that the default
428 globaltag will be used if no other globaltags are specified.
430 This is a shortcut to just calling
432 >>> conditions.override_globaltags()
433 >>> conditions.globaltags += list(conditions.default_globaltags)
438 Append a text file containing local test payloads to the end of the list of
439 `testing_payloads`. This will mean they will have lower priority than payloads
440 in previously defined text files but still higher priority than globaltags.
443 filename (str): file containing a local definition of payloads and their
444 intervals of validity for testing
447 This functionality is strictly for testing purposes. Using local payloads
448 leads to results which cannot be reproduced by anyone else and thus cannot
453 Insert a text file containing local test payloads in the beginning of the list
454 of `testing_payloads`. This will mean they will have higher priority than payloads in
455 previously defined text files as well as higher priority than globaltags.
458 filename (str): file containing a local definition of payloads and their
459 intervals of validity for testing
462 This functionality is strictly for testing purposes. Using local payloads
463 leads to results which cannot be reproduced by anyone else and thus cannot
467 List of text files to look for local testing payloads. Each entry should be a
468 text file containing local payloads and their intervals of validity to be used
471 Payloads found in these files and valid for the current run will have a higher
472 priority than any of the `globaltags`. If a valid payload is present in multiple
473 files the first one in the list will have higher priority.
476 This functionality is strictly for testing purposes. Using local payloads
477 leads to results which cannot be reproduced by anyone else and thus cannot
481 List of metadata providers to use when looking for payload metadata. There are currently two supported providers:
483 1. Central metadata provider to look for payloads in the central conditions database.
484 This provider is used for any entry in this list which starts with ``http(s)://``.
485 The URL should point to the top level of the REST api endpoints on the server
487 2. Local metadata provider to look for payloads in a local SQLite snapshot taken
488 from the central server. This provider will be assumed for any entry in this
489 list not starting with a protocol specifier or if the protocol is given as ``file://``
491 This list should rarely need to be changed. The only exception is for users who
492 want to be able to use the software without internet connection after they
493 downloaded a snapshot of the necessary globaltags with ``b2conditionsdb download``
494 to point to this location.
497 List of payload locations to search for payloads which have been found by any of
498 the configured `metadata_providers`. This can be a local directory or a
499 ``http(s)://`` url pointing to the payload directory on a server.
501 For remote locations starting with ``http(s)://`` we assume that the layout of
502 the payloads on the server is the same as on the main payload server:
503 The combination of given location and the relative url in the payload metadata
504 field ``payloadUrl`` should point to the correct payload on the server.
506 For local directories, two layouts are supported and will be auto detected:
509 All payloads are in the same directory without any substructure with the name
510 ``dbstore_{name}_rev_{revision}.root``
512 All payloads are stored in subdirectories in the form ``AB/{name}_r{revision}.root``
513 where ``A`` and ``B`` are the first two characters of the md5 checksum of the
517 Given ``payload_locations = ["payload_dir/", "http://server.com/payloads"]``
518 the framework would look for a payload with name ``BeamParameters`` in revision
519 ``45`` (and checksum ``a34ce5...``) in the following places
522 1. ``payload_dir/a3/BeamParameters_r45.root``
523 2. ``payload_dir/dbstore_BeamParameters_rev_45.root``
524 3. ``http://server.com/payloads/dbstore/BeamParameters/dbstore_BeamParameters_rev_45.root``
525 given the usual pattern of the ``payloadUrl`` metadata. But this could be
526 changed on the central servers so mirrors should not depend on this convention
527 but copy the actual structure of the central server.
529 If the payload cannot be found in any of the given locations the framework will
530 always attempt to download it directly from the central server and put it in a
531 local cache directory.
533 .def("expert_settings", expert, R
"DOC(expert_settings(**kwargs)
535 Set some additional settings for the conditions database.
537 You can supply any combination of keyword-only arguments defined below. The
538 function will return a dictionary containing all current settings.
540 >>> conditions.expert_settings(connection_timeout=5, max_retries=1)
541 {'save_payloads': 'localdb/database.txt',
542 'download_cache_location': '',
543 'download_lock_timeout': 120,
544 'usable_globaltag_states': {'PUBLISHED', 'RUNNING', 'TESTING', 'VALIDATED'},
545 'connection_timeout': 5,
546 'stalled_timeout': 60,
551 Modification of these parameters should not be needed, in rare
552 circumstances this could be used to optimize access for many jobs at once
553 but should only be set by experts.
556 save_payloads (str): Where to store new payloads created during processing.
557 This should be a filename to contain the payload information and the payload
558 files will be placed in the same directory as the file.
559 download_cache_location (str): Where to store payloads which have been downloaded
560 from the central server. This could be a user defined directory, otherwise
561 empty string defaults to ``$TMPDIR/basf2-conditions`` where ``$TMPDIR`` is the
562 temporary directories defined in the system. Newly downloaded payloads will
563 be stored in this directory in a hashed structure, see `payload_locations`
564 download_lock_timeout (int): How many seconds to wait for a write lock when
565 concurrently downloading the same payload between different processes.
566 If locking fails the payload will be downloaded to a temporary file
567 separately for each process.
568 usable_globaltag_states (set(str)): Names of globaltag states accepted for
569 processing. This can be changed to make sure that only fully published
570 globaltags are used or to enable running on an open tag. It is not possible
571 to allow usage of 'INVALID' tags, those will always be rejected.
572 connection_timeout (int): timeout in seconds before connection should be
573 aborted. 0 sets the timeout to the default (300s)
574 stalled_timeout (int): timeout in seconds before a download should be
575 aborted if the speed stays below 10 KB/s, 0 disables this timeout
576 max_retries (int): maximum amount of retries if the server responded with
577 an HTTP response of 500 or more. 0 disables retrying
578 backoff_factor (int): backoff factor for retries in seconds. Retries are
579 performed using something similar to binary backoff: For retry :math:`n`
580 and a ``backoff_factor`` :math:`f` we wait for a random time chosen
581 uniformely from the interval :math:`[1, (2^{n} - 1) \times f]` in
586 Set a callback function to be called just before processing.
588 This callback can be used to further customize the globaltags to be used during
589 processing. It will be called after the input files have been opened and checked
590 with three keyword arguments:
593 The globaltags determined from either the input files or, if no input files
594 are present, the default globaltags
597 The globaltags provided by the user
600 If there are not input files (e.g. generating events) this argument is None.
601 Otherwise it is a list of all the ``FileMetaData`` instances from all input files.
602 This list can be empty if there is no metadata associated with the input files.
604 From this information the callback function should then compose the final list
605 of globaltags to be used for processing and return this list. If ``None`` is
606 returned the default behavior is applied as if there were no callback function.
607 If anything else is returned the processing is aborted.
609 If no callback function is specified the default behavior is equivalent to ::
611 def callback(base_tags, user_tags, metadata):
613 basf2.B2FATAL("No baseline globaltags available. Please use override")
615 return user_tags + base_tags
617 If `override_enabled` is ``True`` then the callback function will not be called.
620 If a callback is set it is responsible to select the correct list of globaltags
621 and also make sure that all files are compatible. No further checks will be
622 done by the framework but any list of globaltags which is returned will be used
625 If the list of ``base_tags`` is empty that usually means that the input files
626 had different globaltag settings but it is the responsibility of the callback
627 to then verify if the list of globaltags is usable or not.
629 If the callback function determines that no working set of globaltags can be
630 determined then it should abort processing using a FATAL error or an exception
bool m_overrideEnabled
is the globaltag override enabled?
static Configuration & getInstance()
Get a reference to the instance which will be used when the Database is initialized.
CppOrPyList m_globalTags
the list with all user globaltags
void prependGlobalTag(const std::string &globalTag)
preprend a globaltag
boost::python::tuple getDefaultGlobalTagsPy() const
Get the tuple of default globaltags as python version.
void appendGlobalTag(const std::string &globalTag)
Append a globaltag.
Configuration()
Initialize default values.
void ensureEditable() const
Check whether the configuration object can be edited or if the database has been initialized already.
void setGlobaltagCallbackPy(const boost::python::object &obj)
Set a callback function from python which will be called when processing starts and should return the...
std::vector< std::string > getBaseTags() const
Get the base globaltags to be used in addition to user globaltags.
void disableGlobalTagReplay()
Disable global tag replay.
boost::python::list getGlobalTagsPy()
Get the list of user globaltags as python version.
void setMetadataProvidersPy(const boost::python::list &list)
Set the list of metadata providers in python.
boost::python::list getTestingPayloadLocationsPy()
Get the list of text files containing test payloads in python.
static void fillFromEnv(T &target, const std::string &envName, const std::string &defaultValue)
Fill a target object from a list of environment variables.
std::vector< FileMetaData > m_inputMetadata
the file metadata of all input files if globaltag replay is requested by input module
std::vector< std::string > getFinalListOfTags()
Get the final list of globaltags to be used for processing.
void setPayloadLocationsPy(const boost::python::list &list)
Set the list of payload locations in python.
CppOrPyList m_metadataProviders
the list with all the metadata providers
void setInputMetadata(const std::vector< FileMetaData > &inputMetadata)
To be called by input modules with the list of all input FileMetaData.
boost::python::list getMetadataProvidersPy()
Get the list of metadata providers in python.
void overrideGlobalTags()
Enable globaltag override: If this is called once than overrideEnabled() will return true and getFina...
void setTestingPayloadLocationsPy(const boost::python::list &list)
Set the list of text files containing test payloads in python.
std::optional< std::vector< std::string > > m_inputGlobaltags
the list of globaltags from all the input files to be used in addition to the user globaltags
void prependTestingPayloadLocation(const std::string &filename)
Prepend a local text file with testing payloads to the list.
boost::python::list getPayloadLocationsPy()
Get the list og payload locations in python.
static void exposePythonAPI()
expose this class to python
CppOrPyList m_payloadLocations
the list with all the payload locations
void overrideGlobalTagsPy(const boost::python::list &globalTags)
Enable globaltag override and set the list of user globaltags in one go.
void reset()
Reset to default values.
void setGlobalTagsPy(const boost::python::list &globalTags)
Set the list of globaltags from python.
bool overrideEnabled() const
Check if override is enabled by previous calls to overrideGlobalTags()
std::optional< boost::python::object > m_callback
the callback function to determine the final final list of globaltags
std::vector< std::string > getDefaultGlobalTags() const
Get the std::vector of default globaltags.
void appendTestingPayloadLocation(const std::string &filename)
Add a local text file with testing payloads.
bool m_databaseInitialized
bool indicating whether the database has been initialized, in which case any changes to the configura...
boost::python::list & ensurePy()
Return the python list version.
void prepend(const std::string &element)
Prepend an element to whatever representation we currently have.
void shallowCopy(const boost::python::object &source)
shallow copy all elements of the source object into the python representation.
void append(const std::string &element)
Append an element to whatever representation we currently have.
std::vector< std::string > & ensureCpp()
Return the C++ vector version.
std::variant< std::vector< std::string >, boost::python::list > m_value
Store either a std::vector or a python list of strings.
static Downloader & getDefaultInstance()
Return the default instance.
static std::string get(const std::string &name, const std::string &fallback="")
Get the value of an environment variable or the given fallback value if the variable is not set.
static bool isSet(const std::string &name)
Check if a value is set in the database.
static Database & Instance()
Instance of a singleton Database.
static std::vector< std::string > getOrCreateList(const std::string &name, const std::string &fallback, const std::string &separators=" \t\n\r")
Get a list of values from an environment variable or the given fallback string if the variable is not...
boost::python::object createROOTObjectPyCopy(const T &instance)
Create a python wrapped copy from a class instance which has a ROOT dictionary.
static void reset(bool keepConfig=false)
Reset the database instance.
boost::python::object convertToPythonObject(const Scalar &value)
------------— From C++ TO Python Converter ---------------------—
Scalar convertPythonObject(const boost::python::object &pyObject, Scalar)
Convert from Python to given type.
bool iteratePythonObject(const boost::python::object &pyObject, Functor function)
Helper function to loop over a python object that implements the iterator concept and call a functor ...
VisitOverload(Ts...) -> VisitOverload< Ts... >
Function for the C++17 std::visit overload pattern to allow simple use of variants.
static std::string name()
type name.