Release 1.18.1: Bug fix for Pure1 clients

Tiberiu Vilcu · Tiberiu Vilcu · commit 2d9fdef0b733 · 2021-09-27T17:06:05.000-07:00
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -6,6 +6,7 @@ A log of changes by version and date.
 ======= ========== =====
 Version Date       Notes
 ======= ========== =====
+1.18.1  09/27/2021 Bug fix for Pure1 clients
 1.18.0  09/15/2021 Added FlashArray 2.9 client
 1.17.0  08/13/2021 Added FlashBlade 2.1 client
 1.16.0  08/02/2021 Added FlashArray 2.8 client
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,7 +29,7 @@
 # The short X.Y version
 version = u'1.18'
 # The full version, including alpha/beta/rc tags
-release = u'1.18.0'
+release = u'1.18.1'
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/docs/pure1_reference.rst b/docs/pure1_reference.rst
@@ -153,6 +153,12 @@ LicenseResourceReference
 .. autoclass:: pypureclient.pure1.models.LicenseResourceReference
     :members:
 
+MarketplacePartner
+~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pypureclient.pure1.models.MarketplacePartner
+    :members:
+
 Metric
 ~~~~~~
 
diff --git a/docs/source/pypureclient.pure1.Pure1_1_0.models.rst b/docs/source/pypureclient.pure1.Pure1_1_0.models.rst
@@ -460,6 +460,14 @@ pypureclient.pure1.Pure1\_1\_0.models.license\_resource\_reference module
     :undoc-members:
     :show-inheritance:
 
+pypureclient.pure1.Pure1\_1\_0.models.marketplace\_partner module
+-----------------------------------------------------------------
+
+.. automodule:: pypureclient.pure1.Pure1_1_0.models.marketplace_partner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 pypureclient.pure1.Pure1\_1\_0.models.metric module
 ---------------------------------------------------
 
@@ -804,14 +812,6 @@ pypureclient.pure1.Pure1\_1\_0.models.subscription\_license\_get\_response modul
     :undoc-members:
     :show-inheritance:
 
-pypureclient.pure1.Pure1\_1\_0.models.subscription\_license\_marketplace\_partner module
-----------------------------------------------------------------------------------------
-
-.. automodule:: pypureclient.pure1.Pure1_1_0.models.subscription_license_marketplace_partner
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 pypureclient.pure1.Pure1\_1\_0.models.subscription\_license\_response module
 ----------------------------------------------------------------------------
 
diff --git a/docs/source/pypureclient.pure1.Pure1_1_1.models.rst b/docs/source/pypureclient.pure1.Pure1_1_1.models.rst
@@ -452,6 +452,22 @@ pypureclient.pure1.Pure1\_1\_1.models.inline\_response401 module
     :undoc-members:
     :show-inheritance:
 
+pypureclient.pure1.Pure1\_1\_1.models.license\_resource\_reference module
+-------------------------------------------------------------------------
+
+.. automodule:: pypureclient.pure1.Pure1_1_1.models.license_resource_reference
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pypureclient.pure1.Pure1\_1\_1.models.marketplace\_partner module
+-----------------------------------------------------------------
+
+.. automodule:: pypureclient.pure1.Pure1_1_1.models.marketplace_partner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 pypureclient.pure1.Pure1\_1\_1.models.metric module
 ---------------------------------------------------
 
