U
    «`”[¤  ã                   @   s8   d Z ddlmZmZ G dd„ deƒZG dd„ deƒZdS )z6
Generic sentence handling tools: hopefully reusable.
é    )Úabsolute_importÚdivisionc                   @   s:   e Zd ZdZeƒ Zdd„ Zedd„ ƒZdd„ Z	dd	„ Z
d
S )Ú_BaseSentencea-  
    A base sentence class for a particular protocol.

    Using this base class, specific sentence classes can almost automatically
    be created for a particular protocol.
    To do this, fill the ALLOWED_ATTRIBUTES class attribute using
    the C{getSentenceAttributes} class method of the producer::

        class FooSentence(BaseSentence):
            """
            A sentence for integalactic transmodulator sentences.

            @ivar transmogrificationConstant: The value used in the
                transmogrifier while producing this sentence, corrected for
                gravitational fields.
            @type transmogrificationConstant: C{Tummy}
            """
            ALLOWED_ATTRIBUTES = FooProtocol.getSentenceAttributes()

    @ivar presentAttributes: An iterable containing the names of the
        attributes that are present in this sentence.
    @type presentAttributes: iterable of C{str}

    @cvar ALLOWED_ATTRIBUTES: A set of attributes that are allowed in this
        sentence.
    @type ALLOWED_ATTRIBUTES: C{set} of C{str}
    c                 C   s
   || _ dS )z½
        Initializes a sentence with parsed sentence data.

        @param sentenceData: The parsed sentence data.
        @type sentenceData: C{dict} (C{str} -> C{str} or L{None})
        N)Ú_sentenceData)ÚselfZsentenceData© r   ú?/usr/lib/python3/dist-packages/twisted/positioning/_sentence.pyÚ__init__)   s    z_BaseSentence.__init__c                 C   s
   t | jƒS )zÑ
        An iterable containing the names of the attributes that are present in
        this sentence.

        @return: The iterable of names of present attributes.
        @rtype: iterable of C{str}
        )Úiterr   )r   r   r   r   ÚpresentAttributes3   s    	z_BaseSentence.presentAttributesc                 C   s8   || j kr| j |d¡S | jj}d||f }t|ƒ‚dS )z5
        Gets an attribute of this sentence.
        Nz"%s sentences have no %s attributes)ÚALLOWED_ATTRIBUTESr   ÚgetÚ	__class__Ú__name__ÚAttributeError)r   ÚnameÚ	classNameÚmsgr   r   r   Ú__getattr__?   s
    
z_BaseSentence.__getattr__c                 C   sL   | j  ¡ }dd„ t|ƒD ƒ}d |¡}| j  d¡p4d}| jj}d|||f S )z˜
        Returns a textual representation of this sentence.

        @return: A textual representation of this sentence.
        @rtype: C{str}
        c                 S   s$   g | ]\}}|d krd||f ‘qS )Útypez%s: %sr   )Ú.0ÚkÚvr   r   r   Ú
<listcomp>S   s      z*_BaseSentence.__repr__.<locals>.<listcomp>z, r   zunknown typez<%s (%s) {%s}>)r   ÚitemsÚsortedÚjoinr   r   r   )r   r   ÚdataZdataReprZtypeReprr   r   r   r   Ú__repr__K   s    

z_BaseSentence.__repr__N)r   Ú
__module__Ú__qualname__Ú__doc__Úsetr   r	   Úpropertyr   r   r   r   r   r   r   r   
   s   

r   c                   @   s   e Zd ZdZedd„ ƒZdS )Ú!_PositioningSentenceProducerMixina©  
    A mixin for certain protocols that produce positioning sentences.

    This mixin helps protocols that store the layout of sentences that they
    consume in a C{_SENTENCE_CONTENTS} class variable provide all sentence
    attributes that can ever occur. It does this by providing a class method,
    C{getSentenceAttributes}, which iterates over all sentence types and
    collects the possible sentence attributes.
    c                 C   s<   t dgƒ}| j ¡ D ]"}|D ]}|dkr*q| |¡ qq|S )aR  
        Returns a set of all attributes that might be found in the sentences
        produced by this protocol.

        This is basically a set of all the attributes of all the sentences that
        this protocol can produce.

        @return: The set of all possible sentence attribute names.
        @rtype: C{set} of C{str}
        r   N)r"   Z_SENTENCE_CONTENTSÚvaluesÚadd)ÚclsZ
attributesZattributeListZ	attributer   r   r   ÚgetSentenceAttributesg   s    
z7_PositioningSentenceProducerMixin.getSentenceAttributesN)r   r   r    r!   Úclassmethodr(   r   r   r   r   r$   ]   s   	r$   N)r!   Z
__future__r   r   Úobjectr   r$   r   r   r   r   Ú<module>   s   S