phillbaker
commented
2 years ago Hi @tpow thanks for opening an issue and for providing a test case, that's fantastic.
My guess is that multi_occurrence() needs to look recursively into the nesting before failing. In our case the top level is optional, but the next is not.
To clarify here, Payments, Charges, Refunds, Voids are marked as optional with the minOccurs="0":
<s:element minOccurs="0" maxOccurs="1" name="Payments" type="s1:ArrayOfPaymentInMsg" />
<s:element minOccurs="0" maxOccurs="1" name="Charges" type="s1:ArrayOfChargeInMsg" />
<s:element minOccurs="0" maxOccurs="1" name="Refunds" type="s1:ArrayOfRefundInMsg" />
<s:element minOccurs="0" maxOccurs="1" name="Voids" type="s1:ArrayOfVoidInMsg" />where is the next level marked as required? Does the WSDL itself leave these objects as optional, but the server interpretation require them?
req.Charges.ChargeInMsg = [sample_charge,] # if req.Charges is None, cannot do above, but # the following doesn't seem to work correctly # req.Charges = [sample_charge,]
Would something like req.Charges = client.factory.create("ns1:ArrayOfChargeInMsg") work?
Since this is less convenient and a pain to convert codebases if you're trying to convert to suds-community, one workaround is here: https://github.com/BingAds/BingAds-Python-SDK/commit/8d1a51595f9f4776d2b719be7f3fc1378cee4f4f#diff-84a7c57706647cffbba7321972ce82a9aa06e7d49b8c32b4d7a34417ffba9e45R13, provide a custom Builder class to client.factory.builder that has the desired behavior.
Since this has come up a few times, I could see a few options going forward:
- Update the code if there is a way to determine whether the attribute is optional by examining the WSDL
- Add an explicit configuration option to the top level suds client configuring this
- Refactor the Builder class to extract a method to determine if a node should be built. By default it would have the current implementation, but could be more easily subclassed and overridden without having to duplicate logic. E.g.
class Builder: # ... def skip_value(self, type): """ get whether or not to skip setting the value """ return type.optional() and not type.multi_occurrence()
class MyBuilder: def skip_value(self, type): return False # always set value
What do you think?
tpow
We recently evaluated switching to suds-community from suds-jurko and found a compatibility problem. Elements that were previous populated with empty lists are now set to None. Here's the comparison:
suds-community gives this:
Versus suds-jurko:
I've dug in to the problem and narrowed it down to the change in behavior due to #14, #15, and #16. Reverting the changed line (as in
setattr(data, type.name, value) # if not type.optional() or type.multi_occurrence() else None)) in builder.py fixes the problem for us, but think I understand why the change was made in the first place so suspect that removing all of it is not the right solution.My guess is that
multi_occurrence()needs to look recursively into the nesting before failing. In our case the top level is optional, but the next is not.It is also possible that we aren't using suds correctly or misunderstand the structure somehow, but I can say that the code works with sud-jurko and not with suds-community.
Although the API we are calling is not public and is controlled by a vendor, I have built the following test that demonstrates the problem. If dropped into the test suite, it should run and fail. Note that this is a pruned down and somewhat modified version of the vendor's schema and almost certainly could be simplified more. Sorry that it is a bit noisy.
It looks like incorporating parts of this into the test suite, perhaps as an expansion to the changes made for the #16 pull request would be beneficial.
We would appreciate any clarification if we are misusing suds somehow and/or confirmation that this is a bug.
Thanks! Tim