Suds генерирует пустые элементы; как их удалить?

Question

[Major Edit основанные на опыте, так как 1-й пост два дня назад.]

Я строю Python SOAP/XML скрипт, используя Suds, но я изо всех сил, чтобы получить код для создания SOAP/XML, который является приемлемым для сервера , Я думал, что проблема заключается в том, что Suds не генерировал префиксы для внутренних элементов, но впоследствии выясняется, что отсутствие префиксов (см. Sh-Data и внутренние элементы) не является проблемой, поскольку элементы Sh-Data и MetaSwitchData объявляют соответствующие пространства имен (см. ниже).

<SOAP-ENV:Envelope xmlns:ns3="http://www.metaswitch.com/ems/soap/sh" xmlns:ns0="http://www.metaswitch.com/ems/soap/sh/userdata" xmlns:ns1="http://www.metaswitch.com/ems/soap/sh/servicedata" xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> 
    <SOAP-ENV:Header/> 
    <ns2:Body> 
     <ns3:ShUpdate> 
     <ns3:UserIdentity>Meribel/TD Test Sub Gateway 3</ns3:UserIdentity> 
     <ns3:DataReference>0</ns3:DataReference> 
     <ns3:UserData> 
      <Sh-Data xmlns="http://www.metaswitch.com/ems/soap/sh/userdata"> 
       <RepositoryData> 
        <ServiceIndication>Meta_SubG_BaseInformation</ServiceIndication> 
        <SequenceNumber>0</SequenceNumber> 
        <ServiceData> 
        <MetaSwitchData xmlns="http://www.metaswitch.com/ems/soap/sh/servicedata" IgnoreSequenceNumber="False" MetaSwitchVersion="?"> 
         <Meta_SubG_BaseInformation Action="apply"> 
          <NetworkElementName>Meribel</NetworkElementName> 
          <Description>TD Test Sub Gateway 3</Description> 
          <DomainName>test.datcon.co.uk</DomainName> 
          <MediaGatewayModel>Cisco ATA</MediaGatewayModel> 
          <CallFeatureServerControlStatus/> 
          <CallAgentControlStatus/> 
          <UseStaticNATMapping/> 
          <AuthenticationRequired/> 
          <ProviderStatus/> 
          <DeactivationMode/> 
         </Meta_SubG_BaseInformation> 
        </MetaSwitchData> 
        </ServiceData> 
       </RepositoryData> 
      </Sh-Data> 
     </ns3:UserData> 
     <ns3:OriginHost>user@domain.com?clientVersion=7.3</ns3:OriginHost> 
     </ns3:ShUpdate> 
    </ns2:Body> 
</SOAP-ENV:Envelope> 

Но это все еще не удается. Проблема в том, что Suds генерирует пустые элементы для дополнительных элементов (помеченных как Mandatory = No в WSDL). Но сервер требует, чтобы дополнительный элемент либо присутствует с разумной стоимостью или отсутствуют, и я получаю следующее сообщение об ошибке (потому что <CallFeatureServerControlStatus/> элемент не является одним из допустимых значений.

The user data provided did not validate against the MetaSwitch XML Schema for user data.
Details: cvc-enumeration-valid: Value '' is not facet-valid with respect to enumeration '[Controlling, Abandoned, Cautiously controlling]'. It must be a value from the enumeration.

Если взять сгенерированный SOAP/XML в SoapUI и удалить пустые элементы, запрос работает просто отлично.

есть ли способ, чтобы получить Suds либо не создают пустые элементы для дополнительных полей, или для меня, чтобы удалить их в коде после этого?

Главное обновление

Я решил эту проблему (что я видел в другом месте), но довольно неэлегантно. Поэтому я отправляю свое текущее решение в надежде, что: а) он помогает другим и/или б) кто-то может предложить лучшую работу.