diff --git a/pypureclient/flasharray/FA_2_0/client.py b/pypureclient/flasharray/FA_2_0/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.0/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.0/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_1/client.py b/pypureclient/flasharray/FA_2_1/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.1/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.1/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_2/client.py b/pypureclient/flasharray/FA_2_2/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.2/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.2/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_3/client.py b/pypureclient/flasharray/FA_2_3/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.3/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.3/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_4/client.py b/pypureclient/flasharray/FA_2_4/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.4/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.4/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_5/client.py b/pypureclient/flasharray/FA_2_5/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.5/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.5/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_6/client.py b/pypureclient/flasharray/FA_2_6/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.6/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.6/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_7/client.py b/pypureclient/flasharray/FA_2_7/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.7/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.7/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_8/client.py b/pypureclient/flasharray/FA_2_8/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.8/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.8/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/flasharray/FA_2_9/client.py b/pypureclient/flasharray/FA_2_9/client.py
@@ -20,7 +20,7 @@ class Client(object):
     DEFAULT_TIMEOUT = 15.0
     DEFAULT_RETRIES = 5
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.18.0/FA/2.9/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/FA/2.9/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, target, id_token=None, private_key_file=None, private_key_password=None,
diff --git a/pypureclient/pure1/Pure1_1_0/__init__.py b/pypureclient/pure1/Pure1_1_0/__init__.py
@@ -29,6 +29,7 @@
 from .models.hardware_connector import HardwareConnector
 from .models.http import Http
 from .models.license_resource_reference import LicenseResourceReference
+from .models.marketplace_partner import MarketplacePartner
 from .models.metric import Metric
 from .models.metric_availability import MetricAvailability
 from .models.metric_history import MetricHistory
@@ -50,7 +51,6 @@
 from .models.smb import Smb
 from .models.subscription import Subscription
 from .models.subscription_license import SubscriptionLicense
-from .models.subscription_license_marketplace_partner import SubscriptionLicenseMarketplacePartner
 from .models.support_contract import SupportContract
 from .models.tag import Tag
 from .models.tag_put import TagPut
@@ -88,6 +88,7 @@ def add_properties(model):
     HardwareConnector,
     Http,
     LicenseResourceReference,
+    MarketplacePartner,
     Metric,
     MetricAvailability,
     MetricHistory,
@@ -109,7 +110,6 @@ def add_properties(model):
     Smb,
     Subscription,
     SubscriptionLicense,
-    SubscriptionLicenseMarketplacePartner,
     SupportContract,
     Tag,
     TagPut,
