pep-8 pycharm pass, force deprecation for movement service

radzhome · radzhome · commit a6b7c5b28cc0 · 2016-01-18T20:49:05.000-05:00
* pep-8 pass on the entire package
* force deprecation warning for python 2.7
* rename package movement to deprecated status
* promote country service for postal validation
diff --git a/examples/country_postal_inquiry.py b/examples/country_postal_inquiry.py
diff --git a/examples/postal_inquiry.py b/examples/postal_inquiry.py
@@ -1,50 +1,56 @@
 #!/usr/bin/env python
 """
-PostalCodeInquiryRequest classes are used to validate and receive additional
+ValidatePostalRequest classes are used to validate and receive additional
 information about postal codes.
 """
 import logging
-import sys
-
 from example_config import CONFIG_OBJ
-from fedex.services.package_movement import PostalCodeInquiryRequest
-from fedex.tools.conversion import sobject_to_dict
+from fedex.services.country_service import FedexValidatePostalRequest
 
-# Un-comment to see the response from Fedex printed in stdout.
-logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+# Set this to the INFO level to see the response from Fedex printed in stdout.
+logging.basicConfig(level=logging.INFO)
 
 # We're using the FedexConfig object from example_config.py in this dir.
-inquiry = PostalCodeInquiryRequest(CONFIG_OBJ)
-inquiry.PostalCode = '29631'
-inquiry.CountryCode = 'US'
-
-# If you'd like to see some documentation on the ship service WSDL, un-comment
+customer_transaction_id = "*** ValidatePostal Request v4 using Python ***"  # Optional transaction_id
+inquiry = FedexValidatePostalRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+inquiry.Address.PostalCode = '29631'
+inquiry.Address.CountryCode = 'US'
+inquiry.Address.StreetLines = ['104 Knox Road']
+inquiry.Address.City = 'Clemson'
+inquiry.Address.StateOrProvinceCode = 'SC'
+
+# If you'd like to see some documentation on the country service WSDL, un-comment
 # this line. (Spammy).
 # print(inquiry.client)
 
 # Un-comment this to see your complete, ready-to-send request as it stands
 # before it is actually sent. This is useful for seeing what values you can
 # change.
 # print(inquiry.CarrierCode)
-# print(inquiry.ClientDetail)
-# print(inquiry.TransactionDetail)
+# print(inquiry.Address)
+# print(inquiry.ShipDateTime)
+# print(inquiry.CheckForMismatch)
+# print(inquiry.RoutingCode)
 
 # Fires off the request, sets the 'response' attribute on the object.
 inquiry.send_request()
 
 # See the response printed out.
-# print(inquiry.response)
-
-# This will convert the response to a python dict object. To
-# make it easier to work with.
-# from fedex.tools.conversion import basic_sobject_to_dict
-# print(basic_sobject_to_dict(inquiry.response))
-
-# This will dump the response data dict to json.
-# from fedex.tools.conversion import sobject_to_json
-# print(sobject_to_json(inquiry.response))
+print(inquiry.response)
 
 # Here is the overall end result of the query.
 print("HighestSeverity: {}".format(inquiry.response.HighestSeverity))
