ini_helper.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Willow Garage, Inc.
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 
00034 def pack(data):
00035     """
00036     Packs 'data' into a form that can be easily and readably written to an ini file
00037     :param data: A list of strings or a list of items with a 'text' method to be flattened into a string ''list''
00038     :return: A string suitable for output to ini files ''str''
00039     """
00040     if len(data) == 0:
00041         return ''
00042 
00043     def _get_str(item):
00044         try:
00045             return item.text()
00046         except:
00047             return item
00048 
00049     data = [_get_str(value) for value in data]
00050     if len(data) == 1:
00051         return data[0]
00052     return data
00053 
00054 
00055 def unpack(data):
00056     """
00057     Unpacks the values read from an ini file
00058     :param data: An entry taken from an ini file ''list or string''
00059     :return: A list of strings ''list''
00060     """
00061     if data is None or data == '':
00062         data = []
00063     elif is_string(data):
00064         data = [data]
00065     return data
00066 
00067 
00068 def is_string(s):
00069     """Check if the argument is a string which works for both Python 2 and 3."""
00070     try:
00071         return isinstance(s, basestring)
00072     except NameError:
00073         return isinstance(s, str)


rqt_py_common
Author(s): Dorian Scholz, Isaac Saito
autogenerated on Sat Jun 8 2019 20:23:34