diff --git a/pypureclient/pure1/Pure1_1_0/api_client.py b/pypureclient/pure1/Pure1_1_0/api_client.py
@@ -177,6 +177,14 @@ def __call_api(
             return (return_data, response_data.status,
                     response_data.getheaders())
 
+    def extract_object_dict_from_object(self, obj):
+        """Convert model obj to dict, using `swagger_types`
+        and use `attribute_map` to determine json keys. """
+        obj_dict =  {obj.attribute_map[attr]: getattr(obj, attr)
+                       for attr, _ in six.iteritems(obj.swagger_types)
+                       if hasattr(obj, attr)}
+        return obj_dict
+
     def sanitize_for_serialization(self, obj):
         """Builds a JSON POST object.
 
@@ -207,14 +215,7 @@ def sanitize_for_serialization(self, obj):
         if isinstance(obj, dict):
             obj_dict = obj
         else:
-            # Convert model obj to dict except
-            # attributes `swagger_types`, `attribute_map`
-            # and attributes which value is not None.
-            # Convert attribute name to json key in
-            # model definition for request.
-            obj_dict = {obj.attribute_map[attr]: getattr(obj, attr)
-                        for attr, _ in six.iteritems(obj.swagger_types)
-                        if hasattr(obj, attr)}
+            obj_dict = self.extract_object_dict_from_object(obj)
 
         return {key: self.sanitize_for_serialization(val)
                 for key, val in six.iteritems(obj_dict)}
@@ -230,7 +231,7 @@ def deserialize(self, response, response_type):
         """
         # handle file downloading
         # save response body into a tmp file and return the instance
-        if response_type == "file":
+        if response_type == "file" or response_type == "KeytabFileResponse":
             return self.__deserialize_file(response)
 
         # fetch data from response object
@@ -524,6 +525,11 @@ def __deserialize_file(self, response):
         :param response:  RESTResponse.
         :return: file path.
         """
+
+        # If no results, just return None
+        if response.data == "":
+            return None
+
         fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
         os.close(fd)
         os.remove(path)
@@ -534,8 +540,12 @@ def __deserialize_file(self, response):
                                  content_disposition).group(1)
             path = os.path.join(os.path.dirname(path), filename)
 
-        with open(path, "wb") as f:
-            f.write(response.data)
+        if type(response.data) == str:
+            with open(path, "w") as f:
+                f.write(response.data)
+        else:
+            with open(path, "wb") as f:
+                f.write(response.data)
 
         return path
 
diff --git a/pypureclient/pure1/Pure1_1_0/client.py b/pypureclient/pure1/Pure1_1_0/client.py
@@ -32,7 +32,7 @@ class Client(object):
     TIMEOUT_KEY = 'timeout'
     TIMEOUT_DEFAULT = 15.0
     # Format: client/client_version/endpoint/endpoint_version/system/release
-    USER_AGENT = ('pypureclient/1.11.0/Pure1/1.0/{sys}/{rel}'
+    USER_AGENT = ('pypureclient/1.18.1/Pure1/1.0/{sys}/{rel}'
                   .format(sys=platform.system(), rel=platform.release()))
 
     def __init__(self, **kwargs):
diff --git a/pypureclient/pure1/Pure1_1_0/models/__init__.py b/pypureclient/pure1/Pure1_1_0/models/__init__.py
@@ -97,6 +97,7 @@ def quoteStrings(s):
 from .inline_response400 import InlineResponse400
 from .inline_response401 import InlineResponse401
 from .license_resource_reference import LicenseResourceReference
+from .marketplace_partner import MarketplacePartner
 from .metric import Metric
 from .metric_availability import MetricAvailability
 from .metric_get_response import MetricGetResponse
@@ -139,7 +140,6 @@ def quoteStrings(s):
 from .subscription_get_response import SubscriptionGetResponse
 from .subscription_license import SubscriptionLicense
 from .subscription_license_get_response import SubscriptionLicenseGetResponse
-from .subscription_license_marketplace_partner import SubscriptionLicenseMarketplacePartner
 from .subscription_license_response import SubscriptionLicenseResponse
 from .subscription_response import SubscriptionResponse
 from .support_contract import SupportContract
diff --git a/pypureclient/pure1/Pure1_1_0/models/marketplace_partner.py b/pypureclient/pure1/Pure1_1_0/models/marketplace_partner.py
@@ -21,7 +21,7 @@
 if typing.TYPE_CHECKING:
     from pypureclient.pure1.Pure1_1_0 import models
 
-class SubscriptionLicenseMarketplacePartner(object):
+class MarketplacePartner(object):
     """
     Attributes:
       swagger_types (dict): The key is attribute name
@@ -59,7 +59,7 @@ def __init__(
 
     def __setattr__(self, key, value):
         if key not in self.attribute_map:
-            raise KeyError("Invalid key `{}` for `SubscriptionLicenseMarketplacePartner`".format(key))
+            raise KeyError("Invalid key `{}` for `MarketplacePartner`".format(key))
         self.__dict__[key] = value
 
     def __getattribute__(self, item):
@@ -91,7 +91,7 @@ def to_dict(self):
                     ))
                 else:
                     result[attr] = value
-        if issubclass(SubscriptionLicenseMarketplacePartner, dict):
+        if issubclass(MarketplacePartner, dict):
             for key, value in self.items():
                 result[key] = value
 
@@ -107,7 +107,7 @@ def __repr__(self):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, SubscriptionLicenseMarketplacePartner):
+        if not isinstance(other, MarketplacePartner):
             return False
 
         return self.__dict__ == other.__dict__