Оказалось, что проблема заключается не в том, что Suds генерирует пустые элементы для необязательных элементов (помеченных как Mandatory = No в WSDL). Но скорее, что Suds генерирует пустые элементы для необязательного комплекса элементов. Например, следующие элементы Meta_SubG_BaseInformation - это простые элементы, и Suds ничего не генерирует для них в SOAP/XML.

<xs:element name="CMTS" type="xs:string" minOccurs="0"> 
    <xs:annotation> 
     <xs:documentation> 
      <d:DisplayName firstVersion="5.0" lastVersion="7.4">CMTS</d:DisplayName> 
      <d:ValidFrom>5.0</d:ValidFrom> 
      <d:ValidTo>7.4</d:ValidTo> 
      <d:Type firstVersion="5.0" lastVersion="7.4">String</d:Type> 
      <d:BaseAccess firstVersion="5.0" lastVersion="7.4">RWRWRW</d:BaseAccess> 
      <d:Mandatory firstVersion="5.0" lastVersion="7.4">No</d:Mandatory> 
      <d:MaxLength firstVersion="5.0" lastVersion="7.4">1024</d:MaxLength> 
     </xs:documentation> 
    </xs:annotation> 
</xs:element> 

<xs:element name="TAGLocation" type="xs:string" minOccurs="0"> 
    <xs:annotation> 
     <xs:documentation> 
      <d:DisplayName>Preferred location of Trunk Gateway</d:DisplayName> 
      <d:Type>String</d:Type> 
      <d:BaseAccess>RWRWRW</d:BaseAccess> 
      <d:Mandatory>No</d:Mandatory> 
      <d:DefaultValue>None</d:DefaultValue> 
      <d:MaxLength>1024</d:MaxLength> 
     </xs:documentation> 
    </xs:annotation> 
</xs:element> 

В отличие от следующих Meta_SubG_BaseInformation элемент представляет собой сложный элемент, и даже тогда, когда это не является обязательным, и мой код не присваивает ему значение, он заканчивает тем, что в создаваемом SOAP/XML.

<xs:element name="ProviderStatus" type="tMeta_SubG_BaseInformation_ProviderStatus" minOccurs="0"> 
    <xs:annotation> 
     <xs:documentation> 
      <d:DisplayName>Provider status</d:DisplayName> 
      <d:Type>Choice of values</d:Type> 
      <d:BaseAccess>R-R-R-</d:BaseAccess> 
      <d:Mandatory>No</d:Mandatory> 
      <d:Values> 
       <d:Value>Unavailable</d:Value> 
       <d:Value>Available</d:Value> 
       <d:Value>Inactive</d:Value> 
       <d:Value>Active</d:Value> 
       <d:Value>Out of service</d:Value> 
       <d:Value>Quiescing</d:Value> 
       <d:Value>Unconfigured</d:Value> 
       <d:Value>Pending available</d:Value> 
      </d:Values> 
     </xs:documentation> 
    </xs:annotation> 
</xs:element> 

Suds генерирует следующее для ProviderStatus, которое (как указано выше) нарушает мой сервер.

<ProviderStatus/> 

Работа вокруг, чтобы установить все Meta_SubG_BaseInformation элементы None после создания родительского элемента, и перед присвоением значений, как показано в следующем. Это лишнее для простых элементов, но гарантирует, что не назначенные сложные элементы не приведут к созданию SOAP/XML.

subGatewayBaseInformation = client.factory.create('ns1:Meta_SubG_BaseInformation') 
for (el) in subGatewayBaseInformation: 
    subGatewayBaseInformation.__setitem__(el[0], None) 
subGatewayBaseInformation._Action   = 'apply' 
subGatewayBaseInformation.NetworkElementName = 'Meribel' 
etc... 

Это приводит к тому, что Suds генерирует SOAP/XML без пустых элементов, что приемлемо для моего сервера.

Но знает ли кто-нибудь о более чистом способе достижения такого же эффекта?

Решение будет основываться на ответах на ваши комментарии и комментарии как Душан, так и Роланд Смит.

