#
# Copyright (c) 2015-2026, ParaTools, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# (1) Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# (2) Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# (3) Neither the name of ParaTools, Inc. nor the names of its contributors may
# be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
"""TAU Commander package initialization.
The first line of this file is the first thing to be executed whenever TAU Commander
is invoked in any way. This module establishes global constants and checks the Python version.
It should be as short and simple.
"""
import os
import sys
EXIT_FAILURE = -100
"""int: Process exit code indicating unrecoverable failure."""
EXIT_WARNING = 100
"""int: Process exit code indicating non-optimal condition on exit."""
EXIT_SUCCESS = 0
"""int: Process exit code indicating successful operation."""
HELP_CONTACT = '<support@paratools.com>'
"""str: E-mail address users should contact for help."""
TAUCMDR_URL = 'www.taucommander.com'
"""str: URL of the TAU Commander project."""
MINIMUM_PYTHON_VERSION = (3, 11, 4)
"""tuple: Oldest supported Python version (MAJOR, MINOR, MICRO). Must match `requires-python` in pyproject.toml."""
# Sliced so that pyupgrade --py311-plus doesn't delete the check as dead code.
if sys.version_info[:3] < MINIMUM_PYTHON_VERSION:
VERSION = '.'.join([str(x) for x in sys.version_info[0:3]])
sys.stderr.write("""{}
{}
{}
Your Python version is {} but Python {} or newer is required.
Please install the required Python version or contact {} for support.
""".format(TAUCMDR_URL, sys.executable, sys.version, VERSION, '.'.join([str(x) for x in MINIMUM_PYTHON_VERSION]),
HELP_CONTACT))
sys.exit(EXIT_FAILURE)
# Imported after the version check so that an unsupported Python fails there, not here.
import importlib.metadata # pylint: disable=wrong-import-position
[docs]
def _installed_version(): # type: () -> str
try:
return importlib.metadata.version('taucmdr')
except importlib.metadata.PackageNotFoundError:
return "0.0.0"
__version__ = _installed_version()
"""str: TAU Commander Version, from the installed package's metadata, or ``0.0.0`` if the package isn't installed."""
TAUCMDR_VERSION = __version__
"""str: TAU Commander Version"""
TAUCMDR_SCRIPT = os.environ.get('__TAUCMDR_SCRIPT__') or 'tau'
"""str: Script that launched TAU Commander.
Appears in help messages, and the compiler wrappers run this path.
**Do not** change it once it is set.
"""
[docs]
def _system_prefix(): # type: () -> str | None
values = {var: os.environ.get(var) for var in ('TAUCMDR_SYSTEM_PREFIX', '__TAUCMDR_SYSTEM_PREFIX__')}
for var, value in values.items():
# A relative path would lead to a different directory in each working directory,
# such as a build directory where the compiler wrappers run.
# Thus, the system prefix is required to be an absolute path.
if value and not os.path.isabs(value):
sys.stderr.write(f"{var} ('{value}') must be an absolute path.\n")
sys.exit(EXIT_FAILURE)
paths = {var: os.path.realpath(value) for var, value in values.items() if value}
if len(set(paths.values())) > 1:
sys.stderr.write(f"TAUCMDR_SYSTEM_PREFIX ('{values['TAUCMDR_SYSTEM_PREFIX']}') and __TAUCMDR_SYSTEM_PREFIX__ "
f"('{values['__TAUCMDR_SYSTEM_PREFIX__']}') point to different directories. Set only one.\n")
sys.exit(EXIT_FAILURE)
return next(iter(paths.values()), None)
SYSTEM_PREFIX = _system_prefix()
"""str: System-level TAU Commander files, or None if there is no system level.
The system level is set by the environment variable ``TAUCMDR_SYSTEM_PREFIX``, or by its older name
``__TAUCMDR_SYSTEM_PREFIX__``. It is unset or empty for no system level.
"""
USER_PREFIX = os.path.realpath(os.path.abspath(os.environ.get('__TAUCMDR_USER_PREFIX__',
os.path.join(os.path.expanduser('~'),
'.local', 'taucmdr'))))
"""str: User-level TAU Commander files."""
PROJECT_DIR = '.tau'
"""str: Name of the project-level directory containing TAU Commander project files."""
[docs]
def version_banner(): # type: () -> str
"""Return a human readable text banner describing the TAU Commander installation."""
import platform
import socket
from datetime import datetime
import taucmdr.logger
fmt = ("TAU Commander [ %(url)s ]\n"
"\n"
"Prefix : %(prefix)s\n"
"Version : %(version)s\n"
"Timestamp : %(timestamp)s\n"
"Hostname : %(hostname)s\n"
"Platform : %(platform)s\n"
"Working Dir. : %(cwd)s\n"
"Terminal Size : %(termsize)s\n"
"Frozen : %(frozen)s\n"
"Python : %(python)s\n"
"Python Version : %(pyversion)s\n"
"Python Impl. : %(pyimpl)s\n"
"PYTHONPATH : %(pythonpath)s\n")
data = {"url": TAUCMDR_URL,
"prefix": os.path.dirname(os.path.realpath(__file__)),
"version": TAUCMDR_VERSION,
"timestamp": str(datetime.now()),
"hostname": socket.gethostname(),
"platform": platform.platform(),
"cwd": os.getcwd(),
"termsize": 'x'.join([str(dim) for dim in taucmdr.logger.TERM_SIZE]),
"frozen": getattr(sys, 'frozen', False),
"python": sys.executable,
"pyversion": platform.python_version(),
"pyimpl": platform.python_implementation(),
"pythonpath": os.pathsep.join(sys.path)}
return fmt % data