Source code for peng3dnet.util

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#  Copyright 2017 notna <>
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  GNU General Public License for more details.
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
#  MA 02110-1301, USA.

from . import errors

[docs]def parse_address(addr,default_port=8080): """ Parses an IP Address into a tuple of ``(addr,port)``\ . If the address does not contain an explicitly specified port, the value given with ``default_port`` is used. Note that currently only IPv4 addresses are supported, but IPv6 support may be added in the future. If an IPv6 Address is detected, a :py:exc:`~peng3dnet.errors.UnsupportedAddressError` will be raised. Additionally, the port returned is checked for plausibility, e.g. an integer in range 0-65535. If the port is invalid in any way, a :py:exc:`~peng3dnet.errors.InvalidPortError` will be raised. """ addr = str(addr) addrs = addr.split(":") if len(addrs)==1: addr = addrs[0] port = default_port elif len(addrs)==2: addr = addrs[0] try: port = int(addrs[1]) except Exception: raise errors.InvalidPortError("Port %s is not an integer"%addrs[1]) else: raise errors.UnsupportedAddressError("Address appears to be an IPv6 address, currently not supported") if not isinstance(port,int): raise errors.InvalidPortError("Port must be an integer") elif port<0: raise errors.InvalidPortError("Port may not be less than zero") elif port>65535: raise errors.InvalidPortError("Port may not be higher than 65535") # TODO: add address validation return addr,port
[docs]def normalize_addr_socketstyle(addr,default_port=8080): """ Normalizes the given address to a 2-tuple as accepted by the :py:mod:`socket` module. Currently accepts a 2-tuple and IPv4 addresses in string format. If the address does not contain a port, the ``default_port`` will be used. Note that this function will pass through any exceptions raised by parsing functions it calls. """ if len(addr)==2: return addr else: return parse_address(addr,default_port)
[docs]def normalize_addr_formatted(addr): """ Normalizes the given address to a string like ````\ . This method is currently not implemented. """ raise NotImplementedError("not yet implemented")