← Back
Editing: flavors.cpython-38.pyc
U ��W[�[ � @ s� d Z ddlmZmZ ddlZddlmZmZ ddlm Z m Z ddl m Z m Z mZmZ ddlmZmZmZmZmZmZmZmZmZ eZeZeZ eZ d Z d Z d Z d Z!G d d� de"�Z#G dd� de�Z$G dd� de�Z%G dd� de%�Z&ee$�G dd� de&��Z'G dd� de&�Z(G dd� de%�Z)G dd � d e%�Z*G d d � d e*�Z+G d d � d e�Z,G d!d"� d"e,e%�Z-d#d$� Z.ed%e.� d&d'� Z/ed(e/� d)d*� Z0ed+e0� eG d,d-� d-��Z1eG d.d/� d/��Z2dS )0a� This module represents flavors of remotely accessible objects. Currently this is only objects accessible through Perspective Broker, but will hopefully encompass all forms of remote access which can emulate subsets of PB (such as XMLRPC or SOAP). Future Plans: Optimization. Exploitation of new-style object model. Optimizations to this module should not affect external-use semantics at all, but may have a small impact on users who subclass and override methods. @author: Glyph Lefkowitz � )�absolute_import�divisionN)� implementer� Interface)�log�reflect)�_PY3�unicode� comparable�cmp� ) �setUnjellyableForClass�setUnjellyableForClassTree� setUnjellyableFactoryForClass�unjellyableRegistry� Jellyable� Unjellyable�setInstanceState�getInstanceState� _createBlanks copy� caches cached� remotec @ s e Zd ZdZdS )� NoSuchMethodz(Raised if there is no such remote methodN)�__name__� __module__� __qualname__�__doc__� r r �8/usr/lib/python3/dist-packages/twisted/spread/flavors.pyr 2 s r c @ s e Zd ZdZdd� ZdS )�IPBRootz6Factory for root Referenceable objects for PB servers.c C s dS )z%Return root Referenceable for broker.Nr )�brokerr r r � rootObject9 s zIPBRoot.rootObjectN�r r r r r! r r r r r 6 s r c @ s e Zd ZdZdd� ZdS )� Serializableax An object that can be passed remotely. I am a style of object which can be serialized by Perspective Broker. Objects which wish to be referenceable or copied remotely have to subclass Serializable. However, clients of Perspective Broker will probably not want to directly subclass Serializable; the Flavors of transferable objects are listed below. What it means to be "Serializable" is that an object can be passed to or returned from a remote method. Certain basic types (dictionaries, lists, tuples, numbers, strings) are serializable by default; however, classes need to choose a specific serialization style: L{Referenceable}, L{Viewable}, L{Copyable} or L{Cacheable}. You may also pass C{[lists, dictionaries, tuples]} of L{Serializable} instances to or return them from remote methods, as many levels deep as you like. c C s t | �S )z�Return an ID which uniquely represents this object for this process. By default, this uses the 'id' builtin, but can be overridden to indicate that two values are identity-equivalent (such as proxies for the same object). )�id��selfr r r �processUniqueIDQ s z Serializable.processUniqueIDN)r r r r r' r r r r r# = s r# c @ s e Zd ZdZdd� Zdd� ZdS )� ReferenceableNc C s� |� |�}|� |�}dd� |�� D �r<tdd� |�� D ��}t|t�sP|�d�}t| d| d�}|dkrvtd|f ��z|||�}W n* t k r� t � d |||f � � Y nX |� || j �S ) z�A remote message has been received. Dispatch it appropriately. The default implementation is to dispatch to a method called 'remote_messagename' and call it with the same arguments. c S s g | ]}t |t�r|�qS r )� isinstance�bytes)�.0�keyr r r � <listcomp>s s z7Referenceable.remoteMessageReceived.<locals>.<listcomp>c s s | ]\}}|� d �|fV qdS )�utf8N)�decode)r+ �k�vr r r � <genexpr>t s z6Referenceable.remoteMessageReceived.<locals>.<genexpr>r. z remote_%sNzNo such method: remote_%s�%s didn't accept %s and %s)� unserialize�keys�dict�itemsr) �strr/ �getattrr � TypeErrorr �msg� serialize� perspective�r& r �message�args�kw�method�stater r r �remoteMessageReceivedh s z#Referenceable.remoteMessageReceivedc C s d|j �| �gS )zw(internal) Return a tuple which will be used as the s-expression to serialize this to a peer. r )�invokerZregisterReference�r& �jellierr r r �jellyFor� s zReferenceable.jellyFor)r r r r= rD rH r r r r r( [ s r( c @ s e Zd ZdZdd� ZdS )�Roota I provide a root object to L{pb.Broker}s for a L{pb.PBClientFactory} or L{pb.PBServerFactory}. When a factory produces a L{pb.Broker}, it supplies that L{pb.Broker} with an object named "root". That object is obtained by calling my rootObject method. c C s | S )z�A factory is requesting to publish me as a root object. When a factory is sending me as the root object, this method will be invoked to allow per-broker versions of an object. By default I return myself. r )r& r r r r r! � s zRoot.rootObjectNr" r r r r rI � s rI c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) � ViewPointaF I act as an indirect reference to an object accessed through a L{pb.IPerspective}. Simply put, I combine an object with a perspective so that when a peer calls methods on the object I refer to, the method will be invoked with that perspective as a first argument, so that it can know who is calling it. While L{Viewable} objects will be converted to ViewPoints by default when they are returned from or sent as arguments to a remote method, any object may be manually proxied as well. (XXX: Now that this class is no longer named C{Proxy}, this is the only occurrence of the term 'proxied' in this docstring, and may be unclear.) This can be useful when dealing with L{pb.IPerspective}s, L{Copyable}s, and L{Cacheable}s. It is legal to implement a method as such on a perspective:: | def perspective_getViewPointForOther(self, name): | defr = self.service.getPerspectiveRequest(name) | defr.addCallbacks(lambda x, self=self: ViewPoint(self, x), log.msg) | return defr This will allow you to have references to Perspective objects in two different ways. One is through the initial 'attach' call -- each peer will have a L{pb.RemoteReference} to their perspective directly. The other is through this method; each peer can get a L{pb.RemoteReference} to all other perspectives in the service; but that L{pb.RemoteReference} will be to a L{ViewPoint}, not directly to the object. The practical offshoot of this is that you can implement 2 varieties of remotely callable methods on this Perspective; view_xxx and C{perspective_xxx}. C{view_xxx} methods will follow the rules for ViewPoint methods (see ViewPoint.L{remoteMessageReceived}), and C{perspective_xxx} methods will follow the rules for Perspective methods. c C s || _ || _dS )z8Initialize me with a Perspective and an Object. N)r= �object)r& r= rK r r r �__init__� s zViewPoint.__init__c C s t | j�t | j�fS )zPReturn an ID unique to a proxy for this perspective+object combination. )r$ r= rK r% r r r r' � s zViewPoint.processUniqueIDc C s� |� || j�}|� || j�}t|t�s0|�d�}t| jd| �}z|| jf| |�}W n* tk r� t� d|||f � � Y nX |� || j|||�}|S )a7 A remote message has been received. Dispatch it appropriately. The default implementation is to dispatch to a method called 'C{view_messagename}' to my Object and call it on my object with the same arguments, modified by inserting my Perspective as the first argument. r. zview_%sr3 ) r4 r= r) r8 r/ r9 rK r: r r; r< )r& r r? r@ rA rB rC �rvr r r rD � s z ViewPoint.remoteMessageReceivedN)r r r r rL r' rD r r r r rJ � s 'rJ c @ s e Zd ZdZdd� ZdS )�ViewableaB I will be converted to a L{ViewPoint} when passed to or returned from a remote method. The beginning of a peer's interaction with a PB Service is always through a perspective. However, if a C{perspective_xxx} method returns a Viewable, it will be serialized to the peer as a response to that method. c C s t |jj| ��|�S )zQSerialize a L{ViewPoint} for me and the perspective of the given broker. )rJ rE �serializingPerspectiverH rF r r r rH � s zViewable.jellyForN)r r r r rH r r r r rN � s rN c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd S ) �Copyablea� Subclass me to get copied each time you are returned from or passed to a remote method. When I am returned from or passed to a remote method call, I will be converted into data via a set of callbacks (see my methods for more info). That data will then be serialized using Jelly, and sent to the peer. The peer will then look up the type to represent this with; see L{RemoteCopy} for details. c C s | j S )z�Gather state to send when I am serialized for a peer. I will default to returning self.__dict__. Override this to customize this behavior. )�__dict__r% r r r �getStateToCopy s zCopyable.getStateToCopyc C s | � � S )z� Gather state to send when I am serialized for a particular perspective. I will default to calling L{getStateToCopy}. Override this to customize this behavior. )rR �r& r= r r r �getStateToCopyFor s zCopyable.getStateToCopyForc C s t �| j��d�S )z�Determine what type tag to send for me. By default, send the string representation of my class (package.module.Class); normally this is adequate, but you may override this to change it. �utf-8)r Zqual� __class__�encoder% r r r � getTypeToCopy s zCopyable.getTypeToCopyc C s | � � S )z�Determine what type tag to send for me. By default, defer to self.L{getTypeToCopy}() normally this is adequate, but you may override this to change it. )rX rS r r r �getTypeToCopyFor& s zCopyable.getTypeToCopyForc C sZ |j dkrt| |�S |j j}| �|�}| �|�}|�| �}|�||�|�g� |�| |�S )z�Assemble type tag and state to copy for this broker. This will call L{getTypeToCopyFor} and L{getStateToCopy}, and return an appropriate s-expression to represent me. N) rE r rO rY rT �prepare�extend�jelly�preserve)r& rG �p�trC Zsxpr r r rH / s zCopyable.jellyForN) r r r r rR rT rX rY rH r r r r rP � s rP c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) � Cacheablea� A cached instance. This means that it's copied; but there is some logic to make sure that it's only copied once. Additionally, when state is retrieved, it is passed a "proto-reference" to the state as it will exist on the client. XXX: The documentation for this class needs work, but it's the most complex part of PB and it is inherently difficult to explain. c C s | � |�S )a- Get state to cache on the client and client-cache reference to observe locally. This is similar to getStateToCopyFor, but it additionally passes in a reference to the client-side RemoteCache instance that will be created when it is unserialized. This allows Cacheable instances to keep their RemoteCaches up to date when they change, such that no changes can occur between the point at which the state is initially copied and the client receives it that are not propagated. )rT �r& r= �observerr r r � getStateToCacheAndObserveForL s z&Cacheable.getStateToCacheAndObserveForc C s� |j dkrt| |�S |j �| d�}|dkr�|j �| �}|j j}| �|�}t|j | |�}| �||�}|�| �}|� |�}|� |||g� |� | |�S t |fS dS )z�Return an appropriate tuple to serialize me. Depending on whether this broker has cached me or not, this may return either a full state or a reference to an existing cache. Nr ) rE r �cachedRemotelyAsZ cacheRemotelyrO rY �RemoteCacheObserverrc rZ r\ r[ r] � cached_atom) r& rG �luidr^ Ztype_rb rC �lZjstater r r rH \ s zCacheable.jellyForc C s dS )z�This method is called when a client has stopped observing me. The 'observer' argument is the same as that passed in to getStateToCacheAndObserveFor. Nr ra r r r �stoppedObservingr s zCacheable.stoppedObservingN)r r r r rc rH ri r r r r r` @ s r` c @ s e Zd ZdZdd� Zdd� ZdS )� RemoteCopya I am a remote copy of a Copyable object. When the state from a L{Copyable} object is received, an instance will be created based on the copy tags table (see setUnjellyableForClass) and sent the L{setCopyableState} message. I provide a reasonable default implementation of that message; subclass me if you wish to serve as a copier for remote data. NOTE: copiers are invoked with no arguments. Do not implement a constructor which requires args in a subclass of L{RemoteCopy}! c C s t rdd� |�� D �}|| _dS )a( I will be invoked with the state to copy locally. 'state' is the data returned from the remote object's 'getStateToCopyFor' method, which will often be the remote object's dictionary (or a filtered approximation of it depending on my peer's perspective). c S s* i | ]"\}}t |t�r |�d �n||�qS )r. )r) r* r/ )r+ �x�yr r r � <dictcomp>� s � z/RemoteCopy.setCopyableState.<locals>.<dictcomp>N)r r7 rQ )r& rC r r r �setCopyableState� s �zRemoteCopy.setCopyableStatec C s. |j d krt| ||�S | �|�|d �� | S �Nr )rE r rn �unjelly)r& � unjellier� jellyListr r r � unjellyFor� s zRemoteCopy.unjellyForN)r r r r rn rs r r r r rj { s rj c @ sP e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd Z d Z d d� Z dd� Z d S )� RemoteCachea� A cache is a local representation of a remote L{Cacheable} object. This represents the last known state of this object. It may also have methods invoked on it -- in order to update caches, the cached class generates a L{pb.RemoteReference} to this object as it is originally sent. Much like copy, I will be invoked with no arguments. Do not implement a constructor that requires arguments in one of my subclasses. c C s� t |t�s|�d�}|�|�}|�|�}t| d| �}z|||�}W n* tk rn t�d|||f � � Y nX |�|d|||�S )z�A remote message has been received. Dispatch it appropriately. The default implementation is to dispatch to a method called 'C{observe_messagename}' and call it on my with the same arguments. r. z observe_%sr3 N) r) r8 r/ r4 r9 r: r r; r< r> r r r rD � s z!RemoteCache.remoteMessageReceivedc C s2 |j dkrt| |�S |j | jks(td��d| jfS )zTserialize me (only for the broker I'm for) as the original cached reference Nz3You cannot exchange cached proxies between brokers.s lcache)rE r r �AssertionErrorrg rF r r r rH � s zRemoteCache.jellyForc C s� |j d krt| ||�S |j | _|d | _| �� }t|dd �}|rF|� |j �|d | � |�|�|d �� |j | _ |j | _|d | _|S )Nr rL � ) rE r r rg �_borgifyr9 Z cacheLocallyrn rp rQ )r& rq rr ZborgCopyZinitr r r rs � s zRemoteCache.unjellyForc C s6 t || j�r"tt| j�t|j��S tt| j�|�S dS )z,Compare me [to another RemoteCache. N)r) rV r r$ rQ �r& �otherr r r �__cmp__� s zRemoteCache.__cmp__c C s t t| j�tj �S )zHash me. )�intr$ rQ �sys�maxsizer% r r r �__hash__� s zRemoteCache.__hash__Nc C s2 z| j r| j �| j� W n t�� Y nX dS )z7Do distributed reference counting on finalize. N)r Z decCacheRefrg r Zdeferrr% r r r �__del__� s zRemoteCache.__del__c C s t | j�}| j|_|S )a� Create a new object that shares its state (i.e. its C{__dict__}) and type with this object, but does not share its identity. This is an instance of U{the Borg design pattern <https://code.activestate.com/recipes/66531/>} originally described by Alex Martelli, but unlike the example given there, this is not a replacement for a Singleton. Instead, it is for lifecycle tracking (and distributed garbage collection). The purpose of these separate objects is to have a separate object tracking each application-level reference to the root L{RemoteCache} object being tracked by the broker, and to have their C{__del__} methods be invoked. This may be achievable via a weak value dictionary to track the root L{RemoteCache} instances instead, but this implementation strategy predates the availability of weak references in Python. @return: The new instance. @rtype: C{self.__class__} )r rV rQ )r& Zblankr r r rw � s zRemoteCache._borgify) r r r r rD rH rs rz r~ r rg r rw r r r r rt � s rt c C s |d }| j �|��� S ro )rE ZcachedLocallyAsrw )rq � unjellyListrg r r r � unjellyCached s r� �cachedc C s |d }| j �|�}|S ro )rE ZremotelyCachedForLUID)rq r� rg �objr r r � unjellyLCache s r� Zlcachec C s | j �|d �}|S ro )rE ZlocalObjectForID)rq r� r� r r r � unjellyLocal" s r� Zlocalc @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) �RemoteCacheMethodz1A method on a reference to a L{RemoteCache}. c C s || _ || _|| _|| _dS )z (internal) initialize. N)�namer r= r� )r& r� r r� r= r r r rL - s zRemoteCacheMethod.__init__c C s t | j| j| j| jf|�S �N)r r� r r= r� rx r r r rz 5 s zRemoteCacheMethod.__cmp__c C s t | j| j| j| jf�S r� )�hashr� r r= r� r% r r r r~ 8 s zRemoteCacheMethod.__hash__c O sD | j �| j�}|dkr*ddlm} |d��| j �d| j|| j||�S )�"(internal) action method. Nr �� ProtocolError�QYou can't call a cached method when the object hasn't been given to the peer yet.r )r rd r� �pbr� � _sendMessager= r� )r& r@ rA �cacheIDr� r r r �__call__; s �zRemoteCacheMethod.__call__N)r r r r rL rz r~ r� r r r r r� ( s r� c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )re a6 I am a reverse-reference to the peer's L{RemoteCache}. I am generated automatically when a cache is serialized. I represent a reference to the client's L{RemoteCache} object that will represent a particular L{Cacheable}; I am the additional object passed to getStateToCacheAndObserveFor. c C s || _ || _|| _dS )a (internal) Initialize me. @param broker: a L{pb.Broker} instance. @param cached: a L{Cacheable} instance that this L{RemoteCacheObserver} corresponds to. @param perspective: a reference to the perspective who is observing this. N)r r� r= )r& r r� r= r r r rL Q s z RemoteCacheObserver.__init__c C s d| j | j| jt| �f S )Nz'<RemoteCacheObserver(%s, %s, %s) at %s>)r r� r= r$ r% r r r �__repr__` s �z RemoteCacheObserver.__repr__c C s* t | j�d t | j�d t | j�d S )ziGenerate a hash unique to all L{RemoteCacheObserver}s for this broker/perspective/cached triplet i )r� r r= r� r% r r r r~ d s � �z RemoteCacheObserver.__hash__c C s t | j| j| jf|�S )z6Compare me to another L{RemoteCacheObserver}. )r r r= r� rx r r r rz l s zRemoteCacheObserver.__cmp__c O sV | j �| j�}t|t�r"|�d�}|dkr>ddlm} |d��| j �d| j ||||�S )r� rU Nr r� r� r ) r rd r� r) r rW r� r� r� r= )r& �_namer@ rA r� r� r r r � callRemoter s �z RemoteCacheObserver.callRemotec C s t || j| j| j�S )z/Get a L{pb.RemoteMethod} for this key. )r� r r� r= )r& r, r r r � remoteMethod s z RemoteCacheObserver.remoteMethodN) r r r r rL r� r~ rz r� r� r r r r re G s re )3r Z __future__r r r| Zzope.interfacer r Ztwisted.pythonr r Ztwisted.python.compatr r r r r\ r r r r r r r r r ZsetCopierForClassZsetCopierForClassTreeZsetFactoryForClassZcopyTagsZ copy_atomZ cache_atomrf Z remote_atom�AttributeErrorr r r# r( rI rJ rN rP r` rj rt r� r� r� r� re r r r r �<module> sH , 2KD;"x
Save File
Cancel