-print("ExpressFreightContractorDeliveryArea: {}".format(sobject_to_dict(inquiry.response.ExpressDescription)))
-print("ExpressDescription: {}".format(sobject_to_dict(inquiry.response.ExpressFreightDescription)))
+print("")
+
+print("State/Province: {}".format(inquiry.response.PostalDetail.StateOrProvinceCode))
+print("City First Initial: {}".format(inquiry.response.PostalDetail.CityFirstInitials))
+print("Clean Postal Code: {}".format(inquiry.response.PostalDetail.CleanedPostalCode))
+
+for loc_description in inquiry.response.PostalDetail.LocationDescriptions:
+    print("Location ID: {}".format(loc_description.LocationId))
+    print("Location No.: {}".format(loc_description.LocationNumber))
+    print("Country Code: {}".format(loc_description.CountryCode))
+    print("Postal Code: {}".format(loc_description.PostalCode))
+    print("Service Area: {}".format(loc_description.ServiceArea))
+    print("Airport ID: {}".format(loc_description.AirportId))
+    print("FedEx Europe First Origin: {}".format(loc_description.FedExEuropeFirstOrigin))
diff --git a/examples/postal_inquiry_deprecated.py b/examples/postal_inquiry_deprecated.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+"""
+PostalCodeInquiryRequest classes are used to validate and receive additional
+information about postal codes.
+"""
+import logging
+import sys
+import warnings
+from example_config import CONFIG_OBJ
+from fedex.services.package_movement import PostalCodeInquiryRequest
+from fedex.tools.conversion import sobject_to_dict
+
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+warnings.simplefilter('always', DeprecationWarning)  # Show deprecation on this module in py2.7.
+
+# We're using the FedexConfig object from example_config.py in this dir.
+inquiry = PostalCodeInquiryRequest(CONFIG_OBJ)
+inquiry.PostalCode = '29631'
+inquiry.CountryCode = 'US'
+
+# If you'd like to see some documentation on the ship service WSDL, un-comment
+# this line. (Spammy).
+# print(inquiry.client)
+
+# Un-comment this to see your complete, ready-to-send request as it stands
+# before it is actually sent. This is useful for seeing what values you can
+# change.
+# print(inquiry.CarrierCode)
+# print(inquiry.ClientDetail)
+# print(inquiry.TransactionDetail)
+
+# Fires off the request, sets the 'response' attribute on the object.
+inquiry.send_request()
+
+# See the response printed out.
+# print(inquiry.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(inquiry.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(inquiry.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(inquiry.response.HighestSeverity))
+print("ExpressFreightContractorDeliveryArea: {}".format(sobject_to_dict(inquiry.response.ExpressDescription)))
+print("ExpressDescription: {}".format(sobject_to_dict(inquiry.response.ExpressFreightDescription)))
diff --git a/examples/rate_request.py b/examples/rate_request.py
@@ -123,11 +123,7 @@
                                                   rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
                                                   rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount))
 
-# Not sure if 'NOTE' checking should be put in base class.
-# For now can check notifications manually.
-# if notification.Severity == 'NOTE':
-#     self.logger.warning(FedexFailure(notification.Code,
-#                                      notification.Message))
+# Check for warnings, this is also logged by the base class.
 if rate_request.response.HighestSeverity == 'NOTE':
     for notification in rate_request.response.Notifications:
         if notification.Severity == 'NOTE':
diff --git a/examples/track_shipment.py b/examples/track_shipment.py
@@ -70,7 +70,8 @@
         print("Status Description: {}".format(match.StatusDetail.Description))
     if hasattr(match, 'StatusDetail.AncillaryDetails'):
         print("Status AncillaryDetails Reason: {}".format(match.StatusDetail.AncillaryDetails[-1].Reason))
-        print("Status AncillaryDetails Description: {}".format(match.StatusDetail.AncillaryDetails[-1].ReasonDescription))
+        print("Status AncillaryDetails Description: {}"
+              "".format(match.StatusDetail.AncillaryDetails[-1].ReasonDescription))
     if hasattr(match, 'ServiceCommitMessage'):
         print("Commit Message: {}".format(match.ServiceCommitMessage))
     if hasattr(match, 'Notification'):
diff --git a/fedex/base_service.py b/fedex/base_service.py
@@ -17,7 +17,6 @@
 
 class GeneralSudsPlugin(MessagePlugin):
     def __init__(self, **kwargs):
-        
         self.request_logger = logging.getLogger('fedex.request')
         self.response_logger = logging.getLogger('fedex.response')
         self.kwargs = kwargs
