Reference Guide
2.5.0
utils.py
1
# -----------------------------------------------------------------------------
2
# BSD 3-Clause License
3
#
4
# Copyright (c) 2018-2024, Science and Technology Facilities Council.
5
# All rights reserved.
6
#
7
# Redistribution and use in source and binary forms, with or without
8
# modification, are permitted provided that the following conditions are met:
9
#
10
# * Redistributions of source code must retain the above copyright notice, this
11
# list of conditions and the following disclaimer.
12
#
13
# * Redistributions in binary form must reproduce the above copyright notice,
14
# this list of conditions and the following disclaimer in the documentation
15
# and/or other materials provided with the distribution.
16
#
17
# * Neither the name of the copyright holder nor the names of its
18
# contributors may be used to endorse or promote products derived from
19
# this software without specific prior written permission.
20
#
21
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32
# POSSIBILITY OF SUCH DAMAGE.
33
# -----------------------------------------------------------------------------
34
# Authors: A. R. Porter and R. W. Ford, STFC Daresbury Lab
35
36
'''This module provides generic utility functions.'''
37
38
import
sys
39
40
41
def
within_virtual_env():
42
'''
43
Utility function that identifies whether we are running in a Python
44
virtual environment. Works for virtualenv and Python 3's venv.
45
46
:returns: True if we're running in a virtual environment.
47
:rtype: bool
48
49
'''
50
# pylint: disable=no-member
51
return
(hasattr(sys,
'real_prefix'
)
or
52
(hasattr(sys,
'base_prefix'
)
and
sys.base_prefix != sys.prefix))
53
54
55
def
a_or_an(string):
56
'''Returns 'an' if the supplied string starts with a vowel or 'h',
57
otherwise returns 'a'.
58
59
:param str string: the string to check.
60
61
:returns: 'an' if the supplied string starts with a vowel or 'h', \
62
otherwise returns 'a'.
63
:rtype: str
64
65
'''
66
char = string[0].lower()
67
if
char
in
[
"a"
,
"e"
,
"i"
,
"o"
,
"u"
,
"h"
]:
68
return
"an"
69
return
"a"
src
psyclone
utils.py
Generated by
1.9.1