FilesExpand file tree

 master

/

utils.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

130 lines (105 loc) · 4.56 KB

 master

/

utils.py

Copy path

Top

File metadata and controls

• Code
• Blame

130 lines (105 loc) · 4.56 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

# Licensed under the Apache License, Version 2.0 (the "License"); you may

# not use this file except in compliance with the License. You may obtain

# a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

# License for the specific language governing permissions and limitations

# under the License.

import functools

import string

import time

import deprecation

from openstack import _log

from openstack import exceptions

from openstack import version

def deprecated(deprecated_in=None, removed_in=None,

details=""):

"""Mark a method as deprecated

:param deprecated_in: The version string where this method is deprecated.

Generally this is the next version to be released.

:param removed_in: The version where this method will be removed

from the code base. Generally this is the next

major version. This argument is helpful for the

tests when using ``deprecation.fail_if_not_removed``.

:param str details: Helpful details to callers and the documentation.

This will usually be a recommendation for alternate

code to use.

"""

# As all deprecations within this library have the same current_version,

# return a partial function with the library version always set.

partial = functools.partial(deprecation.deprecated,

current_version=version.__version__)

# TODO(shade) shade's tags break these - so hard override them for now.

# We'll want a patch fixing this before we cut any releases.

removed_in = '2.0.0'

return partial(deprecated_in=deprecated_in, removed_in=removed_in,

details=details)

@deprecated(deprecated_in="0.10.0", removed_in="1.0",

details="Use openstack.enable_logging instead")

def enable_logging(*args, **kwargs):

"""Backwards compatibility wrapper function.

openstacksdk has had enable_logging in utils. It's in _log now and

exposed directly at openstack.enable_logging.

"""

return _log.enable_logging(*args, **kwargs)

def urljoin(*args):

"""A custom version of urljoin that simply joins strings into a path.

The real urljoin takes into account web semantics like when joining a url

like /path this should be joined to http://host/path as it is an anchored

link. We generally won't care about that in client.

"""

return '/'.join(str(a or '').strip('/') for a in args)

def iterate_timeout(timeout, message, wait=2):

"""Iterate and raise an exception on timeout.

This is a generator that will continually yield and sleep for

wait seconds, and if the timeout is reached, will raise an exception

with <message>.

"""

log = _log.setup_logging('openstack.iterate_timeout')

try:

# None as a wait winds up flowing well in the per-resource cache

# flow. We could spread this logic around to all of the calling

# points, but just having this treat None as "I don't have a value"

# seems friendlier

if wait is None:

wait = 2

elif wait == 0:

# wait should be < timeout, unless timeout is None

wait = 0.1 if timeout is None else min(0.1, timeout)

wait = float(wait)

except ValueError:

raise exceptions.SDKException(

"Wait value must be an int or float value. {wait} given"

" instead".format(wait=wait))

start = time.time()

count = 0

while (timeout is None) or (time.time() < start + timeout):

count += 1

yield count

log.debug('Waiting %s seconds', wait)

time.sleep(wait)

raise exceptions.ResourceTimeout(message)

def get_string_format_keys(fmt_string, old_style=True):

"""Gets a list of required keys from a format string

Required mostly for parsing base_path urls for required keys, which

use the old style string formatting.

"""

if old_style:

class AccessSaver(object):

def __init__(self):

self.keys = []

def __getitem__(self, key):

self.keys.append(key)

a = AccessSaver()

fmt_string % a

return a.keys

else:

keys = []

for t in string.Formatter().parse(fmt_string):

if t[1] is not None:

keys.append(t[1])

return keys