diff --git a/fedex/services/address_validation_service.py b/fedex/services/address_validation_service.py
@@ -37,7 +37,7 @@ def __init__(self, config_obj, *args, **kwargs):
         """@ivar: Holds the AddressToValidate WSDL object."""
         # Call the parent FedexBaseService class for basic setup work.
         super(FedexAddressValidationRequest, self).__init__(
-            self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs)
+                self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs)
 
     def _prepare_wsdl_objects(self):
         """
@@ -63,12 +63,12 @@ def _assemble_and_send_request(self):
         self.logger.debug(self.VersionId)
         # Fire off the query.
         return self.client.service.addressValidation(
-            WebAuthenticationDetail=self.WebAuthenticationDetail,
-            ClientDetail=self.ClientDetail,
-            TransactionDetail=self.TransactionDetail,
-            Version=self.VersionId,
-            InEffectAsOfTimestamp=datetime.datetime.now(),
-            AddressesToValidate=self.AddressesToValidate)
+                WebAuthenticationDetail=self.WebAuthenticationDetail,
+                ClientDetail=self.ClientDetail,
+                TransactionDetail=self.TransactionDetail,
+                Version=self.VersionId,
+                InEffectAsOfTimestamp=datetime.datetime.now(),
+                AddressesToValidate=self.AddressesToValidate)
 
     def add_address(self, address_item):
         """
diff --git a/fedex/services/availability_commitment_service.py b/fedex/services/availability_commitment_service.py
@@ -58,7 +58,7 @@ def __init__(self, config_obj, *args, **kwargs):
         # Exception: binding 'ns:ValidationAvailabilityAndCommitmentServiceSoapBinding', not-found
 
         super(FedexAvailabilityCommitmentRequest, self).__init__(
-            self._config_obj, 'AvailabilityAndCommitmentService_v4.wsdl', *args, **kwargs)
+                self._config_obj, 'AvailabilityAndCommitmentService_v4.wsdl', *args, **kwargs)
 
     def _prepare_wsdl_objects(self):
         """
@@ -88,13 +88,13 @@ def _assemble_and_send_request(self):
         self.logger.debug(self.VersionId)
         # Fire off the query.
         return self.client.service.serviceAvailability(
-            WebAuthenticationDetail=self.WebAuthenticationDetail,
-            ClientDetail=self.ClientDetail,
-            TransactionDetail=self.TransactionDetail,
-            Version=self.VersionId,
-            Origin=self.Origin,
-            Destination=self.Destination,
-            ShipDate=self.ShipDate,
-            CarrierCode=self.CarrierCode,
-            Service=self.Service,
-            Packaging=self.Packaging)
+                WebAuthenticationDetail=self.WebAuthenticationDetail,
+                ClientDetail=self.ClientDetail,
+                TransactionDetail=self.TransactionDetail,
+                Version=self.VersionId,
+                Origin=self.Origin,
+                Destination=self.Destination,
+                ShipDate=self.ShipDate,
+                CarrierCode=self.CarrierCode,
+                Service=self.Service,
+                Packaging=self.Packaging)
diff --git a/fedex/services/country_service.py b/fedex/services/country_service.py
@@ -48,7 +48,7 @@ def __init__(self, config_obj, *args, **kwargs):
         """@ivar: Holds the CheckForMismatch boolean objects."""
 
         super(FedexValidatePostalRequest, self).__init__(
-            self._config_obj, 'CountryService_v4.wsdl', *args, **kwargs)
+                self._config_obj, 'CountryService_v4.wsdl', *args, **kwargs)
 
     def _prepare_wsdl_objects(self):
         """
