####################################################################################################################################
####################################################################################################################################
####
#### MIT License
####
#### ParaMonte: plain powerful parallel Monte Carlo library.
####
#### Copyright (C) 2012-present, The Computational Data Science Lab
####
#### This file is part of the ParaMonte library.
####
#### Permission is hereby granted, free of charge, to any person obtaining a
#### copy of this software and associated documentation files (the "Software"),
#### to deal in the Software without restriction, including without limitation
#### the rights to use, copy, modify, merge, publish, distribute, sublicense,
#### and/or sell copies of the Software, and to permit persons to whom the
#### Software is furnished to do so, subject to the following conditions:
####
#### The above copyright notice and this permission notice shall be
#### included in all copies or substantial portions of the Software.
####
#### THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
#### EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
#### MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
#### IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
#### DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
#### OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
#### OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
####
#### ACKNOWLEDGMENT
####
#### ParaMonte is an honor-ware and its currency is acknowledgment and citations.
#### As per the ParaMonte library license agreement terms, if you use any parts of
#### this library for any purposes, kindly acknowledge the use of ParaMonte in your
#### work (education/research/industry/development/...) by citing the ParaMonte
#### library as described on this page:
####
#### https://github.com/cdslaborg/paramonte/blob/3548c097f2a25dfc0613061800656d27d0e0ddbe/ACKNOWLEDGMENT.md
####
####################################################################################################################################
####################################################################################################################################
import os
####################################################################################################################################
#### Version
####################################################################################################################################
[docs]class Version:
"""
This is the Version class for generating objects
that contain the methods for getting and dumping
the python-interface or kernel versions of the
ParaMonte library installation on the system.
**Parameters**
versionPath
A string containing the path to either the
ParaMonte kernel or interface version file.
versionType
A string containing the type of the version
file. It can be one of the following values:
"interface"
implying the Python-interface version
number of the ParaMonte library.
"kernel"
implying the kernel-routines version
number of the ParaMonte library.
"""
################################################################################################################################
#### __init__
################################################################################################################################
def __init__(self,versionPath,versionType):
self._versionList = ["interface","kernel"]
self._versionPath = versionPath
self._versionType = versionType
self._versionSave = None
self._checkVersionType()
################################################################################################################################
#### get
################################################################################################################################
[docs] def get(self):
"""
Get the Python-interface or kernel version of the
ParaMonte library, in verbose format.
**Parameters**
None
**Returns**
None
"""
return "ParaMonte Python " + self._versionType.capitalize() + " Version " + self.dump()
################################################################################################################################
#### dump
################################################################################################################################
[docs] def dump(self):
"""
Dump **only the version number** of either
the Python-interface or kernel of the
ParaMonte library.
**Parameters**
None
**Returns**
None
"""
for versionType in self._versionList:
if versionType==self._versionType:
if self._versionSave is None:
versionFileName = ".VERSION_" + versionType.upper()
versionFilePath = os.path.join(self._versionPath, versionFileName)
try:
with open(versionFilePath,"r") as versionFile:
self._versionSave = versionFile.readline().strip("\n")
except:
self._versionSave = "UNKNOWN"
return self._versionSave
else:
return self._versionSave
################################################################################################################################
#### _checkVersionType
################################################################################################################################
[docs] def _checkVersionType(self):
versionTypeNotFound = True
for versionType in self._versionList:
if versionType==self._versionType:
versionTypeNotFound = False
break
if versionTypeNotFound:
raise Exception ( "The input versionType is not a valid recognized version type. Possible values:\n"
+ "\n".join(self._versionList)
)