fedex.services.location

26 """ - 27 The postal code inquiry enables customers to validate postal codes - 28 and service commitments. - 29 """ - 30 -

31 - def __init__(self, config_obj, postal_code=None, country_code=None, *args, **kwargs): -

32 """ - 33 Sets up an inquiry request. The optional keyword args - 34 detailed on L{FedexBaseService} apply here as well. - 35 - 36 @type config_obj: L{FedexConfig} - 37 @param config_obj: A valid FedexConfig object - 38 @param postal_code: a valid postal code - 39 @param country_code: ISO country code to which the postal code belongs to. - 40 """ - 41 self._config_obj = config_obj - 42 - 43 # Holds version info for the VersionId SOAP object. - 44 self._version_info = {'service_id': 'pmis', 'major': '4', - 45 'intermediate': '0', 'minor': '0'} - 46 self.PostalCode = postal_code - 47 self.CountryCode = country_code - 48 - 49 # Call the parent FedexBaseService class for basic setup work. - 50 super(PostalCodeInquiryRequest, self). 11 + 12 -class FedexPostalCodeNotFound(FedexError): + 13 """ + 14 Exception: Sent when the postalcode is missing. + 15 """ + 16 pass + 17 + 18 + 19 -class FedexInvalidPostalCodeFormat(FedexError): + 20 """ + 21 Exception: Sent when the postal code is invalid + 22 """ + 23 pass + 24 + 25 + 26 -class PostalCodeInquiryRequest(FedexBaseService): + 27 """ + 28 The postal code inquiry enables customers to validate postal codes + 29 and service commitments. + 30 """ + 31 + 32 - def __init__(self, config_obj, postal_code=None, country_code=None, *args, **kwargs): + 33 """ + 34 Sets up an inquiry request. The optional keyword args + 35 detailed on L{FedexBaseService} apply here as well. + 36 + 37 @type config_obj: L{FedexConfig} + 38 @param config_obj: A valid FedexConfig object + 39 @param postal_code: a valid postal code + 40 @param country_code: ISO country code to which the postal code belongs to. + 41 """ + 42 self._config_obj = config_obj + 43 + 44 # Holds version info for the VersionId SOAP object. + 45 self._version_info = {'service_id': 'pmis', + 46 'major': '4', + 47 'intermediate': '0', + 48 'minor': '0'} + 49 + 50 self.PostalCode = postal_code + 51 self.CountryCode = country_code + 52 + 53 warnings.warn( + 54 "Package Movement Service has been deprecated; " + 55 "please use Country Service for postal code validation requests or " + 56 "Availability and Commitment Service for service availability " + 57 "requests instead.", + 58 DeprecationWarning + 59 ) + 60 + 61 # Call the parent FedexBaseService class for basic setup work. + 62 super(PostalCodeInquiryRequest, self).Source Code for __init__(self._config_obj, - 51 'PackageMovementInformationService_v4.wsdl', - 52 *args, **kwargs) - 53 - 54 - def _check_response_for_request_errors(self): - 55 """ - 56 Checks the response to see if there were any errors specific to - 57 this WSDL. - 58 """ - 59 if self.response.HighestSeverity == "ERROR": - 60 for notification in self.response.Notifications: # pragma: no cover - 61 if notification.Severity == "ERROR": - 62 if "Postal Code Not Found" in notification.Message: - 63 raise FedexPostalCodeNotFound(notification.Code, - 64 notification.Message) - 65 - 66 elif "Invalid Postal Code Format" in self.response.Notifications: - 67 raise FedexInvalidPostalCodeFormat(notification.Code, - 68 notification.Message) - 69 else: - 70 raise FedexError(notification.Code, - 71 notification.Message) - 72 - 73 - def _prepare_wsdl_objects(self): - 74 """ - 75 Preps the WSDL data structures for the user. - 76 """ + 63 'PackageMovementInformationService_v4.wsdl', + 64 *args, **kwargs) + 65 + 66 - def _check_response_for_request_errors(self): + 67 """ + 68 Checks the response to see if there were any errors specific to + 69 this WSDL. + 70 """ + 71 if self.response.HighestSeverity == "ERROR": + 72 for notification in self.response.Notifications: # pragma: no cover + 73 if notification.Severity == "ERROR": + 74 if "Postal Code Not Found" in notification.Message: + 75 raise FedexPostalCodeNotFound(notification.Code, + 76 notification.Message) 77 - 78 self.CarrierCode = 'FDXE' - 79 - 80 - def _assemble_and_send_request(self): - 81 """ - 82 Fires off the Fedex request. - 83 - 84 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES - 85 ON FedexBaseService AND IS INHERITED. - 86 """ - 87 client = self.client - 88 - 89 # We get an exception like this when specifying an IntegratorId: - 90 # suds.TypeNotFound: Type not found: 'IntegratorId' - 91 # Setting it to None does not seem to appease it. - 92 - 93 del self.ClientDetail.IntegratorId - 94 - 95 # Fire off the query. - 96 response = client.service.postalCodeInquiry(WebAuthenticationDetail=self.WebAuthenticationDetail, - 97 ClientDetail=self.ClientDetail, - 98 TransactionDetail=self.TransactionDetail, - 99 Version=self.VersionId, -100 PostalCode=self.PostalCode, -101 CountryCode=self.CountryCode, -102 CarrierCode=self.CarrierCode) -103 -104 return response - 105 + + diff --git a/docs/2.3.0/fedex.tools-pysrc.html b/docs/2.3.0/fedex.tools-pysrc.html new file mode 100644 index 0000000..66a7e1b --- /dev/null +++ b/docs/2.3.0/fedex.tools-pysrc.html @@ -0,0 +1,112 @@ + + + + + fedex.tools + + + + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + + Package fedex :: + Package tools + + + + + + + [hide private] [frames] | no frames] + +Source Code for Package fedex.tools ++1 +2 + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:06 2016 + + http://epydoc.sourceforge.net + + + + + diff --git a/docs/2.3.0/fedex.tools.conversion-module.html b/docs/2.3.0/fedex.tools.conversion-module.html new file mode 100644 index 0000000..5488bd2 --- /dev/null +++ b/docs/2.3.0/fedex.tools.conversion-module.html @@ -0,0 +1,291 @@ + + + + + fedex.tools.conversion + + + + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + + Package fedex :: + Package tools :: + Module conversion + + + + + + + [hide private] [frames] | no frames] + + +Module conversion source code +Response output conversion tools to help parse suds response object + output. + + + + + + + + + + + + + + + + + + + + + + + Functions [hide private] + + + + + + + + + basic_sobject_to_dict(obj) + Converts suds object to dict very quickly. + source code + + + + + + + + + + + + sobject_to_dict(obj, + key_to_lower=False, + json_serialize=False) + Converts a suds object to a dict. + source code + + + + + + + + + + + + sobject_to_json(obj, + key_to_lower=False) + Converts a suds object to json. + source code + + + + + + + + + + + + + + + + + + + + Variables [hide private] + + + + __package__ = None + + + + + + + + + + + + + + Function Details [hide private] + + + + + + + + + basic_sobject_to_dict(obj) + + source code + + + Converts suds object to dict very quickly. Does not serialize date + time or normalize key case. :param obj: suds object :return: dict + object + + + + + + + + + + + + sobject_to_dict(obj, + key_to_lower=False, + json_serialize=False) + + source code + + + Converts a suds object to a dict. :param json_serialize: If set, + changes date and time types to iso string. :param key_to_lower: If set, + changes index key name to lower case. :param obj: suds object :return: + dict object + + + + + + + + + + + + sobject_to_json(obj, + key_to_lower=False) + + source code + + + Converts a suds object to json. :param obj: suds object :param + key_to_lower: If set, changes index key name to lower case. :return: json + object + + + + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:05 2016 + + http://epydoc.sourceforge.net + + + + + diff --git a/docs/2.3.0/fedex.tools.conversion-pysrc.html b/docs/2.3.0/fedex.tools.conversion-pysrc.html new file mode 100644 index 0000000..e55ab05 --- /dev/null +++ b/docs/2.3.0/fedex.tools.conversion-pysrc.html @@ -0,0 +1,205 @@ + + + + + fedex.tools.conversion + + + + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + + Package fedex :: + Package tools :: + Module conversion + + + + + + + [hide private] [frames] | no frames] + +Source Code for Module fedex.tools.conversion ++ 1 """Response output conversion tools to help parse suds + 2 response object output. + 3 """ + 4 + 5 + 6 # This is the suds way of doing this, but its slower. + 7 # For reference only. + 8 # from suds.sudsobject import asdict + 9 # from suds.sax.text import Text +10 # +11 # def response_to_dict(obj): +12 # """ Converts a suds object to a dictionary. +13 # :param obj: object +14 # :return: dictionary +15 # """ +16 # out = {} +17 # for k, v in asdict(obj).items(): # k = k.lower() +18 # if hasattr(v, '__keylist__'): +19 # out[k] = response_to_dict(v) +20 # elif isinstance(v, list): # tuple not used +21 # out[k] = [] +22 # for item in v: +23 # if hasattr(item, '__keylist__'): +24 # out[k].append(response_to_dict(item)) +25 # else: +26 # out[k].append( +27 # item.title() if isinstance(item, Text) else item) +28 # else: +29 # out[k] = v.title() if isinstance(v, Text) else v +30 # return out +31 +32 +33 -def basic_sobject_to_dict(obj): + 34 """Converts suds object to dict very quickly. +35 Does not serialize date time or normalize key case. +36 :param obj: suds object +37 :return: dict object +38 """ +39 if not hasattr(obj, '__keylist__'): +40 return obj +41 data = {} +42 fields = obj.__keylist__ +43 for field in fields: +44 val = getattr(obj, field) +45 if isinstance(val, list): +46 data[field] = [] +47 for item in val: +48 data[field].append(basic_sobject_to_dict(item)) +49 else: +50 data[field] = basic_sobject_to_dict(val) +51 return data + 52 +53 +54 -def sobject_to_dict(obj, key_to_lower=False, json_serialize=False): + 55 """ +56 Converts a suds object to a dict. +57 :param json_serialize: If set, changes date and time types to iso string. +58 :param key_to_lower: If set, changes index key name to lower case. +59 :param obj: suds object +60 :return: dict object +61 """ +62 import datetime +63 +64 if not hasattr(obj, '__keylist__'): +65 if json_serialize and isinstance(obj, (datetime.datetime, datetime.time, datetime.date)): +66 return obj.isoformat() +67 else: +68 return obj +69 data = {} +70 fields = obj.__keylist__ +71 for field in fields: +72 val = getattr(obj, field) +73 if key_to_lower: +74 field = field.lower() +75 if isinstance(val, list): +76 data[field] = [] +77 for item in val: +78 data[field].append(sobject_to_dict(item, json_serialize=json_serialize)) +79 else: +80 data[field] = sobject_to_dict(val, json_serialize=json_serialize) +81 return data + 82 +83 +84 -def sobject_to_json(obj, key_to_lower=False): + 85 """ +86 Converts a suds object to json. +87 :param obj: suds object +88 :param key_to_lower: If set, changes index key name to lower case. +89 :return: json object +90 """ +91 import json +92 data = sobject_to_dict(obj, key_to_lower=key_to_lower, json_serialize=True) +93 return json.dumps(data) + 94 + + + + + + + + + + + + + + + + + + + + Home Trees Indices Help + + + + + + + Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:06 2016 + + http://epydoc.sourceforge.net + + + + + diff --git a/docs/2.2.0/frames.html b/docs/2.3.0/frames.html similarity index 100% rename from docs/2.2.0/frames.html rename to docs/2.3.0/frames.html diff --git a/docs/2.2.0/help.html b/docs/2.3.0/help.html similarity index 99% rename from docs/2.2.0/help.html rename to docs/2.3.0/help.html index b6c3a4a..9324ba4 100644 --- a/docs/2.2.0/help.html +++ b/docs/2.3.0/help.html @@ -246,7 +246,7 @@ The Navigation Bar - + @@ -124,10 +125,15 @@ Identifier Index (in fedex) + + + + + - - Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + Generated by Epydoc 3.0.1 on Fri Jan 29 14:18:05 2016 Identifier Index I J K - L + L M N O @@ -110,7 +110,8 @@ Identifier Index base_service (in fedex) basic_sobject_to_dict() +(in fedex.tools.conversion) country_service (in fedex.services) conversion +(in fedex.tools) create_wsdl_object_of_type() (in FedexBaseService)

