python-manilaclient/manilaclient/utils.py
Stephen Finucane 0002625e2b utils: Remove unicode-related helpers
The 'unicode_key_value_to_string' and '_encode' helpers were used to
handle the difference between unicode and byte strings in Python 2. In a
Python 3-only world, they are unnecessary. Remove them.

Some references to text encoding in the HACKING file are removed. In
theory, we should no longer have to worry about byte strings.

Change-Id: I0694b25dc4d72e817cb08ce6cafb39bb8226293d
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-07-14 10:26:30 +01:00

69 lines
2.1 KiB
Python

# 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.
from urllib import parse
class HookableMixin(object):
"""Mixin so classes can register and run hooks."""
_hooks_map = {}
@classmethod
def add_hook(cls, hook_type, hook_func):
if hook_type not in cls._hooks_map:
cls._hooks_map[hook_type] = []
cls._hooks_map[hook_type].append(hook_func)
@classmethod
def run_hooks(cls, hook_type, *args, **kwargs):
hook_funcs = cls._hooks_map.get(hook_type) or []
for hook_func in hook_funcs:
hook_func(*args, **kwargs)
def safe_issubclass(*args):
"""Like issubclass, but will just return False if not a class."""
try:
if issubclass(*args):
return True
except TypeError:
pass
return False
def get_function_name(func):
return "%s.%s" % (func.__module__, func.__qualname__)
def safe_urlencode(params_dict):
"""Workaround incompatible change to urllib.parse
urllib's parse library used to adhere to RFC 2396 until
python 3.7. The library moved from RFC 2396 to RFC 3986
for quoting URL strings in python 3.7 and '~' is now
included in the set of reserved characters. [1]
This utility ensures "~" is never encoded.
See LP 1785283 [2] for more details.
[1] https://docs.python.org/3/library/urllib.parse.html#url-quoting
[2] https://bugs.launchpad.net/python-manilaclient/+bug/1785283
:param params_dict can be a list of (k,v) tuples, or a dictionary
"""
parsed_params = parse.urlencode(params_dict)
return parsed_params.replace("%7E", "~")