diff --git a/pypureclient/pure1/Pure1_1_0/models/subscription_license.py b/pypureclient/pure1/Pure1_1_0/models/subscription_license.py
@@ -35,7 +35,7 @@ class SubscriptionLicense(object):
         'name': 'str',
         'average_on_demand': 'CurrentMetric',
         'expiration_date': 'int',
-        'marketplace_partner': 'SubscriptionLicenseMarketplacePartner',
+        'marketplace_partner': 'MarketplacePartner',
         'reservation': 'CurrentMetric',
         'resources': 'list[LicenseResourceReference]',
         'service_tier': 'str',
@@ -69,7 +69,7 @@ def __init__(
         name=None,  # type: str
         average_on_demand=None,  # type: models.CurrentMetric
         expiration_date=None,  # type: int
-        marketplace_partner=None,  # type: models.SubscriptionLicenseMarketplacePartner
+        marketplace_partner=None,  # type: models.MarketplacePartner
         reservation=None,  # type: models.CurrentMetric
         resources=None,  # type: List[models.LicenseResourceReference]
         service_tier=None,  # type: str
@@ -84,7 +84,7 @@ def __init__(
             name (str): A non-modifiable, locally unique name chosen by the system.
             average_on_demand (CurrentMetric): Estimated daily on-demand usage of the license from the current calendar quarter to date.
             expiration_date (int): Date when the license expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.
-            marketplace_partner (SubscriptionLicenseMarketplacePartner)
+            marketplace_partner (MarketplacePartner): Reference information about the marketplace partner of this license.
             reservation (CurrentMetric): Current reservation amount of the license.
             resources (list[LicenseResourceReference]): References to the resources that operate under this license.
             service_tier (str): The tier of the service for the license.
diff --git a/pypureclient/pure1/Pure1_1_0/rest.py b/pypureclient/pure1/Pure1_1_0/rest.py
@@ -217,12 +217,20 @@ def request(self, method, url, query_params=None, headers=None,
             r = RESTResponse(r)
 
             # In the python 3, the response.data is bytes.
-            # we need to decode it to string.
+            should_log_body = True
             if six.PY3:
-                r.data = r.data.decode('utf8')
-
-            # log response body
-            logger.debug("response body: %s", r.data)
+                try:
+                    decoded_data = r.data.decode('utf8')
+                    r.data = decoded_data
+                except:
+                    # make sure we don't try to log this data if it's not utf-8 compatible
+                    should_log_body = False
+                    logger.debug("response body could not be decoded using utf-8")
+
+            # log response body if and only if it's not file data. file data might error if we try
+            # to write it to this log
+            if should_log_body:
+                logger.debug("response body: %s", r.data)
 
         if not 200 <= r.status <= 299:
             raise ApiException(http_resp=r)
diff --git a/pypureclient/pure1/Pure1_1_1/__init__.py b/pypureclient/pure1/Pure1_1_1/__init__.py
diff --git a/pypureclient/pure1/Pure1_1_1/api_client.py b/pypureclient/pure1/Pure1_1_1/api_client.py
diff --git a/pypureclient/pure1/Pure1_1_1/client.py b/pypureclient/pure1/Pure1_1_1/client.py
diff --git a/pypureclient/pure1/Pure1_1_1/models/__init__.py b/pypureclient/pure1/Pure1_1_1/models/__init__.py
diff --git a/pypureclient/pure1/Pure1_1_1/models/license_resource_reference.py b/pypureclient/pure1/Pure1_1_1/models/license_resource_reference.py
diff --git a/pypureclient/pure1/Pure1_1_1/models/marketplace_partner.py b/pypureclient/pure1/Pure1_1_1/models/marketplace_partner.py
diff --git a/pypureclient/pure1/Pure1_1_1/models/subscription_license.py b/pypureclient/pure1/Pure1_1_1/models/subscription_license.py
diff --git a/pypureclient/pure1/Pure1_1_1/rest.py b/pypureclient/pure1/Pure1_1_1/rest.py
diff --git a/setup.py b/setup.py
