#
# Copyright (C) 2010-2017 Samuel Abels
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""
Handy shortcuts for converting types.
"""
from __future__ import absolute_import
from builtins import str
import re
import Exscript
[docs]def to_list(item):
"""
If the given item is iterable, this function returns the given item.
If the item is not iterable, this function returns a list with only the
item in it.
:type item: object
:param item: Any object.
:rtype: list
:return: A list with the item in it.
"""
if hasattr(item, '__iter__') and not isinstance(item, str):
return item
return [item]
[docs]def to_host(host, default_protocol='telnet', default_domain=''):
"""
Given a string or a Host object, this function returns a Host object.
:type host: string|Host
:param host: A hostname (may be URL formatted) or a Host object.
:type default_protocol: str
:param default_protocol: Passed to the Host constructor.
:type default_domain: str
:param default_domain: Appended to each hostname that has no domain.
:rtype: Host
:return: The Host object.
"""
if host is None:
raise TypeError('None can not be cast to Host')
if hasattr(host, 'get_address'):
return host
if default_domain and not '.' in host:
host += '.' + default_domain
return Exscript.Host(host, default_protocol=default_protocol)
[docs]def to_hosts(hosts, default_protocol='telnet', default_domain=''):
"""
Given a string or a Host object, or a list of strings or Host objects,
this function returns a list of Host objects.
:type hosts: string|Host|list(string)|list(Host)
:param hosts: One or more hosts or hostnames.
:type default_protocol: str
:param default_protocol: Passed to the Host constructor.
:type default_domain: str
:param default_domain: Appended to each hostname that has no domain.
:rtype: list[Host]
:return: A list of Host objects.
"""
return [to_host(h, default_protocol, default_domain)
for h in to_list(hosts)]
[docs]def to_regex(regex, flags=0):
"""
Given a string, this function returns a new re.RegexObject.
Given a re.RegexObject, this function just returns the same object.
:type regex: string|re.RegexObject
:param regex: A regex or a re.RegexObject
:type flags: int
:param flags: See Python's re.compile().
:rtype: re.RegexObject
:return: The Python regex object.
"""
if regex is None:
raise TypeError('None can not be cast to re.RegexObject')
if hasattr(regex, 'match'):
return regex
return re.compile(regex, flags)
[docs]def to_regexs(regexs):
"""
Given a string or a re.RegexObject, or a list of strings or
re.RegexObjects, this function returns a list of re.RegexObjects.
:type regexs: str|re.RegexObject|list(str|re.RegexObject)
:param regexs: One or more regexs or re.RegexObjects.
:rtype: list(re.RegexObject)
:return: A list of re.RegexObjects.
"""
return [to_regex(r) for r in to_list(regexs)]