# SPDX-License-Identifier: BSD-3-Clause AND Apache-2.0
# Copyright 2018 Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * 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.
#
# * Neither the name of the copyright holder 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.
# Copyright 2019 Blue Cheetah Analog Design Inc.
#
# 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.
"""This module contains some commonly used IO functions.
In particular, this module keeps track of BAG's system-wide encoding/decoding settings.
"""
# default BAG file encoding.
# default codec error policy
[docs]bag_codec_error = 'replace'
[docs]def fix_string(obj):
"""Fix the given potential string object to ensure python 2/3 compatibility.
If the given object is raw bytes, decode it into a string using
current encoding and return it. Otherwise, just return the given object.
This method is useful for writing python 2/3 compatible code.
Parameters
----------
obj :
any python object.
Returns
-------
val :
the given object, or a decoded string if the given object is bytes.
"""
if isinstance(obj, bytes):
obj = obj.decode(encoding=bag_encoding, errors=bag_codec_error)
return obj
[docs]def to_bytes(my_str):
"""Convert the given string to raw bytes.
Parameters
----------
my_str : string
the string to encode to bytes.
Returns
-------
val : bytes
raw bytes of the string.
"""
return bytes(my_str.encode(encoding=bag_encoding, errors=bag_codec_error))
[docs]def set_encoding(new_encoding):
"""Sets the BAG input/output encoding.
Parameters
----------
new_encoding : string
the new encoding name.
"""
global bag_encoding
if not isinstance(new_encoding, str):
raise Exception('encoding name must be string/unicode.')
bag_encoding = new_encoding
[docs]def get_encoding():
"""Returns the BAG input/output encoding.
Returns
-------
bag_encoding : unicode
the encoding name.
"""
return bag_encoding
[docs]def set_error_policy(new_policy):
"""Sets the error policy on encoding/decoding errors.
Parameters
----------
new_policy : string
the new error policy name. See codecs package documentation
for more information.
"""
global bag_codec_error
bag_codec_error = new_policy
[docs]def get_error_policy():
"""Returns the current BAG encoding/decoding error policy.
Returns
-------
policy : unicode
the current error policy name.
"""
return bag_codec_error