Это решение использует Suds MessagePlugin, чтобы обрезать «пустой» XML формы <SubscriberType/>, прежде чем Suds отправит запрос на провод. Нам нужно только обрезать ShUpdates (где мы обновляем данные на сервере), а логика (особенно индексирование вниз для детей, чтобы получить список элементов служебной информации) очень специфично для WSDL. Это не сработает для разных WSDL.

class MyPlugin(MessagePlugin): 
    def marshalled(self, context): 
    pruned = [] 
    req = context.envelope.children[1].children[0] 
    if (req.name == 'ShUpdate'): 
     si = req.children[2].children[0].children[0].children[2].children[0].children[0] 
     for el in si.children: 
     if re.match('<[a-zA-Z0-9]*/>', Element.plain(el)): 
      pruned.append(el) 
     for p in pruned: 
     si.children.remove(p) 

И тогда нам просто нужно ссылаться на плагин при создании клиента.

client = Client(url, plugins=[MyPlugin()]) 

Answer 1

Вы можете фильтровать пустые элементы с помощью регулярного выражения.

Предполагая, что ваши данные XML находятся в строке xmltext;

import re 
filteredtext = re.sub('\s+<.*?/>', '', xmltext) 

Answer 2

Вы можете использовать плагин для изменения XML, прежде чем отправляется на сервер (мой ответ основан на решении Рональда Смита):

from suds.plugin import MessagePlugin 
from suds.client import Client 
import re 

class MyPlugin(MessagePlugin): 
    def sending(self, context): 
     context.envelope = re.sub('\s+<.*?/>', '', context.envelope) 


client = Client(URL_WSDL, plugins=[MyPlugin()]) 

Цитируя documentation:

The MessagePlugin currently has (5) hooks ::
(...)
sending()
Provides the plugin with the opportunity to inspect/modify the message text before it is sent.

В основном Suds вызовет sending перед отправкой XML, поэтому вы можете изменить сгенерированный XML (содержащийся в context.envelope). Для этого вам необходимо передать класс плагина MyPlugin в конструктор Client.

Редактировать

Другой способ заключается в использовании marshalled изменить структуру XML, удаление пустых элементов (непроверенный код):

class MyPlugin(MessagePlugin): 
    def marshalled(self, context): 
     #remove empty tags inside the Body element 
     #context.envelope[0] is the SOAP-ENV:Header element 
     context.envelope[1].prune() 

Answer 3

Я думал, что я разделю довольно простое обновление на решение выше, которое должно работать для любого WSDL: Обратите внимание, что метод отправки не требуется - это позволяет вам проверять свои изменения, так как печать запроса отладки клиента вызывает до, когда запускается метод маршала.

class XMLBS_Plugin(MessagePlugin): 
def marshalled(self, context): 
    def w(x): 
     if x.isempty(): 
      print "EMPTY: ", x 
      x.detach() 

    context.envelope.walk(w) 

def sending(self,context): 
    c = copy.deepcopy(context.envelope) 
    c=c.replace('><','>\n<') # some sort of readability 
    logging.info("SENDING: \n%s"%c) 

Answer 4

Что вы думаете о следующем MonkeyPatch пропустить сложные типы со значением None?

from suds.mx.literal import Typed 
old_skip = Typed.skip 
def new_skip(self, content): 
    x = old_skip(self, content) 
    if not x and getattr(content.value, 'value', False) is None: 
     x = True 
    return x 
Typed.skip = new_skip 

Answer 5

Я знаю, что этот был закрыт давным-давно, но после того, как я лично работаю над проблемой, я нахожу, что текущих ответов не хватает.

Использование метода отправки в MessagePlugin не будет работать, потому что, несмотря на то, что документация сильно подразумевает, вы не можете фактически изменить строку сообщения оттуда. Вы можете получить только конечный результат.

Метод маршаллинга, как упоминалось ранее, является лучшим для этого, так как он позволяет влиять на XML. Я создал следующий плагин, чтобы исправить эту проблему для себя:

