5.0.0 release, fixing various bugs and enable SOAP gzip compression.

Author: msaniscalchi

ChangeLog

@@ -1,3 +1,26 @@
+5.0.0 -- 1/13/17:
+* BREAKING CHANGE: The underlying suds client now has cache enabled. By default,
+  suds uses FileCache which requires access to local file system and will break
+  users using Google App Engine. For more details on how to configure or disable
+  caching, see the README.
+* The library will now automatically apply a monkey patch to the suds-jurko
+  dependency on initialization that will modify the suds.transport.http module.
+  The patch modifies HttpTransport's send method such that it can detect and
+  decompress a gzip encoded SOAP body.
+* Added new "enable_compression" optional keyword argument for AdWordsClient and
+  DfpClient. If set True, the client will request gzip compression and
+  automatically decompress the SOAP body for you. For more details on this
+  feature, see:
+  https://developers.google.com/adwords/api/docs/guides/bestpractices?hl=en#use_compression
+* Resolved issues:
+  Issue 77: https://github.com/googleads/googleads-python-lib/issues/77
+  Issue 97: https://github.com/googleads/googleads-python-lib/issues/97
+* Resolved pull requests:
+  PR 79: https://github.com/googleads/googleads-python-lib/pull/79
+  PR 81: https://github.com/googleads/googleads-python-lib/pull/81
+  PR 91: https://github.com/googleads/googleads-python-lib/pull/91
+  PR 99: https://github.com/googleads/googleads-python-lib/pull/99
+
 4.8.0 -- 11/29/16:
 * Added support for DFP v201611.
 * Removed support for DFP v201508 and v201511.

README.md