SchemaValidationError (in fedex.base_service)	send_validation_request() -(in FedexProcessShipmentRequest)	services -(in fedex)	sending() +(in GeneralSudsPlugin)	sobject_to_dict() +(in fedex.tools.conversion)
send_request() (in FedexBaseService)	sending() -(in GeneralSudsPlugin)	services +(in fedex)	sobject_to_json() +(in fedex.tools.conversion)
send_validation_request() +(in FedexProcessShipmentRequest)	ship_service (in fedex.services)

Class Hierarchy

Class Hierarchy

Class Hierarchy

Getting Support

Getting Support

Getting Support

Identifier Index

Source Code for Module fedex.services.location_service

Class FedexSearchLocationRequest

init(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

_prepare_wsdl_objects(self) +

_assemble_and_send_request(self) +

Module package_movement

Source Code for Package fedex.tools

Module conversion

basic_sobject_to_dict(obj) +

sobject_to_dict(obj, + key_to_lower=False, + json_serialize=False) +

sobject_to_json(obj, + key_to_lower=False) +

Source Code for Module fedex.tools.conversion

The Navigation Bar

Identifier Index

Identifier Index

D

Identifier Index

L

M

Identifier Index

Identifier Index

Identifier Index

Identifier Index

Identifier Index

Module Hierarchy

Module tools

Variables

Module conversion

Functions

Variables

Modules

Class Hierarchy

Class Hierarchy

Class Hierarchy

Getting Support

Getting Support

Getting Support

Source Code for Module fedex.services.location_service

Class FedexSearchLocationRequest

__init__(self, + config_obj, + *args, + **kwargs) + (Constructor) +

_prepare_wsdl_objects(self) +

_assemble_and_send_request(self) +

Module package_movement

Source Code for Package fedex.tools

Module conversion

basic_sobject_to_dict(obj) +

sobject_to_dict(obj, + key_to_lower=False, + json_serialize=False) +

sobject_to_json(obj, + key_to_lower=False) +

Source Code for Module fedex.tools.conversion

The Navigation Bar

Identifier Index

Identifier Index

D

Identifier Index

Identifier Index

L

M

Identifier Index

Identifier Index

Identifier Index

Identifier Index

Identifier Index

Module Hierarchy

Module tools

Variables

Module conversion

Functions

Variables

Modules

init(self, + config_obj, + *args, + **kwargs) +
(Constructor) +