class ClearEmpty(MessagePlugin): 
    def clear_empty_tags(self, tags): 
     for tag in tags: 
      children = tag.getChildren()[:] 
      if children: 
       self.clear_empty_tags(children) 
      if re.match(r'^<[^>]+?/>$', tag.plain()): 
       tag.parent.remove(tag) 

    def marshalled(self, context): 
     self.clear_empty_tags(context.envelope.getChildren()[:]) 

Это устранит все пустые теги.Вы можете настроить это по мере необходимости, если вам нужно только удалить некоторые пустые теги из какого-либо места, но эта рекурсивная функция работает и (если ваша XML-схема не настолько невыразимо плоха, чтобы иметь вложенность больше, чем глубина вызова Python), не следует вызывают проблему. Обратите внимание, что мы копируем списки здесь, потому что использование remove() управляет ими, когда мы итерации и вызываем проблемы.

На дополнительной ноте, регулярное выражение, которое было дано в других ответов bad-- \s+<.*?/> используется на <test> <thingus/> </test> будет соответствовать <test> <thingus/>, а не только <thingus/>, как вы могли бы ожидать. Это связано с тем, что > считается «любым персонажем» .. Если вам действительно нужно использовать регулярное выражение для исправления этой проблемы при визуализированном XML (Примечание: XML - сложный синтаксис, который лучше обрабатывается лексером), правильным будет <[^>]*/>.

Мы используем его здесь, потому что я не мог найти наиболее правильный способ попросить lexer '- это отдельный пустой тег', кроме того, чтобы проверить полученный результат этого тега и регулярное выражение. В этом случае я также добавил маркеры ^ и $, потому что рендеринг тега в этом методе отображает весь его контекст, и это означает, что любой пустой тег под конкретным тегом будет согласован. Мы просто хотим, чтобы один конкретный тег был сопоставлен, поэтому мы можем сказать API удалить его из дерева.

Наконец, чтобы помочь тем, кто ищет то, что могло бы подсказали этот вопрос, в первую очередь, вопрос подошел для меня, когда я получил сообщение об ошибке, как это:

cvc-enumeration-valid: Value '' is not facet-valid with respect to enumeration 

Это происходит потому, что пустой тег заставляет сервер интерпретировать все, что было бы под этим тегом, как нулевые значения/пустые строки.

Answer 6

Там еще более простой способ - нет необходимости в Reg Ex или возбуждающих итераторы;)

Во-первых, определить плагин:

class PrunePlugin(MessagePlugin): 
    def marshalled(self, context): 
     context.envelope = context.envelope.prune() 

Затем использовать его при создании клиента:

client = Client(url, plugins=[PrunePlugin()]) 

Метод prune() удалит все пустые узлы, как указано здесь: http://jortel.fedorapeople.org/suds/doc/suds.sax.element.Element-class.html

Answer 7

Метод фабрики Suds генерирует обычный объект Python с регулярными атрибутами python, которые сопоставляются с определением типа WSDL.

Вы можете использовать встроенную функцию del, чтобы удалить атрибуты.

>>> order_details = c.factory.create('ns2:OrderDetails') 
>>> order_details 
(OrderDetails){ 
    Amount = None 
    CurrencyCode = None 
    OrderChannelType = 
     (OrderChannelType){ 
     value = None 
     } 
    OrderDeliveryType = 
     (OrderDeliveryType){ 
     value = None 
     } 
    OrderLines = 
     (ArrayOfOrderLine){ 
     OrderLine[] = <empty> 
     } 
    OrderNo = None 
    TotalOrderValue = None 
} 
>>> del order_details.OrderLines 
>>> del order_details.OrderDeliveryType 
>>> del order_details.OrderChannelType 
>>> order_details 
(OrderDetails){ 
    Amount = None 
    CurrencyCode = None 
    OrderNo = None 
    TotalOrderValue = None 
}