From 9c464ba53f0c1317a397f96202b577f0729fc4eb Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 16 Oct 2014 19:23:53 +0900 Subject: [PATCH] Use graduated oslo libraries The following libraries have been graduated: - gettextutils -> oslo.i18n - jsonutils -> oslo.serialization - strutils, timeutils -> oslo.utils Add neutronclient.i18n module as oslo.i18n adapter. Remove openstack.common related files completely because neutronclient no longer use any oslo-incubator modules. Closes-Bug: #1382017 Change-Id: Ib7ebcb691a12858049baab3b122f95bf43038f18 --- neutronclient/client.py | 2 +- neutronclient/common/serializer.py | 4 +- neutronclient/common/utils.py | 8 +- neutronclient/common/validators.py | 2 +- .../{openstack/common/__init__.py => i18n.py} | 17 +- neutronclient/neutron/client.py | 2 +- neutronclient/neutron/v2_0/__init__.py | 4 +- neutronclient/neutron/v2_0/agentscheduler.py | 2 +- neutronclient/neutron/v2_0/credential.py | 2 +- neutronclient/neutron/v2_0/floatingip.py | 2 +- neutronclient/neutron/v2_0/fw/firewall.py | 2 +- .../neutron/v2_0/fw/firewallpolicy.py | 2 +- neutronclient/neutron/v2_0/fw/firewallrule.py | 2 +- .../neutron/v2_0/lb/healthmonitor.py | 2 +- neutronclient/neutron/v2_0/lb/member.py | 2 +- neutronclient/neutron/v2_0/lb/pool.py | 2 +- neutronclient/neutron/v2_0/lb/vip.py | 2 +- neutronclient/neutron/v2_0/metering.py | 2 +- .../neutron/v2_0/nec/packetfilter.py | 2 +- neutronclient/neutron/v2_0/network.py | 2 +- neutronclient/neutron/v2_0/networkprofile.py | 2 +- .../neutron/v2_0/nsx/networkgateway.py | 2 +- neutronclient/neutron/v2_0/nsx/qos_queue.py | 2 +- neutronclient/neutron/v2_0/policyprofile.py | 2 +- neutronclient/neutron/v2_0/port.py | 5 +- neutronclient/neutron/v2_0/quota.py | 4 +- neutronclient/neutron/v2_0/router.py | 5 +- neutronclient/neutron/v2_0/securitygroup.py | 2 +- neutronclient/neutron/v2_0/subnet.py | 5 +- neutronclient/neutron/v2_0/vpn/ikepolicy.py | 2 +- .../neutron/v2_0/vpn/ipsec_site_connection.py | 5 +- neutronclient/neutron/v2_0/vpn/ipsecpolicy.py | 2 +- neutronclient/neutron/v2_0/vpn/utils.py | 2 +- neutronclient/neutron/v2_0/vpn/vpnservice.py | 2 +- neutronclient/openstack/__init__.py | 0 .../openstack/common/gettextutils.py | 498 ------------------ neutronclient/openstack/common/importutils.py | 73 --- neutronclient/openstack/common/jsonutils.py | 186 ------- neutronclient/openstack/common/strutils.py | 239 --------- neutronclient/openstack/common/timeutils.py | 210 -------- neutronclient/shell.py | 6 +- neutronclient/tests/unit/test_auth.py | 2 +- neutronclient/tests/unit/test_cli20_agents.py | 3 +- .../tests/unit/test_cli20_network.py | 2 +- openstack-common.conf | 7 - requirements.txt | 3 + 46 files changed, 71 insertions(+), 1265 deletions(-) rename neutronclient/{openstack/common/__init__.py => i18n.py} (54%) delete mode 100644 neutronclient/openstack/__init__.py delete mode 100644 neutronclient/openstack/common/gettextutils.py delete mode 100644 neutronclient/openstack/common/importutils.py delete mode 100644 neutronclient/openstack/common/jsonutils.py delete mode 100644 neutronclient/openstack/common/strutils.py delete mode 100644 neutronclient/openstack/common/timeutils.py delete mode 100644 openstack-common.conf diff --git a/neutronclient/client.py b/neutronclient/client.py index ebf0b972a..1ff612706 100644 --- a/neutronclient/client.py +++ b/neutronclient/client.py @@ -29,7 +29,7 @@ import six from neutronclient.common import exceptions from neutronclient.common import utils -from neutronclient.openstack.common.gettextutils import _ +from neutronclient.i18n import _ _logger = logging.getLogger(__name__) diff --git a/neutronclient/common/serializer.py b/neutronclient/common/serializer.py index 0b5efd0cb..267d3edd6 100644 --- a/neutronclient/common/serializer.py +++ b/neutronclient/common/serializer.py @@ -21,12 +21,12 @@ import logging from xml.etree import ElementTree as etree from xml.parsers import expat +from oslo.serialization import jsonutils import six from neutronclient.common import constants from neutronclient.common import exceptions as exception -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils +from neutronclient.i18n import _ LOG = logging.getLogger(__name__) diff --git a/neutronclient/common/utils.py b/neutronclient/common/utils.py index bdc4b5336..28137b7fa 100644 --- a/neutronclient/common/utils.py +++ b/neutronclient/common/utils.py @@ -20,12 +20,12 @@ import logging import os +from oslo.utils import encodeutils +from oslo.utils import importutils import six from neutronclient.common import _ from neutronclient.common import exceptions -from neutronclient.openstack.common import importutils -from neutronclient.openstack.common import strutils def env(*vars, **kwargs): @@ -125,7 +125,7 @@ def http_log_req(_logger, args, kwargs): if 'body' in kwargs and kwargs['body']: string_parts.append(" -d '%s'" % (kwargs['body'])) - req = strutils.safe_encode("".join(string_parts)) + req = encodeutils.safe_encode("".join(string_parts)) _logger.debug("\nREQ: %s\n", req) @@ -140,7 +140,7 @@ def http_log_resp(_logger, resp, body): def _safe_encode_without_obj(data): if isinstance(data, six.string_types): - return strutils.safe_encode(data) + return encodeutils.safe_encode(data) return data diff --git a/neutronclient/common/validators.py b/neutronclient/common/validators.py index e732dfdcb..304ba35c5 100644 --- a/neutronclient/common/validators.py +++ b/neutronclient/common/validators.py @@ -16,7 +16,7 @@ import netaddr from neutronclient.common import exceptions -from neutronclient.openstack.common.gettextutils import _ +from neutronclient.i18n import _ def validate_int_range(parsed_args, attr_name, min_value=None, max_value=None): diff --git a/neutronclient/openstack/common/__init__.py b/neutronclient/i18n.py similarity index 54% rename from neutronclient/openstack/common/__init__.py rename to neutronclient/i18n.py index d1223eaf7..f8084067f 100644 --- a/neutronclient/openstack/common/__init__.py +++ b/neutronclient/i18n.py @@ -1,4 +1,3 @@ -# # 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 @@ -11,7 +10,19 @@ # License for the specific language governing permissions and limitations # under the License. -import six +from oslo import i18n +_translators = i18n.TranslatorFactory(domain='neutronclient') -six.add_move(six.MovedModule('mox', 'mox', 'mox3.mox')) +# The primary translation function using the well-known name "_" +_ = _translators.primary + +# Translators for log levels. +# +# The abbreviated names are meant to reflect the usual use of a short +# name like '_'. The "L" is for "log" and the other letter comes from +# the level. +_LI = _translators.log_info +_LW = _translators.log_warning +_LE = _translators.log_error +_LC = _translators.log_critical diff --git a/neutronclient/neutron/client.py b/neutronclient/neutron/client.py index 4f0c5b01d..7236a8a0a 100644 --- a/neutronclient/neutron/client.py +++ b/neutronclient/neutron/client.py @@ -16,7 +16,7 @@ from neutronclient.common import exceptions from neutronclient.common import utils -from neutronclient.openstack.common.gettextutils import _ +from neutronclient.i18n import _ API_NAME = 'network' diff --git a/neutronclient/neutron/v2_0/__init__.py b/neutronclient/neutron/v2_0/__init__.py index eb118b191..538b48c59 100644 --- a/neutronclient/neutron/v2_0/__init__.py +++ b/neutronclient/neutron/v2_0/__init__.py @@ -24,13 +24,13 @@ import re from cliff.formatters import table from cliff import lister from cliff import show +from oslo.serialization import jsonutils import six from neutronclient.common import command from neutronclient.common import exceptions from neutronclient.common import utils -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils +from neutronclient.i18n import _ HEX_ELEM = '[0-9A-Fa-f]' UUID_PATTERN = '-'.join([HEX_ELEM + '{8}', HEX_ELEM + '{4}', diff --git a/neutronclient/neutron/v2_0/agentscheduler.py b/neutronclient/neutron/v2_0/agentscheduler.py index db702b5bf..e77f186db 100644 --- a/neutronclient/neutron/v2_0/agentscheduler.py +++ b/neutronclient/neutron/v2_0/agentscheduler.py @@ -16,10 +16,10 @@ from __future__ import print_function +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 from neutronclient.neutron.v2_0 import network from neutronclient.neutron.v2_0 import router -from neutronclient.openstack.common.gettextutils import _ PERFECT_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%f" diff --git a/neutronclient/neutron/v2_0/credential.py b/neutronclient/neutron/v2_0/credential.py index 8dd38a113..ffec5ee1d 100644 --- a/neutronclient/neutron/v2_0/credential.py +++ b/neutronclient/neutron/v2_0/credential.py @@ -11,8 +11,8 @@ # under the License. # +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListCredential(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/floatingip.py b/neutronclient/neutron/v2_0/floatingip.py index e995bcac0..f52e52a77 100644 --- a/neutronclient/neutron/v2_0/floatingip.py +++ b/neutronclient/neutron/v2_0/floatingip.py @@ -18,8 +18,8 @@ from __future__ import print_function import argparse +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListFloatingIP(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/fw/firewall.py b/neutronclient/neutron/v2_0/fw/firewall.py index 06b804037..149036a2a 100644 --- a/neutronclient/neutron/v2_0/fw/firewall.py +++ b/neutronclient/neutron/v2_0/fw/firewall.py @@ -18,8 +18,8 @@ import argparse +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 -from neutronclient.openstack.common.gettextutils import _ class ListFirewall(neutronv20.ListCommand): diff --git a/neutronclient/neutron/v2_0/fw/firewallpolicy.py b/neutronclient/neutron/v2_0/fw/firewallpolicy.py index e2771c26c..5d1a4b7f7 100644 --- a/neutronclient/neutron/v2_0/fw/firewallpolicy.py +++ b/neutronclient/neutron/v2_0/fw/firewallpolicy.py @@ -20,8 +20,8 @@ from __future__ import print_function import argparse +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 -from neutronclient.openstack.common.gettextutils import _ def _format_firewall_rules(firewall_policy): diff --git a/neutronclient/neutron/v2_0/fw/firewallrule.py b/neutronclient/neutron/v2_0/fw/firewallrule.py index aa4b90c53..03f425c7b 100644 --- a/neutronclient/neutron/v2_0/fw/firewallrule.py +++ b/neutronclient/neutron/v2_0/fw/firewallrule.py @@ -18,8 +18,8 @@ import argparse +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 -from neutronclient.openstack.common.gettextutils import _ class ListFirewallRule(neutronv20.ListCommand): diff --git a/neutronclient/neutron/v2_0/lb/healthmonitor.py b/neutronclient/neutron/v2_0/lb/healthmonitor.py index 6dfae9841..83c2cf57f 100644 --- a/neutronclient/neutron/v2_0/lb/healthmonitor.py +++ b/neutronclient/neutron/v2_0/lb/healthmonitor.py @@ -18,8 +18,8 @@ from __future__ import print_function +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListHealthMonitor(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/lb/member.py b/neutronclient/neutron/v2_0/lb/member.py index 1d589f269..7fd6f1ea0 100644 --- a/neutronclient/neutron/v2_0/lb/member.py +++ b/neutronclient/neutron/v2_0/lb/member.py @@ -16,8 +16,8 @@ # @author: Ilya Shakhat, Mirantis Inc. # +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListMember(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/lb/pool.py b/neutronclient/neutron/v2_0/lb/pool.py index f491f74b5..c10f7a87f 100644 --- a/neutronclient/neutron/v2_0/lb/pool.py +++ b/neutronclient/neutron/v2_0/lb/pool.py @@ -19,8 +19,8 @@ import six +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ def _format_provider(pool): diff --git a/neutronclient/neutron/v2_0/lb/vip.py b/neutronclient/neutron/v2_0/lb/vip.py index 8b1108c0d..3c85d3378 100644 --- a/neutronclient/neutron/v2_0/lb/vip.py +++ b/neutronclient/neutron/v2_0/lb/vip.py @@ -16,8 +16,8 @@ # @author: Ilya Shakhat, Mirantis Inc. # +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListVip(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/metering.py b/neutronclient/neutron/v2_0/metering.py index 20ca7572f..c2649c483 100644 --- a/neutronclient/neutron/v2_0/metering.py +++ b/neutronclient/neutron/v2_0/metering.py @@ -14,8 +14,8 @@ # License for the specific language governing permissions and limitations # under the License. +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 -from neutronclient.openstack.common.gettextutils import _ class ListMeteringLabel(neutronv20.ListCommand): diff --git a/neutronclient/neutron/v2_0/nec/packetfilter.py b/neutronclient/neutron/v2_0/nec/packetfilter.py index 957a16ad9..48d0f744d 100644 --- a/neutronclient/neutron/v2_0/nec/packetfilter.py +++ b/neutronclient/neutron/v2_0/nec/packetfilter.py @@ -15,8 +15,8 @@ from neutronclient.common import exceptions from neutronclient.common import validators +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListPacketFilter(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/network.py b/neutronclient/neutron/v2_0/network.py index 54d546570..a984926aa 100644 --- a/neutronclient/neutron/v2_0/network.py +++ b/neutronclient/neutron/v2_0/network.py @@ -17,8 +17,8 @@ import argparse from neutronclient.common import exceptions +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ def _format_subnets(network): diff --git a/neutronclient/neutron/v2_0/networkprofile.py b/neutronclient/neutron/v2_0/networkprofile.py index e89b0a0ee..03fc4972a 100644 --- a/neutronclient/neutron/v2_0/networkprofile.py +++ b/neutronclient/neutron/v2_0/networkprofile.py @@ -16,9 +16,9 @@ from __future__ import print_function +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 from neutronclient.neutron.v2_0 import parse_args_to_dict -from neutronclient.openstack.common.gettextutils import _ RESOURCE = 'network_profile' SEGMENT_TYPE_CHOICES = ['vlan', 'overlay', 'multi-segment', 'trunk'] diff --git a/neutronclient/neutron/v2_0/nsx/networkgateway.py b/neutronclient/neutron/v2_0/nsx/networkgateway.py index d6795687e..52a38256b 100644 --- a/neutronclient/neutron/v2_0/nsx/networkgateway.py +++ b/neutronclient/neutron/v2_0/nsx/networkgateway.py @@ -17,8 +17,8 @@ from __future__ import print_function from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ GW_RESOURCE = 'network_gateway' DEV_RESOURCE = 'gateway_device' diff --git a/neutronclient/neutron/v2_0/nsx/qos_queue.py b/neutronclient/neutron/v2_0/nsx/qos_queue.py index e8c8254fc..7f6cb68b2 100644 --- a/neutronclient/neutron/v2_0/nsx/qos_queue.py +++ b/neutronclient/neutron/v2_0/nsx/qos_queue.py @@ -13,8 +13,8 @@ # License for the specific language governing permissions and limitations # under the License. +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListQoSQueue(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/policyprofile.py b/neutronclient/neutron/v2_0/policyprofile.py index 580ef8ca7..03fd8af10 100644 --- a/neutronclient/neutron/v2_0/policyprofile.py +++ b/neutronclient/neutron/v2_0/policyprofile.py @@ -15,9 +15,9 @@ from __future__ import print_function +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 from neutronclient.neutron.v2_0 import parse_args_to_dict -from neutronclient.openstack.common.gettextutils import _ RESOURCE = 'policy_profile' diff --git a/neutronclient/neutron/v2_0/port.py b/neutronclient/neutron/v2_0/port.py index 5434de28b..4d2d7fa30 100644 --- a/neutronclient/neutron/v2_0/port.py +++ b/neutronclient/neutron/v2_0/port.py @@ -16,11 +16,12 @@ import argparse +from oslo.serialization import jsonutils + from neutronclient.common import exceptions from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils def _format_fixed_ips(port): diff --git a/neutronclient/neutron/v2_0/quota.py b/neutronclient/neutron/v2_0/quota.py index 6e5ad174f..780f510b1 100644 --- a/neutronclient/neutron/v2_0/quota.py +++ b/neutronclient/neutron/v2_0/quota.py @@ -20,13 +20,13 @@ import argparse from cliff import lister from cliff import show +from oslo.serialization import jsonutils import six from neutronclient.common import exceptions from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils def get_tenant_id(tenant_id, client): diff --git a/neutronclient/neutron/v2_0/router.py b/neutronclient/neutron/v2_0/router.py index 71969f575..6973218cb 100644 --- a/neutronclient/neutron/v2_0/router.py +++ b/neutronclient/neutron/v2_0/router.py @@ -18,10 +18,11 @@ from __future__ import print_function import argparse +from oslo.serialization import jsonutils + from neutronclient.common import exceptions +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils def _format_external_gateway_info(router): diff --git a/neutronclient/neutron/v2_0/securitygroup.py b/neutronclient/neutron/v2_0/securitygroup.py index 8c554a904..a1a2bf5b9 100644 --- a/neutronclient/neutron/v2_0/securitygroup.py +++ b/neutronclient/neutron/v2_0/securitygroup.py @@ -17,8 +17,8 @@ import argparse from neutronclient.common import exceptions +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ class ListSecurityGroup(neutronV20.ListCommand): diff --git a/neutronclient/neutron/v2_0/subnet.py b/neutronclient/neutron/v2_0/subnet.py index 5e90d0021..ed5b478e3 100644 --- a/neutronclient/neutron/v2_0/subnet.py +++ b/neutronclient/neutron/v2_0/subnet.py @@ -16,11 +16,12 @@ import argparse +from oslo.serialization import jsonutils + from neutronclient.common import exceptions from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronV20 -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils def _format_allocation_pools(subnet): diff --git a/neutronclient/neutron/v2_0/vpn/ikepolicy.py b/neutronclient/neutron/v2_0/vpn/ikepolicy.py index 71df04772..e2f5d2861 100644 --- a/neutronclient/neutron/v2_0/vpn/ikepolicy.py +++ b/neutronclient/neutron/v2_0/vpn/ikepolicy.py @@ -17,9 +17,9 @@ # from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 from neutronclient.neutron.v2_0.vpn import utils as vpn_utils -from neutronclient.openstack.common.gettextutils import _ class ListIKEPolicy(neutronv20.ListCommand): diff --git a/neutronclient/neutron/v2_0/vpn/ipsec_site_connection.py b/neutronclient/neutron/v2_0/vpn/ipsec_site_connection.py index 116451158..59d676e0a 100644 --- a/neutronclient/neutron/v2_0/vpn/ipsec_site_connection.py +++ b/neutronclient/neutron/v2_0/vpn/ipsec_site_connection.py @@ -16,12 +16,13 @@ # @author: Swaminathan Vasudevan, Hewlett-Packard. # +from oslo.serialization import jsonutils + from neutronclient.common import exceptions from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 from neutronclient.neutron.v2_0.vpn import utils as vpn_utils -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import jsonutils def _format_peer_cidrs(ipsec_site_connection): diff --git a/neutronclient/neutron/v2_0/vpn/ipsecpolicy.py b/neutronclient/neutron/v2_0/vpn/ipsecpolicy.py index 99eb844e7..cade641b9 100644 --- a/neutronclient/neutron/v2_0/vpn/ipsecpolicy.py +++ b/neutronclient/neutron/v2_0/vpn/ipsecpolicy.py @@ -16,9 +16,9 @@ # @author: Swaminathan Vasudevan, Hewlett-Packard. from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 from neutronclient.neutron.v2_0.vpn import utils as vpn_utils -from neutronclient.openstack.common.gettextutils import _ class ListIPsecPolicy(neutronv20.ListCommand): diff --git a/neutronclient/neutron/v2_0/vpn/utils.py b/neutronclient/neutron/v2_0/vpn/utils.py index 832a6a2c7..74fbeef6f 100644 --- a/neutronclient/neutron/v2_0/vpn/utils.py +++ b/neutronclient/neutron/v2_0/vpn/utils.py @@ -21,7 +21,7 @@ from neutronclient.common import exceptions -from neutronclient.openstack.common.gettextutils import _ +from neutronclient.i18n import _ dpd_supported_actions = ['hold', 'clear', 'restart', 'restart-by-peer', 'disabled'] diff --git a/neutronclient/neutron/v2_0/vpn/vpnservice.py b/neutronclient/neutron/v2_0/vpn/vpnservice.py index 4dac74375..cf892646f 100644 --- a/neutronclient/neutron/v2_0/vpn/vpnservice.py +++ b/neutronclient/neutron/v2_0/vpn/vpnservice.py @@ -16,8 +16,8 @@ # @author: Swaminathan Vasudevan, Hewlett-Packard. # +from neutronclient.i18n import _ from neutronclient.neutron import v2_0 as neutronv20 -from neutronclient.openstack.common.gettextutils import _ class ListVPNService(neutronv20.ListCommand): diff --git a/neutronclient/openstack/__init__.py b/neutronclient/openstack/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/neutronclient/openstack/common/gettextutils.py b/neutronclient/openstack/common/gettextutils.py deleted file mode 100644 index 22243e156..000000000 --- a/neutronclient/openstack/common/gettextutils.py +++ /dev/null @@ -1,498 +0,0 @@ -# Copyright 2012 Red Hat, Inc. -# Copyright 2013 IBM Corp. -# All Rights Reserved. -# -# 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. - -""" -gettext for openstack-common modules. - -Usual usage in an openstack.common module: - - from neutronclient.openstack.common.gettextutils import _ -""" - -import copy -import functools -import gettext -import locale -from logging import handlers -import os - -from babel import localedata -import six - -_AVAILABLE_LANGUAGES = {} - -# FIXME(dhellmann): Remove this when moving to oslo.i18n. -USE_LAZY = False - - -class TranslatorFactory(object): - """Create translator functions - """ - - def __init__(self, domain, lazy=False, localedir=None): - """Establish a set of translation functions for the domain. - - :param domain: Name of translation domain, - specifying a message catalog. - :type domain: str - :param lazy: Delays translation until a message is emitted. - Defaults to False. - :type lazy: Boolean - :param localedir: Directory with translation catalogs. - :type localedir: str - """ - self.domain = domain - self.lazy = lazy - if localedir is None: - localedir = os.environ.get(domain.upper() + '_LOCALEDIR') - self.localedir = localedir - - def _make_translation_func(self, domain=None): - """Return a new translation function ready for use. - - Takes into account whether or not lazy translation is being - done. - - The domain can be specified to override the default from the - factory, but the localedir from the factory is always used - because we assume the log-level translation catalogs are - installed in the same directory as the main application - catalog. - - """ - if domain is None: - domain = self.domain - if self.lazy: - return functools.partial(Message, domain=domain) - t = gettext.translation( - domain, - localedir=self.localedir, - fallback=True, - ) - if six.PY3: - return t.gettext - return t.ugettext - - @property - def primary(self): - "The default translation function." - return self._make_translation_func() - - def _make_log_translation_func(self, level): - return self._make_translation_func(self.domain + '-log-' + level) - - @property - def log_info(self): - "Translate info-level log messages." - return self._make_log_translation_func('info') - - @property - def log_warning(self): - "Translate warning-level log messages." - return self._make_log_translation_func('warning') - - @property - def log_error(self): - "Translate error-level log messages." - return self._make_log_translation_func('error') - - @property - def log_critical(self): - "Translate critical-level log messages." - return self._make_log_translation_func('critical') - - -# NOTE(dhellmann): When this module moves out of the incubator into -# oslo.i18n, these global variables can be moved to an integration -# module within each application. - -# Create the global translation functions. -_translators = TranslatorFactory('neutronclient') - -# The primary translation function using the well-known name "_" -_ = _translators.primary - -# Translators for log levels. -# -# The abbreviated names are meant to reflect the usual use of a short -# name like '_'. The "L" is for "log" and the other letter comes from -# the level. -_LI = _translators.log_info -_LW = _translators.log_warning -_LE = _translators.log_error -_LC = _translators.log_critical - -# NOTE(dhellmann): End of globals that will move to the application's -# integration module. - - -def enable_lazy(): - """Convenience function for configuring _() to use lazy gettext - - Call this at the start of execution to enable the gettextutils._ - function to use lazy gettext functionality. This is useful if - your project is importing _ directly instead of using the - gettextutils.install() way of importing the _ function. - """ - # FIXME(dhellmann): This function will be removed in oslo.i18n, - # because the TranslatorFactory makes it superfluous. - global _, _LI, _LW, _LE, _LC, USE_LAZY - tf = TranslatorFactory('neutronclient', lazy=True) - _ = tf.primary - _LI = tf.log_info - _LW = tf.log_warning - _LE = tf.log_error - _LC = tf.log_critical - USE_LAZY = True - - -def install(domain, lazy=False): - """Install a _() function using the given translation domain. - - Given a translation domain, install a _() function using gettext's - install() function. - - The main difference from gettext.install() is that we allow - overriding the default localedir (e.g. /usr/share/locale) using - a translation-domain-specific environment variable (e.g. - NOVA_LOCALEDIR). - - :param domain: the translation domain - :param lazy: indicates whether or not to install the lazy _() function. - The lazy _() introduces a way to do deferred translation - of messages by installing a _ that builds Message objects, - instead of strings, which can then be lazily translated into - any available locale. - """ - if lazy: - from six import moves - tf = TranslatorFactory(domain, lazy=True) - moves.builtins.__dict__['_'] = tf.primary - else: - localedir = '%s_LOCALEDIR' % domain.upper() - if six.PY3: - gettext.install(domain, - localedir=os.environ.get(localedir)) - else: - gettext.install(domain, - localedir=os.environ.get(localedir), - unicode=True) - - -class Message(six.text_type): - """A Message object is a unicode object that can be translated. - - Translation of Message is done explicitly using the translate() method. - For all non-translation intents and purposes, a Message is simply unicode, - and can be treated as such. - """ - - def __new__(cls, msgid, msgtext=None, params=None, - domain='neutronclient', *args): - """Create a new Message object. - - In order for translation to work gettext requires a message ID, this - msgid will be used as the base unicode text. It is also possible - for the msgid and the base unicode text to be different by passing - the msgtext parameter. - """ - # If the base msgtext is not given, we use the default translation - # of the msgid (which is in English) just in case the system locale is - # not English, so that the base text will be in that locale by default. - if not msgtext: - msgtext = Message._translate_msgid(msgid, domain) - # We want to initialize the parent unicode with the actual object that - # would have been plain unicode if 'Message' was not enabled. - msg = super(Message, cls).__new__(cls, msgtext) - msg.msgid = msgid - msg.domain = domain - msg.params = params - return msg - - def translate(self, desired_locale=None): - """Translate this message to the desired locale. - - :param desired_locale: The desired locale to translate the message to, - if no locale is provided the message will be - translated to the system's default locale. - - :returns: the translated message in unicode - """ - - translated_message = Message._translate_msgid(self.msgid, - self.domain, - desired_locale) - if self.params is None: - # No need for more translation - return translated_message - - # This Message object may have been formatted with one or more - # Message objects as substitution arguments, given either as a single - # argument, part of a tuple, or as one or more values in a dictionary. - # When translating this Message we need to translate those Messages too - translated_params = _translate_args(self.params, desired_locale) - - translated_message = translated_message % translated_params - - return translated_message - - @staticmethod - def _translate_msgid(msgid, domain, desired_locale=None): - if not desired_locale: - system_locale = locale.getdefaultlocale() - # If the system locale is not available to the runtime use English - if not system_locale[0]: - desired_locale = 'en_US' - else: - desired_locale = system_locale[0] - - locale_dir = os.environ.get(domain.upper() + '_LOCALEDIR') - lang = gettext.translation(domain, - localedir=locale_dir, - languages=[desired_locale], - fallback=True) - if six.PY3: - translator = lang.gettext - else: - translator = lang.ugettext - - translated_message = translator(msgid) - return translated_message - - def __mod__(self, other): - # When we mod a Message we want the actual operation to be performed - # by the parent class (i.e. unicode()), the only thing we do here is - # save the original msgid and the parameters in case of a translation - params = self._sanitize_mod_params(other) - unicode_mod = super(Message, self).__mod__(params) - modded = Message(self.msgid, - msgtext=unicode_mod, - params=params, - domain=self.domain) - return modded - - def _sanitize_mod_params(self, other): - """Sanitize the object being modded with this Message. - - - Add support for modding 'None' so translation supports it - - Trim the modded object, which can be a large dictionary, to only - those keys that would actually be used in a translation - - Snapshot the object being modded, in case the message is - translated, it will be used as it was when the Message was created - """ - if other is None: - params = (other,) - elif isinstance(other, dict): - # Merge the dictionaries - # Copy each item in case one does not support deep copy. - params = {} - if isinstance(self.params, dict): - for key, val in self.params.items(): - params[key] = self._copy_param(val) - for key, val in other.items(): - params[key] = self._copy_param(val) - else: - params = self._copy_param(other) - return params - - def _copy_param(self, param): - try: - return copy.deepcopy(param) - except Exception: - # Fallback to casting to unicode this will handle the - # python code-like objects that can't be deep-copied - return six.text_type(param) - - def __add__(self, other): - msg = _('Message objects do not support addition.') - raise TypeError(msg) - - def __radd__(self, other): - return self.__add__(other) - - if six.PY2: - def __str__(self): - # NOTE(luisg): Logging in python 2.6 tries to str() log records, - # and it expects specifically a UnicodeError in order to proceed. - msg = _('Message objects do not support str() because they may ' - 'contain non-ascii characters. ' - 'Please use unicode() or translate() instead.') - raise UnicodeError(msg) - - -def get_available_languages(domain): - """Lists the available languages for the given translation domain. - - :param domain: the domain to get languages for - """ - if domain in _AVAILABLE_LANGUAGES: - return copy.copy(_AVAILABLE_LANGUAGES[domain]) - - localedir = '%s_LOCALEDIR' % domain.upper() - find = lambda x: gettext.find(domain, - localedir=os.environ.get(localedir), - languages=[x]) - - # NOTE(mrodden): en_US should always be available (and first in case - # order matters) since our in-line message strings are en_US - language_list = ['en_US'] - # NOTE(luisg): Babel <1.0 used a function called list(), which was - # renamed to locale_identifiers() in >=1.0, the requirements master list - # requires >=0.9.6, uncapped, so defensively work with both. We can remove - # this check when the master list updates to >=1.0, and update all projects - list_identifiers = (getattr(localedata, 'list', None) or - getattr(localedata, 'locale_identifiers')) - locale_identifiers = list_identifiers() - - for i in locale_identifiers: - if find(i) is not None: - language_list.append(i) - - # NOTE(luisg): Babel>=1.0,<1.3 has a bug where some OpenStack supported - # locales (e.g. 'zh_CN', and 'zh_TW') aren't supported even though they - # are perfectly legitimate locales: - # https://github.com/mitsuhiko/babel/issues/37 - # In Babel 1.3 they fixed the bug and they support these locales, but - # they are still not explicitly "listed" by locale_identifiers(). - # That is why we add the locales here explicitly if necessary so that - # they are listed as supported. - aliases = {'zh': 'zh_CN', - 'zh_Hant_HK': 'zh_HK', - 'zh_Hant': 'zh_TW', - 'fil': 'tl_PH'} - for (locale, alias) in six.iteritems(aliases): - if locale in language_list and alias not in language_list: - language_list.append(alias) - - _AVAILABLE_LANGUAGES[domain] = language_list - return copy.copy(language_list) - - -def translate(obj, desired_locale=None): - """Gets the translated unicode representation of the given object. - - If the object is not translatable it is returned as-is. - If the locale is None the object is translated to the system locale. - - :param obj: the object to translate - :param desired_locale: the locale to translate the message to, if None the - default system locale will be used - :returns: the translated object in unicode, or the original object if - it could not be translated - """ - message = obj - if not isinstance(message, Message): - # If the object to translate is not already translatable, - # let's first get its unicode representation - message = six.text_type(obj) - if isinstance(message, Message): - # Even after unicoding() we still need to check if we are - # running with translatable unicode before translating - return message.translate(desired_locale) - return obj - - -def _translate_args(args, desired_locale=None): - """Translates all the translatable elements of the given arguments object. - - This method is used for translating the translatable values in method - arguments which include values of tuples or dictionaries. - If the object is not a tuple or a dictionary the object itself is - translated if it is translatable. - - If the locale is None the object is translated to the system locale. - - :param args: the args to translate - :param desired_locale: the locale to translate the args to, if None the - default system locale will be used - :returns: a new args object with the translated contents of the original - """ - if isinstance(args, tuple): - return tuple(translate(v, desired_locale) for v in args) - if isinstance(args, dict): - translated_dict = {} - for (k, v) in six.iteritems(args): - translated_v = translate(v, desired_locale) - translated_dict[k] = translated_v - return translated_dict - return translate(args, desired_locale) - - -class TranslationHandler(handlers.MemoryHandler): - """Handler that translates records before logging them. - - The TranslationHandler takes a locale and a target logging.Handler object - to forward LogRecord objects to after translating them. This handler - depends on Message objects being logged, instead of regular strings. - - The handler can be configured declaratively in the logging.conf as follows: - - [handlers] - keys = translatedlog, translator - - [handler_translatedlog] - class = handlers.WatchedFileHandler - args = ('/var/log/api-localized.log',) - formatter = context - - [handler_translator] - class = openstack.common.log.TranslationHandler - target = translatedlog - args = ('zh_CN',) - - If the specified locale is not available in the system, the handler will - log in the default locale. - """ - - def __init__(self, locale=None, target=None): - """Initialize a TranslationHandler - - :param locale: locale to use for translating messages - :param target: logging.Handler object to forward - LogRecord objects to after translation - """ - # NOTE(luisg): In order to allow this handler to be a wrapper for - # other handlers, such as a FileHandler, and still be able to - # configure it using logging.conf, this handler has to extend - # MemoryHandler because only the MemoryHandlers' logging.conf - # parsing is implemented such that it accepts a target handler. - handlers.MemoryHandler.__init__(self, capacity=0, target=target) - self.locale = locale - - def setFormatter(self, fmt): - self.target.setFormatter(fmt) - - def emit(self, record): - # We save the message from the original record to restore it - # after translation, so other handlers are not affected by this - original_msg = record.msg - original_args = record.args - - try: - self._translate_and_log_record(record) - finally: - record.msg = original_msg - record.args = original_args - - def _translate_and_log_record(self, record): - record.msg = translate(record.msg, self.locale) - - # In addition to translating the message, we also need to translate - # arguments that were passed to the log method that were not part - # of the main message e.g., log.info(_('Some message %s'), this_one)) - record.args = _translate_args(record.args, self.locale) - - self.target.emit(record) diff --git a/neutronclient/openstack/common/importutils.py b/neutronclient/openstack/common/importutils.py deleted file mode 100644 index 0ab88e19d..000000000 --- a/neutronclient/openstack/common/importutils.py +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2011 OpenStack Foundation. -# All Rights Reserved. -# -# 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. - -""" -Import related utilities and helper functions. -""" - -import sys -import traceback - - -def import_class(import_str): - """Returns a class from a string including module and class.""" - mod_str, _sep, class_str = import_str.rpartition('.') - __import__(mod_str) - try: - return getattr(sys.modules[mod_str], class_str) - except AttributeError: - raise ImportError('Class %s cannot be found (%s)' % - (class_str, - traceback.format_exception(*sys.exc_info()))) - - -def import_object(import_str, *args, **kwargs): - """Import a class and return an instance of it.""" - return import_class(import_str)(*args, **kwargs) - - -def import_object_ns(name_space, import_str, *args, **kwargs): - """Tries to import object from default namespace. - - Imports a class and return an instance of it, first by trying - to find the class in a default namespace, then failing back to - a full path if not found in the default namespace. - """ - import_value = "%s.%s" % (name_space, import_str) - try: - return import_class(import_value)(*args, **kwargs) - except ImportError: - return import_class(import_str)(*args, **kwargs) - - -def import_module(import_str): - """Import a module.""" - __import__(import_str) - return sys.modules[import_str] - - -def import_versioned_module(version, submodule=None): - module = 'neutronclient.v%s' % version - if submodule: - module = '.'.join((module, submodule)) - return import_module(module) - - -def try_import(import_str, default=None): - """Try to import a module and if it fails return default.""" - try: - return import_module(import_str) - except ImportError: - return default diff --git a/neutronclient/openstack/common/jsonutils.py b/neutronclient/openstack/common/jsonutils.py deleted file mode 100644 index d53b1e99d..000000000 --- a/neutronclient/openstack/common/jsonutils.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright 2010 United States Government as represented by the -# Administrator of the National Aeronautics and Space Administration. -# Copyright 2011 Justin Santa Barbara -# All Rights Reserved. -# -# 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. - -''' -JSON related utilities. - -This module provides a few things: - - 1) A handy function for getting an object down to something that can be - JSON serialized. See to_primitive(). - - 2) Wrappers around loads() and dumps(). The dumps() wrapper will - automatically use to_primitive() for you if needed. - - 3) This sets up anyjson to use the loads() and dumps() wrappers if anyjson - is available. -''' - - -import codecs -import datetime -import functools -import inspect -import itertools -import sys - -if sys.version_info < (2, 7): - # On Python <= 2.6, json module is not C boosted, so try to use - # simplejson module if available - try: - import simplejson as json - except ImportError: - import json -else: - import json - -import six -import six.moves.xmlrpc_client as xmlrpclib - -from neutronclient.openstack.common import gettextutils -from neutronclient.openstack.common import importutils -from neutronclient.openstack.common import strutils -from neutronclient.openstack.common import timeutils - -netaddr = importutils.try_import("netaddr") - -_nasty_type_tests = [inspect.ismodule, inspect.isclass, inspect.ismethod, - inspect.isfunction, inspect.isgeneratorfunction, - inspect.isgenerator, inspect.istraceback, inspect.isframe, - inspect.iscode, inspect.isbuiltin, inspect.isroutine, - inspect.isabstract] - -_simple_types = (six.string_types + six.integer_types - + (type(None), bool, float)) - - -def to_primitive(value, convert_instances=False, convert_datetime=True, - level=0, max_depth=3): - """Convert a complex object into primitives. - - Handy for JSON serialization. We can optionally handle instances, - but since this is a recursive function, we could have cyclical - data structures. - - To handle cyclical data structures we could track the actual objects - visited in a set, but not all objects are hashable. Instead we just - track the depth of the object inspections and don't go too deep. - - Therefore, convert_instances=True is lossy ... be aware. - - """ - # handle obvious types first - order of basic types determined by running - # full tests on nova project, resulting in the following counts: - # 572754 - # 460353 - # 379632 - # 274610 - # 199918 - # 114200 - # 51817 - # 26164 - # 6491 - # 283 - # 19 - if isinstance(value, _simple_types): - return value - - if isinstance(value, datetime.datetime): - if convert_datetime: - return timeutils.strtime(value) - else: - return value - - # value of itertools.count doesn't get caught by nasty_type_tests - # and results in infinite loop when list(value) is called. - if type(value) == itertools.count: - return six.text_type(value) - - # FIXME(vish): Workaround for LP bug 852095. Without this workaround, - # tests that raise an exception in a mocked method that - # has a @wrap_exception with a notifier will fail. If - # we up the dependency to 0.5.4 (when it is released) we - # can remove this workaround. - if getattr(value, '__module__', None) == 'mox': - return 'mock' - - if level > max_depth: - return '?' - - # The try block may not be necessary after the class check above, - # but just in case ... - try: - recursive = functools.partial(to_primitive, - convert_instances=convert_instances, - convert_datetime=convert_datetime, - level=level, - max_depth=max_depth) - if isinstance(value, dict): - return dict((k, recursive(v)) for k, v in six.iteritems(value)) - elif isinstance(value, (list, tuple)): - return [recursive(lv) for lv in value] - - # It's not clear why xmlrpclib created their own DateTime type, but - # for our purposes, make it a datetime type which is explicitly - # handled - if isinstance(value, xmlrpclib.DateTime): - value = datetime.datetime(*tuple(value.timetuple())[:6]) - - if convert_datetime and isinstance(value, datetime.datetime): - return timeutils.strtime(value) - elif isinstance(value, gettextutils.Message): - return value.data - elif hasattr(value, 'iteritems'): - return recursive(dict(value.iteritems()), level=level + 1) - elif hasattr(value, '__iter__'): - return recursive(list(value)) - elif convert_instances and hasattr(value, '__dict__'): - # Likely an instance of something. Watch for cycles. - # Ignore class member vars. - return recursive(value.__dict__, level=level + 1) - elif netaddr and isinstance(value, netaddr.IPAddress): - return six.text_type(value) - else: - if any(test(value) for test in _nasty_type_tests): - return six.text_type(value) - return value - except TypeError: - # Class objects are tricky since they may define something like - # __iter__ defined but it isn't callable as list(). - return six.text_type(value) - - -def dumps(value, default=to_primitive, **kwargs): - return json.dumps(value, default=default, **kwargs) - - -def loads(s, encoding='utf-8', **kwargs): - return json.loads(strutils.safe_decode(s, encoding), **kwargs) - - -def load(fp, encoding='utf-8', **kwargs): - return json.load(codecs.getreader(encoding)(fp), **kwargs) - - -try: - import anyjson -except ImportError: - pass -else: - anyjson._modules.append((__name__, 'dumps', TypeError, - 'loads', ValueError, 'load')) - anyjson.force_implementation(__name__) diff --git a/neutronclient/openstack/common/strutils.py b/neutronclient/openstack/common/strutils.py deleted file mode 100644 index 730373665..000000000 --- a/neutronclient/openstack/common/strutils.py +++ /dev/null @@ -1,239 +0,0 @@ -# Copyright 2011 OpenStack Foundation. -# All Rights Reserved. -# -# 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. - -""" -System-level utilities and helper functions. -""" - -import math -import re -import sys -import unicodedata - -import six - -from neutronclient.openstack.common.gettextutils import _ - - -UNIT_PREFIX_EXPONENT = { - 'k': 1, - 'K': 1, - 'Ki': 1, - 'M': 2, - 'Mi': 2, - 'G': 3, - 'Gi': 3, - 'T': 4, - 'Ti': 4, -} -UNIT_SYSTEM_INFO = { - 'IEC': (1024, re.compile(r'(^[-+]?\d*\.?\d+)([KMGT]i?)?(b|bit|B)$')), - 'SI': (1000, re.compile(r'(^[-+]?\d*\.?\d+)([kMGT])?(b|bit|B)$')), -} - -TRUE_STRINGS = ('1', 't', 'true', 'on', 'y', 'yes') -FALSE_STRINGS = ('0', 'f', 'false', 'off', 'n', 'no') - -SLUGIFY_STRIP_RE = re.compile(r"[^\w\s-]") -SLUGIFY_HYPHENATE_RE = re.compile(r"[-\s]+") - - -def int_from_bool_as_string(subject): - """Interpret a string as a boolean and return either 1 or 0. - - Any string value in: - - ('True', 'true', 'On', 'on', '1') - - is interpreted as a boolean True. - - Useful for JSON-decoded stuff and config file parsing - """ - return bool_from_string(subject) and 1 or 0 - - -def bool_from_string(subject, strict=False, default=False): - """Interpret a string as a boolean. - - A case-insensitive match is performed such that strings matching 't', - 'true', 'on', 'y', 'yes', or '1' are considered True and, when - `strict=False`, anything else returns the value specified by 'default'. - - Useful for JSON-decoded stuff and config file parsing. - - If `strict=True`, unrecognized values, including None, will raise a - ValueError which is useful when parsing values passed in from an API call. - Strings yielding False are 'f', 'false', 'off', 'n', 'no', or '0'. - """ - if not isinstance(subject, six.string_types): - subject = six.text_type(subject) - - lowered = subject.strip().lower() - - if lowered in TRUE_STRINGS: - return True - elif lowered in FALSE_STRINGS: - return False - elif strict: - acceptable = ', '.join( - "'%s'" % s for s in sorted(TRUE_STRINGS + FALSE_STRINGS)) - msg = _("Unrecognized value '%(val)s', acceptable values are:" - " %(acceptable)s") % {'val': subject, - 'acceptable': acceptable} - raise ValueError(msg) - else: - return default - - -def safe_decode(text, incoming=None, errors='strict'): - """Decodes incoming text/bytes string using `incoming` if they're not - already unicode. - - :param incoming: Text's current encoding - :param errors: Errors handling policy. See here for valid - values http://docs.python.org/2/library/codecs.html - :returns: text or a unicode `incoming` encoded - representation of it. - :raises TypeError: If text is not an instance of str - """ - if not isinstance(text, (six.string_types, six.binary_type)): - raise TypeError("%s can't be decoded" % type(text)) - - if isinstance(text, six.text_type): - return text - - if not incoming: - incoming = (sys.stdin.encoding or - sys.getdefaultencoding()) - - try: - return text.decode(incoming, errors) - except UnicodeDecodeError: - # Note(flaper87) If we get here, it means that - # sys.stdin.encoding / sys.getdefaultencoding - # didn't return a suitable encoding to decode - # text. This happens mostly when global LANG - # var is not set correctly and there's no - # default encoding. In this case, most likely - # python will use ASCII or ANSI encoders as - # default encodings but they won't be capable - # of decoding non-ASCII characters. - # - # Also, UTF-8 is being used since it's an ASCII - # extension. - return text.decode('utf-8', errors) - - -def safe_encode(text, incoming=None, - encoding='utf-8', errors='strict'): - """Encodes incoming text/bytes string using `encoding`. - - If incoming is not specified, text is expected to be encoded with - current python's default encoding. (`sys.getdefaultencoding`) - - :param incoming: Text's current encoding - :param encoding: Expected encoding for text (Default UTF-8) - :param errors: Errors handling policy. See here for valid - values http://docs.python.org/2/library/codecs.html - :returns: text or a bytestring `encoding` encoded - representation of it. - :raises TypeError: If text is not an instance of str - """ - if not isinstance(text, (six.string_types, six.binary_type)): - raise TypeError("%s can't be encoded" % type(text)) - - if not incoming: - incoming = (sys.stdin.encoding or - sys.getdefaultencoding()) - - if isinstance(text, six.text_type): - return text.encode(encoding, errors) - elif text and encoding != incoming: - # Decode text before encoding it with `encoding` - text = safe_decode(text, incoming, errors) - return text.encode(encoding, errors) - else: - return text - - -def string_to_bytes(text, unit_system='IEC', return_int=False): - """Converts a string into an float representation of bytes. - - The units supported for IEC :: - - Kb(it), Kib(it), Mb(it), Mib(it), Gb(it), Gib(it), Tb(it), Tib(it) - KB, KiB, MB, MiB, GB, GiB, TB, TiB - - The units supported for SI :: - - kb(it), Mb(it), Gb(it), Tb(it) - kB, MB, GB, TB - - Note that the SI unit system does not support capital letter 'K' - - :param text: String input for bytes size conversion. - :param unit_system: Unit system for byte size conversion. - :param return_int: If True, returns integer representation of text - in bytes. (default: decimal) - :returns: Numerical representation of text in bytes. - :raises ValueError: If text has an invalid value. - - """ - try: - base, reg_ex = UNIT_SYSTEM_INFO[unit_system] - except KeyError: - msg = _('Invalid unit system: "%s"') % unit_system - raise ValueError(msg) - match = reg_ex.match(text) - if match: - magnitude = float(match.group(1)) - unit_prefix = match.group(2) - if match.group(3) in ['b', 'bit']: - magnitude /= 8 - else: - msg = _('Invalid string format: %s') % text - raise ValueError(msg) - if not unit_prefix: - res = magnitude - else: - res = magnitude * pow(base, UNIT_PREFIX_EXPONENT[unit_prefix]) - if return_int: - return int(math.ceil(res)) - return res - - -def to_slug(value, incoming=None, errors="strict"): - """Normalize string. - - Convert to lowercase, remove non-word characters, and convert spaces - to hyphens. - - Inspired by Django's `slugify` filter. - - :param value: Text to slugify - :param incoming: Text's current encoding - :param errors: Errors handling policy. See here for valid - values http://docs.python.org/2/library/codecs.html - :returns: slugified unicode representation of `value` - :raises TypeError: If text is not an instance of str - """ - value = safe_decode(value, incoming, errors) - # NOTE(aababilov): no need to use safe_(encode|decode) here: - # encodings are always "ascii", error handling is always "ignore" - # and types are always known (first: unicode; second: str) - value = unicodedata.normalize("NFKD", value).encode( - "ascii", "ignore").decode("ascii") - value = SLUGIFY_STRIP_RE.sub("", value).strip().lower() - return SLUGIFY_HYPHENATE_RE.sub("-", value) diff --git a/neutronclient/openstack/common/timeutils.py b/neutronclient/openstack/common/timeutils.py deleted file mode 100644 index 386534ba3..000000000 --- a/neutronclient/openstack/common/timeutils.py +++ /dev/null @@ -1,210 +0,0 @@ -# Copyright 2011 OpenStack Foundation. -# All Rights Reserved. -# -# 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. - -""" -Time related utilities and helper functions. -""" - -import calendar -import datetime -import time - -import iso8601 -import six - - -# ISO 8601 extended time format with microseconds -_ISO8601_TIME_FORMAT_SUBSECOND = '%Y-%m-%dT%H:%M:%S.%f' -_ISO8601_TIME_FORMAT = '%Y-%m-%dT%H:%M:%S' -PERFECT_TIME_FORMAT = _ISO8601_TIME_FORMAT_SUBSECOND - - -def isotime(at=None, subsecond=False): - """Stringify time in ISO 8601 format.""" - if not at: - at = utcnow() - st = at.strftime(_ISO8601_TIME_FORMAT - if not subsecond - else _ISO8601_TIME_FORMAT_SUBSECOND) - tz = at.tzinfo.tzname(None) if at.tzinfo else 'UTC' - st += ('Z' if tz == 'UTC' else tz) - return st - - -def parse_isotime(timestr): - """Parse time from ISO 8601 format.""" - try: - return iso8601.parse_date(timestr) - except iso8601.ParseError as e: - raise ValueError(six.text_type(e)) - except TypeError as e: - raise ValueError(six.text_type(e)) - - -def strtime(at=None, fmt=PERFECT_TIME_FORMAT): - """Returns formatted utcnow.""" - if not at: - at = utcnow() - return at.strftime(fmt) - - -def parse_strtime(timestr, fmt=PERFECT_TIME_FORMAT): - """Turn a formatted time back into a datetime.""" - return datetime.datetime.strptime(timestr, fmt) - - -def normalize_time(timestamp): - """Normalize time in arbitrary timezone to UTC naive object.""" - offset = timestamp.utcoffset() - if offset is None: - return timestamp - return timestamp.replace(tzinfo=None) - offset - - -def is_older_than(before, seconds): - """Return True if before is older than seconds.""" - if isinstance(before, six.string_types): - before = parse_strtime(before).replace(tzinfo=None) - else: - before = before.replace(tzinfo=None) - - return utcnow() - before > datetime.timedelta(seconds=seconds) - - -def is_newer_than(after, seconds): - """Return True if after is newer than seconds.""" - if isinstance(after, six.string_types): - after = parse_strtime(after).replace(tzinfo=None) - else: - after = after.replace(tzinfo=None) - - return after - utcnow() > datetime.timedelta(seconds=seconds) - - -def utcnow_ts(): - """Timestamp version of our utcnow function.""" - if utcnow.override_time is None: - # NOTE(kgriffs): This is several times faster - # than going through calendar.timegm(...) - return int(time.time()) - - return calendar.timegm(utcnow().timetuple()) - - -def utcnow(): - """Overridable version of utils.utcnow.""" - if utcnow.override_time: - try: - return utcnow.override_time.pop(0) - except AttributeError: - return utcnow.override_time - return datetime.datetime.utcnow() - - -def iso8601_from_timestamp(timestamp): - """Returns an iso8601 formatted date from timestamp.""" - return isotime(datetime.datetime.utcfromtimestamp(timestamp)) - - -utcnow.override_time = None - - -def set_time_override(override_time=None): - """Overrides utils.utcnow. - - Make it return a constant time or a list thereof, one at a time. - - :param override_time: datetime instance or list thereof. If not - given, defaults to the current UTC time. - """ - utcnow.override_time = override_time or datetime.datetime.utcnow() - - -def advance_time_delta(timedelta): - """Advance overridden time using a datetime.timedelta.""" - assert(not utcnow.override_time is None) - try: - for dt in utcnow.override_time: - dt += timedelta - except TypeError: - utcnow.override_time += timedelta - - -def advance_time_seconds(seconds): - """Advance overridden time by seconds.""" - advance_time_delta(datetime.timedelta(0, seconds)) - - -def clear_time_override(): - """Remove the overridden time.""" - utcnow.override_time = None - - -def marshall_now(now=None): - """Make an rpc-safe datetime with microseconds. - - Note: tzinfo is stripped, but not required for relative times. - """ - if not now: - now = utcnow() - return dict(day=now.day, month=now.month, year=now.year, hour=now.hour, - minute=now.minute, second=now.second, - microsecond=now.microsecond) - - -def unmarshall_time(tyme): - """Unmarshall a datetime dict.""" - return datetime.datetime(day=tyme['day'], - month=tyme['month'], - year=tyme['year'], - hour=tyme['hour'], - minute=tyme['minute'], - second=tyme['second'], - microsecond=tyme['microsecond']) - - -def delta_seconds(before, after): - """Return the difference between two timing objects. - - Compute the difference in seconds between two date, time, or - datetime objects (as a float, to microsecond resolution). - """ - delta = after - before - return total_seconds(delta) - - -def total_seconds(delta): - """Return the total seconds of datetime.timedelta object. - - Compute total seconds of datetime.timedelta, datetime.timedelta - doesn't have method total_seconds in Python2.6, calculate it manually. - """ - try: - return delta.total_seconds() - except AttributeError: - return ((delta.days * 24 * 3600) + delta.seconds + - float(delta.microseconds) / (10 ** 6)) - - -def is_soon(dt, window): - """Determines if time is going to happen in the next window seconds. - - :param dt: the time - :param window: minimum seconds to remain to consider the time not soon - - :return: True if expiration is within the given duration - """ - soon = (utcnow() + datetime.timedelta(seconds=window)) - return normalize_time(dt) <= soon diff --git a/neutronclient/shell.py b/neutronclient/shell.py index 7ce585b31..0329d5272 100644 --- a/neutronclient/shell.py +++ b/neutronclient/shell.py @@ -31,6 +31,7 @@ from keystoneclient.auth.identity import v3 as v3_auth from keystoneclient import discover from keystoneclient.openstack.common.apiclient import exceptions as ks_exc from keystoneclient import session +from oslo.utils import encodeutils import six.moves.urllib.parse as urlparse from cliff import app @@ -39,6 +40,7 @@ from cliff import commandmanager from neutronclient.common import clientmanager from neutronclient.common import exceptions as exc from neutronclient.common import utils +from neutronclient.i18n import _ from neutronclient.neutron.v2_0 import agent from neutronclient.neutron.v2_0 import agentscheduler from neutronclient.neutron.v2_0 import credential @@ -69,8 +71,6 @@ from neutronclient.neutron.v2_0.vpn import ikepolicy from neutronclient.neutron.v2_0.vpn import ipsec_site_connection from neutronclient.neutron.v2_0.vpn import ipsecpolicy from neutronclient.neutron.v2_0.vpn import vpnservice -from neutronclient.openstack.common.gettextutils import _ -from neutronclient.openstack.common import strutils from neutronclient.version import __version__ @@ -938,7 +938,7 @@ class NeutronShell(app.App): def main(argv=sys.argv[1:]): try: return NeutronShell(NEUTRON_API_VERSION).run( - list(map(strutils.safe_decode, argv))) + list(map(encodeutils.safe_decode, argv))) except KeyboardInterrupt: print("... terminating neutron client", file=sys.stderr) return 130 diff --git a/neutronclient/tests/unit/test_auth.py b/neutronclient/tests/unit/test_auth.py index 34e5e93a3..a1113e13a 100644 --- a/neutronclient/tests/unit/test_auth.py +++ b/neutronclient/tests/unit/test_auth.py @@ -19,6 +19,7 @@ import uuid import fixtures from mox3 import mox +from oslo.serialization import jsonutils import requests import requests_mock import six @@ -34,7 +35,6 @@ from keystoneclient import session from neutronclient import client from neutronclient.common import exceptions from neutronclient.common import utils -from neutronclient.openstack.common import jsonutils USERNAME = 'testuser' diff --git a/neutronclient/tests/unit/test_cli20_agents.py b/neutronclient/tests/unit/test_cli20_agents.py index 2b0226602..de16d610e 100644 --- a/neutronclient/tests/unit/test_cli20_agents.py +++ b/neutronclient/tests/unit/test_cli20_agents.py @@ -16,8 +16,9 @@ import sys +from oslo.serialization import jsonutils + from neutronclient.neutron.v2_0 import agent -from neutronclient.openstack.common import jsonutils from neutronclient.tests.unit import test_cli20 diff --git a/neutronclient/tests/unit/test_cli20_network.py b/neutronclient/tests/unit/test_cli20_network.py index c5891a293..a7f5aa817 100644 --- a/neutronclient/tests/unit/test_cli20_network.py +++ b/neutronclient/tests/unit/test_cli20_network.py @@ -17,10 +17,10 @@ import itertools import sys from mox3 import mox +from oslo.serialization import jsonutils from neutronclient.common import exceptions from neutronclient.neutron.v2_0 import network -from neutronclient.openstack.common import jsonutils from neutronclient import shell from neutronclient.tests.unit import test_cli20 diff --git a/openstack-common.conf b/openstack-common.conf deleted file mode 100644 index 902a82e40..000000000 --- a/openstack-common.conf +++ /dev/null @@ -1,7 +0,0 @@ -[DEFAULT] - -# The list of modules to copy from openstack-common -modules=gettextutils,jsonutils,strutils,timeutils - -# The base module to hold the copy of openstack.common -base=neutronclient diff --git a/requirements.txt b/requirements.txt index aeeb180ca..ebd9f76a0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,9 @@ argparse cliff>=1.7.0 # Apache-2.0 iso8601>=0.1.9 netaddr>=0.7.12 +oslo.i18n>=1.0.0 # Apache-2.0 +oslo.serialization>=1.0.0 # Apache-2.0 +oslo.utils>=1.0.0 # Apache-2.0 requests>=2.2.0,!=2.4.0 python-keystoneclient>=0.11.1 simplejson>=2.2.0