@@ -77,12 +77,12 @@ def _assemble_and_send_request(self):
         self.logger.debug(self.VersionId)
         # Fire off the query.
         return self.client.service.validatePostal(
-            WebAuthenticationDetail=self.WebAuthenticationDetail,
-            ClientDetail=self.ClientDetail,
-            TransactionDetail=self.TransactionDetail,
-            Version=self.VersionId,
-            Address=self.Address,
-            ShipDateTime=self.ShipDateTime,
-            CarrierCode=self.CarrierCode,
-            CheckForMismatch=self.CheckForMismatch,
-            RoutingCode=self.RoutingCode)
+                WebAuthenticationDetail=self.WebAuthenticationDetail,
+                ClientDetail=self.ClientDetail,
+                TransactionDetail=self.TransactionDetail,
+                Version=self.VersionId,
+                Address=self.Address,
+                ShipDateTime=self.ShipDateTime,
+                CarrierCode=self.CarrierCode,
+                CheckForMismatch=self.CheckForMismatch,
+                RoutingCode=self.RoutingCode)
diff --git a/fedex/services/location_service.py b/fedex/services/location_service.py
@@ -53,7 +53,7 @@ def __init__(self, config_obj, *args, **kwargs):
         """@ivar: Holds the LocationSortDetail WSDL object."""
 
         super(FedexSearchLocationRequest, self).__init__(
-            self._config_obj, 'LocationsService_v3.wsdl', *args, **kwargs)
+                self._config_obj, 'LocationsService_v3.wsdl', *args, **kwargs)
 
     def _prepare_wsdl_objects(self):
         """
@@ -85,13 +85,13 @@ def _assemble_and_send_request(self):
         self.logger.debug(self.VersionId)
         # Fire off the query.
         return self.client.service.searchLocations(
-            WebAuthenticationDetail=self.WebAuthenticationDetail,
-            ClientDetail=self.ClientDetail,
-            TransactionDetail=self.TransactionDetail,
-            Version=self.VersionId,
-            LocationsSearchCriterion=self.LocationsSearchCriterion,
-            PhoneNumber=self.PhoneNumber,
-            MultipleMatchesAction=self.MultipleMatchesAction,
-            Constraints=self.Constraints,
-            Address=self.Address,
-            SortDetail=self.SortDetail)
+                WebAuthenticationDetail=self.WebAuthenticationDetail,
+                ClientDetail=self.ClientDetail,
+                TransactionDetail=self.TransactionDetail,
+                Version=self.VersionId,
+                LocationsSearchCriterion=self.LocationsSearchCriterion,
+                PhoneNumber=self.PhoneNumber,
+                MultipleMatchesAction=self.MultipleMatchesAction,
+                Constraints=self.Constraints,
+                Address=self.Address,
+                SortDetail=self.SortDetail)
diff --git a/fedex/services/package_movement.py b/fedex/services/package_movement.py
@@ -51,11 +51,11 @@ def __init__(self, config_obj, postal_code=None, country_code=None, *args, **kwa
         self.CountryCode = country_code
 
         warnings.warn(
-            "DeprecationWarning: Package Movement Service has been deprecated; "
-            "please use Country Service for postal code validation requests or "
-            "Availability and Commitment Service for service availability "
-            "requests instead.",
-            DeprecationWarning
+                "Package Movement Service has been deprecated; "
+                "please use Country Service for postal code validation requests or "
+                "Availability and Commitment Service for service availability "
+                "requests instead.",
+                DeprecationWarning
         )
 
         # Call the parent FedexBaseService class for basic setup work.
diff --git a/fedex/services/rate_service.py b/fedex/services/rate_service.py
@@ -36,7 +36,7 @@ def __init__(self, config_obj, *args, **kwargs):
         """@ivar: Holds the RequestedShipment WSDL object including the shipper, recipient and shipt time."""
         # Call the parent FedexBaseService class for basic setup work.
         super(FedexRateServiceRequest, self).__init__(
-            self._config_obj, 'RateService_v18.wsdl', *args, **kwargs)
+                self._config_obj, 'RateService_v18.wsdl', *args, **kwargs)
         self.ClientDetail.Region = config_obj.express_region_code
         """@ivar: Holds the express region code from the config object."""
 
@@ -100,12 +100,12 @@ def _assemble_and_send_request(self):
 
         # Fire off the query.
         return self.client.service.getRates(
-            WebAuthenticationDetail=self.WebAuthenticationDetail,
-            ClientDetail=self.ClientDetail,
-            TransactionDetail=self.TransactionDetail,
-            Version=self.VersionId,
-            RequestedShipment=self.RequestedShipment,
-            ReturnTransitAndCommit=self.ReturnTransitAndCommit)
+                WebAuthenticationDetail=self.WebAuthenticationDetail,
+                ClientDetail=self.ClientDetail,
+                TransactionDetail=self.TransactionDetail,
+                Version=self.VersionId,
+                RequestedShipment=self.RequestedShipment,
+                ReturnTransitAndCommit=self.ReturnTransitAndCommit)
 
     def add_package(self, package_item):
         """
diff --git a/fedex/services/ship_service.py b/fedex/services/ship_service.py
diff --git a/fedex/services/track_service.py b/fedex/services/track_service.py
diff --git a/fedex/tools/conversion.py b/fedex/tools/conversion.py
diff --git a/tests/test_package_movement_service.py b/tests/test_package_movement_service.py
