Completed
Pull Request — master (#2669)
by Lakshmi
06:34
created

KeyReference.__str__()   A

Complexity

Conditions 1

Size

Total Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
c 1
b 0
f 0
dl 0
loc 2
rs 10
1
# Licensed to the StackStorm, Inc ('StackStorm') under one or more
2
# contributor license agreements.  See the NOTICE file distributed with
3
# this work for additional information regarding copyright ownership.
4
# The ASF licenses this file to You under the Apache License, Version 2.0
5
# (the "License"); you may not use this file except in compliance with
6
# the License.  You may obtain a copy of the License at
7
#
8
#     http://www.apache.org/licenses/LICENSE-2.0
9
#
10
# Unless required by applicable law or agreed to in writing, software
11
# distributed under the License is distributed on an "AS IS" BASIS,
12
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
# See the License for the specific language governing permissions and
14
# limitations under the License.
15
16
from st2common.constants.keyvalue import PREFIX_SEPARATOR
17
18
19
class KeyReference(object):
20
    """
21
    Holds a reference to key given name and prefix. For example, if key name is foo and prefix
22
    is bob, this returns a string of form "bob.foo". This assumes '.' is the PREFIX_SEPARATOR.
23
    """
24
25
    def __init__(self, name, prefix=''):
26
        self._prefix = prefix
27
        self._name = name
28
        self.ref = ('%s%s%s' % (self._prefix, PREFIX_SEPARATOR, self._name)
29
                    if self._prefix else self._name)
30
31
    def __str__(self):
32
        return self.ref
33