@@ -162,6 +162,31 @@ suds_client.set_options(
 suds_client.service.mutate([operation])
 ```
 
+##How can I configure or disable caching for the suds client?
+
+By default, the suds clients are cached because reading and digesting the WSDL
+can be expensive. However, the default caching method requires permission to
+access a local file system that may not be available in certain hosting
+environments such as App Engine.
+
+You can pass an implementation of `suds.cache.Cache` to the `AdWordsClient` or
+`DfpClient` initializer to modify the default caching behavior.
+
+For example, configuring a different location and duration of the cache file:
+```python
+file_cache = suds.cache.FileCache(location=cache_path, days=2)
+adwords_client = adwords.AdWordsClient(
+  developer_token, oauth2_client, user_agent,
+  client_customer_id=client_customer_id, cache=file_cache)
+```
+
+You can also disable caching in similar fashion:
+```python
+adwords_client = adwords.AdWordsClient(
+  developer_token, oauth2_client, user_agent,
+  client_customer_id=client_customer_id, cache=suds.cache.NoCache)
+```
+
 ##Timeout Tips
 The requests sent by this library are sent via urllib, which is consequently
 where the timeout is set. If you set a system timeout elsewhere, the googleads

…es/adwords/adwords_appengine_demo/README …adwords/adwords_appengine_demo/README.mdexamples/adwords/adwords_appengine_demo/README renamed to examples/adwords/adwords_appengine_demo/README.md examples/adwords/adwords_appengine_demo/README renamed to examples/adwords/adwords_appengine_demo/README.md

@@ -19,6 +19,8 @@
 import time
 
 
+from suds.cache import NoCache
+
 from demo import VERSION
 from googleads.adwords import AdWordsClient
 from googleads.errors import GoogleAdsError
@@ -45,7 +47,8 @@ def __init__(self, client_id, client_secret, refresh_token,
     credentials = GoogleRefreshTokenClient(client_id, client_secret,
                                            refresh_token)
     self.client = AdWordsClient(dev_token, credentials, self._USER_AGENT,
-                                client_customer_id=manager_account_id)
+                                client_customer_id=manager_account_id,
+                                cache=NoCache)
 
   def AddAdGroup(self, client_customer_id, campaign_id, name, status):
     """Create a new ad group.

examples/adwords/adwords_appengine_demo/handlers/api_handler.py

@@ -70,7 +70,8 @@ def main(client, ad_group_id):
         operation_index = re.findall(r'operations\[(.*)\]\.',
                                      error['fieldPath'])
         if operation_index:
-          operation = operations[int(operation_index[0])]
+          index = int(operation_index[0])
+          operation = operations[index]
           print ('Ad with headline \'%s\' violated %s policy \'%s\'.' %
                  (operation['operand']['ad']['headline'],
                   'exemptable' if error['isExemptable'] else 'non-exemptable',
@@ -85,13 +86,15 @@ def main(client, ad_group_id):
             operation['exemptionRequests'].append({
                 'key': error['key']
             })
-        else:
-          # Remove non-exemptable operation
-          print 'Removing the operation from the request.'
-          operations.delete(operation)
+          else:
+            # Set non-exemptable operation to None to mark for deletion
+            print 'Removing the operation from the request.'
+            operations[index] = None
       else:
         # Non-policy error returned, re-throw exception.
         raise e
+    # Remove the non-exemptable operations.
+    operations = [op for op in operations if op is not None]
 
   # Add these ads. Disable "validate only" so the ads will get created.
   client.validate_only = False

examples/adwords/v201605/error_handling/handle_policy_violation_error.py

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""This example downloads a criteria performance report as a string with AWQL.
+"""This example downloads a criteria performance report as a stream with AWQL.
 
 To get report fields, run get_report_fields.py.
 

examples/adwords/v201605/reporting/download_criteria_report_as_stream_with_awql.py

@@ -70,7 +70,8 @@ def main(client, ad_group_id):
         operation_index = re.findall(r'operations\[(.*)\]\.',
                                      error['fieldPath'])
         if operation_index:
-          operation = operations[int(operation_index[0])]
+          index = int(operation_index[0])
+          operation = operations[index]
           print ('Ad with headline \'%s\' violated %s policy \'%s\'.' %
                  (operation['operand']['ad']['headline'],
                   'exemptable' if error['isExemptable'] else 'non-exemptable',
@@ -85,13 +86,15 @@ def main(client, ad_group_id):
             operation['exemptionRequests'].append({
                 'key': error['key']
             })
-        else:
-          # Remove non-exemptable operation
-          print 'Removing the operation from the request.'
-          operations.delete(operation)
+          else:
+            # Set non-exemptable operation to None to mark for deletion
+            print 'Removing the operation from the request.'
+            operations[index] = None
       else:
         # Non-policy error returned, re-throw exception.
         raise e
+    # Remove the non-exemptable operations.
+    operations = [op for op in operations if op is not None]
 
   # Add these ads. Disable "validate only" so the ads will get created.
   client.validate_only = False

examples/adwords/v201607/error_handling/handle_policy_violation_error.py

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""This example downloads a criteria performance report as a string with AWQL.
+"""This example downloads a criteria performance report as a stream with AWQL.
 
 To get report fields, run get_report_fields.py.
 

examples/adwords/v201607/reporting/download_criteria_report_as_stream_with_awql.py

@@ -70,7 +70,8 @@ def main(client, ad_group_id):
         operation_index = re.findall(r'operations\[(.*)\]\.',
                                      error['fieldPath'])
         if operation_index:
-          operation = operations[int(operation_index[0])]
+          index = int(operation_index[0])
+          operation = operations[index]
           print ('Ad with headline \'%s\' violated %s policy \'%s\'.' %
                  (operation['operand']['ad']['headline'],
                   'exemptable' if error['isExemptable'] else 'non-exemptable',
@@ -85,13 +86,15 @@ def main(client, ad_group_id):
             operation['exemptionRequests'].append({
                 'key': error['key']
             })
-        else:
-          # Remove non-exemptable operation
-          print 'Removing the operation from the request.'
-          operations.delete(operation)
+          else:
+            # Set non-exemptable operation to None to mark for deletion
+            print 'Removing the operation from the request.'
+            operations[index] = None
       else:
         # Non-policy error returned, re-throw exception.
         raise e
+    # Remove the non-exemptable operations.
+    operations = [op for op in operations if op is not None]
 
   # Add these ads. Disable "validate only" so the ads will get created.
   client.validate_only = False

examples/adwords/v201609/error_handling/handle_policy_violation_error.py

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""This example downloads a criteria performance report as a string with AWQL.
+"""This example downloads a criteria performance report as a stream with AWQL.
 
 To get report fields, run get_report_fields.py.