You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2018/12/14 18:46:24 UTC
[GitHub] dangogh closed pull request #3115: Fixed a Python2 compatibility
issue in the Traffic Control client
dangogh closed pull request #3115: Fixed a Python2 compatibility issue in the Traffic Control client
URL: https://github.com/apache/trafficcontrol/pull/3115
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/traffic_control/clients/python/trafficops/setup.py b/traffic_control/clients/python/trafficops/setup.py
old mode 100644
new mode 100755
index f69296f06..e37a3bb21
--- a/traffic_control/clients/python/trafficops/setup.py
+++ b/traffic_control/clients/python/trafficops/setup.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
@@ -27,8 +28,8 @@
setup(
name='TrafficOps',
version=version,
- author='Robert Scrimo Jr.',
- author_email='robert_scrimo@comcast.com',
+ author='Apache Software foundation',
+ author_email='dev@trafficcontrol.apache.org',
packages=['common', 'trafficops'],
url='http://trafficcontrol.apache.org/',
license='http://www.apache.org/licenses/LICENSE-2.0',
diff --git a/traffic_control/clients/python/trafficops/trafficops/__init__.py b/traffic_control/clients/python/trafficops/trafficops/__init__.py
index 99057b844..82a4c01f0 100644
--- a/traffic_control/clients/python/trafficops/trafficops/__init__.py
+++ b/traffic_control/clients/python/trafficops/trafficops/__init__.py
@@ -24,4 +24,4 @@
from trafficops.tosession import *
# The Module Version
-__version__ = '0.1.0'
+__version__ = '0.1.1'
diff --git a/traffic_control/clients/python/trafficops/trafficops/tosession.py b/traffic_control/clients/python/trafficops/trafficops/tosession.py
index 7ba50e7fe..e52cd56ef 100644
--- a/traffic_control/clients/python/trafficops/trafficops/tosession.py
+++ b/traffic_control/clients/python/trafficops/trafficops/tosession.py
@@ -28,7 +28,7 @@
# Third-party Modules
import munch
-
+from future.utils import raise_from
import requests.exceptions as rex
# Local Modules
@@ -208,13 +208,13 @@ def login(self, username, password):
msg = msg.format(e)
logging.error(msg)
logging.warning("disabling certificate verification is not recommended.")
- raise restapi.LoginError(msg) from e
+ raise_from(restapi.LoginError(msg), e)
except restapi.OperationError as e:
logging.debug("%s", e, exc_info=True, stack_info=True)
msg = u'Logging in to Traffic Ops has failed. Reason: {0}'.format(e)
self.close()
logging.error(msg)
- raise restapi.OperationError(msg) from e
+ raise_from(restapi.OperationError(msg), e)
logging.info("Authenticated.")
@@ -286,7 +286,7 @@ def get_all_deliveryservice_servers(self, *args, **kwargs):
return result_set, response # Note: Return last response object received
-#
+#
# PUT ALL API DEFINITIONS BELOW AND UNDER ITS RESPECTIVE PAGE (whether it is 1.2 or 1.3, etc, if its a CDN put it under CDN header and corresponding calls)
#
@@ -558,7 +558,7 @@ def create_cache_group_fallbacks(self, data=None):
Creates fallback configuration for the cache group. New fallbacks can be added only via POST.
https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/cachegroup_fallbacks.html#api-1-2-cachegroup-fallbacks
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
- :type data: Dict[Text, Any]
+ :type data: Dict[Text, Any]
:rtype: Tuple[Dict[Text, Any], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -566,7 +566,7 @@ def create_cache_group_fallbacks(self, data=None):
@restapi.api_request(u'put', u'cachegroup_fallbacks', (u'1.2', u'1.3'))
def update_cache_group_fallbacks(self, data=None):
"""
- Updates an existing fallback configuration for the cache group.
+ Updates an existing fallback configuration for the cache group.
https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/cachegroup_fallbacks.html#api-1-2-cachegroup-fallbacks
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
@@ -608,7 +608,7 @@ def get_cache_stats(self, query_params=None):
# CDN
# https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/cdn.html#cdn
#
-
+
@restapi.api_request(u'get', u'cdns', (u'1.1', u'1.2', u'1.3',))
def get_cdns(self):
"""
@@ -1048,7 +1048,7 @@ def delete_deliveryservice_by_id(self, delivery_service_id=None):
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
- #
+ #
# Delivery Service Health
# https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/deliveryservice.html#health
#
@@ -1138,7 +1138,7 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
def delete_deliveryservice_servers_by_id(self, delivery_service_id=None, server_id=None):
"""
Removes a server (cache) from a delivery service.
- :param delivery_service_id: The delivery service id
+ :param delivery_service_id: The delivery service id
:type delivery_service_id: int
:param server_id: The server id to remove from delivery service
:type server_id: int
@@ -1149,7 +1149,7 @@ def delete_deliveryservice_servers_by_id(self, delivery_service_id=None, server_
#
# Delivery Service User
# https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/deliveryservice.html#delivery-service-user
- #
+ #
@restapi.api_request(u'post', u'deliveryservice_user', (u'1.2', u'1.3'))
def create_delivery_service_user_link(self, data=None):
@@ -1402,7 +1402,7 @@ def get_federations(self):
@restapi.api_request(u'post', u'federations', (u'1.2', u'1.3'))
def create_federation(self, data=None):
"""
- Allows a user to add federations for their delivery service(s).
+ Allows a user to add federations for their delivery service(s).
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
@@ -1415,7 +1415,7 @@ def get_federations_for_cdn(self, cdn_name=None):
"""
Retrieves a list of federations for a cdn.
:param cdn_name: The CDN name to find federation
- :type cdn_name: String
+ :type cdn_name: String
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1426,7 +1426,7 @@ def get_federation_for_cdn_by_id(self, cdn_name=None, federation_id=None):
"""
Retrieves a federation for a cdn.
:param cdn_name: The CDN name to find federation
- :type cdn_name: String
+ :type cdn_name: String
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1437,7 +1437,7 @@ def create_federation_in_cdn(self, cdn_name=None, data=None):
"""
Create a federation.
:param cdn_name: The CDN name to find federation
- :type cdn_name: String
+ :type cdn_name: String
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1447,9 +1447,9 @@ def update_federation_in_cdn(self, cdn_name=None, federation_id=None, query_para
"""
Update a federation.
:param cdn_name: The CDN name to find federation
- :type cdn_name: String
+ :type cdn_name: String
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1459,9 +1459,9 @@ def delete_federation_in_cdn(self, cdn_name=None, federation_id=None):
"""
Delete a federation.
:param cdn_name: The CDN name to find federation
- :type cdn_name: String
+ :type cdn_name: String
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1476,9 +1476,9 @@ def get_federation_delivery_services(self, federation_id=None):
"""
Retrieves delivery services assigned to a federation
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1487,9 +1487,9 @@ def get_federation_delivery_services(self, federation_id=None):
@restapi.api_request(u'post', u'federations/{federation_id:d}/deliveryservices', (u'1.2', u'1.3'))
def assign_delivery_services_to_federations(self, federation_id=None, data=None):
"""
- Create one or more federation / delivery service assignments.
+ Create one or more federation / delivery service assignments.
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
@@ -1499,11 +1499,11 @@ def assign_delivery_services_to_federations(self, federation_id=None, data=None)
@restapi.api_request(u'delete', u'federation_resolvers/{federation_id:d}/deliveryservices/{delivery_service_id:d}', (u'1.2', u'1.3'))
def delete_federation_resolver(self, federation_resolver_id=None, delivery_service_id=None):
"""
- Removes a delivery service from a federation.
+ Removes a delivery service from a federation.
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:param federation_id: The delivery service id
- :type federation_id: int
+ :type federation_id: int
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1518,7 +1518,7 @@ def get_federation_resolvers_by_id(self, federation_id=None):
"""
Retrieves federation resolvers assigned to a federation
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1527,9 +1527,9 @@ def get_federation_resolvers_by_id(self, federation_id=None):
@restapi.api_request(u'post', u'federations/{federation_id:d}/federation_resolvers', (u'1.2', u'1.3'))
def assign_federation_resolver_to_federations(self, federation_id=None, data=None):
"""
- Create one or more federation / federation resolver assignments.
+ Create one or more federation / federation resolver assignments.
:param federation_id: The federation id
- :type federation_id: int
+ :type federation_id: int
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
@@ -1544,7 +1544,7 @@ def assign_federation_resolver_to_federations(self, federation_id=None, data=Non
@restapi.api_request(u'get', u'federation_resolvers', (u'1.2', u'1.3'))
def get_federation_resolvers(self, query_params=None):
"""
- Get federation resolvers.
+ Get federation resolvers.
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1553,7 +1553,7 @@ def get_federation_resolvers(self, query_params=None):
@restapi.api_request(u'post', u'federation_resolvers', (u'1.2', u'1.3'))
def create_federation_resolver(self, data=None):
"""
- Create a federation resolver.
+ Create a federation resolver.
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
@@ -1563,7 +1563,7 @@ def create_federation_resolver(self, data=None):
@restapi.api_request(u'delete', u'federation_resolvers/{federation_resolver_id:d}', (u'1.2', u'1.3'))
def delete_federation_resolver(self, federation_resolver_id=None):
"""
- Delete a federation resolver.
+ Delete a federation resolver.
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
:type data: Dict[Text, Any]
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
@@ -1579,7 +1579,7 @@ def delete_federation_resolver(self, federation_resolver_id=None):
@restapi.api_request(u'get', u'federations/{federation_id:d}/users', (u'1.2', u'1.3'))
def get_federation_users(self, federation_id=None):
"""
- Retrieves users assigned to a federation.
+ Retrieves users assigned to a federation.
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1587,7 +1587,7 @@ def get_federation_users(self, federation_id=None):
@restapi.api_request(u'post', u'federations/{federation_id:d}/users', (u'1.2', u'1.3'))
def create_federation_user(self, federation_id=None, data=None):
"""
- Create one or more federation / user assignments.
+ Create one or more federation / user assignments.
:param federation_id: Federation ID
:type federation_id: int
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
@@ -1599,7 +1599,7 @@ def create_federation_user(self, federation_id=None, data=None):
@restapi.api_request(u'delete', u'federations/{federation_id:d}/users/{user_id:d}', (u'1.2', u'1.3'))
def delete_federation_user(self, federation_id=None, user_id=None):
"""
- Delete one or more federation / user assignments.
+ Delete one or more federation / user assignments.
:param federation_id: Federation ID
:type federation_id: int
:param user_id: Federation User ID
@@ -1616,7 +1616,7 @@ def delete_federation_user(self, federation_id=None, user_id=None):
@restapi.api_request(u'get', u'hwinfo.json', (u'1.2', u'1.3'))
def get_hwinfo(self):
"""
- Get hwinfo for servers.
+ Get hwinfo for servers.
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
"""
@@ -1630,7 +1630,7 @@ def get_hwinfo(self):
@restapi.api_request(u'get', u'osversions', (u'1.2', u'1.3'))
def get_osversions(self):
"""
- Get all OS versions for ISO generation and the directory where the kickstarter files are found.
+ Get all OS versions for ISO generation and the directory where the kickstarter files are found.
The values are retrieved from osversions.cfg found in either /var/www/files or in the location defined by the kickstart.files.location parameter (if defined).
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
@@ -2279,7 +2279,7 @@ def get_statuses_by_id(self, status_id=None):
#
# Steering Targets
- #
+ #
#
#
@@ -2348,7 +2348,7 @@ def create_tenant(self, data=None):
# TO Extensions
# https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/to_extension.html#to-extensions
#
-
+
@restapi.api_request(u'get', u'to_extensions.json', (u'1.1', u'1.2', u'1.3',))
def get_to_extensions(self):
"""
@@ -2484,8 +2484,8 @@ def get_authenticated_user(self):
@restapi.api_request(u'get', u'user/current/jobs.json', (u'1.1', u'1.2', u'1.3',))
def get_authenticated_user_jobs(self):
"""
- Retrieves the user’s list of jobs.
- https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/user.html#api-1-2-users
+ Retrieves the user's list of jobs.
+ https://traffic-control-cdn.readthedocs.io/en/latest/api/user_current_jobs.html
:rtype: Tuple[Union[Dict[Text, Any], List[Dict[Text, Any]]], requests.Response]
:raises: Union[trafficops.restapi.LoginError, trafficops.restapi.OperationError]
@@ -2494,9 +2494,9 @@ def get_authenticated_user_jobs(self):
@restapi.api_request(u'post', u'user/current/jobs', (u'1.1', u'1.2', u'1.3',))
def create_invalidation_job(self, data=None):
"""
- Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed.
+ Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed.
Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time.
- To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the regex_revalidate ATS plugin (https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html).
+ To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the regex_revalidate ATS plugin (https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html).
This forces a revalidation of the content, rather than a new get..
https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/user.html#api-1-2-users
:param data: The update action. QueueUpdateRequest() can be used for this argument also.
@@ -2513,9 +2513,9 @@ def create_invalidation_job(self, data=None):
@restapi.api_request(u'get', u'cdns/{cdn_name}/snapshot', (u'1.2', u'1.3',))
def get_current_snapshot_crconfig(self, cdn_name=None):
"""
- Retrieves the CURRENT snapshot for a CDN which doesn’t necessarily represent the current state of the CDN.
+ Retrieves the CURRENT snapshot for a CDN which doesn't necessarily represent the current state of the CDN.
The contents of this snapshot are currently used by Traffic Monitor and Traffic Router.
- https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/topology.html#snapshot-crconfig
+ https://traffic-control-cdn.readthedocs.io/en/latest/api/cdns_name_snapshot.html
:param cdn_name: The CDN name
:type cdn_name: Text
:rtype: Tuple[Dict[Text, Any], requests.Response]
@@ -2525,8 +2525,8 @@ def get_current_snapshot_crconfig(self, cdn_name=None):
@restapi.api_request(u'get', u'cdns/{cdn_name}/snapshot/new', (u'1.2', u'1.3',))
def get_pending_snapshot_crconfig(self, cdn_name=None):
"""
- Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN.
- The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router.
+ Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN.
+ The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router.
Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router.
https://traffic-control-cdn.readthedocs.io/en/latest/api/v12/topology.html#snapshot-crconfig
:param cdn_name: The CDN name
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services