EnvironmentInformation Class Reference

Inheritance diagram for EnvironmentInformation:

Public Member Functions
	__init__ (self)
	revision_number (self)
	__str__ (self)
	__repr__ (self)
	get_current_revision_number (self)

Public Attributes
str	externals_version = ""
	Externals version.
str	externals_option = ""
	Compile options of externals.
str	option = ""
	Compile options.
str	architecture = ""
	OS.
str	release = ""
	Release version.
str	release_folder = ""
	Release folder.

Protected Attributes
str	_cached_revision = ""
	Revision number (cached, the real getter is the property)

Detailed Description

Helper class for accessing the information about the environment.

Definition at line 12 of file information.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Get the variables from the environment variables.

Definition at line 18 of file information.py.

    def __init__(self):
        """
        Get the variables from the environment variables.
        """
        
        self.externals_version = ""
        
        self.externals_option = ""
        
        self.option = ""
        
        self.architecture = ""
        
        self.release = ""
        
        self.release_folder = ""
        
        self._cached_revision = ""
 

Member Function Documentation

__repr__()

__repr__

(

self

)

Also for ipython.

Definition at line 62 of file information.py.

    def __repr__(self):
        """
        Also for ipython.
        """
        return self.__str__()
 

__str__()

__str__

(

self

)

A nice representation.

Definition at line 47 of file information.py.

    def __str__(self):
        """
        A nice representation.
        """
        result = ""
        result += "externals version: " + self.externals_version + "\n"
        result += "externals option: " + self.externals_option + "\n"
        result += "option: " + self.option + "\n"
        result += "architecture: " + self.architecture + "\n"
        result += "release: " + self.release + "\n"
        result += "release folder: " + self.release_folder + "\n"
        result += "revision number: " + self.revision_number + "\n"
        result += "date: " + datetime.now().strftime("%Y-%m-%d") + "\n"
        return result
 

get_current_revision_number()

get_current_revision_number

(

self

)

Try to download the current revision number from SVN.

Definition at line 68 of file information.py.

    def get_current_revision_number(self):
        """
        Try to download the current revision number from SVN.
        """
        try:
            return check_output(["git", "log", "-1", "--format='%H'"], cwd=self.release_folder).decode()
        except BaseException:
            return ""

revision_number()

revision_number

(

self

)

Get the cached revision number from SVN or get it from SVN directly.

Definition at line 38 of file information.py.

    def revision_number(self):
        """
        Get the cached revision number from SVN or get it from SVN directly.
        """
        if not self._cached_revision:
            self._cached_revision = self.get_current_revision_number()
 
        return self._cached_revision
 

Member Data Documentation

_cached_revision

str _cached_revision = ""

protected

Revision number (cached, the real getter is the property)

Definition at line 35 of file information.py.

architecture

str architecture = ""

OS.

Definition at line 29 of file information.py.

externals_option

str externals_option = ""

Compile options of externals.

Definition at line 25 of file information.py.

externals_version

str externals_version = ""

Externals version.

Definition at line 23 of file information.py.

option

str option = ""

Compile options.

Definition at line 27 of file information.py.

release

str release = ""

Release version.

Definition at line 31 of file information.py.

release_folder

str release_folder = ""

Release folder.

Definition at line 33 of file information.py.

---

The documentation for this class was generated from the following file:

• framework/scripts/hep_ipython_tools/information.py