File manager - Edit - /home/u478019808/domains/bestandroidphones.store/public_html/static/img/logo/base.tar
Back
__pycache__/__init__.cpython-39.pyc 0000644 00000000421 15025317163 0013144 0 ustar 00 a vyg� � @ s d Z ddlmZ eee�ZdS )z Shared __init__.py for apitools.� )� extend_pathN)�__doc__�pkgutilr �__path__�__name__� r r �:/opt/gsutil/third_party/apitools/apitools/base/__init__.py�<module> s py/__pycache__/extra_types.cpython-39.pyc 0000644 00000021455 15025317163 0014416 0 ustar 00 a vyg�& � @ s, d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m Z ejr�dd lmZ n dd lmZ g d �ZejZG d d � d ej�ZG d d� de�eej��Zdd� Zdd� Zdd� Zdd� ZdZ dZ dd� Z dd � Z d d � Z G d d � d ej!�Z"G d!d"� d"ej!�Z#G d#d$� d$ej!�Z$e$ee#ee"eiZ%e&e%�'� �Z(d%d&� Z)d'd(� Z*d<d)d*�Z+d=d+d,�Z,d>d-d.�Z-e+Z.e,Z/e j0e.e-d/�e"� e j0e.e/d/�e#� e j0e.e/d/�e$� d0d1� Z1d2d3� Z2e �3e1e2�ej4� d4d5� Z5d6d7� Z6e �3e5e6�ej7� d8d9� Z8d:d;� Z9e �3e8e9�e� dS )?z#Extra types understood by apitools.� N)� message_types)�messages)� protojson)�encoding_helper)� exceptions)�util)�Iterable)� DateField�DateTimeMessage� JsonArray� JsonObject� JsonValue�JsonProtoEncoder�JsonProtoDecoderc @ s e Zd Zdd� ZdS )� _FieldMetac C s t �| |||� d S �N)�type�__init__)�cls�name�bases�dct� r �@/opt/gsutil/third_party/apitools/apitools/base/py/extra_types.pyr > s z_FieldMeta.__init__N)�__name__� __module__� __qualname__r r r r r r < s r c @ s, e Zd ZdZeejjg�ZejjZ e j Z dS )r z!Field definition for Date values.N) r r r �__doc__� frozensetr �Variant�STRING�VARIANTS�DEFAULT_VARIANT�datetime�dater r r r r r D s r c sB � fdd�� � � D �}dd� |D �}t|�dkr>t�d� ��d S )Nc s g | ]}|� � |j�f�qS r ��get_assigned_valuer ��.0�f�� json_valuer r � <listcomp>N s �z&_ValidateJsonValue.<locals>.<listcomp>c S s g | ]\}}|d ur||f�qS r r �r( r) �valuer r r r, P s �� �Malformed JsonValue: %s)� all_fields�lenr �InvalidDataError)r+ �entries�assigned_entriesr r* r �_ValidateJsonValueM s �� �r6 c s� t �� t� t� � � jr dS � fdd�� �� D �}dd� |D �}|d \}}t|tj�s^|S |j t u rpt |�S |j t u r�t |�S dS )z-Convert the given JsonValue to a json string.Nc s g | ]}|� � |j�f�qS r r% r' r* r r r, ] s �z+_JsonValueToPythonValue.<locals>.<listcomp>c S s g | ]\}}|d ur||f�qS r r r- r r r r, _ s �r )r � Typecheckr r6 �is_nullr1 � isinstancer � MessageField� message_typer �_JsonObjectToPythonValuer �_JsonArrayToPythonValue)r+ r4 r5 �fieldr. r r* r �_JsonValueToPythonValueW s" �� r? c C s t �| t� tdd� | jD ��S )Nc S s g | ]}|j t|j�f�qS r )�keyr? r. )r( �propr r r r, l � z,_JsonObjectToPythonValue.<locals>.<listcomp>)r r7 r �dict� propertiesr* r r r r< j s �r< c C s t �| t� dd� | jD �S )Nc S s g | ] }t |��qS r )r? )r( �er r r r, r rB z+_JsonArrayToPythonValue.<locals>.<listcomp>)r r7 r r4 r* r r r r= p s r= l l���� c C s� | du rt dd�S t| t�r&t | d�S t| tj�r<t | d�S t| tj�r�t| tj�rvt| k rht k rvn n t | d�S t t | �d�S t| t �r�t t | �d�S t| t �r�t t| �d �S t�d | ��dS ) z.Convert the given python value to a JsonValue.NT)r8 )� boolean_value)� string_value)� integer_value)� double_value�� object_value�� array_valuez Cannot convert "%s" to JsonValue)r r9 �bool�six� string_types�numbers�Number� integer_types� _MININT64� _MAXINT64�floatrC �_PythonValueToJsonObjectr �_PythonValueToJsonArrayr r3 �Zpy_valuer r r �_PythonValueToJsonValuey s$ �rZ c C s$ t �| t� tdd� | �� D �d�S )Nc S s" g | ]\}}t j|t|�d ��qS ))r@ r. )r �PropertyrZ )r( r@ r. r r r r, � s �z,_PythonValueToJsonObject.<locals>.<listcomp>)rD )r r7 rC r �itemsrY r r r rW � s ��rW c C s t ttt| ��d�S )N)r4 )r �list�maprZ rY r r r rX � s rX c @ sn e Zd ZdZejddd�Ze�d�Ze�d�Z ej dej j d�Z ejd ej jd�Ze�d d �Ze�d d �ZdS )r zAny valid JSON value.r/ F)�default� � � )�variant� r � r � N)r r r r r � BooleanFieldr8 rF � StringFieldrG � FloatFieldr �DOUBLErI � IntegerField�INT64rH r: rK rM r r r r r � s r c @ s2 e Zd ZdZG dd� dej�Zejeddd�ZdS )r z�A JSON object value. Messages: Property: A property of a JsonObject. Fields: properties: A list of properties of a JsonObject. c @ s& e Zd ZdZe�d�Ze�ed�Z dS )zJsonObject.Propertyz�A property of a JSON object. Fields: key: Name of the property. value: A JsonValue attribute. r/ r` N) r r r r r rh r@ r: r r. r r r r r[ � s r[ r/ T��repeatedN) r r r r r �Messager[ r: rD r r r r r � s r c @ s e Zd ZdZejeddd�ZdS )r zA JSON array value.r/ Trm N)r r r r r r: r r4 r r r r r � s r c C s t �| t� tt| � | �S r )r r7 �_JSON_PROTO_TYPES�_JSON_PROTO_TO_PYTHON_MAPr )� json_protor r r �_JsonProtoToPythonValue� s rs c C s8 t | t�rt| �S t | t�r0t | tj�s0t| �S t| �S r )r9 rC rW r rO rP rX rZ rY r r r �_PythonValueToJsonProto� s �rt c C s t �t| ��S r )�json�dumpsrs )rr Zunused_encoderr r r �_JsonProtoToJson� s rw c C s t t�| ��S r )rt ru �loads)� json_data�unused_decoderr r r �_JsonToJsonProto� s r{ c C sV t t�| ��}t|t�r |S t|t�r0t|d�S t|t�rDt|d�S t�d| ��d S )NrJ rL r0 ) rt ru rx r9 r r r r r3 )ry rz �resultr r r �_JsonToJsonValue� s �r} )�encoder�decoderc C s t �� �| |�}tj|dd�S )NT�r. �complete)r � ProtoJson� encode_field�encoding� CodecResult�r> r. r| r r r �_EncodeDateTimeField s r� c C s$ t �� �t�d�|�}tj|dd�S )Nr/ Tr� )r r� � decode_fieldr � DateTimeFieldr� r� )� unused_fieldr. r| r r r �_DecodeDateTimeField s �r� c C sT t jjt jjg}| j|vr(tj|dd�S | jr>dd� |D �}nt|�}tj|dd�S )z-Handle the special case of int64 as a string.Fr� c S s g | ] }t |��qS r )�str)r( �xr r r r, rB z%_EncodeInt64Field.<locals>.<listcomp>T) r r rl �UINT64rc r� r� rn r� )r> r. � capabilitiesr| r r r �_EncodeInt64Field s � r� c C s t j|dd�S )NFr� )r� r� )r� r. r r r �_DecodeInt64Field! s r� c C s, | j rdd� |D �}n|�� }tj|dd�S )z"Encoder for datetime.date objects.c S s g | ] }|� � �qS r )� isoformat)r( �dr r r r, - rB z$_EncodeDateField.<locals>.<listcomp>Tr� )rn r� r� r� r� r r r �_EncodeDateField* s r� c C s t j �|d��� }tj|dd�S )Nz%Y-%m-%dTr� )r# �strptimer$ r� r� )r� r. r$ r r r �_DecodeDateField3 s r� )N)N)N):r r# ru rQ rO �apitools.base.protorpcliter r r �apitools.base.pyr r� r r �PY3�collections.abcr � collections�__all__r r �with_metaclass�Fieldr r6 r? r< r= rU rT rZ rW rX ro r r r rq �tuple�keysrp rs rt rw r{ r} r r �RegisterCustomMessageCodecr� r� �RegisterFieldTypeCodecr� r� r� rk r� r� r r r r �<module> s� � ������ � � py/__pycache__/buffered_stream.cpython-39.pyc 0000644 00000004442 15025317163 0015201 0 ustar 00 a vyg � @ s$ d Z ddlmZ G dd� de�ZdS )zSmall helper class to provide a small slice of a stream. This class reads ahead to detect if we are at the end of the stream. � )� exceptionsc @ sV e Zd ZdZdd� Zdd� Zdd� Zedd � �Zed d � �Z ed d � �Z ddd�Z dS )�BufferedStreamzABuffers a stream, reading ahead to determine if we're at the end.c C sF || _ || _d| _| j �|�| _t| j�|k | _| jt| j� | _d S )Nr )�_BufferedStream__stream�_BufferedStream__start_pos�_BufferedStream__buffer_pos�read� _BufferedStream__buffered_data�len� _BufferedStream__stream_at_end�_BufferedStream__end_pos)�self�stream�start�size� r �D/opt/gsutil/third_party/apitools/apitools/base/py/buffered_stream.py�__init__ s zBufferedStream.__init__c C s d| j | j| j| jf S )Nz>Buffered stream %s from position %s-%s with %s bytes remaining)r r r �_bytes_remaining�r r r r �__str__& s ��zBufferedStream.__str__c C s t | j�S �N)r r r r r r �__len__+ s zBufferedStream.__len__c C s | j S r )r r r r r �stream_exhausted. s z BufferedStream.stream_exhaustedc C s | j S r )r r r r r �stream_end_position2 s z"BufferedStream.stream_end_positionc C s t | j�| j S r )r r r r r r r r 6 s z BufferedStream._bytes_remainingNc C sn |du s|dk r0t �d|| j| j| j| jf ��d}| jrjt|| j�}| j| j| j| � }| j|7 _|S )zReads from the buffer.Nr zpIllegal read of size %s requested on BufferedStream. Wrapped stream %s is at position %s-%s, %s bytes remaining.� ) r �NotYetImplementedErrorr r r r �minr r )r r �datar r r r : s ��� �zBufferedStream.read)N) �__name__� __module__� __qualname__�__doc__r r r �propertyr r r r r r r r r s r N)r! �apitools.base.pyr �objectr r r r r �<module> s py/__pycache__/compression.cpython-39.pyc 0000644 00000010261 15025317163 0014401 0 ustar 00 a vyg � @ s@ d Z ddlmZ ddlmZ dgZd dd�ZG d d � d e�ZdS ) z!Compression support for apitools.� )�deque)�gzip�CompressStreamN� � c C s� d}d}t � }tjd||d��R}|r.|j|k rb| �|�}t|�} |�|� || 7 }| |k r d}qbq W d � n1 sv0 Y |||fS )a� Compresses an input stream into a file-like buffer. This reads from the input stream until either we've stored at least length compressed bytes, or the input stream has been exhausted. This supports streams of unknown size. Args: in_stream: The input stream to read from. length: The target number of compressed bytes to buffer in the output stream. If length is none, the input stream will be compressed until it's exhausted. The actual length of the output buffer can vary from the target. If the input stream is exhaused, the output buffer may be smaller than expected. If the data is incompressible, the maximum length can be exceeded by can be calculated to be: chunksize + 5 * (floor((chunksize - 1) / 16383) + 1) + 17 This accounts for additional header data gzip adds. For the default 16MiB chunksize, this results in the max size of the output buffer being: length + 16Mib + 5142 bytes compresslevel: Optional, defaults to 2. The desired compression level. chunksize: Optional, defaults to 16MiB. The chunk size used when reading data from the input stream to write into the output buffer. Returns: A file-like output buffer of compressed bytes, the number of bytes read from the input stream, and a flag denoting if the input stream was exhausted. r F�wb)�mode�fileobj� compresslevelTN)�StreamingBufferr �GzipFile�length�read�len�write) Z in_streamr r � chunksizeZin_readZ in_exhaustedZ out_streamZcompress_stream�data� data_length� r �@/opt/gsutil/third_party/apitools/apitools/base/py/compression.pyr s" '� "c @ sF e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd d � Z dd d�Z d S )r z�Provides a file-like object that writes to a temporary buffer. When data is read from the buffer, it is permanently removed. This is useful when there are memory constraints preventing the entire buffer from being stored in memory. c C s t � | _d| _d S )Nr )r �_StreamingBuffer__buf�_StreamingBuffer__size��selfr r r �__init__a s zStreamingBuffer.__init__c C s | j S �N�r r r r r �__len__g s zStreamingBuffer.__len__c C s t | j�S r )�boolr r r r r � __nonzero__j s zStreamingBuffer.__nonzero__c C s | j S r r r r r r r o s zStreamingBuffer.lengthc C s. |d ur*|r*| j �|� | jt|�7 _d S r )r �appendr r )r r r r r r t s zStreamingBuffer.writeNc C s� |du r| j }g }|dkrB| jrB| j�� }|t|�8 }|�|� q|dk r||d d|� |d |d� |d< }| j�|� d�|�}| j t|�8 _ |S )aM Read at most size bytes from this buffer. Bytes read from this buffer are consumed and are permanently removed. Args: size: If provided, read no more than size bytes from the buffer. Otherwise, this reads the entire buffer. Returns: The bytes read from this buffer. Nr ���� )r r �popleftr r � appendleft�join)r �sizeZret_listr � remainder�retr r r r { s & zStreamingBuffer.read)N) �__name__� __module__� __qualname__�__doc__r r r �propertyr r r r r r r r X s r )Nr r ) r, � collectionsr �apitools.base.pyr �__all__r �objectr r r r r �<module> s � � : py/__pycache__/stream_slice.cpython-39.pyc 0000644 00000004374 15025317163 0014522 0 ustar 00 a vyg� � @ s$ d Z ddlmZ G dd� de�ZdS )z8Small helper class to provide a small slice of a stream.� )� exceptionsc @ sF e Zd ZdZdd� Zdd� Zdd� Zdd � Zed d � �Z dd d�Z d S )� StreamSlicez)Provides a slice-like object for streams.c C s || _ || _|| _d S �N��_StreamSlice__stream� _StreamSlice__remaining_bytes�_StreamSlice__max_bytes)�self�streamZ max_bytes� r �A/opt/gsutil/third_party/apitools/apitools/base/py/stream_slice.py�__init__ s zStreamSlice.__init__c C s d| j | j| jf S )Nz0Slice of stream %s with %s/%s bytes not yet readr �r r r r �__str__ s �zStreamSlice.__str__c C s | j S r �r r r r r �__len__# s zStreamSlice.__len__c C s t | j�S r )�boolr r r r r � __nonzero__& s zStreamSlice.__nonzero__c C s | j S r r r r r r �length+ s zStreamSlice.lengthNc C sf |durt || j�}n| j}| j�|�}|dkrP|sPt�d| j| j| j f ��| jt|�8 _|S )aG Read at most size bytes from this slice. Compared to other streams, there is one case where we may unexpectedly raise an exception on read: if the underlying stream is exhausted (i.e. returns no bytes on read), and the size of this slice indicates we should still be able to read more bytes, we raise exceptions.StreamExhausted. Args: size: If provided, read no more than size bytes from the stream. Returns: The bytes read from this slice. Raises: exceptions.StreamExhausted Nr z;Not enough bytes in stream; expected %d, exhausted after %d)�minr r �readr �StreamExhaustedr �len)r �sizeZ read_size�datar r r r 0 s ���zStreamSlice.read)N) �__name__� __module__� __qualname__�__doc__r r r r �propertyr r r r r r r s r N)r �apitools.base.pyr �objectr r r r r �<module> s py/__pycache__/credentials_lib.cpython-39.pyc 0000644 00000053247 15025317163 0015176 0 ustar 00 a vyg�u � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl m Z ddl mZ ddlZddlmZ ddlmZ ddlmZ dd lmZ zddlZd ZW nP e�y Z z6ej�d d �Z e � d �s�e � d�s�e�dZW Y dZ[n dZ[0 0 zddl m Z W n e�yB ddl m Z Y n0 zddl m Z d Z!W nJ e�y� dZ!zddl m"Z" W n e�y� ddl m"Z" Y n0 Y n0 zddl#Z#e#j$Z$W n e�y� dZ$Y n0 g d�Z%e�&� a'dd� Z(g Z)d6dd�Z*d7dd�Z+d8dd�Z,d d � Z-d9d d �Z.G d d!� d!e j/�Z0G d"d#� d#e j1j2�Z3d:d$d%�Z4d;d&d'�Z5G d(d)� d)e6�Z7d<d*d+�Z8d,d-� Z9e*d=d.d/��Z:e*d0d1� �Z;e*d2d3� �Z<e*d>d4d5��Z=dS )?z,Common credentials classes and constructors.� )�print_functionN)�service_account)�tools)� http_client)�urllib)� exceptions)�utilT�SERVER_SOFTWARE� Z DevelopmentzGoogle App EngineF)�gce)�multiprocess_file_storage)�multistore_file)�CredentialsFromFile�GaeAssertionCredentials�GceAssertionCredentials�GetCredentials� GetUserinfo�!ServiceAccountCredentialsFromFilec C s | a d S �N)�cache_file_lock)�lock� r �D/opt/gsutil/third_party/apitools/apitools/base/py/credentials_lib.py�SetCredentialsCacheFileLock_ s r c C s0 |du rt t�}nt|t t��}t�|| � | S )aP Register a new method for fetching credentials. This new method should be a function with signature: client_info, **kwds -> Credentials or None This method can be used as a decorator, unless position needs to be supplied. Note that method must *always* accept arbitrary keyword arguments. Args: method: New credential-fetching method. position: (default: None) Where in the list of methods to add this; if None, we append. In all but rare cases, this should be either 0 or None. Returns: method, for use as a decorator. N)�len�_CREDENTIALS_METHODS�min�insert)�method�positionr r r �_RegisterCredentialsMethodj s r c K s� t �|�}||d�t|��|p$d| d�} tD ]$} | | fi | ��} | dur.| S q.|pbtj�d�}t|| |d�} | dur~| S t � d��dS )zDAttempt to get credentials, using an oauth dance as the last resort.� z%s-generated/0.1)� client_id� client_secret�scope� user_agentNz~/.apitools.token)�oauth2client_argsz"Could not create valid credentials) r �NormalizeScopes�join�sortedr �os�path� expanduserr r �CredentialsError) � package_name�scopesr" r# r% �credentials_filename�api_key�clientr& �kwds� client_infor � credentialsr r r r � s& � ��r c C s� t j�| �} tjdkr@tjj| |d�}|dur<|dur<||_|S t | ��}t � |�}W d � n1 sh0 Y |� d�}|tj jkr�t�d| f ��tj|d |d |d |d ||d �}|S dS ) z=Use the credentials in filename to create a token for scopes.�1.5.2�r/ N�typez'Invalid service account credentials: %sr" � client_email�private_key_id� private_key)Zservice_account_id�service_account_emailr: Zprivate_key_pkcs8_textr/ r% )r* r+ r, � oauth2client� __version__r �ServiceAccountCredentialsZfrom_json_keyfile_namer% �open�json�load�getr2 �SERVICE_ACCOUNTr r- Z_ServiceAccountCredentials)�filenamer/ r% r5 �keyfileZservice_account_infoZ account_typer r r r � s2 �� ( ��r c C s� t j�|�}t�|�}tjdkrDtjj | ||d�}|dur@||_ |S t |d��(}tj j | |�� ||d�W d � S 1 s|0 Y dS )z4Create a new credential from the named .p12 keyfile.r6 r7 N�rb�r% )r* r+ r, r r' r= r> r r? Zfrom_p12_keyfiler% r@ r2 Z SignedJwtAssertionCredentials�read)�service_account_nameZprivate_key_filenamer/ r% r5 �key_filer r r �$ServiceAccountCredentialsFromP12File� s �� �rL c C s� |rt j�dd�}nt j�dd�}d| d | }ddi}tjj||d �}tj�tj�i ��}z|�|�}W n8 tj j y� } z t � d |j ��W Y d }~n d }~0 0 |S ) z4Request the given url from the GCE metadata service.�GCE_METADATA_IPz169.254.169.254�GCE_METADATA_ROOTzmetadata.google.internalzhttp://z/computeMetadata/v1/zMetadata-Flavor�Google)�headersz$Could not reach metadata service: %sN)r* �environrC r �request�Request� build_opener� ProxyHandlerr@ �error�URLErrorr �CommunicationError�reason) � relative_urlZuse_metadata_ip�base_url�urlrP rR �opener�response�er r r �_GceMetadataRequest� s ��r` c s� e Zd ZdZd � fdd� Zedd� �Zdd � Zd d � Zd d � Z dd� Z dd� Z dd� Z dd� Z � fdd�Zedd� �Zedd� �Z� ZS ) r z(Assertion credentials for GCE instances.N�defaultc s� t j|dd�| _d}|�d�}|r.| �||�}|p:| �|�}|rP|sP| �||� t�� �4 t� d� t t | �j f d|i|�� W d � n1 s�0 Y dS )aA Initializes the credentials instance. Args: scopes: The scopes to get. If None, whatever scopes that are available to the instance are used. service_account_name: The service account to retrieve the scopes from. **kwds: Additional keyword args. �utf-8��encodingN�cache_filename�ignorer$ ) �six� ensure_text�._GceAssertionCredentials__service_account_namerC �_CheckCacheFileForMatch�_ScopesFromMetadataServer�_WriteCacheFile�warnings�catch_warnings� simplefilter�superr �__init__)�selfr/ rJ r3 Z cached_scopesre �� __class__r r rq � s � � z GceAssertionCredentials.__init__c O s, z| |i |��W S t jy& Y d S 0 d S r �r �Error��cls�argsr3 r r r �Get s zGceAssertionCredentials.Getc C s� |rt t|��nd| jd�}t|�}zN|�� }|s8W dS t�|�}|d |d krp|d d|d fv rp|d W S W n ty� � Y n Y n0 dS )a Checks the cache file to see if it matches the given credentials. Args: cache_filename: Cache filename to check. scopes: Scopes for the desired credentials. Returns: List of scopes (if cache matches) or None. N�r/ � svc_acct_namer| r/ )r) �listri �_MultiProcessCacheFile� LockedReadrA �loads�KeyboardInterrupt)rr re r/ �creds� cache_fileZcached_creds_strZ cached_credsr r r rj s � z/GceAssertionCredentials._CheckCacheFileForMatchc C sb t dd� |D ��}|| jd�}t�|�}t|�}z|�|� W n tyR � Y n Y n0 dS )aB Writes the credential metadata to the cache file. This does not save the credentials themselves (CredentialStore class optionally handles that after this class is initialized). Args: cache_filename: Cache filename to check. scopes: Scopes for the desired credentials. c S s g | ]}t �|��qS r )rg rh ��.0r$ r r r � <listcomp>C � z;GceAssertionCredentials._WriteCacheFile.<locals>.<listcomp>r{ N)r) ri rA �dumpsr~ � LockedWriter� )rr re r/ r� Z creds_strr� r r r rl 8 s � z'GceAssertionCredentials._WriteCacheFilec C sv t �� st�d��| �| j�s.t�d| j ��|rjt �|�}| �� }||krrt�dt t || ��f ��n| �� }|S )z5Returns instance scopes based on GCE metadata server.�0GCE credentials requested outside a GCE instancez@GCE credentials requested but service account %s does not exist.z)Instance did not have access to scopes %s) r � DetectGcer �ResourceUnavailableError�GetServiceAccountri r' �GetInstanceScopesr- r) r} )rr r/ Zscope_lsZinstance_scopesr r r rk P s* � �� ��z1GceAssertionCredentials._ScopesFromMetadataServerc C s& d}t |�}dd� |�� D �}||v S )Nzinstance/service-accountsc S s g | ]}t �|��d ��qS )z/ )rg � ensure_str�rstrip)r� �liner r r r� g s �z=GceAssertionCredentials.GetServiceAccount.<locals>.<listcomp>)r` � readlines)rr ZaccountrZ r^ Zresponse_linesr r r r� d s �z)GceAssertionCredentials.GetServiceAccountc C s, d� | j�}t|�}t�dd� |�� D ��S )Nz$instance/service-accounts/{0}/scopesc s s | ]}t �|��� V qd S r )rg r� �stripr� r r r � <genexpr>o s �z<GceAssertionCredentials.GetInstanceScopes.<locals>.<genexpr>)�formatri r` r r' r� )rr rZ r^ r r r r� k s � �z)GceAssertionCredentials.GetInstanceScopesc C s t jj�| |� dS )a7 Refresh self.access_token. This function replaces AppAssertionCredentials._refresh, which does not use the credential store and is therefore poorly suited for multi-threaded scenarios. Args: do_request: A function matching httplib2.Http.request's signature. N)r= r2 �OAuth2Credentials�_refresh)rr Z do_requestr r r r� s s z GceAssertionCredentials._refreshc C s� d� | j�}z t|�}W n. tjyF d| _| jr@| j�| � � Y n0 t� |� � �}zt � |�}W n t y� t�d| ��Y n0 |d | _d|v r�t|d �}tj|d�tjjtjjd�jdd � | _nd| _d | _| jr�| j�| � dS ) z�Refresh self.access_token by querying the metadata server. If self.store is initialized, store acquired credentials there. z#instance/service-accounts/{0}/tokenTz$Could not parse response as JSON: %s� access_token� expires_in)�seconds)�tzN)�tzinfoF)r� ri r` r rX �invalid�store� locked_putrg r� rI rA r� � ValueErrorr- r� �int�datetime� timedelta�now�timezone�utc�replace� token_expiry)rr Zunused_http_requestrZ r^ �contentZcredential_infor� r r r �_do_refresh_request� s8 � � ��z+GceAssertionCredentials._do_refresh_requestc s t tj| ��� S r )rp r �AppAssertionCredentials�to_json�rr rs r r r� � s z GceAssertionCredentials.to_jsonc C s� t �|�}i }d|�dg �v r.|d d |d< d }d|v rD|d g}tf d|i|��}d|v rh|d |_d|v r�tj�|d tjj �|_ d|v r�|d |_ |S )Nre �kwargsr$ r/ r� r� r� ) rA r� rC r r� r� �strptimer= r2 � EXPIRY_FORMATr� r� )rx � json_data�datar� Z scope_listr5 r r r � from_json� s" � z!GceAssertionCredentials.from_jsonc C s t d��d S )Nz6Cannot serialize credentials for GCE service accounts.��NotImplementedErrorr� r r r �serialization_data� s �z*GceAssertionCredentials.serialization_data)Nra )�__name__� __module__� __qualname__�__doc__rq � classmethodrz rj rl rk r� r� r� r� r� r� �propertyr� � __classcell__r r rs r r � s & ! r c sH e Zd ZdZ� fdd�Zedd� �Zedd� �Zdd � Zd d � Z � Z S ) r z1Assertion credentials for Google App Engine apps.c s< t �� st�d��tt �|��| _tt| �j di |�� d S )Nr� )N) r � DetectGaer r� r} r' �_scopesrp r rq )rr r/ r3 rs r r rq � s �z GaeAssertionCredentials.__init__c O s, z| |i |��W S t jy& Y d S 0 d S r ru rw r r r rz � s zGaeAssertionCredentials.Getc C s t �|�}t|d �S )Nr� )rA r� r )rx r� r� r r r r� � s z!GaeAssertionCredentials.from_jsonc C s` ddl m} z|�| j�\}}W n4 |jyT } zt�t|���W Y d}~n d}~0 0 || _dS )z�Refresh self.access_token. Args: _: (ignored) A function matching httplib2.Http.request's signature. r )� app_identityN) Zgoogle.appengine.apir� �get_access_tokenr� rv r r- �strr� )rr �_r� �tokenr_ r r r r� � s $z GaeAssertionCredentials._refreshc C s t d��dS )au Cryptographically sign a blob (of bytes). This method is provided to support a common interface, but the actual key used for a Google Compute Engine service account is not available, so it can't be used to sign content. Args: blob: bytes, Message to be signed. Raises: NotImplementedError, always. z1Compute Engine service accounts cannot sign blobsNr� )rr �blobr r r � sign_blob� s �z!GaeAssertionCredentials.sign_blob) r� r� r� r� rq r� rz r� r� r� r� r r rs r r � s r c C s\ t jtjgd�}|j| d�\}}ttd�r2tj|_ttd�rDtj|_ttd�rXtj |_ |S )z4Retrieves command line flags based on gflags module.)�parents�ry �auth_host_name�auth_host_port�auth_local_webserver) �argparse�ArgumentParserr Z argparserZparse_known_args�hasattr�FLAGSr� r� r� Znoauth_local_webserver)ry �parser�flagsr� r r r �_GetRunFlowFlags s r� c C sL |d }|d }t |tj�s&d�|�}|d | | }trHt�| |�}n t�| |�}t t d�rddt _ |� � }|du s||j �rHtd� td �D ]�}z6tjjf i |��} t|d �} t�| || �}W �qHW q� tjjtf�y } ztd | f � W Y d} ~ q�d} ~ 0 tj�yD } z(td | f � t�d | ��W Y d} ~ q�d} ~ 0 0 q�|S )z Read credentials from a file.r% r$ �:r" r� FNz$Generating new OAuth credentials ...� r� zInvalid authorization: %szCommunication error: %sz,Communication error creating credentials: %s) � isinstancerg � string_typesr( �_NEW_FILESTOREr ZMultiprocessFileStorager Z(get_credential_storage_custom_string_keyr� r� r� rC r� �print�ranger= r2 �OAuth2WebServerFlowr� r Zrun_flow�FlowExchangeError� SystemExit�httplib2� HttpLib2Errorr r- ) r+ r4 r& r% Z scope_keyZ storage_keyZcredential_storer5 r� �flowr� r_ r r r r s> �� "� r c @ s\ e Zd ZdZdZdZe�� Zdd� Z e j dd� �Z e j dd � �Z d d � Zd d � Zdd� ZdS )r~ aO Simple multithreading and multiprocessing safe cache file. Notes on behavior: * the fasteners.InterProcessLock object cannot reliably prevent threads from double-acquiring a lock. A threading lock is used in addition to the InterProcessLock. The threading lock is always acquired first and released last. * The interprocess lock will not deadlock. If a process can not acquire the interprocess lock within `_lock_timeout` the call will return as a cache miss or unsuccessful cache write. * App Engine environments cannot be process locked because (1) the runtime does not provide monotonic time and (2) different processes may or may not share the same machine. Because of this, process locks are disabled and locking is only guaranteed to protect against multithreaded access. � rb c C s> d | _ || _tr,| j| _t�d�|��| _n| j | _d | _d S )Nz{0}.lock) �_file� _filename�_FASTENERS_AVAILABLE�_ProcessLockAcquired�_process_lock_getter� fastenersZInterProcessLockr� � _process_lock�_DummyLockAcquired)rr rE r r r rq S s �z _MultiProcessCacheFile.__init__c c s> z(| j j| jd�}|V W |r:| j �� n|r8| j �� 0 dS )z/Context manager for process locks with timeout.)�timeoutN)r� �acquire� _lock_timeout�release)rr Z is_lockedr r r r� ^ s �z+_MultiProcessCacheFile._ProcessLockAcquiredc c s dV dS )z<Lock context manager for environments without process locks.TNr r� r r r r� h s z)_MultiProcessCacheFile._DummyLockAcquiredc C s� d}| j �� | �� s$W d � dS | �� �n}|sNW d � W d � dS t| jd��"}|�� j| jd�}W d � n1 s�0 Y W d � n1 s�0 Y W d � n1 s�0 Y |S )a Acquire an interprocess lock and dump cache contents. This method safely acquires the locks then reads a string from the cache file. If the file does not exist and cannot be created, it will return None. If the locks cannot be acquired, this will also return None. Returns: cache data - string if present, None on failure. NrG rc )� _thread_lock�_EnsureFileExistsr� r@ r� rI �decode� _encoding)rr � file_contents�acquired_plock�fr r r r m s lz!_MultiProcessCacheFile.LockedReadc C s� t |tj�r|j| jd�}| j�� | �� s:W d � dS | �� �t}|sdW d � W d � dS t| j d��}|� |� W d � n1 s�0 Y W d � W d � dS 1 s�0 Y W d � n1 s�0 Y dS )a� Acquire an interprocess lock and write a string. This method safely acquires the locks then writes a string to the cache file. If the string is written successfully the function will return True, if the write fails for any reason it will return False. Args: cache_data: string or bytes to write. Returns: bool: success rc NF�wbT) r� rg � text_type�encoder� r� r� r� r@ r� �write)rr Z cache_datar� r� r r r r� � s (z"_MultiProcessCacheFile.LockedWritec C sn t j�| j�sjt �d�}zDzt| jd��� W n tyN Y W t �|� dS 0 W t �|� n t �|� 0 dS )z8Touches a file; returns False on error, True on success.� za+bFT)r* r+ �existsr� �umaskr@ �close�OSError)rr Z old_umaskr r r r� � s �z(_MultiProcessCacheFile._EnsureFileExistsN)r� r� r� r� r� r� � threading�Lockr� rq � contextlib�contextmanagerr� r� r r� r� r r r r r~ > s r~ c C s\ |p t �� }t| �}|�|�\}}|jtjkrN| �|� t| �}|�|�\}}t� |pXd�S )a� Get the userinfo associated with the given credentials. This is dependent on the token having either the userinfo.email or userinfo.profile scope for the given token. Args: credentials: (oauth2client.client.Credentials) incoming credentials http: (httplib2.Http, optional) http instance to use Returns: The email address for this token, or None if the required scopes aren't available. z{}) r� �Http�_GetUserinfoUrlrR �statusr � BAD_REQUEST�refreshrA r� )r5 �httpr\ r^ r� r r r r � s r c C s$ d}d| j i}d�|tj�|�f�S )Nz'https://oauth2.googleapis.com/tokeninfor� �?)r� r( r �parse� urlencode)r5 Zurl_root� query_argsr r r r � s r c K sZ | d � � }| d }|r&t|||d�S |r.|r6|r@|s@t�d��|durVt||||�S dS )z1Returns ServiceAccountCredentials from give file.r$ r% rH z:Service account name or keyfile provided without the otherN)�splitr r r- rL )r4 rJ Zservice_account_keyfileZ service_account_json_keyfile� unused_kwdsr/ r% r r r � _GetServiceAccountCredentials� s$ �����r c K s | d � d�}tj|d�S �Nr$ r! r7 )r r rz �r4 r r/ r r r �_GetGaeServiceAccount� s r c K s | d � d�}tj|d�S r )r r rz r r r r �_GetGceServiceAccount� s r c K s� | d � � }|rdS tjj}t�B z |�� }W n$ tjjyR Y W d � dS 0 W d � n1 sh0 Y d}|du r�dS t||�r�||v r�|�|�S dS )z Returns ADC with right scopes.r$ Nz.https://www.googleapis.com/auth/cloud-platform) r r= r2 �GoogleCredentialsr � _implicit_credentials_from_files�"ApplicationDefaultCredentialsErrorr� � create_scoped)r4 Z$skip_application_default_credentialsr r/ �gcr5 �cpr r r �!_GetApplicationDefaultCredentials� s 2 r )N)NNNN)N)F)N)N)N)NNN)F)>r� � __future__r r� r� r� rA r* r� rm r� r= �oauth2client.clientr r rg � six.movesr r �apitools.base.pyr r r� r� � ImportErrorZ import_errorrQ rC Z server_env� startswithZoauth2client.contribr r r� r Zgflagsr� �__all__r� r r r r r r rL r` r� r r2 �AssertionCredentialsr r� r �objectr~ r r r r r r r r r r �<module> s� � � a6 (n � � py/__pycache__/encoding_helper.cpython-39.pyc 0000644 00000060701 15025317163 0015171 0 ustar 00 a vyg�w � @ s( d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddl m Z e� ddd g�Z e� d d d g�ZG d d� de�ZG dd� de� dg d���Zi Zi Zi Zi Zdd� Zdd� Zdd� Zdd� Zdd� Zdbd d �Zd d � Z d d!� Z d"d#� Z dcd%d&�Z d'd(� Z d)d*� Z!ddd+d,�Z"d-d.� Z#d/d0� Z$d1d2� Z%d3d4� Z&G d5d6� d6e j'�Z(d7d8� Z)d9d:� Z*d;d<� Z+d=d>� Z,d?d@� Z-dAdB� Z.dCdD� Z/dEdF� Z0dGdH� Z1ee.e/�ej2� i Z3i Z4dedIdJ�Z5dfdKdL�Z6dgdMdN�Z7dhdOdP�Z8didQdR�Z9dSdT� Z:dUdV� Z;dWdX� Z<dYdZ� Z=d[d\� Z>d]d^� Z?djd`da�Z@dS )kz@Common code for converting proto to other formats, such as JSON.� N)� message_types)�messages)� protojson)� exceptions�_Codec�encoder�decoder� CodecResult�value�completec @ s e Zd ZdZdZdZdZdS )�EdgeTypez'The type of transition made by an edge.� � � N)�__name__� __module__� __qualname__�__doc__�SCALAR�REPEATED�MAP� r r �D/opt/gsutil/third_party/apitools/apitools/base/py/encoding_helper.pyr $ s r c @ s e Zd ZdZdZdd� ZdS )� ProtoEdgea. A description of a one-level transition from a message to a value. Protobuf messages can be arbitrarily nested as fields can be defined with any "message" type. This nesting property means that there are often many levels of proto messages within a single message instance. This class can unambiguously describe a single step from a message to some nested value. Properties: type_: EdgeType, The type of transition represented by this edge. field: str, The name of the message-typed field. index: Any, Additional data needed to make the transition. The semantics of the "index" property change based on the value of "type_": SCALAR: ignored. REPEATED: a numeric index into "field"'s list. MAP: a key into "field"'s mapping. r c C s& | j tjkr| jS d�| j| j�S d S )Nz{}[{}])�type_r r �field�format�index��selfr r r �__str__? s zProtoEdge.__str__N)r r r r � __slots__r r r r r r + s r )r r r c s � fdd�}|S )z;Register field_name as a container for unrecognized fields.c s � t | < | S �N)� _UNRECOGNIZED_FIELD_MAPPINGS��cls�� field_namer r �RegisterO s z'MapUnrecognizedFields.<locals>.Registerr )r' r( r r& r �MapUnrecognizedFieldsM s r) c s � �fdd�}|S )z9Register a custom encoder/decoder for this message class.c s t �� d�t| < | S �N)r r )r �_CUSTOM_MESSAGE_CODECSr$ �r r r r r( W s z,RegisterCustomMessageCodec.<locals>.Registerr �r r r( r r, r �RegisterCustomMessageCodecU s r. c s � �fdd�}|S )z1Register a custom encoder/decoder for this field.c s t �� d�t| < | S r* )r �_CUSTOM_FIELD_CODECS�r r, r r r( _ s z*RegisterCustomFieldCodec.<locals>.Registerr r- r r, r �RegisterCustomFieldCodec] s r1 c s � �fdd�}|S )z>Register a custom encoder/decoder for all fields of this type.c s t �� d�t| < | S r* )r �_FIELD_TYPE_CODECS)� field_typer, r r r( g s � z(RegisterFieldTypeCodec.<locals>.Registerr r- r r, r �RegisterFieldTypeCodece s r4 c C s t t| �t| ��S )z Make a deep copy of a message.)� JsonToMessage�type� MessageToJson��messager r r �CopyProtoMessagen s r: c C s t �� �| �}t|| |�S )z"Convert the given message to JSON.)�_ProtoJsonApiTools�Get�encode_message�_IncludeFields)r9 �include_fields�resultr r r r7 s s r7 c C s t �� �| |�S )z9Convert the given JSON to a message of type message_type.)r; r< �decode_message)� message_typer9 r r r r5 y s r5 c C s t |t�| ��S )z?Convert the given dictionary to a message of type message_type.�r5 �json�dumps)�drB r r r � DictToMessage s rG c C s t �t| ��S )z*Convert the given message to a dictionary.�rD �loadsr7 r8 r r r � MessageToDict� s rJ Fc C sD | � � }|rt|�}g }|D ] \}}|�|j||d�� q ||d�S )z>Convert the given dictionary to an AdditionalProperty message.��keyr )�additionalProperties)�items�sorted�append�AdditionalProperty)Z propertiesZadditional_property_typeZ sort_itemsrN Zmap_rL r r r r � DictToAdditionalPropertyMessage� s � rR c C s t | t�|��S )zAConvert the given python value to a message of type message_type.rC )rB r r r r �PyValueToMessage� s rS c C s t �t| ��S )z,Convert the given message to a python value.rH r8 r r r �MessageToPyValue� s rT c s� �� dd�}dd� }t| t�r�d}| D ]<}|rB|dd|d 7 }|t|fd |i|����d 7 }q&|rx|dd| 7 }|d 7 }|S t| tj��rRt| �jd }�� d �s�| jd | }t dd� | � � D ��}|D ]\}| � |�} |r�|dd|d 7 }t | | j �} || j d t| fd |i|���� d 7 }q�|�rF|dd| 7 }|d7 }|S t| tj��r��� d��r�t| �dk�r�| dd� } t| tj��r�G � �fdd�dtj�� t�| j| j| j| j| j| j| j� | j�d���} t| �S )a7 Return a repr-style string for a protorpc message. protorpc.Message.__repr__ does not return anything that could be considered python code. Adding this function lets us print a protorpc message in such a way that it could be pasted into code later, and used to compare against other things. Args: msg: protorpc.Message, the message to be repr'd. multiline: bool, True if the returned string should have each field assignment on its own line. **kwargs: {str:str}, Additional flags for how to format the string. Known **kwargs: shortstrings: bool, True if all string values should be truncated at 100 characters, since when mocking the contents typically don't matter except for IDs, and IDs are usually less than 100 characters. no_modules: bool, True if the long module name should not be printed with each type. Returns: str, A string of valid python (assuming the right imports have been made) that recreates the message passed into this function. �indentr c S s t | �} | �dd�d | d< | S )NrU r � )�dict�get��kwargsr r r � IndentKwargs� s z#MessageToRepr.<locals>.IndentKwargs�[� � rV � multiline�,�]�(� no_modules�.c S s g | ] }|j �qS r ��name)�.0r r r r � <listcomp>� � z!MessageToRepr.<locals>.<listcomp>�=�)Z shortstrings�d Nc s* e Zd Z�� fdd�Z�fdd�Z� ZS )z$MessageToRepr.<locals>.SpecialTZInfoc s t � | ��� || _d S r" )�super�__init__�offset)r ro )� SpecialTZInfo� __class__r r rn � s z-MessageToRepr.<locals>.SpecialTZInfo.__init__c s( dt | j� d }� �d�s$d| }|S )NzTimeZoneOffset(rk rc z apitools.base.protorpclite.util.)�reprro rX )r �srY r r �__repr__� s z-MessageToRepr.<locals>.SpecialTZInfo.__repr__)r r r rn rt � __classcell__r �rp rZ �rq r rp � s rp ) rX � isinstance�list� MessageToReprr �Messager6 r r rO � all_fields� field_by_name�getattrrf �six� string_types�len�datetime�tzinfo�year�month�day�hour�minute�second� microsecond� utcoffsetrr ) �msgr_ rZ rU r[ rs �item�namesrf r r r rv r rz � sj ���� ���� �rz c C s0 |D ]&}|t | �vr td| ��t| |�} q| S )Nz no field "%s")�dir�KeyErrorr~ )r9 � field_pathr r r r � _GetField� s r� c C s. |d d� D ]}| � |i �} q || |d < d S )N���)� setdefault)Zdictblobr� r r r r r � _SetField s r� c C s� |du r | S t �| �}|D ]f}z&t||�d��}d}t|t�rBg }W n( tyl t�d|t |�f ��Y n0 t ||�d�|� qt � |�S )z0Add the requested fields to the encoded message.Nrd z'No field named %s in message of type %s) rD rI r� �splitrx ry r� r �InvalidDataErrorr6 r� rE )�encoded_messager9 r? r@ r' r Z nullvaluer r r r> s" �� r> c C s6 t t�| �|d �t t�t| ��|d �g}dd� |D �S )Nc S s g | ]}|d ur|�qS r" r �rg �xr r r rh ! ri z#_GetFieldCodecs.<locals>.<listcomp>)r~ r/ rX r2 r6 )r �attrr@ r r r �_GetFieldCodecs s �r� c sT e Zd ZdZdZedd� �Z� fdd�Z� fdd�Z� fd d �Z � fd d �Z � Z S ) r; z&JSON encoder used by apitools clients.Nc C s | j d u r| � | _ | j S r" )� _INSTANCEr$ r r r r< ) s z_ProtoJsonApiTools.Getc sP |t v rt | �|�S t||�}tt| ��||�}t||�}t||�}t||�S r" ) r+ r �_DecodeCustomFieldNamesrm r; rA �_ProcessUnknownEnums�_ProcessUnknownMessages�_DecodeUnknownFields)r rB r� r@ rw r r rA / s �� � z!_ProtoJsonApiTools.decode_messagec s� t |d�D ]"}|||�}|j}|jr | S q t|tj�rP| �|jt� |��}npt|tj �r�t |j |d�pl|}zt t| ��||�}W q� tjy� t|tj�s�� d}Y q�0 nt t| ��||�}|S )z�Decode the given JSON value. Args: field: a messages.Field for the field we're decoding. value: a python value we'd like to decode. Returns: A value suitable for assignment to field. r �� json_nameN)r� r r rx r � MessageFieldrA rB rD rE � EnumField�GetCustomJsonEnumMappingr6 rm r; � decode_field� DecodeErrorr r� )r r r r r@ Z field_valuerw r r r� : s> � ���� ��z _ProtoJsonApiTools.decode_fieldc s| t |tj�r(dd�� fdd�|D �� S t|�tv rFtt|� �|�S t|�}tt � �� |�}t ||�}t j t �|�dd�S )Nz[%s]z, c 3 s | ]}� � |�V qd S r" )r= r� r r r � <genexpr>] s �z4_ProtoJsonApiTools.encode_message.<locals>.<genexpr>T)� sort_keys)rx r � FieldList�joinr6 r+ r �_EncodeUnknownFieldsrm r; r= �_EncodeCustomFieldNamesrD rE rI )r r9 r@ rw r r r= [ s � z!_ProtoJsonApiTools.encode_messagec s� t � d�D ]"}|� |�}|j}|jr | S q t� tj�rl� jrT� fdd�|D �}nt� j|j d�}|rl|S t� tj �r�t� t j �s�t �| �|��}tt| ��� |�S )z�Encode the given value as JSON. Args: field: a messages.Field for the field we're encoding. value: a value for field. Returns: A python value suitable for json.dumps. r c s" g | ]}t � j|jd �p |j�qS )�� python_name)r� r6 rf )rg �er0 r r rh z s ��z3_ProtoJsonApiTools.encode_field.<locals>.<listcomp>r� )r� r r rx r r� �repeatedr� r6 rf r� r � DateTimeFieldrD rI r= rm r; � encode_field)r r r r r@ Zremapped_valuerw r0 r r� i s( �� �z _ProtoJsonApiTools.encode_field) r r r r r� � classmethodr< rA r� r= r� ru r r rw r r; $ s ! r; c C s� t �t| ��}|du r| S | �|�}t|tj�s:t�d��|j }t|j tj�rbt | t � |�|�}n t| |�}t| ||� t| di � | S )z;Rewrite unknown fields in message into message.destination.Nz>Unrecognized fields must be mapped to a compound message type.� _Message__unrecognized_fields)r# rX r6 r} rx r r� r �InvalidDataFromServerErrorrB r �_DecodeUnknownMessagesrD rI �_DecodeUnrecognizedFields�setattr)r9 r� � destinationZ pair_field� pair_type� new_valuesr r r r� � s" � � r� c C sp |j j}g }dd� | �� D �}t�|�D ]B\}}||v r:q(t||�}|j jrTt|�}|||d�} |�| � q(|S )z<Process unknown fields in encoded_message of a message type.c S s g | ] }|j �qS r re r� r r r rh � ri z*_DecodeUnknownMessages.<locals>.<listcomp>rK ) r r6 r| r � iteritemsrS r� �_AsMessageListrP ) r9 r� r� r3 r� Zall_field_namesrf Z value_dictr �new_pairr r r r� � s r� c C s� g }t �� }| �� D ]�}| �|�\}}|�d�}t|tj�rLt||j j �}n|� |j |�}z t |�} W n$ t y� t�� � |j|�} Y n0 || |d�} |�| � q|S )z'Process unrecognized fields in message.r rK )r; r< �all_unrecognized_fields�get_unrecognized_field_infor} rx r r� rG r rB r� �str�UnicodeEncodeErrorr � ProtoJsonrL rP ) r9 r� r� �codecZ unknown_fieldr �_Z value_type� decoded_valueZ new_pair_keyr� r r r r� � s& � � r� c C s t �� }|�t| �|�| ��S r" )r r� rA r6 r= )r9 r� r r r �!_CopyProtoMessageVanillaProtoJson� s r� c C s� t �t| ��}|du r| S t| �}| �|�}t|tj�sFt� d| ��|j }|�d�}|j }t | |�}t �� }|D ]"} |�|| j�} |�| j| |� qrt||g � |S )z6Remap unknown fields in message out of message.source.NzInvalid pairs field %sr )r# rX r6 r� r} rx r r� r ZInvalidUserInputErrorrB �variantr~ r; r< r� r �set_unrecognized_fieldrL r� ) r9 �sourcer@ Z pairs_fieldZ pairs_typeZ value_fieldZ value_variant�pairsr� �pair� encoded_valuer r r r� � s& � r� c C sP z(| j rdd� |D �}n t�|�}d}W n tyB |}d}Y n0 t||d�S )z,Encode the bytes in value as urlsafe base64.c S s g | ]}t �|��qS r )�base64�urlsafe_b64encode)rg �byter r r rh � ri z$_SafeEncodeBytes.<locals>.<listcomp>TF�r r )r� r� r� � TypeErrorr )r r r@ r r r r �_SafeEncodeBytes� s r� c C s> zt �t|��}d}W n ty0 |}d}Y n0 t||d�S )z+Decode the urlsafe base64 value into bytes.TFr� )r� �urlsafe_b64decoder� r� r )Z unused_fieldr r@ r r r r �_SafeDecodeBytes� s r� c C s� |s| S t �t�|��}| �� D ]d}t|tj�r |j|v r | � |j�}|j rbt |�t ||j �ksj|du r | � |j||j tj j� q | S )af Add unknown enum values from encoded_message as unknown fields. ProtoRPC diverges from the usual protocol buffer behavior here and doesn't allow unknown fields. Throwing on unknown fields makes it impossible to let servers add new enum values and stay compatible with older clients, which isn't reasonable for us. We simply store unrecognized enum values as unknown fields, and all is well. Args: message: Proto message we've decoded thus far. encoded_message: JSON string we're decoding. Returns: message, with any unknown enums stored as unrecognized fields. N)rD rI r � ensure_strr| rx r r� rf �get_assigned_valuer� r� r� �Variant�ENUM)r9 r� �decoded_messager r r r r r� s � ��r� c sp |s| S t �t�|��}dd� | �� D �t| �� � � � fdd�|�� D �}|D ]}| �||| t j j � qP| S )a? Store any remaining unknown fields as strings. ProtoRPC currently ignores unknown values for which no type can be determined (and logs a "No variant found" message). For the purposes of reserializing, this is quite harmful (since it throws away information). Here we simply add those as unknown fields of type string (so that they can easily be reserialized). Args: message: Proto message we've decoded thus far. encoded_message: JSON string we're decoding. Returns: message, with any remaining unrecognized fields saved. c S s g | ] }|j �qS r re r� r r r rh 2 ri z+_ProcessUnknownMessages.<locals>.<listcomp>c s g | ]}|� vr|�qS r r r� �Zmessage_fieldsr r rh 4 s �) rD rI r r� r| ry r� �keysr� r r� �STRING)r9 r� r� �missing_fieldsr' r r� r r� s � �r� c C s^ t | tj�st�d| ��|| �� vr8t�d|| f ��t�| i �}t d| ||� |||< dS )a� Add a custom wire encoding for a given enum value. This is primarily used in generated code, to handle enum values which happen to be Python keywords. Args: enum_type: (messages.Enum) An enum type python_name: (basestring) Python name for this value. json_name: (basestring) JSON name to be used on the wire. package: (NoneType, optional) No effect, exists for legacy compatibility. z.Cannot set JSON enum mapping for non-enum "%s"z%Enum value %s not a value for type %s�enumN) � issubclassr �Enumr �TypecheckErrorr� r� �_JSON_ENUM_MAPPINGSr� �_CheckForExistingMappings)� enum_typer� r� �package�field_mappingsr r r �AddCustomJsonEnumMappingE s � � r� c C st t | tj�st�d| ��z| �|�}W n$ tyL t�d|| f ��Y n0 t� | i �}t d| ||� |||< dS )a� Add a custom wire encoding for a given message field. This is primarily used in generated code, to handle enum values which happen to be Python keywords. Args: message_type: (messages.Message) A message type python_name: (basestring) Python name for this value. json_name: (basestring) JSON name to be used on the wire. package: (NoneType, optional) No effect, exists for legacy compatibility. z2Cannot set JSON field mapping for non-message "%s"z#Field %s not recognized for type %sr N) r� r r{ r r� r} r� r� �_JSON_FIELD_MAPPINGSr� r� )rB r� r� r� r� r� r r r �AddCustomJsonFieldMapping] s" �� �� r� c C s t | d||td�S )z=Return the appropriate remapping for the given enum, or None.r� �r� r� �mappings)�_FetchRemappingr� )r� r� r� r r r r� y s �r� c C s t | d||td�S )z>Return the appropriate remapping for the given field, or None.r r� )r� r� )rB r� r� r r r �GetCustomJsonFieldMapping� s �r� c s| |r�rt �d| ��|s.�s.t �d|f ��|�| i �� � rx|rL� �|�S �rx�t� �� �v rx� �fdd�� D �d S dS )z>Common code for fetching a key or value from a remapping dict.z>Cannot specify both python_name and json_name for %s remappingz=Must specify either python_name or json_name for %s remappingc s g | ]}� | �kr|�qS r r )rg �k��field_remappingsr� r r rh � s �z#_FetchRemapping.<locals>.<listcomp>r N)r r� rX ry �values)� type_name� mapping_typer� r� r� r r� r r� � s, ���� �r� c C s~ | dkrt }n | dkrt}|||d�}|durJ||krJt�d| ||f ��|||d�}|durz||krzt�d| ||f ��dS )z5Validate that no mappings exist for the given values.r r� r� Nz6Cannot add mapping for %s "%s", already mapped to "%s"r� )r� r� r r� )r� rB r� r� �getterZ remappingr r r r� � s$ �� ��r� c C sX t t�t| �i ��� �}|rTt�|�}|D ] \}}||v r*|�|�||< q*t�|�}|S r" ) ry r� rX r6 rN rD rI �poprE )r9 r� r� r� r� r� r r r r� � s r� c C sT t �| i �}|rPt�|�}t|�� �D ] \}}||v r&|�|�||< q&t�|�}|S r" )r� rX rD rI ry rN r� rE )rB r� r� r� r� r� r r r r� � s r� c sP ddl m� � fdd�}|| �s(td��t| � j�r:| j} t| � j�rL| j} | S )z1Convert the provided list-as-JsonValue to a list.r �� extra_typesc s* t | � j�rdS t | � j�r&| jr&dS dS )z6Return True if msg is a repeated value as a JsonValue.TF)rx � JsonArray� JsonValue� array_value)r� r� r r �_IsRepeatedJsonValue� s z,_AsMessageList.<locals>._IsRepeatedJsonValuez"invalid argument to _AsMessageList)�apitools.base.pyr� � ValueErrorrx r� r� r� �entries)r� r� r r� r r� � s r� c C sJ | � |j�}t|tj�s dS z|�d�}W n ty> Y dS 0 |jS dS )z3Returns whether the "field" is actually a map-type.FrM N)r� rf rx r r{ r} r� r� )r9 r r �additional_propertiesr r r �_IsMap� s r c c s@ t | |�sJ �| �|j�}|�d�}|D ]}|j|jfV q(dS )z/Yields the (key, value) pair of the map values.rM N)r r� rf rL r )r9 r Z map_messager Zkv_pairr r r � _MapItems� s �r r c c s, t | tj�sdS | �� }|r*||fV dS | �� D ]�}| �|j�}|jr�t|�D ]@\}}t t j |j|�}t |||f �}|D ]\} } | | fV q|qPq2t | |�r�t| |�D ]@\} }t t j|j| �} t ||| f �}|D ]\} } | | fV q�q�q2t t j|jd�} t ||| f �}|D ]\} } | | fV �qq2dS )a� Yields the locations of unrecognized fields within "message". If a sub-message is found to have unrecognized fields, that sub-message will not be searched any further. We prune the search of the sub-message because we assume it is malformed and further checks will not yield productive errors. Args: message: The Message instance to search. _edges: Internal arg for passing state. Yields: (edges_to_message, field_names): edges_to_message: List[ProtoEdge], The edges (relative to "message") describing the path to the sub-message where the unrecognized fields were found. field_names: List[Str], The names of the field(s) that were unrecognized in the sub-message. N)rx r r{ r� r| r� rf r� � enumerater r r �UnrecognizedFieldIterr r r r )r9 Z_edges� field_namesr r �ir� Z repeated_edgeZiter_r� �yrL Zmap_edgeZ scalar_edger r r r � s0 r )N)F)F)N)N)NN)NN)NNN)r )Ar r� � collectionsr� rD r �apitools.base.protorpcliter r r r� r � namedtupler r �objectr r r# r+ r/ r2 r) r. r1 r4 r: r7 r5 rG rJ rR rS rT rz r� r� r> r� r� r; r� r� r� r� r� r� r� r� r� � BytesFieldr� r� r� r� r� r� r� r� r� r� r� r r r r r r r �<module> s� � � [d � � � py/__pycache__/util.cpython-39.pyc 0000644 00000016541 15025317163 0013024 0 ustar 00 a vyg! � @ s d Z ddlZddlZddlZddlmZ ddlm m m Z ddl m m m Z ddlm m mZ ddlmZ ddlmZ ddlmZ ejr�ddlmZ n ddlmZ dd gZd Z d d� Z d d � Z d d� Z d dd�Z d dd�Z!d dd�Z"dd� Z#dd� Z$dd� Z%dS ) z4Assorted utilities shared between parts of apitools.� N)� http_client)�messages)�encoding_helper)� exceptions)�Iterable� DetectGae� DetectGcez:/?#[]@!$&'()*+,;=c C s" t j�dd�} | �d�p | �d�S )z�Determine whether or not we're running on GAE. This is based on: https://developers.google.com/appengine/docs/python/#The_Environment Returns: True iff we're running on GAE. �SERVER_SOFTWARE� z Development/zGoogle App Engine/)�os�environ�get� startswith)�server_software� r �9/opt/gsutil/third_party/apitools/apitools/base/py/util.pyr - s �c C sr d� tj�dd��} z(t�t�i ���tj| ddid��}W n t j yR Y dS 0 |� � t j kop|j�d�dkS ) z�Determine whether or not we're running on GCE. This is based on: https://cloud.google.com/compute/docs/metadata#runninggce Returns: True iff we're running on a GCE instance. z http://{}�GCE_METADATA_ROOTzmetadata.google.internalzMetadata-Flavor�Google)�headersFzmetadata-flavor)�formatr r r �urllib_request� build_opener� ProxyHandler�open�Request� urllib_error�URLError�getcoder �OKr )� metadata_url�or r r r ; s ����c C s\ t | tj�r$t�| �} t| �d��S t | t�rDdd� | D �} t| �S t�dt | �f ��dS )z)Normalize scope_spec to a set of strings.� c S s g | ]}t �|��qS r )�six� ensure_str)�.0�xr r r � <listcomp>V � z#NormalizeScopes.<locals>.<listcomp>z5NormalizeScopes expected string or iterable, found %sN) � isinstancer" � string_typesr# �set�splitr r �TypecheckError�type)Z scope_specr r r �NormalizeScopesP s ��r. c C sL t | |�sH|d u r>t |t�r.dt| �|f }ndt| �|f }t�|��| S )Nz"Type of arg is "%s", not one of %rz Type of arg is "%s", not "%s")r( �tupler- r r, )�argZarg_type�msgr r r � Typecheck] s � r2 c C s |p | j p d}| jD ]�}d| }d}d| }||v rDt}|�||�}||vrZt�d| ��z || }W n ty� t�d| ��Y n0 |du r�t�d| ��z2t|tj �s�t |�}|�|t � |� d�|��}W q t�y } z t�d||| f ��W Y d} ~ qd} ~ 0 0 q|S ) z(Determine the relative path for request.r z{%s}z{+%s}zMissing path parameter %sz%Request missing required parameter %sN�utf_8z3Error setting required parameter %s to value %s: %s)� relative_path� path_params�_RESERVED_URI_CHARS�replacer �InvalidUserInputError�KeyErrorr( r" r) �str� urllib_parse�quote�encode� TypeError) � method_config�paramsr4 �path�paramZparam_templateZreserved_charsZreserved_template�value�er r r �ExpandRelativePathi sJ � � � ���� rE �< c C s2 d| }|d }|t �| |�7 }tdt||��S )a� Calculates amount of time to wait before a retry attempt. Wait time grows exponentially with the number of attempts. A random amount of jitter is added to spread out retry attempts from different clients. Args: retry_attempt: Retry attempt counter. max_wait: Upper bound for wait time [seconds]. Returns: Number of seconds to wait before retrying request. � g @� )�random�uniform�max�min)Z retry_attemptZmax_waitZ wait_timeZ max_jitterr r r �CalculateWaitForRetry� s rM c s\ d�vrt �d� ��dd� | D �}|r<t �dd�|� ��dd� � t� �fd d �| D ��S ) a� Return True iff mime_type is acceptable for one of accept_patterns. Note that this function assumes that all patterns in accept_patterns will be simple types of the form "type/subtype", where one or both of these can be "*". We do not support parameters (i.e. "; q=") in patterns. Args: accept_patterns: list of acceptable MIME types. mime_type: the mime type we would like to match. Returns: Whether or not mime_type matches (at least) one of these patterns. �/zInvalid MIME type: "%s"c S s g | ]}d |v r|�qS )�;r �r$ �pr r r r& � r' z&AcceptableMimeType.<locals>.<listcomp>z.MIME patterns with parameter unsupported: "%s"z, c S s0 | dkr d} t dd� t| �d�|�d��D ��S )z4Return True iff mime_type is acceptable for pattern.�*z*/*c s s | ]\}}|d |fv V qdS )rR Nr )r$ �acceptZprovidedr r r � <genexpr>� r' z>AcceptableMimeType.<locals>.MimeTypeMatches.<locals>.<genexpr>rN )�all�zipr+ )�pattern� mime_typer r r �MimeTypeMatches� s �z+AcceptableMimeType.<locals>.MimeTypeMatchesc 3 s | ]}� |��V qd S )Nr )r$ rW �rY rX r r rT � s �z%AcceptableMimeType.<locals>.<genexpr>)r r8 �GeneratedClientError�join�any)Zaccept_patternsrX Zunsupported_patternsr rZ r �AcceptableMimeType� s ����r^ c s � fdd�| D �S )z2Reverse parameter remappings for URL construction.c s g | ]}t j� |d �p|�qS ))� json_name)�encoding�GetCustomJsonFieldMappingrP �� request_typer r r& � s �z!MapParamNames.<locals>.<listcomp>r )r@ rc r rb r � MapParamNames� s �rd c C st t | �}| �� D ]^\}}tj||d�}|dur@|�|�||< |}t|tj�rtjt |�t |�d�pht |�||< q|S )a� Perform any renames/remappings needed for URL construction. Currently, we have several ways to customize JSON encoding, in particular of field names and enums. This works fine for JSON bodies, but also needs to be applied for path and query parameters in the URL. This function takes a dictionary from param names to values, and performs any registered mappings. We also need the request type (to look up the mappings). Args: params: (dict) Map from param names to values request_type: (protorpc.messages.Message) request type for this API call Returns: A new dict of the same size, with all registered mappings applied. )� python_nameN) �dict�itemsr` ra �popr( r �Enum�GetCustomJsonEnumMappingr- r: )r@ rc � new_params� param_namerC Zfield_remappingr r r �MapRequestParams� s � ��rm )N)N)rF )&�__doc__r rI r" � six.movesr Zsix.moves.urllib.error�moves�urllib�errorr Zsix.moves.urllib.parse�parser; Zsix.moves.urllib.request�requestr �apitools.base.protorpcliter �apitools.base.pyr r` r �PY3�collections.abcr � collections�__all__r6 r r r. r2 rE rM r^ rd rm r r r r �<module> s4 � ' $ py/__pycache__/exceptions.cpython-39.pyc 0000644 00000015604 15025317163 0014227 0 ustar 00 a vyg� � @ s� d Z G dd� de�ZG dd� dee�ZG dd� de�ZG dd� de�ZG d d � d e�ZG d d � d e�ZG d d� de�Z G dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Ze e e e ed�ZG dd� de�ZG d d � d ee�ZG d d � d e�ZG d d!� d!e�ZG d"d#� d#e�ZG d$d%� d%e�ZG d&d'� d'e�ZG d(d)� d)e�ZG d*d+� d+e�ZG d,d-� d-e�ZG d.d/� d/e�ZG d0d1� d1e�ZG d2d3� d3e �Z G d4d5� d5e �Z G d6d7� d7e�Z G d8d9� d9e�Z d:S );z*Exceptions for generated client libraries.c @ s e Zd ZdZdS )�Errorz Base class for all exceptions.N��__name__� __module__� __qualname__�__doc__� r r �?/opt/gsutil/third_party/apitools/apitools/base/py/exceptions.pyr s r c @ s e Zd ZdZdS )�TypecheckErrorz+An object of an incorrect type is provided.Nr r r r r r s r c @ s e Zd ZdZdS )� NotFoundErrorz(A specified resource could not be found.Nr r r r r r s r c @ s e Zd ZdZdS )� UserErrorz,Base class for errors related to user input.Nr r r r r r # s r c @ s e Zd ZdZdS )�InvalidDataErrorz&Base class for any invalid data error.Nr r r r r r ( s r c @ s e Zd ZdZdS )�CommunicationErrorz1Any communication error talking to an API server.Nr r r r r r - s r c sN e Zd ZdZd � fdd� Zdd� Zedd� �Zed d � �Z e d d � �Z � Z S )� HttpErrorz-Error making a request. Soon to be HttpError.Nc s@ t �|||�}tt | ��|� || _|| _|| _|| _|| _d S �N) r �_build_message�super�__init__�response�content�url� method_config�request)�selfr r r r r � error_message�� __class__r r r 6 s zHttpError.__init__c C s t �| j| j| j�S r )r r r r r �r r r r �__str__@ s zHttpError.__str__c C s$ t |t�r|�dd�}d|| |f S )N�ascii�replacez6HttpError accessing <%s>: response: <%s>, content <%s>)� isinstance�bytes�decode)r r r r r r r C s �zHttpError._build_messagec C s t | jd �S �N�status)�intr r r r r � status_codeJ s zHttpError.status_codec K sR z t |j�d��}t�|| �}W n ty6 | }Y n0 ||j|j|jfi |��S r# )r% �info�get� _HTTP_ERRORS� ValueErrorr � request_url)�cls� http_response�kwargsr& Z error_clsr r r � FromResponseP s ��zHttpError.FromResponse)NN) r r r r r r � staticmethodr �propertyr& � classmethodr/ � __classcell__r r r r r 2 s � r c @ s e Zd ZdZdS )�HttpBadRequestErrorzHTTP 400 Bad Request.Nr r r r r r4 [ s r4 c @ s e Zd ZdZdS )�HttpUnauthorizedErrorzHTTP 401 Unauthorized.Nr r r r r r5 _ s r5 c @ s e Zd ZdZdS )�HttpForbiddenErrorzHTTP 403 Forbidden.Nr r r r r r6 c s r6 c @ s e Zd ZdZdS )�HttpNotFoundErrorzHTTP 404 Not Found.Nr r r r r r7 g s r7 c @ s e Zd ZdZdS )�HttpConflictErrorzHTTP 409 Conflict.Nr r r r r r8 k s r8 )i� i� i� i� i� c @ s e Zd ZdZdS )�InvalidUserInputErrorz User-provided input is invalid.Nr r r r r r9 x s r9 c @ s e Zd ZdZdS )�InvalidDataFromServerErrorz+Data received from the server is malformed.Nr r r r r r: } s r: c @ s e Zd ZdZdS )� BatchErrorz3Error generated while constructing a batch request.Nr r r r r r; � s r; c @ s e Zd ZdZdS )�ConfigurationErrorz$Base class for configuration errors.Nr r r r r r< � s r< c @ s e Zd ZdZdS )�GeneratedClientErrorz.The generated client configuration is invalid.Nr r r r r r= � s r= c @ s e Zd ZdZdS )�ConfigurationValueErrorz@Some part of the user-specified client configuration is invalid.Nr r r r r r> � s r> c @ s e Zd ZdZdS )�ResourceUnavailableErrorz'User requested an unavailable resource.Nr r r r r r? � s r? c @ s e Zd ZdZdS )�CredentialsErrorz&Errors related to invalid credentials.Nr r r r r r@ � s r@ c @ s e Zd ZdZdS )� TransferErrorz Errors related to transfers.Nr r r r r rA � s rA c @ s e Zd ZdZdS )�TransferRetryErrorz&Retryable errors related to transfers.Nr r r r r rB � s rB c @ s e Zd ZdZdS )�TransferInvalidErrorz The given transfer is invalid.Nr r r r r rC � s rC c @ s e Zd ZdZdS )� RequestErrorz The request was not successful.Nr r r r r rD � s rD c s, e Zd ZdZ� fdd�Zedd� �Z� ZS )�RetryAfterErrorz,The response contained a retry-after header.c s* t t| �j|||fi |�� t|�| _d S r )r rE r r% � retry_after)r r r r rF r. r r r r � s zRetryAfterError.__init__c K s | |j |j|j|jfi |��S r )r' r r+ rF )r, r- r. r r r r/ � s ��z RetryAfterError.FromResponse)r r r r r r2 r/ r3 r r r r rE � s rE c @ s e Zd ZdZdS )�BadStatusCodeErrorz5The request completed but returned a bad status code.Nr r r r r rG � s rG c @ s e Zd ZdZdS )�NotYetImplementedErrorz*This functionality is not yet implemented.Nr r r r r rH � s rH c @ s e Zd ZdZdS )�StreamExhaustedz?Attempted to read more bytes from a stream than were available.Nr r r r r rI � s rI N) r � Exceptionr � TypeErrorr r r r r r r4 r5 r6 r7 r8 r) r9 r: r; r< r= r> r? r@ rA rB rC rD rE rG rH rI r r r r �<module> sD )� py/__pycache__/encoding.cpython-39.pyc 0000644 00000001114 15025317163 0013623 0 ustar 00 a vyg� � @ s d Z ddlT ddlZg d�ZdS )z@Common code for converting proto to other formats, such as JSON.� )�*N) �CopyProtoMessage� JsonToMessage� MessageToJsonZ DictToMessageZ MessageToDictZPyValueToMessageZMessageToPyValueZ MessageToReprZGetCustomJsonFieldMappingZAddCustomJsonFieldMappingZGetCustomJsonEnumMappingZAddCustomJsonEnumMapping)�__doc__Z apitools.base.py.encoding_helper� apitools.base.py.extra_types�apitools�__all__� r r �=/opt/gsutil/third_party/apitools/apitools/base/py/encoding.py�<module> s py/__pycache__/transfer.cpython-39.pyc 0000644 00000077006 15025317163 0013676 0 ustar 00 a vyg�� � @ sF d Z ddlmZ ddlmZ ddlm mZ ddl m m Z ddl Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lmZ dd lmZ g d �Z d Z d Z dZ dd� Z dd� Z!dd� Z"dd� Z#G dd� de$�Z%G dd� de%�Z&ej'�r2G dd � d ej(�Z)G d d � d e%�Z*dS ) z)Upload and download support for apitools.� )�print_functionN)� http_client)�buffered_stream)� compression)� exceptions)� http_wrapper)� stream_slice)�util)�Download�Upload�RESUMABLE_UPLOAD� SIMPLE_UPLOAD�DownloadProgressPrinter�DownloadCompletePrinter�UploadProgressPrinter�UploadCompletePrinteri P �simple� resumablec C s0 d| j v r td| j d � ntd| j � dS )z*Print download progress based on response.� content-rangez Received %szReceived %d bytesN)�info�print�length)�response�unused_download� r �=/opt/gsutil/third_party/apitools/apitools/base/py/transfer.pyr 7 s r c C s t d� dS )z-Print information about a completed download.zDownload completeN�r )�unused_responser r r r r ? s r c C s t d| jd � dS )z(Print upload progress based on response.zSent %s�rangeN)r r )r � unused_uploadr r r r D s r c C s t d� dS )z+Print information about a completed upload.zUpload completeNr )r r r r r r I s r c @ s� e Zd ZdZd&dd�Zdd � Zed d � �Zed d � �Zedd� �Z e j dd� �Z edd� �Z e j dd� �Z edd� �Z edd� �Z dd� Zedd� �Zed d � �Zd d � Zd d!� Zd"d#� Zd$d%� ZdS )'� _Transferz-Generic bits common to Uploads and Downloads.FNT� c C sF d | _ || _|| _|| _d | _d| _|| _tj| _ || _ |p>d| _ d S )Nr! i ) �_Transfer__bytes_http�_Transfer__close_stream�_Transfer__http�_Transfer__stream�_Transfer__url�_Transfer__num_retries� num_retriesr �)HandleExceptionsAndRebuildHttpConnections� retry_func� auto_transfer� chunksize)�self�stream� close_streamr, r+ �httpr( r r r �__init__R s �z_Transfer.__init__c C s t | �S �N)�str�r- r r r �__repr__c s z_Transfer.__repr__c C s | j S r2 )r# r4 r r r r/ f s z_Transfer.close_streamc C s | j S r2 )r$ r4 r r r r0 j s z_Transfer.httpc C s | j p | jS r2 )r" r0 r4 r r r � bytes_httpn s z_Transfer.bytes_httpc C s || _ d S r2 )r" �r- �valuer r r r6 r s c C s | j S r2 )r' r4 r r r r( v s z_Transfer.num_retriesc C s* t �|tj� |dk r t�d��|| _d S )Nr z*Cannot have negative value for num_retries)r � Typecheck�six� integer_typesr �InvalidDataErrorr' r7 r r r r( z s �c C s | j S r2 )r% r4 r r r r. � s z_Transfer.streamc C s | j S r2 )r& r4 r r r �url� s z _Transfer.urlc C s* | � � | jdu r |p t�� | _|| _dS )a� Initialize this download by setting self.http and self.url. We want the user to be able to override self.http by having set the value in the constructor; in that case, we ignore the provided http. Args: http: An httplib2.Http instance or None. url: The url for this transfer. Returns: None. Initializes self. N)�EnsureUninitializedr0 r �GetHttpr$ r& )r- r0 r= r r r � _Initialize� s z_Transfer._Initializec C s | j d uo| jd uS r2 )r= r0 r4 r r r � initialized� s z_Transfer.initializedc C s t | �jS r2 )�type�__name__r4 r r r � _type_name� s z_Transfer._type_namec C s | j st�d| j ��d S )NzCannot use uninitialized %s�rA r �TransferInvalidErrorrD r4 r r r �EnsureInitialized� s �z_Transfer.EnsureInitializedc C s | j rt�d| j ��d S )NzCannot re-initialize %srE r4 r r r r> � s �z _Transfer.EnsureUninitializedc C s | j r| j�� d S r2 )r# r% �closer4 r r r �__del__� s z_Transfer.__del__c C s" |d ur t j||| fd��� d S )N)�target�args)� threading�Thread�start)r- �callbackr r r r �_ExecuteCallback� s z_Transfer._ExecuteCallback)FNTNr! )rC � __module__� __qualname__�__doc__r1 r5 �propertyr/ r0 r6 �setterr( r. r= r@ rA rD rG r> rI rP r r r r r N s< � r c s e Zd ZdZeejejejej f�Z ed�Z d.� fdd� Z e dd� �Ze dd � �Zed/d d ��Zed0dd��Zed1dd��Ze dd� �Ze dd� �Zdd� Zdd� Zdd� Zd2d d �Zd3d d �Zd4d d!�Zd5d"d#�Z d6d$d%�Z d&d'� Z d7d(d)�Z d8d*d+�Z d9d,d-�Z!� Z"S ):r zqData for a single download. Public attributes: chunksize: default chunksize to use for transfers. �r+ �progress� total_sizer= Nc sL |� dd �}tt| �j|fi |�� d | _d| _|| _d | _|| _|| _ d S )NrX r ) �pop�superr r1 �_Download__initial_response�_Download__progress�_Download__total_size�_Download__encoding�progress_callback�finish_callback)r- r. r_ r` �kwdsrX �� __class__r r r1 � s zDownload.__init__c C s | j S r2 )r\ r4 r r r rW � s zDownload.progressc C s | j S r2 )r^ r4 r r r �encoding� s zDownload.encodingFTc K sF t j�|�}t j�|�r*|s*t�d| ��| t|d�fd|d�|��S )z-Create a new download object from a filename.z*File %s exists and overwrite not specified�wbT)r/ r+ )�os�path� expanduser�existsr �InvalidUserInputError�open)�cls�filenameZ overwriter+ ra rg r r r �FromFile� s ���zDownload.FromFilec K s | |f||d�|��S )z+Create a new Download object from a stream.)r+ rX r )rl r. r+ rX ra r r r � FromStream� s �zDownload.FromStreamc K s� t �|�}| jt|�� � }|r4t�dd�|� ��| j|fi |��} |durV|| _ n |d | _ |durx|� |d �} n|d } t | d|d � t | d|d � | � || � | S ) z?Create a new Download object from a stream and serialized data.�,Invalid serialization data, missing keys: %s�, Nr+ r= r\ rW r] rX ) �json�loads� _REQUIRED_SERIALIZATION_KEYS�set�keysr r< �joinro r+ �FinalizeTransferUrl�setattrr@ ) rl r. � json_datar0 r+ �clientra r � missing_keys�downloadr= r r r �FromData� s* �� �zDownload.FromDatac C s | � � | j| j| j| jd�S )NrV )rG r+ rW rX r= r4 r r r �serialization_data s �zDownload.serialization_datac C s | j S r2 )r] r4 r r r rX s zDownload.total_sizec C s | j s dS d| j| j| jf S )NzDownload (uninitialized)z1Download with %d/%s bytes transferred from url %s�rA rW rX r= r4 r r r �__str__ s �zDownload.__str__c C s$ d|j d< d| jd f |jd< d S )N�media�altz bytes=0-%d� �Range)� query_paramsr, �headers)r- � http_request� url_builderr r r �ConfigureRequest s zDownload.ConfigureRequestc C sB d|v r.|d � d�\}}}|dkr.t|�| _| jdu r>d| _dS )z;Sets the total size based off info if possible otherwise 0.r �/�*Nr )� rpartition�intr] rX )r- r �_�totalr r r Z __SetTotal# s zDownload.__SetTotalc C s� | � � |du r"|du r"t�d��|p*|j}|durB|�|j�|_|j}| jr�| �d�}| �|d|� t � | j pr||�}|j | j vr�tj�|��|| _| �|j� |j�d|j�}|dur�|�|�}| �||� | jr�| �� dS )a� Initialize this download by making a request. Args: http_request: The HttpRequest to use to initialize this download. http: The httplib2.Http instance for this request. client: If provided, let this client process the final URL before sending any additional requests. If client is provided and http is not, client.http will be used instead. N� Must provide client or http.r zcontent-location)r> r � UserErrorr0 rx r= r+ �_Download__ComputeEndByte�_Download__SetRangeHeaderr � MakeRequestr6 � status_code�_ACCEPTABLE_STATUSES� HttpError� FromResponser[ �_Download__SetTotalr �get� request_urlr@ �StreamInChunks)r- r� r0 r{ r= �end_byter r r r �InitializeDownload0 s. � zDownload.InitializeDownloadc C s� |dur||dk r(t �dd||f ��n"|| jkrJt �dd|| jf ��t|| jd �}||k rtt �d||f ��||fS |dk r�td|| j �}|| jd fS dS ) z4Normalizes start and end values based on total size.Nr z0Cannot have end index with negative start index z[start=%d, end=%d]z0Cannot have start index greater than total size z[start=%d, total_size=%d]r� z(Range requested with end[%s] < start[%s])r rF rX �min�max)r- rN �endr r r Z__NormalizeStartEndS s, �� �� �z Download.__NormalizeStartEndc C sN |dk rd| |j d< n2|d u s(||k r8d| |j d< nd||f |j d< d S )Nr zbytes=%dr z bytes=%d-z bytes=%d-%d)r� )r- �requestrN r� r r r Z__SetRangeHeaderh s zDownload.__SetRangeHeaderc C sl |}|dk r| j s|S |r@|| j d }|dur<t||�}n|}| j rh| j d }|durdt||�}n|}|S )a� Compute the last byte to fetch for this request. This is all based on the HTTP spec for Range and Content-Range. Note that this is potentially confusing in several ways: * the value for the last byte is 0-based, eg "fetch 10 bytes from the beginning" would return 9 here. * if we have no information about size, and don't want to use the chunksize, we'll return None. See the tests for more examples. Args: start: byte to start at. end: (int or None, default: None) Suggested last byte. use_chunks: (bool, default: True) If False, ignore self.chunksize. Returns: Last byte to use in a Range header, or None. r r� N)rX r, r� )r- rN r� � use_chunksr� � alternater r r Z__ComputeEndBytep s zDownload.__ComputeEndBytec C sR | � � tj| jd�}| j|||d� |dur:|j�|� tj| j|| j | j d�S )z/Retrieve a chunk, and return the full response.)r= )r� N)r* �retries) rG r �Requestr= r� r� �updater� r6 r* r( )r- rN r� �additional_headersr� r r r Z __GetChunk� s �zDownload.__GetChunkc C s� |j | jvr8|j tjtjfv r,tj�|��n t�|j ��|j tj tj fv r�z| j � t�|j �� W n& ty� | j � t�|j �� Y n0 | j|j7 _|jr�d|jv r�|jd | _n|j tjkr�| j � d� |S )z?Process response (by updating self and writing to self.stream).zcontent-encoding� )r� r� r � FORBIDDEN� NOT_FOUNDr r� r� �TransferRetryError�content�OK�PARTIAL_CONTENTr. �writer: � ensure_binary� TypeError� ensure_textr\ r r r^ � NO_CONTENT�r- r r r r Z__ProcessResponse� s& � � zDownload.__ProcessResponsec C s� | � � d}| jdur,| �||�\}}d}n|}|}|rH|du sH||kr�| j|||d�}| j|||d�}|s�| �|j� | �||�\}}d}| �|�}||j7 }|jdkr4|j t j kr�dS t � d��q4dS )a� Retrieve a given byte range from this download, inclusive. Range must be of one of these three forms: * 0 <= start, end = None: Fetch from start to the end of the file. * 0 <= start <= end: Fetch the bytes from start to end. * start < 0, end = None: Fetch the last -start bytes of the file. (These variations correspond to those described in the HTTP 1.1 protocol for range headers in RFC 2616, sec. 14.35.1.) Args: start: (int) Where to start fetching bytes. (See above.) end: (int, optional) Where to stop fetching bytes. (See above.) additional_headers: (bool, optional) Any additional headers to pass with the request. use_chunks: (bool, default: True) If False, ignore self.chunksize and fetch this range in a single request. Returns: None. Streams bytes into self.stream. FNT)r� r� �r� r z5Zero bytes unexpectedly returned in download response)rG rX � _Download__NormalizeStartEndr� �_Download__GetChunkr� r �_Download__ProcessResponser r� r r� r r� ) r- rN r� r� r� Zprogress_end_normalizedrW r� r r r r �GetRange� s8 ��� �zDownload.GetRangec C s | j |||dd� dS )z%Stream the entire download in chunks.T�rO r` r� r� N)� StreamMedia�r- rO r` r� r r r r� � s �zDownload.StreamInChunksc C s� |p| j }|p| j}| �� | jdur4| j}d| _n"| j| j|d�}| j| j||d�}| jdu rl| �|j � | � |�}| � ||� |j t jks�| j| jkr q�q | � ||� dS )a4 Stream the entire download. Args: callback: (default: None) Callback to call as each chunk is completed. finish_callback: (default: None) Callback to call when the download is complete. additional_headers: (default: None) Additional headers to include in fetching bytes. use_chunks: (bool, default: True) If False, ignore self.chunksize and stream this download in a single request. Returns: None. Streams bytes into self.stream. N)r� r� )r_ r` rG r[ r� rW r� rX r� r r� rP r� r r� )r- rO r` r� r� r r� r r r r� � s, �� �zDownload.StreamMedia)NN)FT)TN)NNN)NN)N)N)NT)N)NNT)NNN)NNNT)#rC rQ rR rS ru r r� r� r� � REQUESTED_RANGE_NOT_SATISFIABLEr� rt r1 rT rW rd � classmethodrn ro r~ r rX r� r� r� r� r� r� r� r� r� r� r� r� � __classcell__r r rb r r � sV � � # + � 6 � �r c @ s$ e Zd ZdZdd� Zdd� ZeZdS )�MultipartBytesGeneratorao Generates a bytes Message object tree for multipart messages This is a BytesGenerator that has been modified to not attempt line termination character modification in the bytes payload. Known to work with the compat32 policy only. It may work on others, but not tested. The outfp object must accept bytes in its write method. c C s |j d u rd S | �|j � d S r2 )�_payloadr� )r- �msgr r r � _handle_text1 s z$MultipartBytesGenerator._handle_textc C s |� dd�S )N�ascii�surrogateescape)�encode)r- �sr r r �_encode8 s z MultipartBytesGenerator._encodeN)rC rQ rR rS r� r� � _writeBodyr r r r r� ) s r� c sV e Zd ZdZed�Zd@� fdd� Zedd � �Ze dAd d ��Z e dBd d ��Z e dCdd��Z edd� �Z edd� �Zedd� �Zdd� Zedd� �Zejdd� �Zedd � �Zejd d � �Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� ZdDd,d-�Zd.d/� Z dEd0d1�Z d2d3� Z dFd4d5�Z dGd6d7�Z dHd8d9�Z!d:d;� Z"dId<d=�Z#dJd>d?�Z$� Z%S )Kr a� Data for a single Upload. Fields: stream: The stream to upload. mime_type: MIME type of the upload. total_size: (optional) Total upload size for the stream. close_stream: (default: False) Whether or not we should close the stream when finished with the upload. auto_transfer: (default: True) If True, stream all bytes as soon as the upload is created. �r+ � mime_typerX r= NFTc sh t t| �j|f||||d�| �� d| _d | _|| _d| _d | _d | _d | _ | | _ || _ | | _ || _ d S )N)r/ r, r+ r0 Fr )rZ r r1 �_Upload__complete�_Upload__final_response�_Upload__mime_type�_Upload__progress�!_Upload__server_chunk_granularity�_Upload__strategy�_Upload__total_size�_Upload__gzip_encodedr_ r` rX ) r- r. r� rX r0 r/ r, r+ r_ r` � gzip_encodedra rb r r r1 O s& ���zUpload.__init__c C s | j S r2 )r� r4 r r r rW c s zUpload.progressc K s| t j�|�}t j�|�s&t�d| ��|sNt�|�\}}|du rNt�d| ��t � |�j }| t |d�|f|d||d�|��S )z+Create a new Upload object from a filename.zCould not find file %sNz Could not guess mime type for %s�rbT�rX r/ r+ r� ) rf rg rh ri r � NotFoundError� mimetypes� guess_typerj �stat�st_sizerk ) rl rm r� r+ r� ra rg r� �sizer r r rn g s � ��zUpload.FromFilec K s. |du rt �d��| ||f|d||d�|��S )z)Create a new Upload object from a stream.Nz!No mime_type specified for streamFr� )r rj )rl r. r� rX r+ r� ra r r r ro x s � ��zUpload.FromStreamc K s� t �|�}| jt|�� � } | r4t�dd�| � ��d|v rFt�d��| j ||d f|� d�|d�|��} t |t j �r�|�� s�t�d��|dur�|| _n |d | _|dur�|�|d �} n|d } t| _| �|| � | �� | �� | jr�| �� | S ) zACreate a new Upload of stream from serialized json_data and http.rp rq rX z/Cannot override total_size on serialized Uploadr� )rX r� z6Cannot restart resumable upload on non-seekable streamNr+ r= )rr rs rt ru rv r r< rw rj ro r� � isinstance�io�IOBase�seekabler+ rx r �strategyr@ �RefreshResumableUploadStaterG r� ) rl r. rz r0 r+ r� r{ ra r r| �uploadr= r r r r~ � sJ ������ �zUpload.FromDatac C s2 | � � | jtkr t�d��| j| j| j| jd�S )Nz2Serialization only supported for resumable uploadsr� ) rG r� r r r< r+ r� rX r= r4 r r r r � s ��zUpload.serialization_datac C s | j S r2 )r� r4 r r r �complete� s zUpload.completec C s | j S r2 )r� r4 r r r r� � s zUpload.mime_typec C s" | j s dS d| j| jpd| jf S )NzUpload (uninitialized)z.Upload with %d/%s bytes transferred for url %sz???r� r4 r r r r� � s �zUpload.__str__c C s | j S r2 )r� r4 r r r r� � s zUpload.strategyc C s$ |t tfvrt�d| ��|| _d S )NzOInvalid value "%s" for upload strategy, must be one of "simple" or "resumable".)r r r r� r� r7 r r r r� � s �c C s | j S r2 )r� r4 r r r rX � s zUpload.total_sizec C s | � � || _d S r2 )r> r� r7 r r r rX � s c C s^ |j du rt| _| jdur dS t}| jdur:| jtkr:t}|jrJ|jsJt}|jsTt}|| _dS )a Determine and set the default upload strategy for this upload. We generally prefer simple or multipart, unless we're forced to use resumable. This happens when any of (1) the upload is too large, (2) the simple endpoint doesn't support multipart requests and we have metadata, or (3) there is no simple upload endpoint. Args: upload_config: Configuration for the upload endpoint. http_request: The associated http request. Returns: None. N) �resumable_pathr r� rX �_RESUMABLE_UPLOAD_THRESHOLDr �body�simple_multipart� simple_path)r- � upload_configr� r� r r r Z__SetDefaultUploadStrategy� s � z!Upload.__SetDefaultUploadStrategyc C s� | j r.|jr.| j |jkr.t�d| j |jf ��t�|j| j�sTt�d| j|jf ��| �||� | j t kr�|j |_ |j r�d|jd< | �|� nd|jd< | �|� | jr�d|jd< t�t�|j ��d �� |_ n |j|_ d |jd< | �|� d S ) z.Configure the request and url for this upload.z*Upload too big: %s larger than max size %sz7MIME type %s does not match any accepted MIME ranges %s� multipartZ uploadTyper� �gzip�Content-Encodingr r N)rX �max_sizer rj r �AcceptableMimeType�acceptr� �!_Upload__SetDefaultUploadStrategyr� r r� � relative_pathr� r� �"_Upload__ConfigureMultipartRequest� _Upload__ConfigureMediaRequestr� r� r �CompressStreamr: �BytesIO�readr� �"_Upload__ConfigureResumableRequest)r- r� r� r� r r r r� � sB ����� ��� zUpload.ConfigureRequestc C s" | j |jd< | j�� |_d|_dS )z;Configure http_request as a simple request for this upload.� content-type� <media body>N)r� r� r. r� r� � loggable_body�r- r� r r r Z__ConfigureMediaRequest" s z Upload.__ConfigureMediaRequestc C s& t �d�}t|ddd� � tj|jd �d�� }|�|j� |� |� tj| j �d�� }d|d< |�| j � � � |� |� t �� }t jr�t}ntj}||d d �}|j|d d � |�� |_|�� }d | |jd< t|t j�r�|�d �}|j�|�}|d �d�\} } } d�| dg�|d< |�|�|_dS )z>Configure http_request as a multipart request for this upload.�related�_write_headersc S s d S r2 r r4 r r r �<lambda>- � z4Upload.__ConfigureMultipartRequest.<locals>.<lambda>r� r� �binaryzContent-Transfer-EncodingF)� mangle_from_)�unixfromz multipart/related; boundary=%rr� ���s s <media body> --N) �mime_multipart� MIMEMultipartry �mime_nonmultipart�MIMENonMultipartr� �split� set_payloadr� �attachr� r. r� r: r� �PY3r� �email_generator� Generator�flatten�getvalue� get_boundaryr� � text_typer� � partitionrw r� ) r- r� Zmsg_rootr� �fpZgenerator_class�gZmultipart_boundaryZbody_componentsr� r� r r r Z__ConfigureMultipartRequest( s6 � � z"Upload.__ConfigureMultipartRequestc C s* | j |jd< | jd ur&t| j�|jd< d S )NzX-Upload-Content-TypezX-Upload-Content-Length)r� r� rX r3 r� r r r Z__ConfigureResumableRequestR s ��z"Upload.__ConfigureResumableRequestc C s� | j tkrdS | �� tj| jdddid�}tj| j|d| jd�}| � |�}|j t j t j fv r�d| _| j| _| j�| j� || _nH|j tjkr�|du r�d| _n| �|�d | _| j�| j� n tj�|��dS ) z�Talk to the server and refresh the state of this resumable upload. Returns: Response if the upload is complete. N�PUT� Content-Rangez bytes */*)r= � http_methodr� r )� redirectionsr� Tr� )r� r rG r r� r= r� r0 r( �_GetRangeHeaderFromResponser� r r� �CREATEDr� rX r� r. �seekrW r� �RESUME_INCOMPLETE�_Upload__GetLastByter r� r� )r- Zrefresh_requestZrefresh_response� range_headerr r r r� X s2 �� � z"Upload.RefreshResumableUploadStatec C s |j �d|j �d��S )Nr� r )r r� r� r r r r z s z"Upload._GetRangeHeaderFromResponsec C s� | j du rt�d��|du r.|du r.t�d��| j tkr<dS |pD|j}|dur\|�|j�|_| �� tj ||| j d�}|j t j kr�tj�|��|j�d�| _|jd }|dur�|�|�}| �||� | jr�| �� S |S )z3Initialize this upload from the given http_request.Nz6No upload strategy set; did you call ConfigureRequest?r� )r� z X-Goog-Upload-Chunk-Granularity�location)r� r r� r r0 rx r= r> r r� r( r� r r� r� r� r r� r� r@ r+ r� )r- r� r0 r{ � http_responser= r r r �InitializeUpload} s6 � � � zUpload.InitializeUploadc C s |� d�\}}}t|�S )N�-)r r� )r- r! r� r� r r r Z __GetLastByte� s zUpload.__GetLastBytec C s6 | j d u rd S |p| j}|| j r2t�d| j ��d S )Nz0Server requires chunksize to be a multiple of %d)r� r, r �ConfigurationValueError)r- r, r r r Z__ValidateChunksize� s ��zUpload.__ValidateChunksizec C s |j dkp|j tjkp|jS )Ni� )r� r �TOO_MANY_REQUESTS� retry_afterr� r r r Z __IsRetryable� s ��zUpload.__IsRetryablec s� �j tkrt�d��|p �j}|p&�j}�j}� �fdd�}� �fdd�}|rR|n|}|sj�jrjt�d��|rz���j � �� � �j �sH|�j � � �}|jtjtjfv r�d�_�qH|jtjtjtjfv�r�j tks��|�s�tj�|����� ��||� q�����|���_ �j d �j � � k�r:t� d �j ����||� q��j�r�t �j d ��r��j � � } �j � d t!j"� �j � � } �j � | � | | k�r�t�#d t$| �t$| � ����||� |S ) z1Helper function for StreamMedia / StreamInChunks.z"Cannot stream non-resumable uploadc s �j | � d�S �Nr� )�_Upload__SendChunk�rN �r� r- r r � CallSendChunk� s �z+Upload.__StreamMedia.<locals>.CallSendChunkc s �j | � d�S r) )�_Upload__SendMediaBodyr+ r, r r �CallSendMediaBody� s �z/Upload.__StreamMedia.<locals>.CallSendMediaBodyz%Cannot gzip encode non-chunked uploadTr� z?Failed to transfer all bytes in chunk, upload paused at byte %dr r z7Upload complete with %s additional bytes left in stream)%r� r r rj r_ r` r� r� �_Upload__ValidateChunksizer, rG r� r. �tellr� r r� r r� r r �_Upload__IsRetryabler� r� r� rP r r r� rW �CommunicationError�hasattrr rf �SEEK_ENDrF r� ) r- rO r` r� r� r r- r/ Z send_funcZ current_posZend_posr r, r Z __StreamMedia� sp � � � � ��� �� zUpload.__StreamMediac C s | j |||dd�S )a� Send this resumable upload in a single request. Args: callback: Progress callback function with inputs (http_wrapper.Response, transfer.Upload) finish_callback: Final callback function with inputs (http_wrapper.Response, transfer.Upload) additional_headers: Dict of headers to include with the upload http_wrapper.Request. Returns: http_wrapper.Response of final response. Fr� ��_Upload__StreamMediar� r r r r� � s �zUpload.StreamMediac C s | j |||d�S )z'Send this (resumable) upload in chunks.)rO r` r� r6 r� r r r r� s �zUpload.StreamInChunksc C s^ dd� }t j| j|| j| j|d�}|jt jkrZ| �| �|��}|d |krZ| j � |d � |S )z6Request helper function for SendMediaBody & SendChunk.c S s | d u rt �d| j ��d S )Nz,Request to url %s did not return a response.)r � RequestErrorr� )r r r r � CheckResponse s ��z0Upload.__SendMediaRequest.<locals>.CheckResponse)r* r� �check_response_funcr� ) r r� r6 r* r( r� r r r r. r )r- r� r� r9 r Z last_byter r r Z__SendMediaRequest s � � zUpload.__SendMediaRequestc C s� | � � | jdu r t�d��t�| j| j| �}tj| j d|d�}| j |j d< || jkrdd| j }nd|| jd | jf }||j d < |r�|j � |� | � || j�S ) z1Send the entire media stream in a single request.Nz*Total size must be known for SendMediaBodyr )r= r r� � Content-Type� bytes */%s�bytes %s-%s/%sr� r )rG rX r rF r � StreamSlicer. r r� r= r� r� r� �_Upload__SendMediaRequest)r- rN r� � body_streamr� � range_stringr r r Z__SendMediaBody s* � � � � zUpload.__SendMediaBodyc C sP | � � | jdu }tj| jdd�}| jrfd|jd< t�| j | j �\}}}|| }| jdu r�|r�|| _ n`| jdu r�t � | j || j �}|j}|jr�|| _ |�| j �}n$t|| j | j�}t�| j || �}||_| j|jd< |r�d|_| jdu r�d||d f } n*||k�rd | j } nd ||d | jf } | |jd < |�rD|j�|� | �||�S ) zSend the specified chunk.Nr )r= r r� r� r; r� z bytes %s-%s/*r� r< r= r )rG rX r r� r= r� r� r r� r. r, r� r ZBufferedStreamZstream_end_positionZstream_exhaustedr� r� r r> r� r� r� r� r? ) r- rN r� Z no_log_bodyr� r@ Z read_lengthZ exhaustedr� rA r r r Z __SendChunk7 sD � � zUpload.__SendChunk)NNFNTNNF)NTF)NTF)NFN)NN)N)NNNT)NNN)NNN)N)N)&rC rQ rR rS ru rt r1 rT rW r� rn ro r~ r r� r� r� r� rU rX r� r� r� r� r� r� r r$ r r0 r2 r7 r� r� r? r. r* r� r r rb r r ? sv � � � � $ -*" � B � � r )+rS � __future__r �email.generator� generatorr �email.mime.multipart�mimer� r �email.mime.nonmultipart� nonmultipartr r� rr r� rf rL r: � six.movesr �apitools.base.pyr r r r r r �__all__r� r r r r r r �objectr r r �BytesGeneratorr� r r r r r �<module> s@ k q py/__pycache__/__init__.cpython-39.pyc 0000644 00000001245 15025317163 0013601 0 ustar 00 a vyg� � @ sx d Z ddlT ddlT ddlT ddlT ddlT ddlT ddlT ddlT ddl T ddl T z ddl T W n e yr Y n0 dS )z*Top-level imports for apitools base files.� )�*N) �__doc__Zapitools.base.py.base_apiZapitools.base.py.batchZ apitools.base.py.credentials_libZapitools.base.py.encoding�apitools.base.py.exceptionsZ apitools.base.py.extra_typesZ apitools.base.py.http_wrapperZapitools.base.py.list_pagerZapitools.base.py.transferZapitools.base.py.utilZapitools.base.py.internal� ImportError� r r �=/opt/gsutil/third_party/apitools/apitools/base/py/__init__.py�<module> s py/__pycache__/gzip.cpython-39.pyc 0000644 00000036667 15025317163 0013033 0 ustar 00 a vyg�U � @ s� d Z ddlZddlmZ ddlmZ ddlZddlZddlZddlZddl Z ddl Z g d�Z d\Z Z ZZZd\ZZdd d �Zd d � ZG dd� de�ZG dd� de j�Zddd�Zdd� ZdS )z�Functions that read and write gzipped files. The user of the file doesn't have to worry about the compression, but random access is not allowed.� N)�builtins)�range)�GzipFile�open�compress� decompress)� � � � � )r r �rb� c C s t | ||�S )z�Shorthand for GzipFile(filename, mode, compresslevel). The filename argument is required; mode defaults to 'rb' and compresslevel defaults to 9. )r )�filename�mode� compresslevel� r �9/opt/gsutil/third_party/apitools/apitools/base/py/gzip.pyr " s r c C s | � t�d|�� d S )Nz<L)�write�struct�pack)�output�valuer r r �write32u, s r c @ sF e Zd ZdZddd�Zdd� Zddd �Zd d � Zdd d�Zdd� Z dS )� _PaddedFilez�Minimal read-only file object that prepends a string to the contents of an actual file. Shouldn't be used outside of gzip.py, as it lacks essential functionality.� c C s || _ t|�| _|| _d| _d S �Nr )�_buffer�len�_length�file�_read)�self�f�prependr r r �__init__7 s z_PaddedFile.__init__c C s~ | j d u r| j�|�S | j | | jkrJ| j }| j |7 _ | j|| j � S | j }d | _ | j|d � | j�|| j | � S d S �N)r! r �readr r )r" �sizer' r r r r' = s �z_PaddedFile.readFc C sf | j d u r|| _n>|r:t|�| j kr:| j t|�8 _ d S | j| j d � | | _t| j�| _d| _ d S r )r! r r r )r" r$ Z readpreviousr r r r$ J s z_PaddedFile.prependc C s | j d u rdS | j| j d � S )Nr )r! r �r" r r r �unusedU s z_PaddedFile.unusedr c C sn |dkrT| j d urTd|| j kr.| jkrDn n| j |7 _ d S || j| j 7 }d | _ d | _| j�||�S )Nr r )r! r r r �seek)r" �offset�whencer r r r+ Z s z_PaddedFile.seekc C s t | j|�S r& )�getattrr )r" �namer r r � __getattr__f s z_PaddedFile.__getattr__N)r )r F)r ) �__name__� __module__� __qualname__�__doc__r% r' r$ r* r+ r0 r r r r r 2 s r c @ s e Zd ZdZdZdZd>dd�Zedd� �Zd d � Z d d � Z d d� Z dd� Z dd� Z dd� Zdd� Zdd� Zd?dd�Zd@d d �Zd d � Zd d!� ZdAd#d$�Zd%d&� Zd'd(� Zed)d*� �Zd+d,� Zejfd-d.�Z d/d0� Z d1d2� Z d3d4� Z d5d6� Z d7d8� Z!dBd:d;�Z"dCd<d=�Z#dS )Dr a The GzipFile class simulates most of the methods of a file object with the exception of the readinto() and truncate() methods. This class only supports opening files in binary mode. If you need to open a compressed file in text mode, use the gzip.open() function. Ni � r c C s< |r"d|v sd|v r"t d�|���|r6d|vr6|d7 }|du rTt�||pJd� }| _|du rxt|dd�}t|tj�sxd}|du r�t|d d�}|� d �r�t | _ d | _ d | _ d | _d | _|| _d| _t|�}nH|� d��rt| _ | �|� t�|tjtj tjd �| _nt d�|���|| _d | _ || _ | j tk�r8| � � dS )az Constructor for the GzipFile class. At least one of fileobj and filename must be given a non-trivial value. The new class instance is based on fileobj, which can be a regular file, an io.BytesIO object, or any other object which simulates a file. It defaults to None, in which case filename is opened to provide a file object. When fileobj is not None, the filename argument is only used to be included in the gzip file header, which may includes the original filename of the uncompressed file. It defaults to the filename of fileobj, if discernible; otherwise, it defaults to the empty string, and in this case the original filename is not included in the header. The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', or 'wb', depending on whether the file will be read or written. The default is the mode of fileobj if discernible; otherwise, the default is 'rb'. A mode of 'r' is equivalent to one of 'rb', and similarly for 'w' and 'wb', and 'a' and 'ab'. The compresslevel argument is an integer from 0 to 9 controlling the level of compression; 1 is fastest and produces the least compression, and 9 is slowest and produces the most compression. 0 is no compression at all. The default is 9. The mtime argument is an optional numeric timestamp to be written to the stream when compressing. All gzip compressed streams are required to contain a timestamp. If omitted or None, the current time is used. This module ignores the timestamp when decompressing; however, some programs, such as gunzip, make use of it. The format of the timestamp is the same as that of the return value of time.time() and of the st_mtime member of the object returned by os.stat(). �t�UzInvalid mode: {!r}�bNr r/ � r �rTr r �d )�w�a) � ValueError�formatr r � myfileobjr. � isinstance�six� string_types� startswith�READr � _new_member�extrabuf� extrasize� extrastartr/ � min_readsizer �WRITE� _init_write�zlib� compressobj�DEFLATED� MAX_WBITS� DEF_MEM_LEVELr �fileobjr, �mtime�_write_gzip_header)r" r r r rQ rR r r r r% v sH ( � zGzipFile.__init__c C sB dd l }|�dtd� | jtkr<| jdd � dkr<| jd S | jS )Nr zuse the name attributer ���z.gz)�warnings�warn�DeprecationWarningr rJ r/ )r" rU r r r r � s zGzipFile.filenamec C sB | j }t|t�r|j}t|�}d|dd� d tt| �� d S )Nz<gzip r ���� �>)rQ r@ r r �repr�hex�id)r" rQ �sr r r �__repr__� s zGzipFile.__repr__c C s | j rtd��dS )zLRaises a ValueError if the underlying file object has been closed. z I/O operation on closed file.N)�closedr= r) r r r � _check_closed� s zGzipFile._check_closedc C s, || _ t�d�d@ | _d| _g | _d| _d S �Nr � �� r )r/ rL �crc32�crcr( �writebuf�bufsize)r" r r r r rK � s zGzipFile._init_writec C s� | j �d� | j �d� z>tj�| j�}t|tj�s>|� d�}|� d�rT|d d� }W n t yl d}Y n0 d}|rzt }| j �t� |�� d�� | j}|d u r�t�� }t| j t|�� | j �d� | j �d � |r�| j �|d � d S ) N� �� zlatin-1s .gzrT r r � � �� )rQ r �os�path�basenamer/ r@ rA � binary_type�encode�endswith�UnicodeEncodeError�FNAME�unichrrR �timer �int)r" �fname�flagsrR r r r rS � s, zGzipFile._write_gzip_headerc C s t �d�d@ | _d| _d S rb )rL rd re r( r) r r r � _init_read s zGzipFile._init_readc C sF | j �|�}t|�|k rB| j �|t|� �}|s8td��||7 }q |S )NzACompressed file ended before the end-of-stream marker was reached)rQ r' r �EOFError)r" �n�datar7 r r r � _read_exact s zGzipFile._read_exactc C s� | j �d�}|dkrdS |dkr(td��t�d| �d��\}}| _|dkrRtd��|t@ rxt�d | �d��\}| �|� |t@ r�| j �d �}|r�|d kr�q�q�|t @ r�| j �d �}|r�|d kr�q�q�|t @ r�| �d� | j � � }|r�| j � |�}| � |� d S ) Nr r Frh zNot a gzipped filez<BBIxxr zUnknown compression methodz<Hr rl T)rQ r' �OSErrorr �unpackr~ rR �FEXTRArt �FCOMMENT�FHCRCr* r �_add_read_data)r" �magic�method�flag� extra_lenr^ r* � uncompressr r r �_read_gzip_header s4 zGzipFile._read_gzip_headerc C s� | � � | jtkr&dd l}t|jd��| jd u r8td��t|t �rJ|� � }t |�dkr�| j� | j � |�� | jt |�7 _t�|| j�d@ | _| jt |�7 _t |�S )Nr z$write() on read-only GzipFile objectz!write() on closed GzipFile objectrc )ra r rJ �errnor �EBADFrQ r= r@ � memoryview�tobytesr r r r( rL rd re r, )r" r} r� r r r r 6 s zGzipFile.writerX c C s� | � � | jtkr&dd l}t|jd��| jdkr>| jd u r>dS d}|dk rn| �|�rft | j |d �}qJ| j}n8|| jkr�| �|�s�|| jkr�| j}q�t | j |d �}qn| j | j }| j ||| � }| j| | _| j |7 _ |S )Nr z$read() on write-only GzipFile objectr � r )ra r rD r� r r� rG rQ r! �min�max_read_chunkr, rH rF )r" r( r� �readsizer, �chunkr r r r' K s, z GzipFile.readc C s� | � � | jtkr&dd l}t|jd��| jdkr>| jd u r>dS | jdkrR| �� rRq>|dk sd|| jkrj| j}| j | j }| j ||| � }| j|8 _| j |7 _ |S )Nr z%read1() on write-only GzipFile objectr ) ra r rD r� r r� rG rQ r! r, rH rF )r" r( r� r, r� r r r �read1h s zGzipFile.read1c C s� | j tkr dd l}t|jd��|dk r*d}| jdkr^| jd u rBdS | jdkr^| �t|d��r^qB| j | j }| j}|t | j �| ks�J �| j ||| � S )Nr z$peek() on write-only GzipFile objectr: r r� ) r rD r� r r� rG rQ r! �maxr, rH r rF )r" r| r� r, � remainingr r r �peek~ s z GzipFile.peekc C s& t |�| j | _| jt |�8 _d S r& )r rG r, )r" �bufr r r �_unread� s zGzipFile._unreadr� c C s� | j d u rdS | jr>| �� | �� s(dS t�tj �| _d| _| j �|�}|dkr�| j� � }| j � | jj d� | � � | � |� dS | j�|�}| � |� | jj dkr�| j � | jj d� | � � d| _dS )NFr T)rQ rE rz r� rL � decompressobjrO r r' �flushr$ � unused_data� _read_eofr� )r" r( r� r� r r r r! � s, zGzipFile._readc C s` t �|| j�d@ | _| j| j }| j|d � | | _| jt|� | _| j| _| jt|� | _d S �Nrc ) rL rd re r, rH rF rG r r( )r" r} r, r r r r� � s zGzipFile._add_read_datac C s� t �d| �d��\}}|| jkr<tdt|�t| j�f ��n|| jd@ krRtd��d}|dkrl| j�d�}qV|r~| j� |d� d S ) Nz<IIr zCRC check failed %s != %src z!Incorrect length of data producedrl r T) r r� r~ re r r\ r( rQ r' r$ )r" rd �isize�cr r r r� � s � zGzipFile._read_eofc C s | j d u S r& �rQ r) r r r r` � s zGzipFile.closedc C s� | j }|d u rd S d | _ zR| jtkrP|�| j�� � t|| j� t|| jd@ � W | j }|r�d | _ |� � n| j }|r�d | _ |� � 0 d S r� ) rQ r rJ r r r� r re r( r? �close)r" rQ r? r r r r� � s" �zGzipFile.closec C s4 | � � | jtkr0| j�| j�|�� | j�� d S r& )ra r rJ rQ r r r� )r" � zlib_moder r r r� � s zGzipFile.flushc C s | j �� S )z�Invoke the underlying file object's fileno() method. This will raise AttributeError if the underlying file object doesn't support fileno(). )rQ �filenor) r r r r� � s zGzipFile.filenoc C s@ | j tkrtd��| j�d� d| _d| _d| _d| _d| _ dS )z[Return the uncompressed stream file position indicator to the beginning of the filezCan't rewind in write moder Tr N) r rD r rQ r+ rE rF rG rH r, r) r r r �rewind s zGzipFile.rewindc C s | j tkS r& )r rD r) r r r �readable s zGzipFile.readablec C s | j tkS r& )r rJ r) r r r �writable s zGzipFile.writablec C s dS )NTr r) r r r �seekable s zGzipFile.seekabler c C s� |r |dkr| j | }ntd��| jtkr~|| j k r<td��|| j }td�}t|d �D ]}| �|� qZ| �t|d �� nP| jtkr�|| j k r�| � � || j }t|d �D ]}| � d� q�| � |d � | j S )Nr zSeek from end not supportedzNegative seek in write moder� ) r, r= r rJ r �bytesr r rD r� r' )r" r, r- �countr� �ir r r r+ s( z GzipFile.seekc C sH |dk rn| j | j }| j�d|�d }|dkr`| j|| 8 _| j || 7 _ | j||� S tj}| j}n|}g }|dk�r | �|�}|�d�}||ks�|dkr�t |�|kr�|d }|dks�|dkr�|� |d |d � � | � ||d d � � �q |� |� |t |� }t ||d �}qv|| jk�r>t || jd d�| _d� |�S )Nr � r rX r r i )r, rH rF �findrG �sys�maxsizerI r' r �appendr� r� �join)r" r( r, r� r� Zbufsr� r r r �readline2 s4 zGzipFile.readline)NNr NN)rX )rX )r� )r )rX )$r1 r2 r3 r4 r? r� r% �propertyr r_ ra rK rS rz r~ r� r r' r� r� r� r! r� r� r` r� rL � Z_SYNC_FLUSHr� r� r� r� r� r� r+ r� r r r r r j sD � V % , r c C sH t �� }t|d|d��}|�| � W d � n1 s60 Y |�� S )z�Compress data in one shot and return the compressed string. Optional argument is the compression level, in range of 0-9. �wb)rQ r r N)�io�BytesIOr r �getvalue)r} r r� r# r r r r Z s (r c C s< t t�| �d��}|�� W d � S 1 s.0 Y dS )zYDecompress a gzip compressed string in one shot. Return the decompressed string. r� N)r r� r� r' )r} r# r r r r d s r )r r )r )r4 rA � six.movesr r r r� rv rm rL r� �__all__�FTEXTr� r� rt r� rD rJ r r �objectr �BufferedIOBaser r r r r r r �<module> s* 8 s py/__pycache__/list_pager.cpython-39.pyc 0000644 00000007662 15025317163 0014204 0 ustar 00 a vyg� � @ sP d Z ddlmZ ddlZdgZdd� Zdd� Zddd d d dd d def dd�ZdS )zGA helper function that executes a series of List queries for many APIs.� )�encodingN� YieldFromListc C sF t |tj�rt| |�S t|�dkr&| S tt| |d �|dd� �S dS )a- Gets a possibly nested attribute. Same as getattr() if attribute is a string; if attribute is a tuple, returns the nested attribute referred to by the fields in the tuple as if they were a dotted accessor path. (ex _GetattrNested(msg, ('foo', 'bar', 'baz')) gets msg.foo.bar.baz r � N)� isinstance�six� string_types�getattr�len�_GetattrNested)�message� attribute� r �?/opt/gsutil/third_party/apitools/apitools/base/py/list_pager.pyr s r c C sl t |tj�rt| ||�S t|�dk r.td��n:t|�dkrJt| |d |�S tt| |dd� �|d |�S dS )a: Sets a possibly nested attribute. Same as setattr() if attribute is a string; if attribute is a tuple, sets the nested attribute referred to by the fields in the tuple as if they were a dotted accessor path. (ex _SetattrNested(msg, ('foo', 'bar', 'baz'), 'v') sets msg.foo.bar.baz to 'v' r zNeed an attribute to setr N���)r r r �setattrr � ValueErrorr )r r �valuer r r �_SetattrNested, s �r �d �List�items� pageToken� nextPageToken� maxResultsc c s� t �|�}t||d� |du s"|r�| rN|du r4d} nt||p>|�} t|| | � t| |�||d�} | | |�}|r|tt||��}|D ]&}|V |du r�q�|d8 }|s� dS q�t| | �}|s�dS t|||� qdS )a� Make a series of List requests, keeping track of page tokens. Args: service: apitools_base.BaseApiService, A service with a .List() method. request: protorpc.messages.Message, The request message corresponding to the service's .List() method, with all the attributes populated except the .maxResults and .pageToken attributes. global_params: protorpc.messages.Message, The global query parameters to provide when calling the given method. limit: int, The maximum number of records to yield. None if all available records should be yielded. batch_size: int, The number of items to retrieve per request. method: str, The name of the method used to fetch resources. field: str, The field in the response that will be a list of items. predicate: lambda, A function that returns true for items to be yielded. current_token_attribute: str or tuple, The name of the attribute in a request message holding the page token for the page being requested. If a tuple, path to attribute. next_token_attribute: str or tuple, The name of the attribute in a response message holding the page token for the next page. If a tuple, path to the attribute. batch_size_attribute: str or tuple, The name of the attribute in a response message holding the maximum number of results to be returned. None if caller-specified batch size is unsupported. If a tuple, path to the attribute. get_field_func: Function that returns the items to be yielded. Argument is response message, and field. Yields: protorpc.message.Message, The resources listed by the service. N)� global_paramsr )r �CopyProtoMessager �minr �list�filterr )�service�requestr �limit� batch_size�method�field� predicateZcurrent_token_attributeZnext_token_attributeZbatch_size_attributeZget_field_funcZrequest_batch_size�responser �item�tokenr r r r A s2 ( � )�__doc__�apitools.base.pyr r �__all__r r r r r r r �<module> s �� py/__pycache__/base_api.cpython-39.pyc 0000644 00000055307 15025317163 0013615 0 ustar 00 a vyg,u � @ s6 d Z ddlZddlZddlZddlZddlZddlZddlmZ ddlm Z ddl m Z ddl m Z ddl mZ ddl mZ dd l mZ dd l mZ g d �Ze�d ��ej� d ZG dd� de j�ZG dd� de j�ZdZdd� Zdd� Z dd� Z dd� Z G dd � d e �Z d d � Z!G d d � d e �Z"G d!d"� d"e �Z#dS )#z Base class for api services.� N)� http_client)�urllib)� message_types)�messages)�encoding)� exceptions)� http_wrapper)�util)� ApiMethodInfo� ApiUploadInfo� BaseApiClient�BaseApiService�NormalizeApiEndpointzoauth2client.utili c @ sP e Zd ZdZejddd�Ze�d�Ze�d�Z e� d�Z e�d�Z e� d �Z d S ) r aT Media upload information for a method. Fields: accept: (repeated) MIME Media Ranges for acceptable media uploads to this method. max_size: (integer) Maximum size of a media upload, such as 3MB or 1TB (converted to an integer). resumable_path: Path to use for resumable uploads. resumable_multipart: (boolean) Whether or not the resumable endpoint supports multipart uploads. simple_path: Path to use for simple uploads. simple_multipart: (boolean) Whether or not the simple endpoint supports multipart uploads. � T��repeated� � � � � N)�__name__� __module__� __qualname__�__doc__r � StringField�accept� IntegerField�max_sizeZresumable_path� BooleanFieldZresumable_multipartZ simple_pathZsimple_multipart� r r �=/opt/gsutil/third_party/apitools/apitools/base/py/base_api.pyr 5 s r c @ s� e Zd ZdZe�d�Ze�d�Ze�d�Ze�d�Z ejddd�Z ejd dd�Z ejd dd�Z e�d �Z e�d �Ze�d �Zejddd�Ze�ed�Zejddd�Ze�d�ZdS )r a� Configuration info for an API method. All fields are strings unless noted otherwise. Fields: relative_path: Relative path for this method. flat_path: Expanded version (if any) of relative_path. method_id: ID for this method. http_method: HTTP verb to use for this method. path_params: (repeated) path parameters for this method. query_params: (repeated) query parameters for this method. ordered_params: (repeated) ordered list of parameters for this method. description: description of this method. request_type_name: name of the request type. response_type_name: name of the response type. request_field: if not null, the field to pass as the body of this POST request. may also be the REQUEST_IS_BODY value below to indicate the whole message is the body. upload_config: (ApiUploadInfo) Information about the upload configuration supported by this method. supports_download: (boolean) If True, this method supports downloading the request via the `alt=media` query parameter. api_version_param: API version system parameter for this method. r r r r r Tr r � � � � � � )�default� � F� N)r r r r r r � relative_pathZ flat_path� method_id� http_method� path_params� query_paramsZordered_params� description�request_type_name�response_type_name� request_field� MessageFieldr � upload_configr Zsupports_download�api_version_paramr r r r! r M s r z <request>c C sH | � d�r$| �d�\}}}tt|�S d| vr6t|| �S t�d| ��d S )Nzmessage_types.�.zUnknown class %s)� startswith� partition�getattrr r �GeneratedClientError)�name�messages_module�_� classnamer r r! � _LoadClass~ s rA c C sJ |D ]@}|� � }t| d| �r(t| |�sd|t| �jf }t�|��qd S )Nz%sz'No %s specified for object of class %s.)�upper�hasattrr; �typer r r< )�obj�attrs�attr� attr_name�msgr r r! �_RequireClassAttrs� s �rJ c C s | � d�s| d7 } | S )N�/)�endswith)Z api_endpointr r r! r � s r c C sZ |� d�s|� d�r"tj�| |�S | �d�r0| n| d }|� d�rN|dd� n|}|| S )z8Custom urljoin replacement supporting : before / in url.zhttp://zhttps://rK r N)r9 r �parse�urljoinrL )�base�url�new_base�new_urlr r r! �_urljoin� s rS c @ sX e Zd ZdZddd�Zedd� �Zedd� �Zej d d� �Zed d � �Z ed d � �Z dS )� _UrlBuilderz"Convenient container for url data.Nc C st t j�t||pd��}|jr,t�d|j ��t j�|jp:d�| _ |d urT| j � |� |j | _ |j | _|jpld| _d S )Nr' zUnexpected url fragment: %s)r rM �urlsplitrS �fragmentr �ConfigurationValueError�parse_qs�queryr0 �update�scheme�_UrlBuilder__scheme�netloc�_UrlBuilder__netloc�pathr, )�self�base_urlr, r0 � componentsr r r! �__init__� s �� z_UrlBuilder.__init__c C sL t j�|�}t j�|j�}t j�|j|jdd d f�}|jp<d}| |||d�S )Nr' )r, r0 ) r rM rU rX rY � urlunsplitr[ r] r_ )�clsrP �urlpartsr0 ra r, r r r! �FromUrl� s � �z_UrlBuilder.FromUrlc C s t j�| j| jdddf�S )Nr' )r rM rd r\ r^ �r` r r r! ra � s �z_UrlBuilder.base_urlc C s@ t j�|�}|js |js |jr,t�d| ��|j| _ |j | _ d S )NzInvalid base url: %s) r rM rU r_ rY rV r rW r[ r\ r] r^ )r` �valuerb r r r! ra � s �c C s t j�| jd�S )NT)r rM � urlencoder0 rh r r r! rY � s z_UrlBuilder.queryc C sB d| j v sd| j v r$t�d| j ��tj�| j| j| j | jdf�S )N�{�}z'Cannot create url with relative path %sr' ) r, r rW r rM rd r\ r^ rY rh r r r! rP � s ��z_UrlBuilder.url)NN) r r r r rc � classmethodrg �propertyra �setterrY rP r r r r! rT � s rT c C s dS )z0Hook for skipping credentials. For internal use.Fr r r r r! �_SkipGetCredentials� s rp c @ sL e Zd ZdZdZdZdZdZdZg Z dZ d:dd �Z d d � Z e d d � �Zedd� �Zedd� �Zedd� �Ze dd� �Zedd� �Zedd� �Zedd� �Zd d � Zed d � �Zejd d!� �Zed"d#� �Z ejd$d%� �Z ed&d'� �Z e j d(d'� �Z ed)d*� �Z e j d+d*� �Z ejd,d-� �Z!d.d/� Z"d0d1� Z#d2d3� Z$d4d5� Z%d6d7� Z&d8d9� Z'dS );r z Base class for client libraries.Nr' TFr �< c C s� t | d� | d ur t�| | j� | | _|| _|| _d| _d| _|| _ | | _ || _ |oZt � }|r||s|| pji } | j f i | �� t|�| _|p�t�� | _| j d ur�| j �| j�| _d | _| p�i | _| | _|| _|| _d| _|}d| _d S )N)Z_packageZ_scopesr> r rq F�proto)rJ r � Typecheck� params_type�%_BaseApiClient__default_global_params� log_request� log_response�_BaseApiClient__num_retries� _BaseApiClient__max_retry_wait� num_retries�max_retry_wait� _credentialsrp �_SetCredentialsr �_urlr ZGetHttp�_http� authorize� _BaseApiClient__include_fields�additional_http_headers�check_response_func� retry_func�response_encoding�(overwrite_transfer_urls_with_client_base�#_BaseApiClient__response_type_model)r` rP � credentials�get_credentials�http�modelrv rw rz r{ Zcredentials_argsZdefault_global_paramsr� r� r� r� r? r r r! rc � s6 zBaseApiClient.__init__c K sL | j | | j| j| j| j| jd�}|�|� ddlm} |j f i |��| _ dS )aF Fetch credentials, and set them for this client. Note that we can't simply return credentials, since creating them may involve side-effecting self. Args: **kwds: Additional keyword arguments are passed on to GetCredentials. Returns: None. Sets self._credentials. )�api_key�client� client_id� client_secret� package_name�scopes� user_agentr )�credentials_libN) �_API_KEY� _CLIENT_ID�_CLIENT_SECRET�_PACKAGE�_SCOPES� _USER_AGENTrZ �apitools.base.pyr� ZGetCredentialsr| )r` �kwds�argsr� r r r! r} s � z BaseApiClient._SetCredentialsc C s& | j | jd�tt�| j���| jd�S )N� )r� r� �scoper� )r� r� �join�sortedr ZNormalizeScopesr� r� �re r r r! � ClientInfo= s �zBaseApiClient.ClientInfoc C s d S �Nr rh r r r! �base_model_classF s z BaseApiClient.base_model_classc C s | j S r� )r rh r r r! r� J s zBaseApiClient.httpc C s | j S r� )r~ rh r r r! rP N s zBaseApiClient.urlc C s | j S r� )r� r� r r r! � GetScopesR s zBaseApiClient.GetScopesc C s t d| j�S )N�StandardQueryParameters)rA �MESSAGES_MODULErh r r r! rt V s zBaseApiClient.params_typec C s | j S r� )r� rh r r r! r� Z s zBaseApiClient.user_agentc C s | j d u r| �� | _ | j S r� )ru rt rh r r r! �_default_global_params^ s z$BaseApiClient._default_global_paramsc C s | j }t|||� d S r� )r� �setattr)r` r= ri �paramsr r r! �AddGlobalParame s z BaseApiClient.AddGlobalParamc C s t �| j�S r� )r ZCopyProtoMessager� rh r r r! � global_paramsi s zBaseApiClient.global_paramsc c s || _ d V d | _ d S r� )r� )r` �include_fieldsr r r! � IncludeFieldsm s zBaseApiClient.IncludeFieldsc C s | j S r� )r� rh r r r! �response_type_models s z!BaseApiClient.response_type_modelc c s | j }d| _dV || _dS )z2In this context, return raw JSON instead of proto.�jsonN)r� r� )r` Z old_modelr r r! �JsonResponseModelw s z BaseApiClient.JsonResponseModelc C s | j S r� )rx rh r r r! rz s zBaseApiClient.num_retriesc C s* t �|tj� |dk r t�d��|| _d S )Nr z*Cannot have negative value for num_retries)r rs �six� integer_typesr �InvalidDataErrorrx �r` ri r r r! rz � s �c C s | j S r� )ry rh r r r! r{ � s z BaseApiClient.max_retry_waitc C s* t �|tj� |dkr t�d��|| _d S )Nr z)max_retry_wait must be a postiive integer)r rs r� r� r r� ry r� r r r! r{ � s �c c s | j }|| _ d V || _ d S r� )rz )r` rz Zold_num_retriesr r r! � WithRetries� s zBaseApiClient.WithRetriesc C s | j rt�d|j|j|� |S )z$Hook for pre-processing of requests.z Calling method %s with %s: %s)rv �logging�infor- r2 )r` � method_config�requestr r r! �ProcessRequest� s �z BaseApiClient.ProcessRequestc C sd |j �| j� | jr`t�d|j|j� t�dt� |j �� |j rVt�d|j pP|j � n t�d� |S )z)Hook for pre-processing of http requests.zMaking http %s to %sz Headers: %szBody: %sz Body: (none)) �headersrZ r� rv r� r� r. rP �pprint�pformat�bodyZ loggable_body)r` � http_requestr r r! �ProcessHttpRequest� s � � z BaseApiClient.ProcessHttpRequestc C s | j rt�d|j|� |S )NzResponse of type %s: %s)rw r� r� r3 )r` r� �responser r r! �ProcessResponse� s �z BaseApiClient.ProcessResponsec C s t j|| jd�S )N)r� )r Z MessageToJsonr� )r` �messager r r! �SerializeMessage� s �z BaseApiClient.SerializeMessagec C sZ zt �||�}W nD tjtjtfyT } z"t�d||j|f ��W Y d}~n d}~0 0 |S )z:Deserialize the given data as method_config.response_type.z+Error decoding response "%s" as type %s: %sN)r Z JsonToMessager ZInvalidDataFromServerErrorr �ValidationError� ValueErrorr )r` � response_type�datar� �er r r! �DeserializeMessage� s � ��z BaseApiClient.DeserializeMessagec C sF t �|�}t| jdd�r&| jj|jd< | jr@t �| j�}|j|_|j S )z?Modify the url for a given transfer, based on auth and version.�keyN) rT rg r; r� r� r0 r� r~ ra rP )r` rP � url_builderZclient_url_builderr r r! �FinalizeTransferUrl� s z!BaseApiClient.FinalizeTransferUrl)NTNNFFr rq NNNNNN)(r r r r r� r� r� r� r� r� r� rc r} rm r� rn r� r� rP r� rt r� r� r� r� � contextlib�contextmanagerr� r� r� rz ro r{ r� r� r� r� r� r� r� r r r r! r � sr � + r c @ s� e Zd ZdZdd� Zedd� �Zedd� �Zdd � Ze d d � �Z d d � Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd-dd �Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd.d'd(�Zd/d)d*�Zd0d+d,�ZdS )1r z&Base class for generated API services.c C s || _ i | _i | _d S r� )�_BaseApiService__client�_method_configs�_upload_configs)r` r� r r r! rc � s zBaseApiService.__init__c C s | j S r� �r� rh r r r! �_client� s zBaseApiService._clientc C s | j S r� r� rh r r r! r� � s zBaseApiService.clientc C s` | j �|�}|r|S t| |d�}|du r0t|��t|dd�}|du rLt|��|� | j |< }|S )z6Returns service cached method config for given method.Nr� )r� �getr; �KeyError)r` �methodr� �func�configr r r! �GetMethodConfig� s z BaseApiService.GetMethodConfigc C s dd� t �| j�D �S )Nc S s g | ]}t |d d�r|j�qS )r� N)r; r )�.0�fr r r! � <listcomp>� s �z1BaseApiService.GetMethodsList.<locals>.<listcomp>)r� � itervalues�__dict__r� r r r! �GetMethodsList� s z BaseApiService.GetMethodsListc C s | j �|�S r� )r� r� )r` r� r r r! �GetUploadConfig� s z BaseApiService.GetUploadConfigc C s | � |�}t| jj|j�S r� )r� r; r� r� r2 �r` r� r� r r r! �GetRequestType� s �z BaseApiService.GetRequestTypec C s | � |�}t| jj|j�S r� )r� r; r� r� r3 r� r r r! �GetResponseType s �z BaseApiService.GetResponseTypec C s~ t �|td�| jjf� | j�� }|p.| j�� }|�� D ]@}|�|j�}|du r\|�|j�}|dg dfvr8t||j|� q8|S )z+Combine the given params with the defaults.Nr ) r rs rD r� rt � all_fields�get_assigned_valuer= r� )r` r� Zdefault_params�result�fieldri r r r! Z__CombineGlobalParams s z$BaseApiService.__CombineGlobalParamsc C s, |� dd�sd|d< |� dd�s(d|d< |S )N� prettyPrintTr �pp)�pop)r` � query_infor r r! Z__EncodePrettyPrint s z"BaseApiService.__EncodePrettyPrintc C sb t |tj�r |dur t�|�S t |tj�r4|�d�S t |tj�rJ|� d�S t |t j �r^|� � S |S )zAEncode value for the URL, using field to skip encoding for bytes.N�utf8) � isinstancer � BytesField�base64�urlsafe_b64encoder� � text_type�encode� binary_type�decode�datetime� isoformat)r` ri r� r r r! Z__FinalUrlValue s z BaseApiService.__FinalUrlValuec s� �� � �jj�� t�dd� �jj�� D ��jj�}t� ��t� ��fdd�|D ��}t�|t���}t���|� ���fdd�|D �� tdd� |� � D ��}�� |�}t� |t���}|S )z<Construct a dictionary of query parameters for this request.c S s g | ] }|j �qS r )r= )r� �xr r r! r� 2 � z9BaseApiService.__ConstructQueryParams.<locals>.<listcomp>c 3 s* | ]"}|�� t� |�t�|��fV qd S r� �� _BaseApiService__FinalUrlValuer; �r� �param)r� �global_params_typer` r r! � <genexpr>5 s � ��z8BaseApiService.__ConstructQueryParams.<locals>.<genexpr>c 3 s, | ]$}|�� t� |d �t�|��fV qd S r� r� r� )r� � request_typer` r r! r = s ���c s s" | ]\}}|d ur||fV qd S r� r )r� �k�vr r r! r B s �) �$_BaseApiService__CombineGlobalParamsr� r� r � MapParamNamesrt r� rD �dictrZ �items�"_BaseApiService__EncodePrettyPrint�MapRequestParams)r` r0 r� r� Zglobal_param_namesr� Zquery_param_namesr )r� r� r� r r` r! Z__ConstructQueryParams, s( ���� z%BaseApiService.__ConstructQueryParamsNc sH t �|jt� ��}t� fdd�|D ��}t �|t� ��}t j|||d�S )z(Determine the relative path for request.c s g | ]}|t � |d �f�qS r� )r; r� �r� r r! r� M s �z:BaseApiService.__ConstructRelativePath.<locals>.<listcomp>�r, )r r r/ rD r r ZExpandRelativePath)r` r� r� r, Zpython_param_namesr� r r r! Z__ConstructRelativePathH s � ��z&BaseApiService.__ConstructRelativePathc C sL |j dkr@t|j�tkr@d|_ d|jd< d|jd< |j|_i |_|j|_dS )z2Make any final general adjustments to the request.�GET�POSTzx-http-method-overridez!application/x-www-form-urlencoded� content-typeN)r. �lenrP �_MAX_URL_LENGTHr� rY r� r0 )r` r� r� r r r! Z__FinalizeRequestS s � ��z BaseApiService.__FinalizeRequestc C s� |j tjtjtjfvr(tjj|||d��|j tjkrHtj |j d|j d�}|j }| j jrnt|t�rn|�| j j�}| jjdkr~|S t|j| jj�}| j�||�S )z Process the given http response.)r� r� z{})r� �content� request_urlr� )� status_coder �OK�CREATED� NO_CONTENTr � HttpError� FromResponser �Responser� r r r� r� r� �bytesr� r� r� rA r3 r� r� )r` r� � http_responser� r r� r r r! Z__ProcessHttpResponse_ s* �� � �z$BaseApiService.__ProcessHttpResponsec C s, |j pd}||jd< d|jd< d|jd< dS )z*Fill in the basic headers on http_request.zapitools-client/1.0z user-agent�application/jsonr z gzip, deflatezaccept-encodingN)r� r� )r` r� r� r� r r r! Z__SetBaseHeadersw s z BaseApiService.__SetBaseHeadersc C s |j r|j |jd< dS )z;Fill in the system parameters to always set for the method.zX-Goog-Api-VersionN)r7 r� )r` r� r� r r r! Z__SetBaseSystemParams� s �z$BaseApiService.__SetBaseSystemParamsc C s� |j s dS t|j| jj�}|j tkr.|}|}n,t||j �}|�|j �}t� |t j � |j }|pb|� }|rp|spdS t� ||� d|j d< | j�|�|_dS )z!Fill in the body on http_request.Nr r )r4 rA r2 r� r� �REQUEST_IS_BODYr; � field_by_namer rs r r5 rD r� r� r� ) r` r� r� r� �uploadr Z body_valueZ body_typeZ body_fieldr r r! Z __SetBody� s( � � zBaseApiService.__SetBodyc C s� t |j| jj�}t�||� | j�||�}tj|j d�}| � || j� | � ||� | � ||||� t | jj|jd�} | �|j||�| _|dur�|�||| � |dur�|�|| � | j||| jd�| _| �|| � | j�|�S )z$Prepares an HTTP request to be sent.)r. r N)rA r2 r� r� r rs r� r �Requestr. � _BaseApiService__SetBaseHeaders�$_BaseApiService__SetBaseSystemParams�_BaseApiService__SetBodyrT rP r, �%_BaseApiService__ConstructQueryParamsr0 ZConfigureRequest�&_BaseApiService__ConstructRelativePath� _BaseApiService__FinalizeRequestr� ) r` r� r� r� r r6 �downloadr r� r� r r r! �PrepareHttpRequest� s4 � � �� � z!BaseApiService.PrepareHttpRequestc C s� |dur|durt �d��| �||||||�}|durJ|j|| jd� dS d}|durf|j|| jd�}|du r�| jj} |r�|jr�|j} | jj | jj d�} | jj r�| jj | d< | jj r�| jj | d< t j| |fi | ��}| �|||�S )z Call this method with request.Nz/Cannot yet use both upload and download at once)r� )Zretriesr{ r� r� )r ZNotYetImplementedErrorr( ZInitializeDownloadr� ZInitializeUploadr� r� Z bytes_httprz r{ r� r� r Z MakeRequest�ProcessHttpResponse) r` r� r� r� r r6 r' r� r r� �optsr r r! � _RunMethod� sB � �� � ��zBaseApiService._RunMethodc C s | j �|| �|||��S )z6Convert an HTTP response to the expected message type.)r� r� �$_BaseApiService__ProcessHttpResponse)r` r� r r� r r r! r) � s �z"BaseApiService.ProcessHttpResponse)N)NNNN)NNNN)N)r r r r rc rn r� r� r� rm r� r� r� r� r r r� r$ r% r& r, r! r" r# r( r+ r) r r r r! r � s< � � � ,r )$r r� r� r� r� r� r� � six.movesr r �apitools.base.protorpcliter r r� r r r r �__all__� getLogger�setLevel�ERRORr �Messager r r rA rJ r rS �objectrT rp r r r r r r! �<module> s: . : q py/__pycache__/batch.cpython-39.pyc 0000644 00000036043 15025317163 0013127 0 ustar 00 a vyg�G � @ s� d Z ddlZddlmZ ddlm mZ ddlm m Z ddl m Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dgZG d d � d e�d g d ���ZG d d� de �Z G d d� de �Z dS )z6Library for handling batch HTTP requests for apitools.� N)� http_client)� urllib_parse)�range)� exceptions)� http_wrapper�BatchApiRequestc @ s e Zd ZdZdS )�RequestResponseAndHandleraO Container for data related to completing an HTTP request. This contains an HTTP request, its response, and a callback for handling the response from the server. Attributes: request: An http_wrapper.Request object representing the HTTP request. response: The http_wrapper.Response object returned from the server. handler: A callback function accepting two arguments, response and exception. Response is an http_wrapper.Response object, and exception is an apiclient.errors.HttpError object if an error occurred, or otherwise None. N)�__name__� __module__� __qualname__�__doc__� r r �:/opt/gsutil/third_party/apitools/apitools/base/py/batch.pyr ) s r )�request�response�handlerc @ s> e Zd ZdZG dd� de�Zd dd�Zd dd�Zdd d �ZdS )r z4Batches multiple api requests into a single request.c @ s\ e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zed d � �Z ed d � �Z dd� Z dS )zBatchApiRequest.ApiCalla/ Holds request and response information for each request. ApiCalls are ultimately exposed to the client once the HTTP batch request has been completed. Attributes: http_request: A client-supplied http_wrapper.Request to be submitted to the server. response: A http_wrapper.Response object given by the server as a response to the user request, or None if an error occurred. exception: An apiclient.errors.HttpError object if an error occurred, or None. c C s> t t|tjg ��| _d| _|| _|| _|| _d| _ d| _ dS )ar Initialize an individual API request. Args: request: An http_wrapper.Request object. retryable_codes: A list of integer HTTP codes that can be retried. service: A service inheriting from base_api.BaseApiService. method_config: Method config for the desired API request. N) �list�setr � UNAUTHORIZED�_ApiCall__retryable_codes�_ApiCall__http_response�_ApiCall__service�_ApiCall__method_config� http_request�_ApiCall__response�_ApiCall__exception)�selfr �retryable_codes�service� method_configr r r �__init__O s �z BatchApiRequest.ApiCall.__init__c C s | j d uS �N)� exception�r r r r �is_errore s z BatchApiRequest.ApiCall.is_errorc C s | j S r! )r r# r r r r i s z BatchApiRequest.ApiCall.responsec C s | j S r! )r r# r r r r" m s z!BatchApiRequest.ApiCall.exceptionc C s | j o| j jtjkS r! )r � status_coder r r# r r r �authorization_failedq s �z,BatchApiRequest.ApiCall.authorization_failedc C s | j d u rdS | j j}|| jvS )NF)r r% r )r Z response_coder r r �terminal_statev s z&BatchApiRequest.ApiCall.terminal_statec C s0 || _ || _| jr,| js,| j�| j| j �| _dS )ap Handles incoming http response to the request in http_request. This is intended to be used as a callback function for BatchHttpRequest.Add. Args: http_response: Deserialized http_wrapper.Response object. exception: apiclient.errors.HttpError object if an error occurred. N)r r r' r �ProcessHttpResponser r )r � http_responser" r r r �HandleResponse} s �z&BatchApiRequest.ApiCall.HandleResponseN) r r r r r �propertyr$ r r" r& r' r* r r r r �ApiCall> s r, Nc C s$ g | _ |p g | _|pd| _|| _dS )a Initialize a batch API request object. Args: batch_url: Base URL for batch API calls. retryable_codes: A list of integer HTTP codes that can be retried. response_encoding: The encoding type of response content. z https://www.googleapis.com/batchN)� api_requestsr � batch_url�response_encoding)r r. r r/ r r r r � s zBatchApiRequest.__init__c C sH |� |�}|�|�}|j||||d�}| �|| j||�}| j�|� dS )a� Add a request to the batch. Args: service: A class inheriting base_api.BaseApiService. method: A string indicated desired method from the service. See the example in the class docstring. request: An input message appropriate for the specified service.method. global_params: Optional additional parameters to pass into method.PrepareHttpRequest. Returns: None )� global_params� upload_configN)�GetMethodConfig�GetUploadConfig�PrepareHttpRequestr, r r- �append) r r �methodr r0 r r1 r Z api_requestr r r �Add� s � �zBatchApiRequest.Add� c C s� dd� | j D �}|pt|�}t|�D ]�}|r6t�|� tdt|�|�D ]�} t| j|| jd�} t� || | | �D ]} | � | j | j � qn| � |� t|jd�rFtdd� t� || | | �D ��rF|jj�|� qFdd� | j D �}|s$ q�q$| j S ) a� Execute all of the requests in the batch. Args: http: httplib2.Http object for use in the request. sleep_between_polls: Integer number of seconds to sleep between polls. max_retries: Max retries. Any requests that have not succeeded by this number of retries simply report the last response or exception, whatever it happened to be. max_batch_size: int, if specified requests will be split in batches of given size. batch_request_callback: function of (http_response, exception) passed to BatchHttpRequest which will be run on any given results. Returns: List of ApiCalls. c S s g | ]}|j s|�qS r �r' ��.0r r r r � <listcomp>� s �z+BatchApiRequest.Execute.<locals>.<listcomp>r )r. �callbackr/ � credentialsc s s | ] }|j V qd S r! )r& r: r r r � <genexpr>� s �z*BatchApiRequest.Execute.<locals>.<genexpr>c S s g | ]}|j s|�qS r r9 r: r r r r< � s �)r- �lenr �time�sleep�BatchHttpRequestr. r/ � itertools�islicer7 r r* �Execute�hasattrr �anyr> �refresh) r �httpZsleep_between_pollsZ max_retriesZmax_batch_sizeZbatch_request_callback�requestsZ batch_size�attempt�iZbatch_http_requestr r r r rF � s: ��� ��zBatchApiRequest.Execute)NNN)N)r8 r8 NN) r r r r �objectr, r r7 rF r r r r r ; s Q � �c @ s` e Zd ZdZddd�Zdd� Zedd� �Zd d � Zd d � Z d d� Z ddd�Z dd� Z dd� Z dS )rC zDBatches multiple http_wrapper.Request objects into a single request.Nc C s0 || _ || _|| _i | _t�� | _t�� | _ dS )a/ Constructor for a BatchHttpRequest. Args: batch_url: URL to send batch requests to. callback: A callback to be called for each response, of the form callback(response, exception). The first parameter is the deserialized Response object. The second is an apiclient.errors.HttpError exception object if an HTTP error occurred while processing the request, or None if no error occurred. response_encoding: The encoding type of response content. N) � _BatchHttpRequest__batch_url�_BatchHttpRequest__callback�$_BatchHttpRequest__response_encoding�,_BatchHttpRequest__request_response_handlersrD �count� _BatchHttpRequest__last_auto_id�uuid�uuid4�_BatchHttpRequest__base_id)r r. r= r/ r r r r � s zBatchHttpRequest.__init__c C s d| j t�|�f S )aK Convert an id to a Content-ID header value. Args: request_id: String identifier for a individual request. Returns: A Content-ID header with the id_ encoded into it. A UUID is prepended to the value because Content-ID headers are supposed to be universally unique. z<%s+%s>)rW r �quote)r � request_idr r r �_ConvertIdToHeader s z#BatchHttpRequest._ConvertIdToHeaderc C sZ | � d�s"| �d�s"t�d| ��d| vr8t�d| ��| dd� �dd�\}}t�|�S )aw Convert a Content-ID header value to an id. Presumes the Content-ID header conforms to the format that _ConvertIdToHeader() returns. Args: header: A string indicating the Content-ID header value. Returns: The extracted id value. Raises: BatchError if the header is not in the expected format. �<�>z Invalid value for Content-ID: %s�+� ���)� startswith�endswithr � BatchError�rsplitr �unquote)�header�_rY r r r �_ConvertHeaderToId% s ��z#BatchHttpRequest._ConvertHeaderToIdc C s� t �|j�}t �dd|j|jdf�}t|tj�s:|� d�}d� |j |df�}|j � dd��d�\}}t�||�}|j �� D ]\}} |dkr�qz| ||< qz|j|d< |�d � |jd ur�|�|j� t�� } tj| d d �} | j|d d � | �� } || S )z�Convert a http_wrapper.Request object into a string. Args: request: A http_wrapper.Request to serialize. Returns: The request as a string in application/http format. � zutf-8� z HTTP/1.1 � content-typezapplication/json�/�HostNr )� maxheaderlenF)�unixfrom)r �urlsplit�url� urlunsplit�path�query� isinstance�six� text_type�decode�join� http_method�headers�get�split�mime_nonmultipart�MIMENonMultipart�items�netloc� set_unixfrom�body� set_payload�StringIO� generator� Generator�flatten�getvalue) r r �parsedZ request_line� status_line�major�minor�msg�key�valueZstr_io�genr� r r r �_SerializeRequest? s< � ��� z"BatchHttpRequest._SerializeRequestc C s\ |� dd�\}}|� dd�\}}}t�� }|�|�}t|�}||d< |�� }t�||| j�S )z�Convert string into Response and content. Args: payload: Header and body string to be deserialized. Returns: A Response object � r^ ri � �status) r| � email_parser�Parser�parsestr�dict� get_payloadr �ResponserO ) r �payloadr� rf r� �parserr� �info�contentr r r �_DeserializeResponsem s z%BatchHttpRequest._DeserializeResponsec C s t t| j��S )z�Create a new id. Auto incrementing number that avoids conflicts with ids already used. Returns: A new unique id string. )�str�nextrT r# r r r �_NewId� s zBatchHttpRequest._NewIdc C s t |d|�}|| j| �� < dS )a Add a new request. Args: request: A http_wrapper.Request to add to the batch. callback: A callback to be called for this response, of the form callback(response, exception). The first parameter is the deserialized response object. The second is an apiclient.errors.HttpError exception object if an HTTP error occurred while processing the request, or None if no errors occurred. Returns: None N)r rR r� )r r r= r r r r r7 � s zBatchHttpRequest.Addc C s^ t �d�}t|ddd� � | jD ]L}t�dd�}d|d< | �|�|d < | �| j| j�}|� |� |� |� q t � | j d �}|�� |_d |�� |jd < t �||�}|jd kr�tj�|��d|jd }|j} t| t�r�| jr�|j� | j�} t � � } | � || �} | � � �st�!d��| �"� D ]:} | �#| d �} | �$| �"� �}| j| j%|d�| j| < �q dS )a= Serialize batch request, send to server, process response. Args: http: A httplib2.Http object to be used to make the request with. Raises: httplib2.HttpLib2Error if a transport error has occured. apiclient.errors.BatchError if the response is the wrong format. �mixed�_write_headersc S s d S r! r r# r r r �<lambda>� � z+BatchHttpRequest._Execute.<locals>.<lambda>Z applicationrJ �binaryzContent-Transfer-Encodingz Content-ID�POSTz multipart/mixed; boundary="%s"rj �, zcontent-type: %s z'Response not in multipart/mixed format.)r N)&�mime_multipart� MIMEMultipart�setattrrR r} r~ rZ r� r r� �attachr �RequestrO � as_stringr� � get_boundaryrz � MakeRequestr% r � HttpError� FromResponser� r� rt �bytesrQ rw r� r� r� � is_multipartrb r� rg r� �_replace)r rJ �messager� r� r� r r re r� r� Z mime_response�partrY r r r �_Execute� sF � � � ��zBatchHttpRequest._Executec C st | � |� | jD ]^}| j| j}| j| j}d}|jdkrFtj�|�}|durX|||� | jdur| �||� qdS )a Execute all the requests as a single batched HTTP request. Args: http: A httplib2.Http object to be used with the request. Returns: None Raises: BatchError if the response is the wrong format. Nr� ) r� rR r r r% r r� r� rP )r rJ r� r r= r" r r r rF � s zBatchHttpRequest.Execute)NN)N)r r r r r rZ � staticmethodrg r� r� r� r7 r� rF r r r r rC � s . <rC ) r � collections�email.generatorr� �email.mime.multipart�mime� multipartr� �email.mime.nonmultipart� nonmultipartr} � email.parserr� r� rD rA rU ru � six.movesr r r �apitools.base.pyr r �__all__� namedtupler rN r rC r r r r �<module> s, �� 9 py/__pycache__/http_wrapper.cpython-39.pyc 0000644 00000025773 15025317163 0014575 0 ustar 00 a vyg]< � @ sh d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddl mZ zddlmZ W n ey� ddlmZ Y n0 g d �Zd Zd Ze je je je jefZe� d g d ��Z ej d)dd��Z G dd� de �Z!G dd� de� dg d���Z"dd� Z#dd� Z$dd� Z%d d � Z&d d d e&e#fd!d"�Z'd e#fd#d$�Z(g Z)d%d&� Z*d'd(� Z+dS )*zpHTTP wrapper for apitools. This library wraps the underlying http library we use, which is currently httplib2. � N)� http_client)�parse)� exceptions)�util)�HttpAccessTokenRefreshError)�AccessTokenRefreshError)� CheckResponse�GetHttp�)HandleExceptionsAndRebuildHttpConnections� MakeRequest�RebuildHttpConnections�Request�Response�RethrowExceptionHandler�4 i� �ExceptionRetryArgs)�http� http_request�exc� num_retries�max_retry_wait�total_wait_secc c s� | j du rdV dS tj}i }|t_|dur^|j�� D ]&\}}d|vrHq6|j||< |�|� q6dV |t_|dur�|�� D ]"\}}||jv rz|j| �|� qzdS )a� Temporarily change the value of httplib2.debuglevel, if necessary. If http_request has a `loggable_body` distinct from `body`, then we need to prevent httplib2 from logging the full body. This sets httplib2.debuglevel for the duration of the `with` block; however, that alone won't change the value of existing HTTP connections. If an httplib2.Http object is provided, we'll also change the level on any cached connections attached to it. Args: http_request: a Request we're logging. level: (int) the debuglevel for logging. http: (optional) an httplib2.Http whose connections we should set the debuglevel on. Yields: None. N�:)� loggable_body�httplib2� debuglevel� connections�items�set_debuglevel)r �levelr Z old_levelZ http_levelsZconnection_key� connection� r! �A/opt/gsutil/third_party/apitools/apitools/base/py/http_wrapper.py�_Httplib2DebuglevelK s$ r# c @ sN e Zd ZdZd dd�Zedd� �Zejd d� �Zed d � �Zejd d � �ZdS )r z1Class encapsulating the data for an HTTP request.� �GETNc C s, || _ || _|pi | _d | _d | _|| _d S �N)�url� http_method�headers�_Request__body�_Request__loggable_body�body)�selfr' r( r) r, r! r! r" �__init__{ s zRequest.__init__c C s | j S r& )r+ �r- r! r! r" r � s zRequest.loggable_bodyc C s | j d u rt�d��|| _d S )Nz0Cannot set loggable body on request with no body)r, r � RequestErrorr+ )r- �valuer! r! r" r � s �c C s | j S r& )r* r/ r! r! r" r, � s z Request.bodyc C sb || _ |dur6t| j dd�p$t| j �}t|�| jd< n| j�dd� t|td�tj f�s^d| _ dS )z>Sets the request body; handles logging and length measurement.N�length�content-lengthz <media body>) r* �getattr�len�strr) �pop� isinstance�type�six� string_typesr )r- r1 � body_lengthr! r! r" r, � s ��)r$ r% Nr$ ) �__name__� __module__� __qualname__�__doc__r. �propertyr �setterr, r! r! r! r" r w s r c @ sL e Zd ZdZdZdd� Zedd� �Zedd� �Zed d � �Z ed d � �Z d S )r z.Class encapsulating data for an HTTP response.r! c C s | j S r& )r2 r/ r! r! r" �__len__� s zResponse.__len__c C sf dd� }d| j v r*d| j v r*|| j d �S d| j v rDt| j �d��S d| j v r\|| j d �S t| j�S )z�Return the length of this response. We expose this as an attribute since using len() directly can fail for responses larger than sys.maxint. Returns: Response length (as int or long) c S sD | � d�\}}}|� d�\}}}|� d�\}}}t|�t|� d S )N� �/�-� )� partition�int)Z content_range�_Z range_specZ byte_range�start�endr! r! r" �ProcessContentRange� s z,Response.length.<locals>.ProcessContentRangez-content-encodingz content-ranger3 )�inforI �getr5 �content)r- rM r! r! r" r2 � s zResponse.lengthc C s t | jd �S )N�status)rI rN r/ r! r! r" � status_code� s zResponse.status_codec C s d| j v rt| j d �S d S )Nz retry-after)rN rI r/ r! r! r" � retry_after� s zResponse.retry_afterc C s | j tv od| jv S )N�location)rR �_REDIRECT_STATUS_CODESrN r/ r! r! r" � is_redirect� s �zResponse.is_redirectN) r= r> r? r@ � __slots__rC rA r2 rR rS rV r! r! r! r" r � s r Z HttpResponse)rN rP � request_urlc C sR | d u rt �d| j ��n4| jdks.| jtkr<t j�| ��n| jrNt j�| ��d S )Nz,Request to url %s did not return a response.�� ) r r0 rX rR �TOO_MANY_REQUESTS�BadStatusCodeError� FromResponserS �RetryAfterError)�responser! r! r" r � s �� �r c C s4 t | dd�r0t| j�� �D ]}d|v r| j|= qdS )a� Rebuilds all http connections in the httplib2.Http instance. httplib2 overloads the map in http.connections to contain two different types of values: { scheme string: connection class } and { scheme + authority string : actual http connection } Here we remove all of the entries for actual connections so that on the next request httplib2 will rebuild them from the connection types. Args: http: An httplib2.Http instance. r Nr )r4 �listr �keys)r �conn_keyr! r! r" r � s r c G s � d S r& r! )Z unused_argsr! r! r" r � s r c C s� d}t | jtjtjtjf�r8t�dt| j�j | j� �nHt | jt j �rXt�d| j� �n(t | jt j �rxt�d| j� �nt | jt j �r�t�d| j� n�t | jtj�r�t�d| j� n�t | jt�r�t�d| j� n�t | jt��rt| jd��r| jjtk�s| jjd k�rt�d | j� nht | jtj��r4t�d � nLt | jtj��rVt�d | jj� n*t | jtj��rzt�d � | jj}n| j�t| j � t�d| j j | j� t � |�p�t!j"| j#| j$d�� dS )z�Exception handler for http failures. This catches known failures and rebuilds the underlying HTTP connections. Args: retry_args: An ExceptionRetryArgs tuple. Nz"Caught HTTP error %s, retrying: %sz!Caught socket error, retrying: %sz)Caught socket address error, retrying: %sz)Caught socket timeout error, retrying: %sz+Caught server not found error, retrying: %sz+Response content was invalid (%s), retryingrQ rY z8Caught transient credential refresh error (%s), retryingz&Request returned no response, retryingz%Response returned status %s, retryingz0Response returned a retry-after header, retryingz-Retrying request to url %s after exception %s)�max_wait)%r8 r r � BadStatusLine�IncompleteRead�ResponseNotReady�logging�debugr9 r= �socket�error�gaierror�timeoutr �ServerNotFoundError� ValueError�TokenRefreshError�hasattrrQ rZ r r0 r[ rR r] rS r r r r' �time�sleepr �CalculateWaitForRetryr r )Z retry_argsrS r! r! r" r � sp ����� � � � �� � � ��r � �< � c C s� d}t � � }t| d�r(t| j�dh | _zt| |||d�W S ty� } zB|d7 }||kr^� n"t � � | } |t| || ||| �� W Y d} ~ q(d} ~ 0 0 q(dS )a� Send http_request via the given http, performing error/retry handling. Args: http: An httplib2.Http instance, or a http multiplexer that delegates to an underlying http, for example, HTTPMultiplexer. http_request: A Request to send. retries: (int, default 7) Number of retries to attempt on retryable replies (such as 429 or 5XX). max_retry_wait: (int, default 60) Maximum number of seconds to wait when retrying. redirections: (int, default 5) Number of redirects to follow. retry_func: Function to handle retries on exceptions. Argument is an ExceptionRetryArgs tuple. check_response_func: Function to validate the HTTP response. Arguments are (Response, response content, url). Raises: InvalidDataFromServerError: if there is no response after retries. Returns: A Response object. r �redirect_codesr )� redirections�check_response_funcrG N)rp ro �setrv �_MakeRequestNoRetry� Exceptionr ) r r �retriesr rw � retry_funcrx �retryZfirst_req_time�er r! r! r" r 9 s" � �r c C s� d}t | dd�r6t�|j�j}|r6|| jv r6| j| }tjdkrDdnd}t||| d��: | j t |j�t |j �|j |j ||d�\}}W d � n1 s�0 Y |du r�t�� �t|||j�} || � | S )a� Send http_request via the given http. This wrapper exists to handle translation between the plain httplib2 request/response types and the Request and Response types above. Args: http: An httplib2.Http instance, or a http multiplexer that delegates to an underlying http, for example, HTTPMultiplexer. http_request: A Request to send. redirections: (int, default 5) Number of redirects to follow. check_response_func: Function to validate the HTTP response. Arguments are (Response, response content, url). Returns: A Response object. Raises: RequestError if no response could be parsed. Nr � r )r )�methodr, r) rw �connection_type)r4 r �urlsplitr' �schemer r r r# �requestr6 r( r, r) r r0 r ) r r rw rx r� Z url_schemeZnew_debuglevelrN rP r^ r! r! r" rz k s" �(rz c C s t �| � d S r& )�_HTTP_FACTORIES�append)�factoryr! r! r" �_RegisterHttpFactory� s r� c K s8 t D ]"}|f i | ��}|d ur| S qtjf i | ��S r& )r� r �Http)�kwdsr� r r! r! r" r � s r )N),r@ � collections� contextlibrf rh rp r r: � six.movesr Zsix.moves.urllibr �apitools.base.pyr r �oauth2client.clientr rn � ImportErrorr �__all__ZRESUME_INCOMPLETErZ �MOVED_PERMANENTLY�FOUND� SEE_OTHER�TEMPORARY_REDIRECTrU � namedtupler �contextmanagerr# �objectr r r r r r r rz r� r� r r! r! r! r" �<module> s` � � +-�3 =� 2� / py/compression_test.py 0000644 00000012305 15025317163 0011152 0 ustar 00 #!/usr/bin/env python # # Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for compression.""" import unittest from apitools.base.py import compression from apitools.base.py import gzip import six class CompressionTest(unittest.TestCase): def setUp(self): # Sample highly compressible data (~50MB). self.sample_data = b'abc' * 16777216 # Stream of the sample data. self.stream = six.BytesIO() self.stream.write(self.sample_data) self.length = self.stream.tell() self.stream.seek(0) def testCompressionExhausted(self): """Test full compression. Test that highly compressible data is actually compressed in entirety. """ output, read, exhausted = compression.CompressStream( self.stream, self.length, 9) # Ensure the compressed buffer is smaller than the input buffer. self.assertLess(output.length, self.length) # Ensure we read the entire input stream. self.assertEqual(read, self.length) # Ensure the input stream was exhausted. self.assertTrue(exhausted) def testCompressionUnbounded(self): """Test unbounded compression. Test that the input stream is exhausted when length is none. """ output, read, exhausted = compression.CompressStream( self.stream, None, 9) # Ensure the compressed buffer is smaller than the input buffer. self.assertLess(output.length, self.length) # Ensure we read the entire input stream. self.assertEqual(read, self.length) # Ensure the input stream was exhausted. self.assertTrue(exhausted) def testCompressionPartial(self): """Test partial compression. Test that the length parameter works correctly. The amount of data that's compressed can be greater than or equal to the requested length. """ output_length = 40 output, _, exhausted = compression.CompressStream( self.stream, output_length, 9) # Ensure the requested read size is <= the compressed buffer size. self.assertLessEqual(output_length, output.length) # Ensure the input stream was not exhausted. self.assertFalse(exhausted) def testCompressionIntegrity(self): """Test that compressed data can be decompressed.""" output, read, exhausted = compression.CompressStream( self.stream, self.length, 9) # Ensure uncompressed data matches the sample data. with gzip.GzipFile(fileobj=output) as f: original = f.read() self.assertEqual(original, self.sample_data) # Ensure we read the entire input stream. self.assertEqual(read, self.length) # Ensure the input stream was exhausted. self.assertTrue(exhausted) class StreamingBufferTest(unittest.TestCase): def setUp(self): self.stream = compression.StreamingBuffer() def testSimpleStream(self): """Test simple stream operations. Test that the stream can be written to and read from. Also test that reading from the stream consumes the bytes. """ # Ensure the stream is empty. self.assertEqual(self.stream.length, 0) # Ensure data is correctly written. self.stream.write(b'Sample data') self.assertEqual(self.stream.length, 11) # Ensure data can be read and the read data is purged from the stream. data = self.stream.read(11) self.assertEqual(data, b'Sample data') self.assertEqual(self.stream.length, 0) def testPartialReads(self): """Test partial stream reads. Test that the stream can be read in chunks while perserving the consumption mechanics. """ self.stream.write(b'Sample data') # Ensure data can be read and the read data is purged from the stream. data = self.stream.read(6) self.assertEqual(data, b'Sample') self.assertEqual(self.stream.length, 5) # Ensure the remaining data can be read. data = self.stream.read(5) self.assertEqual(data, b' data') self.assertEqual(self.stream.length, 0) def testTooShort(self): """Test excessive stream reads. Test that more data can be requested from the stream than available without raising an exception. """ self.stream.write(b'Sample') # Ensure requesting more data than available does not raise an # exception. data = self.stream.read(100) self.assertEqual(data, b'Sample') self.assertEqual(self.stream.length, 0) py/util.py 0000644 00000020433 15025317163 0006530 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Assorted utilities shared between parts of apitools.""" import os import random import six from six.moves import http_client import six.moves.urllib.error as urllib_error import six.moves.urllib.parse as urllib_parse import six.moves.urllib.request as urllib_request from apitools.base.protorpclite import messages from apitools.base.py import encoding_helper as encoding from apitools.base.py import exceptions if six.PY3: from collections.abc import Iterable else: from collections import Iterable __all__ = [ 'DetectGae', 'DetectGce', ] _RESERVED_URI_CHARS = r":/?#[]@!$&'()*+,;=" def DetectGae(): """Determine whether or not we're running on GAE. This is based on: https://developers.google.com/appengine/docs/python/#The_Environment Returns: True iff we're running on GAE. """ server_software = os.environ.get('SERVER_SOFTWARE', '') return (server_software.startswith('Development/') or server_software.startswith('Google App Engine/')) def DetectGce(): """Determine whether or not we're running on GCE. This is based on: https://cloud.google.com/compute/docs/metadata#runninggce Returns: True iff we're running on a GCE instance. """ metadata_url = 'http://{}'.format( os.environ.get('GCE_METADATA_ROOT', 'metadata.google.internal')) try: o = urllib_request.build_opener(urllib_request.ProxyHandler({})).open( urllib_request.Request( metadata_url, headers={'Metadata-Flavor': 'Google'})) except urllib_error.URLError: return False return (o.getcode() == http_client.OK and o.headers.get('metadata-flavor') == 'Google') def NormalizeScopes(scope_spec): """Normalize scope_spec to a set of strings.""" if isinstance(scope_spec, six.string_types): scope_spec = six.ensure_str(scope_spec) return set(scope_spec.split(' ')) elif isinstance(scope_spec, Iterable): scope_spec = [six.ensure_str(x) for x in scope_spec] return set(scope_spec) raise exceptions.TypecheckError( 'NormalizeScopes expected string or iterable, found %s' % ( type(scope_spec),)) def Typecheck(arg, arg_type, msg=None): if not isinstance(arg, arg_type): if msg is None: if isinstance(arg_type, tuple): msg = 'Type of arg is "%s", not one of %r' % ( type(arg), arg_type) else: msg = 'Type of arg is "%s", not "%s"' % (type(arg), arg_type) raise exceptions.TypecheckError(msg) return arg def ExpandRelativePath(method_config, params, relative_path=None): """Determine the relative path for request.""" path = relative_path or method_config.relative_path or '' for param in method_config.path_params: param_template = '{%s}' % param # For more details about "reserved word expansion", see: # http://tools.ietf.org/html/rfc6570#section-3.2.2 reserved_chars = '' reserved_template = '{+%s}' % param if reserved_template in path: reserved_chars = _RESERVED_URI_CHARS path = path.replace(reserved_template, param_template) if param_template not in path: raise exceptions.InvalidUserInputError( 'Missing path parameter %s' % param) try: # TODO(craigcitro): Do we want to support some sophisticated # mapping here? value = params[param] except KeyError: raise exceptions.InvalidUserInputError( 'Request missing required parameter %s' % param) if value is None: raise exceptions.InvalidUserInputError( 'Request missing required parameter %s' % param) try: if not isinstance(value, six.string_types): value = str(value) path = path.replace(param_template, urllib_parse.quote(value.encode('utf_8'), reserved_chars)) except TypeError as e: raise exceptions.InvalidUserInputError( 'Error setting required parameter %s to value %s: %s' % ( param, value, e)) return path def CalculateWaitForRetry(retry_attempt, max_wait=60): """Calculates amount of time to wait before a retry attempt. Wait time grows exponentially with the number of attempts. A random amount of jitter is added to spread out retry attempts from different clients. Args: retry_attempt: Retry attempt counter. max_wait: Upper bound for wait time [seconds]. Returns: Number of seconds to wait before retrying request. """ wait_time = 2 ** retry_attempt max_jitter = wait_time / 4.0 wait_time += random.uniform(-max_jitter, max_jitter) return max(1, min(wait_time, max_wait)) def AcceptableMimeType(accept_patterns, mime_type): """Return True iff mime_type is acceptable for one of accept_patterns. Note that this function assumes that all patterns in accept_patterns will be simple types of the form "type/subtype", where one or both of these can be "*". We do not support parameters (i.e. "; q=") in patterns. Args: accept_patterns: list of acceptable MIME types. mime_type: the mime type we would like to match. Returns: Whether or not mime_type matches (at least) one of these patterns. """ if '/' not in mime_type: raise exceptions.InvalidUserInputError( 'Invalid MIME type: "%s"' % mime_type) unsupported_patterns = [p for p in accept_patterns if ';' in p] if unsupported_patterns: raise exceptions.GeneratedClientError( 'MIME patterns with parameter unsupported: "%s"' % ', '.join( unsupported_patterns)) def MimeTypeMatches(pattern, mime_type): """Return True iff mime_type is acceptable for pattern.""" # Some systems use a single '*' instead of '*/*'. if pattern == '*': pattern = '*/*' return all(accept in ('*', provided) for accept, provided in zip(pattern.split('/'), mime_type.split('/'))) return any(MimeTypeMatches(pattern, mime_type) for pattern in accept_patterns) def MapParamNames(params, request_type): """Reverse parameter remappings for URL construction.""" return [encoding.GetCustomJsonFieldMapping(request_type, json_name=p) or p for p in params] def MapRequestParams(params, request_type): """Perform any renames/remappings needed for URL construction. Currently, we have several ways to customize JSON encoding, in particular of field names and enums. This works fine for JSON bodies, but also needs to be applied for path and query parameters in the URL. This function takes a dictionary from param names to values, and performs any registered mappings. We also need the request type (to look up the mappings). Args: params: (dict) Map from param names to values request_type: (protorpc.messages.Message) request type for this API call Returns: A new dict of the same size, with all registered mappings applied. """ new_params = dict(params) for param_name, value in params.items(): field_remapping = encoding.GetCustomJsonFieldMapping( request_type, python_name=param_name) if field_remapping is not None: new_params[field_remapping] = new_params.pop(param_name) param_name = field_remapping if isinstance(value, messages.Enum): new_params[param_name] = encoding.GetCustomJsonEnumMapping( type(value), python_name=str(value)) or str(value) return new_params py/extra_types.py 0000644 00000023366 15025317163 0010132 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Extra types understood by apitools.""" import datetime import json import numbers import six from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import protojson from apitools.base.py import encoding_helper as encoding from apitools.base.py import exceptions from apitools.base.py import util if six.PY3: from collections.abc import Iterable else: from collections import Iterable __all__ = [ 'DateField', 'DateTimeMessage', 'JsonArray', 'JsonObject', 'JsonValue', 'JsonProtoEncoder', 'JsonProtoDecoder', ] # pylint:disable=invalid-name DateTimeMessage = message_types.DateTimeMessage # pylint:enable=invalid-name # We insert our own metaclass here to avoid letting ProtoRPC # register this as the default field type for strings. # * since ProtoRPC does this via metaclasses, we don't have any # choice but to use one ourselves # * since a subclass's metaclass must inherit from its superclass's # metaclass, we're forced to have this hard-to-read inheritance. # # pylint: disable=protected-access class _FieldMeta(messages._FieldMeta): def __init__(cls, name, bases, dct): # pylint: disable=no-self-argument # pylint: disable=super-init-not-called,non-parent-init-called type.__init__(cls, name, bases, dct) # pylint: enable=protected-access class DateField(six.with_metaclass(_FieldMeta, messages.Field)): """Field definition for Date values.""" VARIANTS = frozenset([messages.Variant.STRING]) DEFAULT_VARIANT = messages.Variant.STRING type = datetime.date def _ValidateJsonValue(json_value): entries = [(f, json_value.get_assigned_value(f.name)) for f in json_value.all_fields()] assigned_entries = [(f, value) for f, value in entries if value is not None] if len(assigned_entries) != 1: raise exceptions.InvalidDataError( 'Malformed JsonValue: %s' % json_value) def _JsonValueToPythonValue(json_value): """Convert the given JsonValue to a json string.""" util.Typecheck(json_value, JsonValue) _ValidateJsonValue(json_value) if json_value.is_null: return None entries = [(f, json_value.get_assigned_value(f.name)) for f in json_value.all_fields()] assigned_entries = [(f, value) for f, value in entries if value is not None] field, value = assigned_entries[0] if not isinstance(field, messages.MessageField): return value elif field.message_type is JsonObject: return _JsonObjectToPythonValue(value) elif field.message_type is JsonArray: return _JsonArrayToPythonValue(value) def _JsonObjectToPythonValue(json_value): util.Typecheck(json_value, JsonObject) return dict([(prop.key, _JsonValueToPythonValue(prop.value)) for prop in json_value.properties]) def _JsonArrayToPythonValue(json_value): util.Typecheck(json_value, JsonArray) return [_JsonValueToPythonValue(e) for e in json_value.entries] _MAXINT64 = 2 << 63 - 1 _MININT64 = -(2 << 63) def _PythonValueToJsonValue(py_value): """Convert the given python value to a JsonValue.""" if py_value is None: return JsonValue(is_null=True) if isinstance(py_value, bool): return JsonValue(boolean_value=py_value) if isinstance(py_value, six.string_types): return JsonValue(string_value=py_value) if isinstance(py_value, numbers.Number): if isinstance(py_value, six.integer_types): if _MININT64 < py_value < _MAXINT64: return JsonValue(integer_value=py_value) return JsonValue(double_value=float(py_value)) if isinstance(py_value, dict): return JsonValue(object_value=_PythonValueToJsonObject(py_value)) if isinstance(py_value, Iterable): return JsonValue(array_value=_PythonValueToJsonArray(py_value)) raise exceptions.InvalidDataError( 'Cannot convert "%s" to JsonValue' % py_value) def _PythonValueToJsonObject(py_value): util.Typecheck(py_value, dict) return JsonObject( properties=[ JsonObject.Property(key=key, value=_PythonValueToJsonValue(value)) for key, value in py_value.items()]) def _PythonValueToJsonArray(py_value): return JsonArray(entries=list(map(_PythonValueToJsonValue, py_value))) class JsonValue(messages.Message): """Any valid JSON value.""" # Is this JSON object `null`? is_null = messages.BooleanField(1, default=False) # Exactly one of the following is provided if is_null is False; none # should be provided if is_null is True. boolean_value = messages.BooleanField(2) string_value = messages.StringField(3) # We keep two numeric fields to keep int64 round-trips exact. double_value = messages.FloatField(4, variant=messages.Variant.DOUBLE) integer_value = messages.IntegerField(5, variant=messages.Variant.INT64) # Compound types object_value = messages.MessageField('JsonObject', 6) array_value = messages.MessageField('JsonArray', 7) class JsonObject(messages.Message): """A JSON object value. Messages: Property: A property of a JsonObject. Fields: properties: A list of properties of a JsonObject. """ class Property(messages.Message): """A property of a JSON object. Fields: key: Name of the property. value: A JsonValue attribute. """ key = messages.StringField(1) value = messages.MessageField(JsonValue, 2) properties = messages.MessageField(Property, 1, repeated=True) class JsonArray(messages.Message): """A JSON array value.""" entries = messages.MessageField(JsonValue, 1, repeated=True) _JSON_PROTO_TO_PYTHON_MAP = { JsonArray: _JsonArrayToPythonValue, JsonObject: _JsonObjectToPythonValue, JsonValue: _JsonValueToPythonValue, } _JSON_PROTO_TYPES = tuple(_JSON_PROTO_TO_PYTHON_MAP.keys()) def _JsonProtoToPythonValue(json_proto): util.Typecheck(json_proto, _JSON_PROTO_TYPES) return _JSON_PROTO_TO_PYTHON_MAP[type(json_proto)](json_proto) def _PythonValueToJsonProto(py_value): if isinstance(py_value, dict): return _PythonValueToJsonObject(py_value) if (isinstance(py_value, Iterable) and not isinstance(py_value, six.string_types)): return _PythonValueToJsonArray(py_value) return _PythonValueToJsonValue(py_value) def _JsonProtoToJson(json_proto, unused_encoder=None): return json.dumps(_JsonProtoToPythonValue(json_proto)) def _JsonToJsonProto(json_data, unused_decoder=None): return _PythonValueToJsonProto(json.loads(json_data)) def _JsonToJsonValue(json_data, unused_decoder=None): result = _PythonValueToJsonProto(json.loads(json_data)) if isinstance(result, JsonValue): return result elif isinstance(result, JsonObject): return JsonValue(object_value=result) elif isinstance(result, JsonArray): return JsonValue(array_value=result) else: raise exceptions.InvalidDataError( 'Malformed JsonValue: %s' % json_data) # pylint:disable=invalid-name JsonProtoEncoder = _JsonProtoToJson JsonProtoDecoder = _JsonToJsonProto # pylint:enable=invalid-name encoding.RegisterCustomMessageCodec( encoder=JsonProtoEncoder, decoder=_JsonToJsonValue)(JsonValue) encoding.RegisterCustomMessageCodec( encoder=JsonProtoEncoder, decoder=JsonProtoDecoder)(JsonObject) encoding.RegisterCustomMessageCodec( encoder=JsonProtoEncoder, decoder=JsonProtoDecoder)(JsonArray) def _EncodeDateTimeField(field, value): result = protojson.ProtoJson().encode_field(field, value) return encoding.CodecResult(value=result, complete=True) def _DecodeDateTimeField(unused_field, value): result = protojson.ProtoJson().decode_field( message_types.DateTimeField(1), value) return encoding.CodecResult(value=result, complete=True) encoding.RegisterFieldTypeCodec(_EncodeDateTimeField, _DecodeDateTimeField)( message_types.DateTimeField) def _EncodeInt64Field(field, value): """Handle the special case of int64 as a string.""" capabilities = [ messages.Variant.INT64, messages.Variant.UINT64, ] if field.variant not in capabilities: return encoding.CodecResult(value=value, complete=False) if field.repeated: result = [str(x) for x in value] else: result = str(value) return encoding.CodecResult(value=result, complete=True) def _DecodeInt64Field(unused_field, value): # Don't need to do anything special, they're decoded just fine return encoding.CodecResult(value=value, complete=False) encoding.RegisterFieldTypeCodec(_EncodeInt64Field, _DecodeInt64Field)( messages.IntegerField) def _EncodeDateField(field, value): """Encoder for datetime.date objects.""" if field.repeated: result = [d.isoformat() for d in value] else: result = value.isoformat() return encoding.CodecResult(value=result, complete=True) def _DecodeDateField(unused_field, value): date = datetime.datetime.strptime(value, '%Y-%m-%d').date() return encoding.CodecResult(value=date, complete=True) encoding.RegisterFieldTypeCodec(_EncodeDateField, _DecodeDateField)(DateField) py/base_api_test.py 0000644 00000034167 15025317163 0010366 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import base64 import datetime import sys import contextlib import unittest import six from six.moves import http_client from six.moves import urllib_parse from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.py import base_api from apitools.base.py import encoding from apitools.base.py import exceptions from apitools.base.py import http_wrapper @contextlib.contextmanager def mock(module, fn_name, patch): unpatch = getattr(module, fn_name) setattr(module, fn_name, patch) try: yield finally: setattr(module, fn_name, unpatch) class SimpleMessage(messages.Message): field = messages.StringField(1) bytes_field = messages.BytesField(2) class MessageWithTime(messages.Message): timestamp = message_types.DateTimeField(1) class MessageWithRemappings(messages.Message): class AnEnum(messages.Enum): value_one = 1 value_two = 2 str_field = messages.StringField(1) enum_field = messages.EnumField('AnEnum', 2) encoding.AddCustomJsonFieldMapping( MessageWithRemappings, 'str_field', 'remapped_field') encoding.AddCustomJsonEnumMapping( MessageWithRemappings.AnEnum, 'value_one', 'ONE/TWO') class StandardQueryParameters(messages.Message): field = messages.StringField(1) prettyPrint = messages.BooleanField( 5, default=True) # pylint: disable=invalid-name pp = messages.BooleanField(6, default=True) nextPageToken = messages.BytesField(7) # pylint:disable=invalid-name class FakeCredentials(object): def authorize(self, _): # pylint: disable=invalid-name return None class FakeClient(base_api.BaseApiClient): MESSAGES_MODULE = sys.modules[__name__] _PACKAGE = 'package' _SCOPES = ['scope1'] _CLIENT_ID = 'client_id' _CLIENT_SECRET = 'client_secret' class FakeService(base_api.BaseApiService): def __init__(self, client=None): client = client or FakeClient( 'http://www.example.com/', credentials=FakeCredentials()) super(FakeService, self).__init__(client) class BaseApiTest(unittest.TestCase): def __GetFakeClient(self): return FakeClient('', credentials=FakeCredentials()) def testUrlNormalization(self): client = FakeClient('http://www.googleapis.com', get_credentials=False) self.assertTrue(client.url.endswith('/')) def testNoCredentials(self): client = FakeClient('', get_credentials=False) self.assertIsNotNone(client) self.assertIsNone(client._credentials) def testIncludeEmptyFieldsClient(self): msg = SimpleMessage() client = self.__GetFakeClient() self.assertEqual('{}', client.SerializeMessage(msg)) with client.IncludeFields(('field',)): self.assertEqual('{"field": null}', client.SerializeMessage(msg)) def testJsonResponse(self): method_config = base_api.ApiMethodInfo( response_type_name='SimpleMessage') service = FakeService() http_response = http_wrapper.Response( info={'status': '200'}, content='{"field": "abc"}', request_url='http://www.google.com') response_message = SimpleMessage(field='abc') self.assertEqual(response_message, service.ProcessHttpResponse( method_config, http_response)) with service.client.JsonResponseModel(): self.assertEqual( http_response.content, service.ProcessHttpResponse(method_config, http_response)) def testJsonResponseEncoding(self): # On Python 3, httplib2 always returns bytes, so we need to check that # we can correctly decode the message content using the given encoding. method_config = base_api.ApiMethodInfo( response_type_name='SimpleMessage') service = FakeService(FakeClient( 'http://www.example.com/', credentials=FakeCredentials(), response_encoding='utf8')) http_response = http_wrapper.Response( info={'status': '200'}, content=b'{"field": "abc"}', request_url='http://www.google.com') response_message = SimpleMessage(field=u'abc') self.assertEqual(response_message, service.ProcessHttpResponse( method_config, http_response)) with service.client.JsonResponseModel(): self.assertEqual( http_response.content.decode('utf8'), service.ProcessHttpResponse(method_config, http_response)) def testAdditionalHeaders(self): additional_headers = {'Request-Is-Awesome': '1'} client = self.__GetFakeClient() # No headers to start http_request = http_wrapper.Request('http://www.example.com') new_request = client.ProcessHttpRequest(http_request) self.assertFalse('Request-Is-Awesome' in new_request.headers) # Add a new header and ensure it's added to the request. client.additional_http_headers = additional_headers http_request = http_wrapper.Request('http://www.example.com') new_request = client.ProcessHttpRequest(http_request) self.assertTrue('Request-Is-Awesome' in new_request.headers) def testCustomCheckResponse(self): def check_response(): pass def fakeMakeRequest(*_, **kwargs): self.assertEqual(check_response, kwargs['check_response_func']) return http_wrapper.Response( info={'status': '200'}, content='{"field": "abc"}', request_url='http://www.google.com') method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', response_type_name='SimpleMessage') client = self.__GetFakeClient() client.check_response_func = check_response service = FakeService(client=client) request = SimpleMessage() with mock(base_api.http_wrapper, 'MakeRequest', fakeMakeRequest): service._RunMethod(method_config, request) def testCustomRetryFunc(self): def retry_func(): pass def fakeMakeRequest(*_, **kwargs): self.assertEqual(retry_func, kwargs['retry_func']) return http_wrapper.Response( info={'status': '200'}, content='{"field": "abc"}', request_url='http://www.google.com') method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', response_type_name='SimpleMessage') client = self.__GetFakeClient() client.retry_func = retry_func service = FakeService(client=client) request = SimpleMessage() with mock(base_api.http_wrapper, 'MakeRequest', fakeMakeRequest): service._RunMethod(method_config, request) def testHttpError(self): def fakeMakeRequest(*unused_args, **unused_kwargs): return http_wrapper.Response( info={'status': http_client.BAD_REQUEST}, content='{"field": "abc"}', request_url='http://www.google.com') method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', response_type_name='SimpleMessage') client = self.__GetFakeClient() service = FakeService(client=client) request = SimpleMessage() with mock(base_api.http_wrapper, 'MakeRequest', fakeMakeRequest): with self.assertRaises(exceptions.HttpBadRequestError) as err: service._RunMethod(method_config, request) http_error = err.exception self.assertEqual('http://www.google.com', http_error.url) self.assertEqual('{"field": "abc"}', http_error.content) self.assertEqual(method_config, http_error.method_config) self.assertEqual(request, http_error.request) def testQueryEncoding(self): method_config = base_api.ApiMethodInfo( request_type_name='MessageWithTime', query_params=['timestamp']) service = FakeService() request = MessageWithTime( timestamp=datetime.datetime(2014, 10, 0o7, 12, 53, 13)) http_request = service.PrepareHttpRequest(method_config, request) url_timestamp = urllib_parse.quote(request.timestamp.isoformat()) self.assertTrue(http_request.url.endswith(url_timestamp)) def testPrettyPrintEncoding(self): method_config = base_api.ApiMethodInfo( request_type_name='MessageWithTime', query_params=['timestamp']) service = FakeService() request = MessageWithTime( timestamp=datetime.datetime(2014, 10, 0o7, 12, 53, 13)) global_params = StandardQueryParameters() http_request = service.PrepareHttpRequest(method_config, request, global_params=global_params) self.assertFalse('prettyPrint' in http_request.url) self.assertFalse('pp' in http_request.url) global_params.prettyPrint = False # pylint: disable=invalid-name global_params.pp = False http_request = service.PrepareHttpRequest(method_config, request, global_params=global_params) self.assertTrue('prettyPrint=0' in http_request.url) self.assertTrue('pp=0' in http_request.url) def testQueryBytesRequest(self): method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', query_params=['bytes_field']) service = FakeService() non_unicode_message = b''.join((six.int2byte(100), six.int2byte(200))) request = SimpleMessage(bytes_field=non_unicode_message) global_params = StandardQueryParameters() http_request = service.PrepareHttpRequest(method_config, request, global_params=global_params) want = urllib_parse.urlencode({ 'bytes_field': base64.urlsafe_b64encode(non_unicode_message), }) self.assertIn(want, http_request.url) def testQueryBytesGlobalParams(self): method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', query_params=['bytes_field']) service = FakeService() non_unicode_message = b''.join((six.int2byte(100), six.int2byte(200))) request = SimpleMessage() global_params = StandardQueryParameters( nextPageToken=non_unicode_message) http_request = service.PrepareHttpRequest(method_config, request, global_params=global_params) want = urllib_parse.urlencode({ 'nextPageToken': base64.urlsafe_b64encode(non_unicode_message), }) self.assertIn(want, http_request.url) def testQueryRemapping(self): method_config = base_api.ApiMethodInfo( request_type_name='MessageWithRemappings', query_params=['remapped_field', 'enum_field']) request = MessageWithRemappings( str_field='foo', enum_field=MessageWithRemappings.AnEnum.value_one) http_request = FakeService().PrepareHttpRequest(method_config, request) result_params = urllib_parse.parse_qs( urllib_parse.urlparse(http_request.url).query) expected_params = {'enum_field': 'ONE%2FTWO', 'remapped_field': 'foo'} self.assertTrue(expected_params, result_params) def testPathRemapping(self): method_config = base_api.ApiMethodInfo( relative_path='parameters/{remapped_field}/remap/{enum_field}', request_type_name='MessageWithRemappings', path_params=['remapped_field', 'enum_field']) request = MessageWithRemappings( str_field='gonna', enum_field=MessageWithRemappings.AnEnum.value_one) service = FakeService() expected_url = service.client.url + 'parameters/gonna/remap/ONE%2FTWO' http_request = service.PrepareHttpRequest(method_config, request) self.assertEqual(expected_url, http_request.url) method_config.relative_path = ( 'parameters/{+remapped_field}/remap/{+enum_field}') expected_url = service.client.url + 'parameters/gonna/remap/ONE/TWO' http_request = service.PrepareHttpRequest(method_config, request) self.assertEqual(expected_url, http_request.url) def testColonInRelativePath(self): method_config = base_api.ApiMethodInfo( relative_path='path:withJustColon', request_type_name='SimpleMessage') service = FakeService() request = SimpleMessage() http_request = service.PrepareHttpRequest(method_config, request) self.assertEqual('http://www.example.com/path:withJustColon', http_request.url) def testOverwritesTransferUrlBase(self): client = self.__GetFakeClient() client.overwrite_transfer_urls_with_client_base = True client._url = 'http://custom.p.googleapis.com/' observed = client.FinalizeTransferUrl( 'http://normal.googleapis.com/path') expected = 'http://custom.p.googleapis.com/path' self.assertEqual(observed, expected) def testApiVersionSystemParameter(self): method_config = base_api.ApiMethodInfo( request_type_name='SimpleMessage', api_version_param='2024-01-01') service = FakeService() request = SimpleMessage() http_request = service.PrepareHttpRequest(method_config, request) self.assertIn('X-Goog-Api-Version', http_request.headers) self.assertEqual( '2024-01-01', http_request.headers['X-Goog-Api-Version']) if __name__ == '__main__': unittest.main() py/testing/mock_test.py 0000644 00000031573 15025317163 0011227 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for apitools.base.py.testing.mock.""" import unittest import httplib2 import six from apitools.base.protorpclite import messages from apitools.base.py import base_api from apitools.base.py import exceptions from apitools.base.py.testing import mock from samples.fusiontables_sample.fusiontables_v1 import \ fusiontables_v1_client as fusiontables from samples.fusiontables_sample.fusiontables_v1 import \ fusiontables_v1_messages as fusiontables_messages def _GetApiServices(api_client_class): return dict( (name, potential_service) for name, potential_service in six.iteritems(api_client_class.__dict__) if (isinstance(potential_service, type) and issubclass(potential_service, base_api.BaseApiService))) class CustomException(Exception): pass class MockTest(unittest.TestCase): def testMockFusionBasic(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual(client.column.List(1), 2) with self.assertRaises(mock.UnexpectedRequestException): client.column.List(3) def testMockFusionException(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, exception=exceptions.HttpError({'status': 404}, '', ''), enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) with self.assertRaises(exceptions.HttpError): client.column.List(1) def testMockFusionTypeChecking(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: messages = client_class.MESSAGES_MODULE client_class.column.List.Expect( messages.FusiontablesColumnListRequest(tableId='foo'), messages.ColumnList(items=[], totalItems=0)) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual( client.column.List( messages.FusiontablesColumnListRequest(tableId='foo')), messages.ColumnList(items=[], totalItems=0)) def testMockFusionTypeCheckingErrors(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: messages = client_class.MESSAGES_MODULE # Wrong request type. with self.assertRaises(exceptions.ConfigurationValueError): client_class.column.List.Expect( messages.FusiontablesColumnInsertRequest(), messages.ColumnList(items=[], totalItems=0)) # Wrong response type. with self.assertRaises(exceptions.ConfigurationValueError): client_class.column.List.Expect( messages.FusiontablesColumnListRequest(tableId='foo'), messages.Column()) # No error if checking is disabled. client_class.column.List.Expect( messages.FusiontablesColumnInsertRequest(), messages.Column(), enable_type_checking=False) client_class.column.List( messages.FusiontablesColumnInsertRequest()) def testMockIfAnotherException(self): with self.assertRaises(CustomException): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) raise CustomException('Something when wrong') def testMockFusionOrder(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) client_class.column.List.Expect( request=2, response=1, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual(client.column.List(1), 2) self.assertEqual(client.column.List(2), 1) def testMockFusionWrongOrder(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) client_class.column.List.Expect( request=2, response=1, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) with self.assertRaises(mock.UnexpectedRequestException): self.assertEqual(client.column.List(2), 1) with self.assertRaises(mock.UnexpectedRequestException): self.assertEqual(client.column.List(1), 2) def testMockFusionTooMany(self): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual(client.column.List(1), 2) with self.assertRaises(mock.UnexpectedRequestException): self.assertEqual(client.column.List(2), 1) def testMockFusionTooFew(self): with self.assertRaises(mock.ExpectedRequestsException): with mock.Client(fusiontables.FusiontablesV1) as client_class: client_class.column.List.Expect( request=1, response=2, enable_type_checking=False) client_class.column.List.Expect( request=2, response=1, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual(client.column.List(1), 2) def testFusionUnmock(self): with mock.Client(fusiontables.FusiontablesV1): client = fusiontables.FusiontablesV1(get_credentials=False) mocked_service_type = type(client.column) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertNotEqual(type(client.column), mocked_service_type) def testRequestMacher(self): class Matcher(object): def __init__(self, eq): self._eq = eq def __eq__(self, other): return self._eq(other) with mock.Client(fusiontables.FusiontablesV1) as client_class: def IsEven(x): return x % 2 == 0 def IsOdd(x): return not IsEven(x) client_class.column.List.Expect( request=Matcher(IsEven), response=1, enable_type_checking=False) client_class.column.List.Expect( request=Matcher(IsOdd), response=2, enable_type_checking=False) client_class.column.List.Expect( request=Matcher(IsEven), response=3, enable_type_checking=False) client_class.column.List.Expect( request=Matcher(IsOdd), response=4, enable_type_checking=False) client = fusiontables.FusiontablesV1(get_credentials=False) self.assertEqual(client.column.List(2), 1) self.assertEqual(client.column.List(1), 2) self.assertEqual(client.column.List(20), 3) self.assertEqual(client.column.List(23), 4) def testClientUnmock(self): mock_client = mock.Client(fusiontables.FusiontablesV1) self.assertFalse(isinstance(mock_client, fusiontables.FusiontablesV1)) attributes = set(mock_client.__dict__.keys()) mock_client = mock_client.Mock() self.assertTrue(isinstance(mock_client, fusiontables.FusiontablesV1)) self.assertTrue(set(mock_client.__dict__.keys()) - attributes) mock_client.Unmock() self.assertFalse(isinstance(mock_client, fusiontables.FusiontablesV1)) self.assertEqual(attributes, set(mock_client.__dict__.keys())) def testMockHasMessagesModule(self): with mock.Client(fusiontables.FusiontablesV1) as mock_client: self.assertEqual(fusiontables_messages, mock_client.MESSAGES_MODULE) def testMockHasUrlProperty(self): with mock.Client(fusiontables.FusiontablesV1) as mock_client: self.assertEqual(fusiontables.FusiontablesV1.BASE_URL, mock_client.url) self.assertFalse(hasattr(mock_client, 'url')) def testMockHasOverrideUrlProperty(self): real_client = fusiontables.FusiontablesV1(url='http://localhost:8080', get_credentials=False) with mock.Client(fusiontables.FusiontablesV1, real_client) as mock_client: self.assertEqual('http://localhost:8080/', mock_client.url) def testMockHasHttpProperty(self): with mock.Client(fusiontables.FusiontablesV1) as mock_client: self.assertIsInstance(mock_client.http, httplib2.Http) self.assertFalse(hasattr(mock_client, 'http')) def testMockHasOverrideHttpProperty(self): real_client = fusiontables.FusiontablesV1(url='http://localhost:8080', http='SomeHttpObject', get_credentials=False) with mock.Client(fusiontables.FusiontablesV1, real_client) as mock_client: self.assertEqual('SomeHttpObject', mock_client.http) def testMockPreservesServiceMethods(self): services = _GetApiServices(fusiontables.FusiontablesV1) with mock.Client(fusiontables.FusiontablesV1): mocked_services = _GetApiServices(fusiontables.FusiontablesV1) self.assertEqual(services.keys(), mocked_services.keys()) for name, service in six.iteritems(services): mocked_service = mocked_services[name] methods = service.GetMethodsList() for method in methods: mocked_method = getattr(mocked_service, method) mocked_method_config = mocked_method.method_config() method_config = getattr(service, method).method_config() self.assertEqual(method_config, mocked_method_config) class _NestedMessage(messages.Message): nested = messages.StringField(1) class _NestedListMessage(messages.Message): nested_list = messages.MessageField(_NestedMessage, 1, repeated=True) class _NestedNestedMessage(messages.Message): nested = messages.MessageField(_NestedMessage, 1) class UtilTest(unittest.TestCase): def testMessagesEqual(self): self.assertFalse(mock._MessagesEqual( _NestedNestedMessage( nested=_NestedMessage( nested='foo')), _NestedNestedMessage( nested=_NestedMessage( nested='bar')))) self.assertTrue(mock._MessagesEqual( _NestedNestedMessage( nested=_NestedMessage( nested='foo')), _NestedNestedMessage( nested=_NestedMessage( nested='foo')))) def testListedMessagesEqual(self): self.assertTrue(mock._MessagesEqual( _NestedListMessage( nested_list=[_NestedMessage(nested='foo')]), _NestedListMessage( nested_list=[_NestedMessage(nested='foo')]))) self.assertTrue(mock._MessagesEqual( _NestedListMessage( nested_list=[_NestedMessage(nested='foo'), _NestedMessage(nested='foo2')]), _NestedListMessage( nested_list=[_NestedMessage(nested='foo'), _NestedMessage(nested='foo2')]))) self.assertFalse(mock._MessagesEqual( _NestedListMessage( nested_list=[_NestedMessage(nested='foo')]), _NestedListMessage( nested_list=[_NestedMessage(nested='bar')]))) self.assertFalse(mock._MessagesEqual( _NestedListMessage( nested_list=[_NestedMessage(nested='foo')]), _NestedListMessage( nested_list=[_NestedMessage(nested='foo'), _NestedMessage(nested='foo')]))) py/testing/mock.py 0000644 00000034706 15025317163 0010171 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """The mock module allows easy mocking of apitools clients. This module allows you to mock out the constructor of a particular apitools client, for a specific API and version. Then, when the client is created, it will be run against an expected session that you define. This way code that is not aware of the testing framework can construct new clients as normal, as long as it's all done within the context of a mock. """ import difflib import sys import six from apitools.base.protorpclite import messages from apitools.base.py import base_api from apitools.base.py import encoding from apitools.base.py import exceptions class Error(Exception): """Exceptions for this module.""" def _MessagesEqual(msg1, msg2): """Compare two protorpc messages for equality. Using python's == operator does not work in all cases, specifically when there is a list involved. Args: msg1: protorpc.messages.Message or [protorpc.messages.Message] or number or string, One of the messages to compare. msg2: protorpc.messages.Message or [protorpc.messages.Message] or number or string, One of the messages to compare. Returns: If the messages are isomorphic. """ if isinstance(msg1, list) and isinstance(msg2, list): if len(msg1) != len(msg2): return False return all(_MessagesEqual(x, y) for x, y in zip(msg1, msg2)) if (not isinstance(msg1, messages.Message) or not isinstance(msg2, messages.Message)): return msg1 == msg2 for field in msg1.all_fields(): field1 = getattr(msg1, field.name) field2 = getattr(msg2, field.name) if not _MessagesEqual(field1, field2): return False return True class UnexpectedRequestException(Error): def __init__(self, received_call, expected_call): expected_key, expected_request = expected_call received_key, received_request = received_call expected_repr = encoding.MessageToRepr( expected_request, multiline=True) received_repr = encoding.MessageToRepr( received_request, multiline=True) expected_lines = expected_repr.splitlines() received_lines = received_repr.splitlines() diff_lines = difflib.unified_diff(expected_lines, received_lines) diff = '\n'.join(diff_lines) if expected_key != received_key: msg = '\n'.join(( 'expected: {expected_key}({expected_request})', 'received: {received_key}({received_request})', '', )).format( expected_key=expected_key, expected_request=expected_repr, received_key=received_key, received_request=received_repr) super(UnexpectedRequestException, self).__init__(msg) else: msg = '\n'.join(( 'for request to {key},', 'expected: {expected_request}', 'received: {received_request}', 'diff: {diff}', '', )).format( key=expected_key, expected_request=expected_repr, received_request=received_repr, diff=diff) super(UnexpectedRequestException, self).__init__(msg) class ExpectedRequestsException(Error): def __init__(self, expected_calls): msg = 'expected:\n' for (key, request) in expected_calls: msg += '{key}({request})\n'.format( key=key, request=encoding.MessageToRepr(request, multiline=True)) super(ExpectedRequestsException, self).__init__(msg) class _ExpectedRequestResponse(object): """Encapsulation of an expected request and corresponding response.""" def __init__(self, key, request, response=None, exception=None): self.__key = key self.__request = request if response and exception: raise exceptions.ConfigurationValueError( 'Should specify at most one of response and exception') if response and isinstance(response, exceptions.Error): raise exceptions.ConfigurationValueError( 'Responses should not be an instance of Error') if exception and not isinstance(exception, exceptions.Error): raise exceptions.ConfigurationValueError( 'Exceptions must be instances of Error') self.__response = response self.__exception = exception @property def key(self): return self.__key @property def request(self): return self.__request def ValidateAndRespond(self, key, request): """Validate that key and request match expectations, and respond if so. Args: key: str, Actual key to compare against expectations. request: protorpc.messages.Message or [protorpc.messages.Message] or number or string, Actual request to compare againt expectations Raises: UnexpectedRequestException: If key or request dont match expectations. apitools_base.Error: If a non-None exception is specified to be thrown. Returns: The response that was specified to be returned. """ if key != self.__key or not (self.__request == request or _MessagesEqual(request, self.__request)): raise UnexpectedRequestException((key, request), (self.__key, self.__request)) if self.__exception: # Can only throw apitools_base.Error. raise self.__exception # pylint: disable=raising-bad-type return self.__response class _MockedMethod(object): """A mocked API service method.""" def __init__(self, key, mocked_client, real_method): self.__name__ = real_method.__name__ self.__key = key self.__mocked_client = mocked_client self.__real_method = real_method self.method_config = real_method.method_config config = self.method_config() self.__request_type = getattr(self.__mocked_client.MESSAGES_MODULE, config.request_type_name) self.__response_type = getattr(self.__mocked_client.MESSAGES_MODULE, config.response_type_name) def _TypeCheck(self, msg, is_request): """Ensure the given message is of the expected type of this method. Args: msg: The message instance to check. is_request: True to validate against the expected request type, False to validate against the expected response type. Raises: exceptions.ConfigurationValueError: If the type of the message was not correct. """ if is_request: mode = 'request' real_type = self.__request_type else: mode = 'response' real_type = self.__response_type if not isinstance(msg, real_type): raise exceptions.ConfigurationValueError( 'Expected {} is not of the correct type for method [{}].\n' ' Required: [{}]\n' ' Given: [{}]'.format( mode, self.__key, real_type, type(msg))) def Expect(self, request, response=None, exception=None, enable_type_checking=True, **unused_kwargs): """Add an expectation on the mocked method. Exactly one of response and exception should be specified. Args: request: The request that should be expected response: The response that should be returned or None if exception is provided. exception: An exception that should be thrown, or None. enable_type_checking: When true, the message type of the request and response (if provided) will be checked against the types required by this method. """ # TODO(jasmuth): the unused_kwargs provides a placeholder for # future things that can be passed to Expect(), like special # params to the method call. # Ensure that the registered request and response mocks actually # match what this method accepts and returns. if enable_type_checking: self._TypeCheck(request, is_request=True) if response: self._TypeCheck(response, is_request=False) # pylint: disable=protected-access # Class in same module. self.__mocked_client._request_responses.append( _ExpectedRequestResponse(self.__key, request, response=response, exception=exception)) # pylint: enable=protected-access def __call__(self, request, **unused_kwargs): # TODO(jasmuth): allow the testing code to expect certain # values in these currently unused_kwargs, especially the # upload parameter used by media-heavy services like bigquery # or bigstore. # pylint: disable=protected-access # Class in same module. if self.__mocked_client._request_responses: request_response = self.__mocked_client._request_responses.pop(0) else: raise UnexpectedRequestException( (self.__key, request), (None, None)) # pylint: enable=protected-access response = request_response.ValidateAndRespond(self.__key, request) if response is None and self.__real_method: response = self.__real_method(request) print(encoding.MessageToRepr( response, multiline=True, shortstrings=True)) return response return response def _MakeMockedService(api_name, collection_name, mock_client, service, real_service): class MockedService(base_api.BaseApiService): pass for method in service.GetMethodsList(): real_method = None if real_service: real_method = getattr(real_service, method) setattr(MockedService, method, _MockedMethod(api_name + '.' + collection_name + '.' + method, mock_client, real_method)) return MockedService class Client(object): """Mock an apitools client.""" def __init__(self, client_class, real_client=None): """Mock an apitools API, given its class. Args: client_class: The class for the API. eg, if you from apis.sqladmin import v1beta3 then you can pass v1beta3.SqladminV1beta3 to this class and anything within its context will use your mocked version. real_client: apitools Client, The client to make requests against when the expected response is None. """ if not real_client: real_client = client_class(get_credentials=False) self.__orig_class = self.__class__ self.__client_class = client_class self.__real_service_classes = {} self.__real_client = real_client self._request_responses = [] self.__real_include_fields = None def __enter__(self): return self.Mock() def Mock(self): """Stub out the client class with mocked services.""" client = self.__real_client or self.__client_class( get_credentials=False) class Patched(self.__class__, self.__client_class): pass self.__class__ = Patched for name in dir(self.__client_class): service_class = getattr(self.__client_class, name) if not isinstance(service_class, type): continue if not issubclass(service_class, base_api.BaseApiService): continue self.__real_service_classes[name] = service_class # pylint: disable=protected-access collection_name = service_class._NAME # pylint: enable=protected-access api_name = '%s_%s' % (self.__client_class._PACKAGE, self.__client_class._URL_VERSION) mocked_service_class = _MakeMockedService( api_name, collection_name, self, service_class, service_class(client) if self.__real_client else None) setattr(self.__client_class, name, mocked_service_class) setattr(self, collection_name, mocked_service_class(self)) self.__real_include_fields = self.__client_class.IncludeFields self.__client_class.IncludeFields = self.IncludeFields # pylint: disable=attribute-defined-outside-init self._url = client._url self._http = client._http return self def __exit__(self, exc_type, value, traceback): is_active_exception = value is not None self.Unmock(suppress=is_active_exception) if is_active_exception: six.reraise(exc_type, value, traceback) return True def Unmock(self, suppress=False): self.__class__ = self.__orig_class for name, service_class in self.__real_service_classes.items(): setattr(self.__client_class, name, service_class) delattr(self, service_class._NAME) self.__real_service_classes = {} del self._url del self._http self.__client_class.IncludeFields = self.__real_include_fields self.__real_include_fields = None requests = [(rq_rs.key, rq_rs.request) for rq_rs in self._request_responses] self._request_responses = [] if requests and not suppress and sys.exc_info()[1] is None: raise ExpectedRequestsException(requests) def IncludeFields(self, include_fields): if self.__real_client: return self.__real_include_fields(self.__real_client, include_fields) py/testing/__init__.py 0000644 00000001135 15025317163 0010765 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Package marker file.""" py/transfer_test.py 0000644 00000064074 15025317163 0010447 0 ustar 00 # -*- coding: utf-8 -*- # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for transfer.py.""" import string import unittest import httplib2 import json import mock import six from six.moves import http_client from apitools.base.py import base_api from apitools.base.py import exceptions from apitools.base.py import gzip from apitools.base.py import http_wrapper from apitools.base.py import transfer class TransferTest(unittest.TestCase): def assertRangeAndContentRangeCompatible(self, request, response): request_prefix = 'bytes=' self.assertIn('range', request.headers) self.assertTrue(request.headers['range'].startswith(request_prefix)) request_range = request.headers['range'][len(request_prefix):] response_prefix = 'bytes ' self.assertIn('content-range', response.info) response_header = response.info['content-range'] self.assertTrue(response_header.startswith(response_prefix)) response_range = ( response_header[len(response_prefix):].partition('/')[0]) msg = ('Request range ({0}) not a prefix of ' 'response_range ({1})').format( request_range, response_range) self.assertTrue(response_range.startswith(request_range), msg=msg) def testComputeEndByte(self): total_size = 100 chunksize = 10 download = transfer.Download.FromStream( six.StringIO(), chunksize=chunksize, total_size=total_size) self.assertEqual(chunksize - 1, download._Download__ComputeEndByte(0, end=50)) def testComputeEndByteReturnNone(self): download = transfer.Download.FromStream(six.StringIO()) self.assertIsNone( download._Download__ComputeEndByte(0, use_chunks=False)) def testComputeEndByteNoChunks(self): total_size = 100 download = transfer.Download.FromStream( six.StringIO(), chunksize=10, total_size=total_size) for end in (None, 1000): self.assertEqual( total_size - 1, download._Download__ComputeEndByte(0, end=end, use_chunks=False), msg='Failed on end={0}'.format(end)) def testComputeEndByteNoTotal(self): download = transfer.Download.FromStream(six.StringIO()) default_chunksize = download.chunksize for chunksize in (100, default_chunksize): download.chunksize = chunksize for start in (0, 10): self.assertEqual( download.chunksize + start - 1, download._Download__ComputeEndByte(start), msg='Failed on start={0}, chunksize={1}'.format( start, chunksize)) def testComputeEndByteSmallTotal(self): total_size = 100 download = transfer.Download.FromStream(six.StringIO(), total_size=total_size) for start in (0, 10): self.assertEqual(total_size - 1, download._Download__ComputeEndByte(start), msg='Failed on start={0}'.format(start)) def testDownloadThenStream(self): bytes_http = object() http = object() download_stream = six.StringIO() download = transfer.Download.FromStream(download_stream, total_size=26) download.bytes_http = bytes_http base_url = 'https://part.one/' with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as make_request: make_request.return_value = http_wrapper.Response( info={ 'content-range': 'bytes 0-25/26', 'status': http_client.OK, }, content=string.ascii_lowercase, request_url=base_url, ) request = http_wrapper.Request(url='https://part.one/') download.InitializeDownload(request, http=http) self.assertEqual(1, make_request.call_count) received_request = make_request.call_args[0][1] self.assertEqual(base_url, received_request.url) self.assertRangeAndContentRangeCompatible( received_request, make_request.return_value) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as make_request: make_request.return_value = http_wrapper.Response( info={ 'status': http_client.REQUESTED_RANGE_NOT_SATISFIABLE, }, content='error', request_url=base_url, ) download.StreamInChunks() self.assertEqual(1, make_request.call_count) received_request = make_request.call_args[0][1] self.assertEqual('bytes=26-', received_request.headers['range']) def testGetRange(self): for (start_byte, end_byte) in [(0, 25), (5, 15), (0, 0), (25, 25)]: bytes_http = object() http = object() download_stream = six.StringIO() download = transfer.Download.FromStream(download_stream, total_size=26, auto_transfer=False) download.bytes_http = bytes_http base_url = 'https://part.one/' with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as make_request: make_request.return_value = http_wrapper.Response( info={ 'content-range': 'bytes %d-%d/26' % (start_byte, end_byte), 'status': http_client.OK, }, content=string.ascii_lowercase[start_byte:end_byte + 1], request_url=base_url, ) request = http_wrapper.Request(url='https://part.one/') download.InitializeDownload(request, http=http) download.GetRange(start_byte, end_byte) self.assertEqual(1, make_request.call_count) received_request = make_request.call_args[0][1] self.assertEqual(base_url, received_request.url) self.assertRangeAndContentRangeCompatible( received_request, make_request.return_value) def testNonChunkedDownload(self): bytes_http = object() http = object() download_stream = six.StringIO() download = transfer.Download.FromStream(download_stream, total_size=52) download.bytes_http = bytes_http base_url = 'https://part.one/' with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as make_request: make_request.return_value = http_wrapper.Response( info={ 'content-range': 'bytes 0-51/52', 'status': http_client.OK, }, content=string.ascii_lowercase * 2, request_url=base_url, ) request = http_wrapper.Request(url='https://part.one/') download.InitializeDownload(request, http=http) self.assertEqual(1, make_request.call_count) received_request = make_request.call_args[0][1] self.assertEqual(base_url, received_request.url) self.assertRangeAndContentRangeCompatible( received_request, make_request.return_value) download_stream.seek(0) self.assertEqual(string.ascii_lowercase * 2, download_stream.getvalue()) def testChunkedDownload(self): bytes_http = object() http = object() download_stream = six.StringIO() download = transfer.Download.FromStream( download_stream, chunksize=26, total_size=52) download.bytes_http = bytes_http # Setting autospec on a mock with an iterable side_effect is # currently broken (http://bugs.python.org/issue17826), so # instead we write a little function. def _ReturnBytes(unused_http, http_request, *unused_args, **unused_kwds): url = http_request.url if url == 'https://part.one/': return http_wrapper.Response( info={ 'content-location': 'https://part.two/', 'content-range': 'bytes 0-25/52', 'status': http_client.PARTIAL_CONTENT, }, content=string.ascii_lowercase, request_url='https://part.one/', ) elif url == 'https://part.two/': return http_wrapper.Response( info={ 'content-range': 'bytes 26-51/52', 'status': http_client.OK, }, content=string.ascii_uppercase, request_url='https://part.two/', ) else: self.fail('Unknown URL requested: %s' % url) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as make_request: make_request.side_effect = _ReturnBytes request = http_wrapper.Request(url='https://part.one/') download.InitializeDownload(request, http=http) self.assertEqual(2, make_request.call_count) for call in make_request.call_args_list: self.assertRangeAndContentRangeCompatible( call[0][1], _ReturnBytes(*call[0])) download_stream.seek(0) self.assertEqual(string.ascii_lowercase + string.ascii_uppercase, download_stream.getvalue()) # @mock.patch.object(transfer.Upload, 'RefreshResumableUploadState', # new=mock.Mock()) def testFinalizesTransferUrlIfClientPresent(self): """Tests download's enforcement of client custom endpoints.""" mock_client = mock.Mock() fake_json_data = json.dumps({ 'auto_transfer': False, 'progress': 0, 'total_size': 0, 'url': 'url', }) transfer.Download.FromData(six.BytesIO(), fake_json_data, client=mock_client) mock_client.FinalizeTransferUrl.assert_called_once_with('url') def testMultipartEncoding(self): # This is really a table test for various issues we've seen in # the past; see notes below for particular histories. test_cases = [ # Python's mime module by default encodes lines that start # with "From " as ">From ", which we need to make sure we # don't run afoul of when sending content that isn't # intended to be so encoded. This test calls out that we # get this right. We test for both the multipart and # non-multipart case. 'line one\nFrom \nline two', # We had originally used a `six.StringIO` to hold the http # request body in the case of a multipart upload; for # bytes being uploaded in Python3, however, this causes # issues like this: # https://github.com/GoogleCloudPlatform/gcloud-python/issues/1760 # We test below to ensure that we don't end up mangling # the body before sending. u'name,main_ingredient\nRäksmörgås,Räkor\nBaguette,Bröd', ] for upload_contents in test_cases: multipart_body = '{"body_field_one": 7}' upload_bytes = upload_contents.encode('ascii', 'backslashreplace') upload_config = base_api.ApiUploadInfo( accept=['*/*'], max_size=None, resumable_multipart=True, resumable_path=u'/resumable/upload', simple_multipart=True, simple_path=u'/upload', ) url_builder = base_api._UrlBuilder('http://www.uploads.com') # Test multipart: having a body argument in http_request forces # multipart here. upload = transfer.Upload.FromStream( six.BytesIO(upload_bytes), 'text/plain', total_size=len(upload_bytes)) http_request = http_wrapper.Request( 'http://www.uploads.com', headers={'content-type': 'text/plain'}, body=multipart_body) upload.ConfigureRequest(upload_config, http_request, url_builder) self.assertEqual( 'multipart', url_builder.query_params['uploadType']) rewritten_upload_contents = b'\n'.join( http_request.body.split(b'--')[2].splitlines()[1:]) self.assertTrue(rewritten_upload_contents.endswith(upload_bytes)) # Test non-multipart (aka media): no body argument means this is # sent as media. upload = transfer.Upload.FromStream( six.BytesIO(upload_bytes), 'text/plain', total_size=len(upload_bytes)) http_request = http_wrapper.Request( 'http://www.uploads.com', headers={'content-type': 'text/plain'}) upload.ConfigureRequest(upload_config, http_request, url_builder) self.assertEqual(url_builder.query_params['uploadType'], 'media') rewritten_upload_contents = http_request.body self.assertTrue(rewritten_upload_contents.endswith(upload_bytes)) class UploadTest(unittest.TestCase): def setUp(self): # Sample highly compressible data. self.sample_data = b'abc' * 200 # Stream of the sample data. self.sample_stream = six.BytesIO(self.sample_data) # Sample url_builder. self.url_builder = base_api._UrlBuilder('http://www.uploads.com') # Sample request. self.request = http_wrapper.Request( 'http://www.uploads.com', headers={'content-type': 'text/plain'}) # Sample successful response. self.response = http_wrapper.Response( info={'status': http_client.OK, 'location': 'http://www.uploads.com'}, content='', request_url='http://www.uploads.com',) # Sample failure response. self.fail_response = http_wrapper.Response( info={'status': http_client.SERVICE_UNAVAILABLE, 'location': 'http://www.uploads.com'}, content='', request_url='http://www.uploads.com',) def testStreamInChunksCompressed(self): """Test that StreamInChunks will handle compression correctly.""" # Create and configure the upload object. upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, gzip_encoded=True) upload.strategy = transfer.RESUMABLE_UPLOAD # Set the chunk size so the entire stream is uploaded. upload.chunksize = len(self.sample_data) # Mock the upload to return the sample response. with mock.patch.object(transfer.Upload, '_Upload__SendMediaRequest') as mock_result, \ mock.patch.object(http_wrapper, 'MakeRequest') as make_request: mock_result.return_value = self.response make_request.return_value = self.response # Initialization. upload.InitializeUpload(self.request, 'http') upload.StreamInChunks() # Get the uploaded request and end position of the stream. (request, _), _ = mock_result.call_args_list[0] # Ensure the mock was called. self.assertTrue(mock_result.called) # Ensure the correct content encoding was set. self.assertEqual(request.headers['Content-Encoding'], 'gzip') # Ensure the stream was compresed. self.assertLess(len(request.body), len(self.sample_data)) def testStreamMediaCompressedFail(self): """Test that non-chunked uploads raise an exception. Ensure uploads with the compressed and resumable flags set called from StreamMedia raise an exception. Those uploads are unsupported. """ # Create the upload object. upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, auto_transfer=True, gzip_encoded=True) upload.strategy = transfer.RESUMABLE_UPLOAD # Mock the upload to return the sample response. with mock.patch.object(http_wrapper, 'MakeRequest') as make_request: make_request.return_value = self.response # Initialization. upload.InitializeUpload(self.request, 'http') # Ensure stream media raises an exception when the upload is # compressed. Compression is not supported on non-chunked uploads. with self.assertRaises(exceptions.InvalidUserInputError): upload.StreamMedia() def testAutoTransferCompressed(self): """Test that automatic transfers are compressed. Ensure uploads with the compressed, resumable, and automatic transfer flags set call StreamInChunks. StreamInChunks is tested in an earlier test. """ # Create the upload object. upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, gzip_encoded=True) upload.strategy = transfer.RESUMABLE_UPLOAD # Mock the upload to return the sample response. with mock.patch.object(transfer.Upload, 'StreamInChunks') as mock_result, \ mock.patch.object(http_wrapper, 'MakeRequest') as make_request: mock_result.return_value = self.response make_request.return_value = self.response # Initialization. upload.InitializeUpload(self.request, 'http') # Ensure the mock was called. self.assertTrue(mock_result.called) def testMultipartCompressed(self): """Test that multipart uploads are compressed.""" # Create the multipart configuration. upload_config = base_api.ApiUploadInfo( accept=['*/*'], max_size=None, simple_multipart=True, simple_path=u'/upload',) # Create the upload object. upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, gzip_encoded=True) # Set a body to trigger multipart configuration. self.request.body = '{"body_field_one": 7}' # Configure the request. upload.ConfigureRequest(upload_config, self.request, self.url_builder) # Ensure the request is a multipart request now. self.assertEqual( self.url_builder.query_params['uploadType'], 'multipart') # Ensure the request is gzip encoded. self.assertEqual(self.request.headers['Content-Encoding'], 'gzip') # Ensure data is compressed self.assertLess(len(self.request.body), len(self.sample_data)) # Ensure uncompressed data includes the sample data. with gzip.GzipFile(fileobj=six.BytesIO(self.request.body)) as f: original = f.read() self.assertTrue(self.sample_data in original) def testMediaCompressed(self): """Test that media uploads are compressed.""" # Create the media configuration. upload_config = base_api.ApiUploadInfo( accept=['*/*'], max_size=None, simple_multipart=True, simple_path=u'/upload',) # Create the upload object. upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, gzip_encoded=True) # Configure the request. upload.ConfigureRequest(upload_config, self.request, self.url_builder) # Ensure the request is a media request now. self.assertEqual(self.url_builder.query_params['uploadType'], 'media') # Ensure the request is gzip encoded. self.assertEqual(self.request.headers['Content-Encoding'], 'gzip') # Ensure data is compressed self.assertLess(len(self.request.body), len(self.sample_data)) # Ensure uncompressed data includes the sample data. with gzip.GzipFile(fileobj=six.BytesIO(self.request.body)) as f: original = f.read() self.assertTrue(self.sample_data in original) def HttpRequestSideEffect(self, responses=None): responses = [(response.info, response.content) for response in responses] def _side_effect(uri, **kwargs): # pylint: disable=unused-argument body = kwargs['body'] read_func = getattr(body, 'read', None) if read_func: # If the body is a stream, consume the stream. body = read_func() self.assertEqual(int(kwargs['headers']['content-length']), len(body)) return responses.pop(0) return _side_effect def testRetryRequestChunks(self): """Test that StreamInChunks will retry correctly.""" refresh_response = http_wrapper.Response( info={'status': http_wrapper.RESUME_INCOMPLETE, 'location': 'http://www.uploads.com'}, content='', request_url='http://www.uploads.com',) # Create and configure the upload object. bytes_http = httplib2.Http() upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, http=bytes_http) upload.strategy = transfer.RESUMABLE_UPLOAD # Set the chunk size so the entire stream is uploaded. upload.chunksize = len(self.sample_data) # Mock the upload to return the sample response. with mock.patch.object(bytes_http, 'request') as make_request: # This side effect also checks the request body. responses = [ self.response, # Initial request in InitializeUpload(). self.fail_response, # 503 status code from server. refresh_response, # Refresh upload progress. self.response, # Successful request. ] make_request.side_effect = self.HttpRequestSideEffect(responses) # Initialization. upload.InitializeUpload(self.request, bytes_http) upload.StreamInChunks() # Ensure the mock was called the correct number of times. self.assertEqual(make_request.call_count, len(responses)) def testStreamInChunks(self): """Test StreamInChunks.""" resume_incomplete_responses = [http_wrapper.Response( info={'status': http_wrapper.RESUME_INCOMPLETE, 'location': 'http://www.uploads.com', 'range': '0-{}'.format(end)}, content='', request_url='http://www.uploads.com',) for end in [199, 399, 599]] responses = [ self.response # Initial request in InitializeUpload(). ] + resume_incomplete_responses + [ self.response, # Successful request. ] # Create and configure the upload object. bytes_http = httplib2.Http() upload = transfer.Upload( stream=self.sample_stream, mime_type='text/plain', total_size=len(self.sample_data), close_stream=False, http=bytes_http) upload.strategy = transfer.RESUMABLE_UPLOAD # Set the chunk size so the entire stream is uploaded. upload.chunksize = 200 # Mock the upload to return the sample response. with mock.patch.object(bytes_http, 'request') as make_request: # This side effect also checks the request body. make_request.side_effect = self.HttpRequestSideEffect(responses) # Initialization. upload.InitializeUpload(self.request, bytes_http) upload.StreamInChunks() # Ensure the mock was called the correct number of times. self.assertEqual(make_request.call_count, len(responses)) @mock.patch.object(transfer.Upload, 'RefreshResumableUploadState', new=mock.Mock()) def testFinalizesTransferUrlIfClientPresent(self): """Tests upload's enforcement of client custom endpoints.""" mock_client = mock.Mock() mock_http = mock.Mock() fake_json_data = json.dumps({ 'auto_transfer': False, 'mime_type': '', 'total_size': 0, 'url': 'url', }) transfer.Upload.FromData(self.sample_stream, fake_json_data, mock_http, client=mock_client) mock_client.FinalizeTransferUrl.assert_called_once_with('url') py/http_wrapper.py 0000644 00000036135 15025317163 0010300 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """HTTP wrapper for apitools. This library wraps the underlying http library we use, which is currently httplib2. """ import collections import contextlib import logging import socket import time import httplib2 import six from six.moves import http_client from six.moves.urllib import parse from apitools.base.py import exceptions from apitools.base.py import util # pylint: disable=ungrouped-imports try: from oauth2client.client import HttpAccessTokenRefreshError as TokenRefreshError # noqa except ImportError: from oauth2client.client import AccessTokenRefreshError as TokenRefreshError # noqa __all__ = [ 'CheckResponse', 'GetHttp', 'HandleExceptionsAndRebuildHttpConnections', 'MakeRequest', 'RebuildHttpConnections', 'Request', 'Response', 'RethrowExceptionHandler', ] # 308 and 429 don't have names in httplib. RESUME_INCOMPLETE = 308 TOO_MANY_REQUESTS = 429 _REDIRECT_STATUS_CODES = ( http_client.MOVED_PERMANENTLY, http_client.FOUND, http_client.SEE_OTHER, http_client.TEMPORARY_REDIRECT, RESUME_INCOMPLETE, ) # http: An httplib2.Http instance. # http_request: A http_wrapper.Request. # exc: Exception being raised. # num_retries: Number of retries consumed; used for exponential backoff. ExceptionRetryArgs = collections.namedtuple( 'ExceptionRetryArgs', ['http', 'http_request', 'exc', 'num_retries', 'max_retry_wait', 'total_wait_sec']) @contextlib.contextmanager def _Httplib2Debuglevel(http_request, level, http=None): """Temporarily change the value of httplib2.debuglevel, if necessary. If http_request has a `loggable_body` distinct from `body`, then we need to prevent httplib2 from logging the full body. This sets httplib2.debuglevel for the duration of the `with` block; however, that alone won't change the value of existing HTTP connections. If an httplib2.Http object is provided, we'll also change the level on any cached connections attached to it. Args: http_request: a Request we're logging. level: (int) the debuglevel for logging. http: (optional) an httplib2.Http whose connections we should set the debuglevel on. Yields: None. """ if http_request.loggable_body is None: yield return old_level = httplib2.debuglevel http_levels = {} httplib2.debuglevel = level if http is not None: for connection_key, connection in http.connections.items(): # httplib2 stores two kinds of values in this dict, connection # classes and instances. Since the connection types are all # old-style classes, we can't easily distinguish by connection # type -- so instead we use the key pattern. if ':' not in connection_key: continue http_levels[connection_key] = connection.debuglevel connection.set_debuglevel(level) yield httplib2.debuglevel = old_level if http is not None: for connection_key, old_level in http_levels.items(): if connection_key in http.connections: http.connections[connection_key].set_debuglevel(old_level) class Request(object): """Class encapsulating the data for an HTTP request.""" def __init__(self, url='', http_method='GET', headers=None, body=''): self.url = url self.http_method = http_method self.headers = headers or {} self.__body = None self.__loggable_body = None self.body = body @property def loggable_body(self): return self.__loggable_body @loggable_body.setter def loggable_body(self, value): if self.body is None: raise exceptions.RequestError( 'Cannot set loggable body on request with no body') self.__loggable_body = value @property def body(self): return self.__body @body.setter def body(self, value): """Sets the request body; handles logging and length measurement.""" self.__body = value if value is not None: # Avoid calling len() which cannot exceed 4GiB in 32-bit python. body_length = getattr( self.__body, 'length', None) or len(self.__body) self.headers['content-length'] = str(body_length) else: self.headers.pop('content-length', None) # This line ensures we don't try to print large requests. if not isinstance(value, (type(None), six.string_types)): self.loggable_body = '<media body>' # Note: currently the order of fields here is important, since we want # to be able to pass in the result from httplib2.request. class Response(collections.namedtuple( 'HttpResponse', ['info', 'content', 'request_url'])): """Class encapsulating data for an HTTP response.""" __slots__ = () def __len__(self): return self.length @property def length(self): """Return the length of this response. We expose this as an attribute since using len() directly can fail for responses larger than sys.maxint. Returns: Response length (as int or long) """ def ProcessContentRange(content_range): _, _, range_spec = content_range.partition(' ') byte_range, _, _ = range_spec.partition('/') start, _, end = byte_range.partition('-') return int(end) - int(start) + 1 if '-content-encoding' in self.info and 'content-range' in self.info: # httplib2 rewrites content-length in the case of a compressed # transfer; we can't trust the content-length header in that # case, but we *can* trust content-range, if it's present. return ProcessContentRange(self.info['content-range']) elif 'content-length' in self.info: return int(self.info.get('content-length')) elif 'content-range' in self.info: return ProcessContentRange(self.info['content-range']) return len(self.content) @property def status_code(self): return int(self.info['status']) @property def retry_after(self): if 'retry-after' in self.info: return int(self.info['retry-after']) @property def is_redirect(self): return (self.status_code in _REDIRECT_STATUS_CODES and 'location' in self.info) def CheckResponse(response): if response is None: # Caller shouldn't call us if the response is None, but handle anyway. raise exceptions.RequestError( 'Request to url %s did not return a response.' % response.request_url) elif (response.status_code >= 500 or response.status_code == TOO_MANY_REQUESTS): raise exceptions.BadStatusCodeError.FromResponse(response) elif response.retry_after: raise exceptions.RetryAfterError.FromResponse(response) def RebuildHttpConnections(http): """Rebuilds all http connections in the httplib2.Http instance. httplib2 overloads the map in http.connections to contain two different types of values: { scheme string: connection class } and { scheme + authority string : actual http connection } Here we remove all of the entries for actual connections so that on the next request httplib2 will rebuild them from the connection types. Args: http: An httplib2.Http instance. """ if getattr(http, 'connections', None): for conn_key in list(http.connections.keys()): if ':' in conn_key: del http.connections[conn_key] def RethrowExceptionHandler(*unused_args): # pylint: disable=misplaced-bare-raise raise def HandleExceptionsAndRebuildHttpConnections(retry_args): """Exception handler for http failures. This catches known failures and rebuilds the underlying HTTP connections. Args: retry_args: An ExceptionRetryArgs tuple. """ # If the server indicates how long to wait, use that value. Otherwise, # calculate the wait time on our own. retry_after = None # Transport failures if isinstance(retry_args.exc, (http_client.BadStatusLine, http_client.IncompleteRead, http_client.ResponseNotReady)): logging.debug('Caught HTTP error %s, retrying: %s', type(retry_args.exc).__name__, retry_args.exc) elif isinstance(retry_args.exc, socket.error): logging.debug('Caught socket error, retrying: %s', retry_args.exc) elif isinstance(retry_args.exc, socket.gaierror): logging.debug( 'Caught socket address error, retrying: %s', retry_args.exc) elif isinstance(retry_args.exc, socket.timeout): logging.debug( 'Caught socket timeout error, retrying: %s', retry_args.exc) elif isinstance(retry_args.exc, httplib2.ServerNotFoundError): logging.debug( 'Caught server not found error, retrying: %s', retry_args.exc) elif isinstance(retry_args.exc, ValueError): # oauth2client tries to JSON-decode the response, which can result # in a ValueError if the response was invalid. Until that is fixed in # oauth2client, need to handle it here. logging.debug('Response content was invalid (%s), retrying', retry_args.exc) elif (isinstance(retry_args.exc, TokenRefreshError) and hasattr(retry_args.exc, 'status') and (retry_args.exc.status == TOO_MANY_REQUESTS or retry_args.exc.status >= 500)): logging.debug( 'Caught transient credential refresh error (%s), retrying', retry_args.exc) elif isinstance(retry_args.exc, exceptions.RequestError): logging.debug('Request returned no response, retrying') # API-level failures elif isinstance(retry_args.exc, exceptions.BadStatusCodeError): logging.debug('Response returned status %s, retrying', retry_args.exc.status_code) elif isinstance(retry_args.exc, exceptions.RetryAfterError): logging.debug('Response returned a retry-after header, retrying') retry_after = retry_args.exc.retry_after else: raise retry_args.exc RebuildHttpConnections(retry_args.http) logging.debug('Retrying request to url %s after exception %s', retry_args.http_request.url, retry_args.exc) time.sleep( retry_after or util.CalculateWaitForRetry( retry_args.num_retries, max_wait=retry_args.max_retry_wait)) def MakeRequest(http, http_request, retries=7, max_retry_wait=60, redirections=5, retry_func=HandleExceptionsAndRebuildHttpConnections, check_response_func=CheckResponse): """Send http_request via the given http, performing error/retry handling. Args: http: An httplib2.Http instance, or a http multiplexer that delegates to an underlying http, for example, HTTPMultiplexer. http_request: A Request to send. retries: (int, default 7) Number of retries to attempt on retryable replies (such as 429 or 5XX). max_retry_wait: (int, default 60) Maximum number of seconds to wait when retrying. redirections: (int, default 5) Number of redirects to follow. retry_func: Function to handle retries on exceptions. Argument is an ExceptionRetryArgs tuple. check_response_func: Function to validate the HTTP response. Arguments are (Response, response content, url). Raises: InvalidDataFromServerError: if there is no response after retries. Returns: A Response object. """ retry = 0 first_req_time = time.time() # Provide compatibility for breaking change in httplib2 0.16.0+: # https://github.com/googleapis/google-api-python-client/issues/803 if hasattr(http, 'redirect_codes'): http.redirect_codes = set(http.redirect_codes) - {308} while True: try: return _MakeRequestNoRetry( http, http_request, redirections=redirections, check_response_func=check_response_func) # retry_func will consume the exception types it handles and raise. # pylint: disable=broad-except except Exception as e: retry += 1 if retry >= retries: raise else: total_wait_sec = time.time() - first_req_time retry_func(ExceptionRetryArgs(http, http_request, e, retry, max_retry_wait, total_wait_sec)) def _MakeRequestNoRetry(http, http_request, redirections=5, check_response_func=CheckResponse): """Send http_request via the given http. This wrapper exists to handle translation between the plain httplib2 request/response types and the Request and Response types above. Args: http: An httplib2.Http instance, or a http multiplexer that delegates to an underlying http, for example, HTTPMultiplexer. http_request: A Request to send. redirections: (int, default 5) Number of redirects to follow. check_response_func: Function to validate the HTTP response. Arguments are (Response, response content, url). Returns: A Response object. Raises: RequestError if no response could be parsed. """ connection_type = None # Handle overrides for connection types. This is used if the caller # wants control over the underlying connection for managing callbacks # or hash digestion. if getattr(http, 'connections', None): url_scheme = parse.urlsplit(http_request.url).scheme if url_scheme and url_scheme in http.connections: connection_type = http.connections[url_scheme] # Custom printing only at debuglevel 4 new_debuglevel = 4 if httplib2.debuglevel == 4 else 0 with _Httplib2Debuglevel(http_request, new_debuglevel, http=http): info, content = http.request( str(http_request.url), method=str(http_request.http_method), body=http_request.body, headers=http_request.headers, redirections=redirections, connection_type=connection_type) if info is None: raise exceptions.RequestError() response = Response(info, content, http_request.url) check_response_func(response) return response _HTTP_FACTORIES = [] def _RegisterHttpFactory(factory): _HTTP_FACTORIES.append(factory) def GetHttp(**kwds): for factory in _HTTP_FACTORIES: http = factory(**kwds) if http is not None: return http return httplib2.Http(**kwds) py/encoding_test.py 0000644 00000077737 15025317163 0010423 0 ustar 00 # -*- coding: utf-8 -*- # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import base64 import datetime import json import sys import unittest from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import util from apitools.base.py import encoding from apitools.base.py import exceptions from apitools.base.py import extra_types class SimpleMessage(messages.Message): field = messages.StringField(1) repfield = messages.StringField(2, repeated=True) class BytesMessage(messages.Message): field = messages.BytesField(1) repfield = messages.BytesField(2, repeated=True) class TimeMessage(messages.Message): timefield = message_types.DateTimeField(3) @encoding.MapUnrecognizedFields('additionalProperties') class AdditionalPropertiesMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.StringField(2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class AdditionalIntPropertiesMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.IntegerField(2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class UnrecognizedEnumMessage(messages.Message): class ThisEnum(messages.Enum): VALUE_ONE = 1 VALUE_TWO = 2 class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.EnumField('UnrecognizedEnumMessage.ThisEnum', 2) additionalProperties = messages.MessageField( AdditionalProperty, 1, repeated=True) class CompoundPropertyType(messages.Message): index = messages.IntegerField(1) name = messages.StringField(2) class MessageWithEnum(messages.Message): class ThisEnum(messages.Enum): VALUE_ONE = 1 VALUE_TWO = 2 field_one = messages.EnumField(ThisEnum, 1) field_two = messages.EnumField(ThisEnum, 2, default=ThisEnum.VALUE_TWO) field_three = messages.EnumField(ThisEnum, 3, repeated=True) ignored_field = messages.EnumField(ThisEnum, 4) @encoding.MapUnrecognizedFields('additionalProperties') class AdditionalMessagePropertiesMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.MessageField(CompoundPropertyType, 2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class MapToMessageWithEnum(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.MessageField(MessageWithEnum, 2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class NestedAdditionalPropertiesWithEnumMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.MessageField( MapToMessageWithEnum, 2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class AdditionalPropertiesWithEnumMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.MessageField(MessageWithEnum, 2) additionalProperties = messages.MessageField( 'AdditionalProperty', 1, repeated=True) class NestedMapMessage(messages.Message): msg_field = messages.MessageField(AdditionalPropertiesWithEnumMessage, 1) class RepeatedNestedMapMessage(messages.Message): map_field = messages.MessageField(NestedMapMessage, 1, repeated=True) class NestedWithEnumMessage(messages.Message): class ThisEnum(messages.Enum): VALUE_ONE = 1 VALUE_TWO = 2 msg_field = messages.MessageField(MessageWithEnum, 1) enum_field = messages.EnumField(ThisEnum, 2) class RepeatedNestedMessage(messages.Message): msg_field = messages.MessageField(SimpleMessage, 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class MapToBytesValue(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.BytesField(2) additionalProperties = messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class MapToDateTimeValue(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = message_types.DateTimeField(2) additionalProperties = messages.MessageField('AdditionalProperty', 1, repeated=True) class HasNestedMessage(messages.Message): nested = messages.MessageField(AdditionalPropertiesMessage, 1) nested_list = messages.StringField(2, repeated=True) class ExtraNestedMessage(messages.Message): nested = messages.MessageField(HasNestedMessage, 1) class MessageWithRemappings(messages.Message): class SomeEnum(messages.Enum): enum_value = 1 second_value = 2 enum_field = messages.EnumField(SomeEnum, 1) double_encoding = messages.EnumField(SomeEnum, 2) another_field = messages.StringField(3) repeated_enum = messages.EnumField(SomeEnum, 4, repeated=True) repeated_field = messages.StringField(5, repeated=True) class MessageWithPackageAndRemappings(messages.Message): class SomeEnum(messages.Enum): enum_value = 1 second_value = 2 enum_field = messages.EnumField(SomeEnum, 1) another_field = messages.StringField(2) @encoding.MapUnrecognizedFields('additionalProperties') class RepeatedJsonValueMessage(messages.Message): class AdditionalProperty(messages.Message): key = messages.StringField(1) value = messages.MessageField(extra_types.JsonValue, 2, repeated=True) additionalProperties = messages.MessageField('AdditionalProperty', 1, repeated=True) encoding.AddCustomJsonEnumMapping(MessageWithRemappings.SomeEnum, 'enum_value', 'wire_name') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'double_encoding', 'doubleEncoding') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'another_field', 'anotherField') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'repeated_field', 'repeatedField') class EncodingTest(unittest.TestCase): def testCopyProtoMessage(self): msg = SimpleMessage(field='abc') new_msg = encoding.CopyProtoMessage(msg) self.assertEqual(msg.field, new_msg.field) msg.field = 'def' self.assertNotEqual(msg.field, new_msg.field) def testCopyProtoMessageInvalidEnum(self): json_msg = '{"field_one": "BAD_VALUE"}' orig_msg = encoding.JsonToMessage(MessageWithEnum, json_msg) new_msg = encoding.CopyProtoMessage(orig_msg) for msg in (orig_msg, new_msg): self.assertEqual(msg.all_unrecognized_fields(), ['field_one']) self.assertEqual( msg.get_unrecognized_field_info('field_one', value_default=None), ('BAD_VALUE', messages.Variant.ENUM)) def testCopyProtoMessageInvalidRepeatedEnum(self): json_msg = '{"field_three": ["VALUE_ONE", "BAD_VALUE"]}' orig_msg = encoding.JsonToMessage(MessageWithEnum, json_msg) new_msg = encoding.CopyProtoMessage(orig_msg) for msg in (orig_msg, new_msg): self.assertEqual(msg.all_unrecognized_fields(), ['field_three']) self.assertEqual( msg.get_unrecognized_field_info('field_three', value_default=None), (['VALUE_ONE', 'BAD_VALUE'], messages.Variant.ENUM)) def testCopyProtoMessageAdditionalProperties(self): msg = AdditionalPropertiesMessage(additionalProperties=[ AdditionalPropertiesMessage.AdditionalProperty( key='key', value='value')]) new_msg = encoding.CopyProtoMessage(msg) self.assertEqual(len(new_msg.additionalProperties), 1) self.assertEqual(new_msg.additionalProperties[0].key, 'key') self.assertEqual(new_msg.additionalProperties[0].value, 'value') def testCopyProtoMessageMappingInvalidEnum(self): json_msg = '{"key_one": {"field_one": "BAD_VALUE"}}' orig_msg = encoding.JsonToMessage(MapToMessageWithEnum, json_msg) new_msg = encoding.CopyProtoMessage(orig_msg) for msg in (orig_msg, new_msg): self.assertEqual( msg.additionalProperties[0].value.all_unrecognized_fields(), ['field_one']) self.assertEqual( msg.additionalProperties[0].value.get_unrecognized_field_info( 'field_one', value_default=None), ('BAD_VALUE', messages.Variant.ENUM)) def testCopyProtoMessageMappingInvalidRepeatedEnum(self): json_msg = '{"key_one": {"field_three": ["VALUE_ONE", "BAD_VALUE"]}}' orig_msg = encoding.JsonToMessage(MapToMessageWithEnum, json_msg) new_msg = encoding.CopyProtoMessage(orig_msg) for msg in (orig_msg, new_msg): self.assertEqual( msg.additionalProperties[0].value.all_unrecognized_fields(), ['field_three']) self.assertEqual( msg.additionalProperties[0].value.get_unrecognized_field_info( 'field_three', value_default=None), (['VALUE_ONE', 'BAD_VALUE'], messages.Variant.ENUM)) def testBytesEncoding(self): b64_str = 'AAc+' b64_msg = '{"field": "%s"}' % b64_str urlsafe_b64_str = 'AAc-' urlsafe_b64_msg = '{"field": "%s"}' % urlsafe_b64_str data = base64.b64decode(b64_str) msg = BytesMessage(field=data) self.assertEqual( msg, encoding.JsonToMessage(BytesMessage, urlsafe_b64_msg)) self.assertEqual(msg, encoding.JsonToMessage(BytesMessage, b64_msg)) self.assertEqual(urlsafe_b64_msg, encoding.MessageToJson(msg)) enc_rep_msg = '{"repfield": ["%(b)s", "%(b)s"]}' % { 'b': urlsafe_b64_str} rep_msg = BytesMessage(repfield=[data, data]) self.assertEqual( rep_msg, encoding.JsonToMessage(BytesMessage, enc_rep_msg)) self.assertEqual(enc_rep_msg, encoding.MessageToJson(rep_msg)) def testBase64RoundtripForMapFields(self): raw_data = b'\xFF\x0F\x80' encoded_data = '/w+A' # Has url-unsafe base64 characters safe_encoded_data = base64.urlsafe_b64encode(raw_data).decode("utf-8") self.assertEqual(raw_data, base64.b64decode(encoded_data)) # Use unsafe encoding, make sure we can load it. json_data = '{"1st": "%s"}' % encoded_data msg = encoding.JsonToMessage(MapToBytesValue, json_data) self.assertEqual(raw_data, msg.additionalProperties[0].value) # Now back to json and again to message from_msg_json_data = encoding.MessageToJson(msg) # Make sure now it is safe url encoded self.assertEqual(safe_encoded_data, json.loads(from_msg_json_data)['1st']) # Make sure we can also load url safe encoded bytes. redone_msg = encoding.JsonToMessage(MapToBytesValue, from_msg_json_data) # Still matches self.assertEqual(raw_data, redone_msg.additionalProperties[0].value) def testBytesEncodingInAMap(self): # Leading bit is 1 should not be interpreted as unicode. data1 = b'\xF0\x11\x0F' data2 = b'\xFF\xFF\xFF' msg = MapToBytesValue( additionalProperties=[ MapToBytesValue.AdditionalProperty(key='1st', value=data1), MapToBytesValue.AdditionalProperty(key='2nd', value=data2) ]) self.assertEqual( '{"1st": "%s", "2nd": "%s"}' % ( base64.b64encode(data1, b'-_').decode("utf-8"), base64.b64encode(data2, b'-_').decode("utf-8")), encoding.MessageToJson(msg)) def testDateTimeEncodingInAMap(self): msg = MapToDateTimeValue( additionalProperties=[ MapToDateTimeValue.AdditionalProperty( key='1st', value=datetime.datetime( 2014, 7, 2, 23, 33, 25, 541000, tzinfo=util.TimeZoneOffset(datetime.timedelta(0)))), MapToDateTimeValue.AdditionalProperty( key='2nd', value=datetime.datetime( 2015, 7, 2, 23, 33, 25, 541000, tzinfo=util.TimeZoneOffset(datetime.timedelta(0)))) ]) self.assertEqual( '{"1st": "2014-07-02T23:33:25.541000+00:00",' ' "2nd": "2015-07-02T23:33:25.541000+00:00"}', encoding.MessageToJson(msg)) def testInvalidEnumEncodingInAMap(self): json_msg = '{"key_one": {"field_one": "BAD_VALUE"}}' msg = encoding.JsonToMessage(MapToMessageWithEnum, json_msg) new_msg = encoding.MessageToJson(msg) self.assertEqual('{"key_one": {"field_one": "BAD_VALUE"}}', new_msg) def testInvalidRepeatedEnumEncodingInAMap(self): json_msg = '{"key_one": {"field_three": ["VALUE_ONE", "BAD_VALUE"]}}' msg = encoding.JsonToMessage(MapToMessageWithEnum, json_msg) new_msg = encoding.MessageToJson(msg) self.assertEqual( '{"key_one": {"field_three": ["VALUE_ONE", "BAD_VALUE"]}}', new_msg) def testIncludeFields(self): msg = SimpleMessage() self.assertEqual('{}', encoding.MessageToJson(msg)) self.assertEqual( '{"field": null}', encoding.MessageToJson(msg, include_fields=['field'])) self.assertEqual( '{"repfield": []}', encoding.MessageToJson(msg, include_fields=['repfield'])) def testNestedIncludeFields(self): msg = HasNestedMessage( nested=AdditionalPropertiesMessage( additionalProperties=[])) self.assertEqual( '{"nested": null}', encoding.MessageToJson(msg, include_fields=['nested'])) self.assertEqual( '{"nested": {"additionalProperties": []}}', encoding.MessageToJson( msg, include_fields=['nested.additionalProperties'])) msg = ExtraNestedMessage(nested=msg) self.assertEqual( '{"nested": {"nested": null}}', encoding.MessageToJson(msg, include_fields=['nested.nested'])) # When clearing 'nested.nested_list', its sibling ('nested.nested') # should remain unaffected. self.assertIn( encoding.MessageToJson(msg, include_fields=['nested.nested_list']), ['{"nested": {"nested": {}, "nested_list": []}}', '{"nested": {"nested_list": [], "nested": {}}}']) self.assertEqual( '{"nested": {"nested": {"additionalProperties": []}}}', encoding.MessageToJson( msg, include_fields=['nested.nested.additionalProperties'])) def testAdditionalPropertyMapping(self): msg = AdditionalPropertiesMessage() msg.additionalProperties = [ AdditionalPropertiesMessage.AdditionalProperty( key='key_one', value='value_one'), AdditionalPropertiesMessage.AdditionalProperty( key=u'key_twð', value='value_two'), ] encoded_msg = encoding.MessageToJson(msg) self.assertEqual( {'key_one': 'value_one', u'key_twð': 'value_two'}, json.loads(encoded_msg)) new_msg = encoding.JsonToMessage(type(msg), encoded_msg) self.assertEqual( set(('key_one', u'key_twð')), set([x.key for x in new_msg.additionalProperties])) self.assertIsNot(msg, new_msg) new_msg.additionalProperties.pop() self.assertEqual(1, len(new_msg.additionalProperties)) self.assertEqual(2, len(msg.additionalProperties)) def testNumericPropertyName(self): json_msg = '{"nested": {"123": "def"}}' msg = encoding.JsonToMessage(HasNestedMessage, json_msg) self.assertEqual(1, len(msg.nested.additionalProperties)) def testNumericPropertyValue(self): json_msg = '{"key_one": "123"}' msg = encoding.JsonToMessage(AdditionalIntPropertiesMessage, json_msg) self.assertEqual( AdditionalIntPropertiesMessage( additionalProperties=[ AdditionalIntPropertiesMessage.AdditionalProperty( key='key_one', value=123)]), msg) def testAdditionalMessageProperties(self): json_msg = '{"input": {"index": 0, "name": "output"}}' result = encoding.JsonToMessage( AdditionalMessagePropertiesMessage, json_msg) self.assertEqual(1, len(result.additionalProperties)) self.assertEqual(0, result.additionalProperties[0].value.index) def testUnrecognizedEnum(self): json_msg = '{"input": "VALUE_ONE"}' result = encoding.JsonToMessage( UnrecognizedEnumMessage, json_msg) self.assertEqual(1, len(result.additionalProperties)) self.assertEqual(UnrecognizedEnumMessage.ThisEnum.VALUE_ONE, result.additionalProperties[0].value) def testNestedFieldMapping(self): nested_msg = AdditionalPropertiesMessage() nested_msg.additionalProperties = [ AdditionalPropertiesMessage.AdditionalProperty( key='key_one', value='value_one'), AdditionalPropertiesMessage.AdditionalProperty( key='key_two', value='value_two'), ] msg = HasNestedMessage(nested=nested_msg) encoded_msg = encoding.MessageToJson(msg) self.assertEqual( {'nested': {'key_one': 'value_one', 'key_two': 'value_two'}}, json.loads(encoded_msg)) new_msg = encoding.JsonToMessage(type(msg), encoded_msg) self.assertEqual( set(('key_one', 'key_two')), set([x.key for x in new_msg.nested.additionalProperties])) new_msg.nested.additionalProperties.pop() self.assertEqual(1, len(new_msg.nested.additionalProperties)) self.assertEqual(2, len(msg.nested.additionalProperties)) def testValidEnums(self): message_json = '{"field_one": "VALUE_ONE"}' message = encoding.JsonToMessage(MessageWithEnum, message_json) self.assertEqual(MessageWithEnum.ThisEnum.VALUE_ONE, message.field_one) self.assertEqual(MessageWithEnum.ThisEnum.VALUE_TWO, message.field_two) self.assertEqual(json.loads(message_json), json.loads(encoding.MessageToJson(message))) def testIgnoredEnums(self): json_with_typo = '{"field_one": "VALUE_OEN"}' message = encoding.JsonToMessage(MessageWithEnum, json_with_typo) self.assertEqual(None, message.field_one) self.assertEqual(('VALUE_OEN', messages.Variant.ENUM), message.get_unrecognized_field_info('field_one')) self.assertEqual(json.loads(json_with_typo), json.loads(encoding.MessageToJson(message))) empty_json = '' message = encoding.JsonToMessage(MessageWithEnum, empty_json) self.assertEqual(None, message.field_one) def testIgnoredEnumsWithDefaults(self): json_with_typo = '{"field_two": "VALUE_OEN"}' message = encoding.JsonToMessage(MessageWithEnum, json_with_typo) self.assertEqual(MessageWithEnum.ThisEnum.VALUE_TWO, message.field_two) self.assertEqual(json.loads(json_with_typo), json.loads(encoding.MessageToJson(message))) def testUnknownNestedRoundtrip(self): json_message = '{"field": "abc", "submessage": {"a": 1, "b": "foo"}}' message = encoding.JsonToMessage(SimpleMessage, json_message) self.assertEqual(json.loads(json_message), json.loads(encoding.MessageToJson(message))) def testUnknownEnumNestedRoundtrip(self): json_with_typo = ('{"outer_key": {"key_one": {"field_one": ' '"VALUE_OEN", "field_two": "VALUE_OEN", ' '"field_three": ["VALUE_ONE", "BAD_VALUE"]}}}') msg = encoding.JsonToMessage(NestedAdditionalPropertiesWithEnumMessage, json_with_typo) self.assertEqual(json.loads(json_with_typo), json.loads(encoding.MessageToJson(msg))) def testJsonDatetime(self): msg = TimeMessage(timefield=datetime.datetime( 2014, 7, 2, 23, 33, 25, 541000, tzinfo=util.TimeZoneOffset(datetime.timedelta(0)))) self.assertEqual( '{"timefield": "2014-07-02T23:33:25.541000+00:00"}', encoding.MessageToJson(msg)) def testEnumRemapping(self): msg = MessageWithRemappings( enum_field=MessageWithRemappings.SomeEnum.enum_value) json_message = encoding.MessageToJson(msg) self.assertEqual('{"enum_field": "wire_name"}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithRemappings, json_message)) def testRepeatedEnumRemapping(self): msg = MessageWithRemappings( repeated_enum=[ MessageWithRemappings.SomeEnum.enum_value, MessageWithRemappings.SomeEnum.second_value, ]) json_message = encoding.MessageToJson(msg) self.assertEqual('{"repeated_enum": ["wire_name", "second_value"]}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithRemappings, json_message)) def testFieldRemapping(self): msg = MessageWithRemappings(another_field='abc') json_message = encoding.MessageToJson(msg) self.assertEqual('{"anotherField": "abc"}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithRemappings, json_message)) def testFieldRemappingWithPackage(self): this_module = sys.modules[__name__] package_name = 'my_package' try: setattr(this_module, 'package', package_name) encoding.AddCustomJsonFieldMapping( MessageWithPackageAndRemappings, 'another_field', 'wire_field_name', package=package_name) msg = MessageWithPackageAndRemappings(another_field='my value') json_message = encoding.MessageToJson(msg) self.assertEqual('{"wire_field_name": "my value"}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithPackageAndRemappings, json_message)) finally: delattr(this_module, 'package') def testEnumRemappingWithPackage(self): this_module = sys.modules[__name__] package_name = 'my_package' try: setattr(this_module, 'package', package_name) encoding.AddCustomJsonEnumMapping( MessageWithPackageAndRemappings.SomeEnum, 'enum_value', 'other_wire_name', package=package_name) msg = MessageWithPackageAndRemappings( enum_field=MessageWithPackageAndRemappings.SomeEnum.enum_value) json_message = encoding.MessageToJson(msg) self.assertEqual('{"enum_field": "other_wire_name"}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithPackageAndRemappings, json_message)) finally: delattr(this_module, 'package') def testRepeatedFieldRemapping(self): msg = MessageWithRemappings(repeated_field=['abc', 'def']) json_message = encoding.MessageToJson(msg) self.assertEqual('{"repeatedField": ["abc", "def"]}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithRemappings, json_message)) def testMultipleRemapping(self): msg = MessageWithRemappings( double_encoding=MessageWithRemappings.SomeEnum.enum_value) json_message = encoding.MessageToJson(msg) self.assertEqual('{"doubleEncoding": "wire_name"}', json_message) self.assertEqual( msg, encoding.JsonToMessage(MessageWithRemappings, json_message)) def testRepeatedRemapping(self): # Should allow remapping if the mapping remains the same. encoding.AddCustomJsonEnumMapping(MessageWithRemappings.SomeEnum, 'enum_value', 'wire_name') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'double_encoding', 'doubleEncoding') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'another_field', 'anotherField') encoding.AddCustomJsonFieldMapping(MessageWithRemappings, 'repeated_field', 'repeatedField') # Should raise errors if the remapping changes the mapping. self.assertRaises( exceptions.InvalidDataError, encoding.AddCustomJsonFieldMapping, MessageWithRemappings, 'double_encoding', 'something_else') self.assertRaises( exceptions.InvalidDataError, encoding.AddCustomJsonFieldMapping, MessageWithRemappings, 'enum_field', 'anotherField') self.assertRaises( exceptions.InvalidDataError, encoding.AddCustomJsonEnumMapping, MessageWithRemappings.SomeEnum, 'enum_value', 'another_name') self.assertRaises( exceptions.InvalidDataError, encoding.AddCustomJsonEnumMapping, MessageWithRemappings.SomeEnum, 'second_value', 'wire_name') def testMessageToRepr(self): # Using the same string returned by MessageToRepr, with the # module names fixed. # pylint: disable=bad-whitespace msg = SimpleMessage(field='field', repfield=['field', 'field', ],) # pylint: enable=bad-whitespace self.assertEqual( encoding.MessageToRepr(msg), r"%s.SimpleMessage(field='field',repfield=['field','field',],)" % ( __name__,)) self.assertEqual( encoding.MessageToRepr(msg, no_modules=True), r"SimpleMessage(field='field',repfield=['field','field',],)") def testMessageToReprWithTime(self): msg = TimeMessage(timefield=datetime.datetime( 2014, 7, 2, 23, 33, 25, 541000, tzinfo=util.TimeZoneOffset(datetime.timedelta(0)))) self.assertEqual( encoding.MessageToRepr(msg, multiline=True), ('%s.TimeMessage(\n ' 'timefield=datetime.datetime(2014, 7, 2, 23, 33, 25, 541000, ' 'tzinfo=apitools.base.protorpclite.util.TimeZoneOffset(' 'datetime.timedelta(0))),\n)') % __name__) self.assertEqual( encoding.MessageToRepr(msg, multiline=True, no_modules=True), 'TimeMessage(\n ' 'timefield=datetime.datetime(2014, 7, 2, 23, 33, 25, 541000, ' 'tzinfo=TimeZoneOffset(datetime.timedelta(0))),\n)') def testRepeatedJsonValuesAsRepeatedProperty(self): encoded_msg = '{"a": [{"one": 1}]}' msg = encoding.JsonToMessage(RepeatedJsonValueMessage, encoded_msg) self.assertEqual(encoded_msg, encoding.MessageToJson(msg)) def testDictToAdditionalPropertyMessage(self): dict_ = {'key': 'value'} encoded_msg = encoding.DictToAdditionalPropertyMessage( dict_, AdditionalPropertiesMessage) expected_msg = AdditionalPropertiesMessage() expected_msg.additionalProperties = [ AdditionalPropertiesMessage.AdditionalProperty( key='key', value='value') ] self.assertEqual(encoded_msg, expected_msg) def testDictToAdditionalPropertyMessageSorted(self): tuples = [('key{0:02}'.format(i), 'value') for i in range(100)] dict_ = dict(tuples) encoded_msg = encoding.DictToAdditionalPropertyMessage( dict_, AdditionalPropertiesMessage, sort_items=True) expected_msg = AdditionalPropertiesMessage() expected_msg.additionalProperties = [ AdditionalPropertiesMessage.AdditionalProperty( key=key, value=value) for key, value in tuples ] self.assertEqual(encoded_msg, expected_msg) def testDictToAdditionalPropertyMessageNumeric(self): dict_ = {'key': 1} encoded_msg = encoding.DictToAdditionalPropertyMessage( dict_, AdditionalIntPropertiesMessage) expected_msg = AdditionalIntPropertiesMessage() expected_msg.additionalProperties = [ AdditionalIntPropertiesMessage.AdditionalProperty( key='key', value=1) ] self.assertEqual(encoded_msg, expected_msg) def testUnrecognizedFieldIter(self): m = encoding.DictToMessage({ 'nested': { 'nested': {'a': 'b'}, 'nested_list': ['foo'], 'extra_field': 'foo', } }, ExtraNestedMessage) results = list(encoding.UnrecognizedFieldIter(m)) self.assertEqual(1, len(results)) edges, fields = results[0] expected_edge = encoding.ProtoEdge( encoding.EdgeType.SCALAR, 'nested', None) self.assertEqual((expected_edge,), edges) self.assertEqual(['extra_field'], fields) def testUnrecognizedFieldIterRepeated(self): m = encoding.DictToMessage({ 'msg_field': [ {'field': 'foo'}, {'not_a_field': 'bar'} ] }, RepeatedNestedMessage) results = list(encoding.UnrecognizedFieldIter(m)) self.assertEqual(1, len(results)) edges, fields = results[0] expected_edge = encoding.ProtoEdge( encoding.EdgeType.REPEATED, 'msg_field', 1) self.assertEqual((expected_edge,), edges) self.assertEqual(['not_a_field'], fields) def testUnrecognizedFieldIterNestedMap(self): m = encoding.DictToMessage({ 'map_field': [{ 'msg_field': { 'foo': {'field_one': 1}, 'bar': {'not_a_field': 1}, } }] }, RepeatedNestedMapMessage) results = list(encoding.UnrecognizedFieldIter(m)) self.assertEqual(1, len(results)) edges, fields = results[0] expected_edges = ( encoding.ProtoEdge(encoding.EdgeType.REPEATED, 'map_field', 0), encoding.ProtoEdge(encoding.EdgeType.MAP, 'msg_field', 'bar'), ) self.assertEqual(expected_edges, edges) self.assertEqual(['not_a_field'], fields) def testUnrecognizedFieldIterAbortAfterFirstError(self): m = encoding.DictToMessage({ 'msg_field': {'field_one': 3}, 'enum_field': 3, }, NestedWithEnumMessage) self.assertEqual(1, len(list(encoding.UnrecognizedFieldIter(m)))) py/http_wrapper_test.py 0000644 00000012137 15025317163 0011333 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for http_wrapper.""" import socket import unittest import httplib2 from six.moves import http_client from mock import patch from apitools.base.py import exceptions from apitools.base.py import http_wrapper # pylint: disable=ungrouped-imports try: from oauth2client.client import HttpAccessTokenRefreshError from oauth2client.client import AccessTokenRefreshError _TOKEN_REFRESH_STATUS_AVAILABLE = True except ImportError: from oauth2client.client import AccessTokenRefreshError _TOKEN_REFRESH_STATUS_AVAILABLE = False class _MockHttpRequest(object): url = None class _MockHttpResponse(object): def __init__(self, status_code): self.response = {'status': status_code} class RaisesExceptionOnLen(object): """Supports length property but raises if __len__ is used.""" def __len__(self): raise Exception('len() called unnecessarily') def length(self): return 1 class HttpWrapperTest(unittest.TestCase): def testRequestBodyUsesLengthProperty(self): http_wrapper.Request(body=RaisesExceptionOnLen()) def testRequestBodyWithLen(self): http_wrapper.Request(body='burrito') @unittest.skipIf(not _TOKEN_REFRESH_STATUS_AVAILABLE, 'oauth2client<1.5 lacks HttpAccessTokenRefreshError.') def testExceptionHandlerHttpAccessTokenError(self): exception_arg = HttpAccessTokenRefreshError(status=503) retry_args = http_wrapper.ExceptionRetryArgs( http={'connections': {}}, http_request=_MockHttpRequest(), exc=exception_arg, num_retries=0, max_retry_wait=0, total_wait_sec=0) # Disable time.sleep for this handler as it is called with # a minimum value of 1 second. with patch('time.sleep', return_value=None): http_wrapper.HandleExceptionsAndRebuildHttpConnections( retry_args) @unittest.skipIf(not _TOKEN_REFRESH_STATUS_AVAILABLE, 'oauth2client<1.5 lacks HttpAccessTokenRefreshError.') def testExceptionHandlerHttpAccessTokenErrorRaises(self): exception_arg = HttpAccessTokenRefreshError(status=200) retry_args = http_wrapper.ExceptionRetryArgs( http={'connections': {}}, http_request=_MockHttpRequest(), exc=exception_arg, num_retries=0, max_retry_wait=0, total_wait_sec=0) # Disable time.sleep for this handler as it is called with # a minimum value of 1 second. with self.assertRaises(HttpAccessTokenRefreshError): with patch('time.sleep', return_value=None): http_wrapper.HandleExceptionsAndRebuildHttpConnections( retry_args) def testExceptionHandlerAccessTokenErrorRaises(self): exception_arg = AccessTokenRefreshError() retry_args = http_wrapper.ExceptionRetryArgs( http={'connections': {}}, http_request=_MockHttpRequest(), exc=exception_arg, num_retries=0, max_retry_wait=0, total_wait_sec=0) # Disable time.sleep for this handler as it is called with # a minimum value of 1 second. with self.assertRaises(AccessTokenRefreshError): with patch('time.sleep', return_value=None): http_wrapper.HandleExceptionsAndRebuildHttpConnections( retry_args) def testDefaultExceptionHandler(self): """Ensures exception handles swallows (retries)""" mock_http_content = 'content'.encode('utf8') for exception_arg in ( http_client.BadStatusLine('line'), http_client.IncompleteRead('partial'), http_client.ResponseNotReady(), socket.error(), socket.gaierror(), httplib2.ServerNotFoundError(), ValueError(), exceptions.RequestError(), exceptions.BadStatusCodeError( {'status': 503}, mock_http_content, 'url'), exceptions.RetryAfterError( {'status': 429}, mock_http_content, 'url', 0)): retry_args = http_wrapper.ExceptionRetryArgs( http={'connections': {}}, http_request=_MockHttpRequest(), exc=exception_arg, num_retries=0, max_retry_wait=0, total_wait_sec=0) # Disable time.sleep for this handler as it is called with # a minimum value of 1 second. with patch('time.sleep', return_value=None): http_wrapper.HandleExceptionsAndRebuildHttpConnections( retry_args) py/stream_slice.py 0000644 00000005253 15025317163 0010230 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Small helper class to provide a small slice of a stream.""" from apitools.base.py import exceptions class StreamSlice(object): """Provides a slice-like object for streams.""" def __init__(self, stream, max_bytes): self.__stream = stream self.__remaining_bytes = max_bytes self.__max_bytes = max_bytes def __str__(self): return 'Slice of stream %s with %s/%s bytes not yet read' % ( self.__stream, self.__remaining_bytes, self.__max_bytes) def __len__(self): return self.__max_bytes def __nonzero__(self): # For 32-bit python2.x, len() cannot exceed a 32-bit number; avoid # accidental len() calls from httplib in the form of "if this_object:". return bool(self.__max_bytes) @property def length(self): # For 32-bit python2.x, len() cannot exceed a 32-bit number. return self.__max_bytes def read(self, size=None): # pylint: disable=missing-docstring """Read at most size bytes from this slice. Compared to other streams, there is one case where we may unexpectedly raise an exception on read: if the underlying stream is exhausted (i.e. returns no bytes on read), and the size of this slice indicates we should still be able to read more bytes, we raise exceptions.StreamExhausted. Args: size: If provided, read no more than size bytes from the stream. Returns: The bytes read from this slice. Raises: exceptions.StreamExhausted """ if size is not None: read_size = min(size, self.__remaining_bytes) else: read_size = self.__remaining_bytes data = self.__stream.read(read_size) if read_size > 0 and not data: raise exceptions.StreamExhausted( 'Not enough bytes in stream; expected %d, exhausted ' 'after %d' % ( self.__max_bytes, self.__max_bytes - self.__remaining_bytes)) self.__remaining_bytes -= len(data) return data py/transfer.py 0000644 00000132660 15025317163 0007405 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Upload and download support for apitools.""" from __future__ import print_function import email.generator as email_generator import email.mime.multipart as mime_multipart import email.mime.nonmultipart as mime_nonmultipart import io import json import mimetypes import os import threading import six from six.moves import http_client from apitools.base.py import buffered_stream from apitools.base.py import compression from apitools.base.py import exceptions from apitools.base.py import http_wrapper from apitools.base.py import stream_slice from apitools.base.py import util __all__ = [ 'Download', 'Upload', 'RESUMABLE_UPLOAD', 'SIMPLE_UPLOAD', 'DownloadProgressPrinter', 'DownloadCompletePrinter', 'UploadProgressPrinter', 'UploadCompletePrinter', ] _RESUMABLE_UPLOAD_THRESHOLD = 5 << 20 SIMPLE_UPLOAD = 'simple' RESUMABLE_UPLOAD = 'resumable' def DownloadProgressPrinter(response, unused_download): """Print download progress based on response.""" if 'content-range' in response.info: print('Received %s' % response.info['content-range']) else: print('Received %d bytes' % response.length) def DownloadCompletePrinter(unused_response, unused_download): """Print information about a completed download.""" print('Download complete') def UploadProgressPrinter(response, unused_upload): """Print upload progress based on response.""" print('Sent %s' % response.info['range']) def UploadCompletePrinter(unused_response, unused_upload): """Print information about a completed upload.""" print('Upload complete') class _Transfer(object): """Generic bits common to Uploads and Downloads.""" def __init__(self, stream, close_stream=False, chunksize=None, auto_transfer=True, http=None, num_retries=5): self.__bytes_http = None self.__close_stream = close_stream self.__http = http self.__stream = stream self.__url = None self.__num_retries = 5 # Let the @property do validation self.num_retries = num_retries self.retry_func = ( http_wrapper.HandleExceptionsAndRebuildHttpConnections) self.auto_transfer = auto_transfer self.chunksize = chunksize or 1048576 def __repr__(self): return str(self) @property def close_stream(self): return self.__close_stream @property def http(self): return self.__http @property def bytes_http(self): return self.__bytes_http or self.http @bytes_http.setter def bytes_http(self, value): self.__bytes_http = value @property def num_retries(self): return self.__num_retries @num_retries.setter def num_retries(self, value): util.Typecheck(value, six.integer_types) if value < 0: raise exceptions.InvalidDataError( 'Cannot have negative value for num_retries') self.__num_retries = value @property def stream(self): return self.__stream @property def url(self): return self.__url def _Initialize(self, http, url): """Initialize this download by setting self.http and self.url. We want the user to be able to override self.http by having set the value in the constructor; in that case, we ignore the provided http. Args: http: An httplib2.Http instance or None. url: The url for this transfer. Returns: None. Initializes self. """ self.EnsureUninitialized() if self.http is None: self.__http = http or http_wrapper.GetHttp() self.__url = url @property def initialized(self): return self.url is not None and self.http is not None @property def _type_name(self): return type(self).__name__ def EnsureInitialized(self): if not self.initialized: raise exceptions.TransferInvalidError( 'Cannot use uninitialized %s' % self._type_name) def EnsureUninitialized(self): if self.initialized: raise exceptions.TransferInvalidError( 'Cannot re-initialize %s' % self._type_name) def __del__(self): if self.__close_stream: self.__stream.close() def _ExecuteCallback(self, callback, response): # TODO(craigcitro): Push these into a queue. if callback is not None: threading.Thread(target=callback, args=(response, self)).start() class Download(_Transfer): """Data for a single download. Public attributes: chunksize: default chunksize to use for transfers. """ _ACCEPTABLE_STATUSES = set(( http_client.OK, http_client.NO_CONTENT, http_client.PARTIAL_CONTENT, http_client.REQUESTED_RANGE_NOT_SATISFIABLE, )) _REQUIRED_SERIALIZATION_KEYS = set(( 'auto_transfer', 'progress', 'total_size', 'url')) def __init__(self, stream, progress_callback=None, finish_callback=None, **kwds): total_size = kwds.pop('total_size', None) super(Download, self).__init__(stream, **kwds) self.__initial_response = None self.__progress = 0 self.__total_size = total_size self.__encoding = None self.progress_callback = progress_callback self.finish_callback = finish_callback @property def progress(self): return self.__progress @property def encoding(self): return self.__encoding @classmethod def FromFile(cls, filename, overwrite=False, auto_transfer=True, **kwds): """Create a new download object from a filename.""" path = os.path.expanduser(filename) if os.path.exists(path) and not overwrite: raise exceptions.InvalidUserInputError( 'File %s exists and overwrite not specified' % path) return cls(open(path, 'wb'), close_stream=True, auto_transfer=auto_transfer, **kwds) @classmethod def FromStream(cls, stream, auto_transfer=True, total_size=None, **kwds): """Create a new Download object from a stream.""" return cls(stream, auto_transfer=auto_transfer, total_size=total_size, **kwds) @classmethod def FromData(cls, stream, json_data, http=None, auto_transfer=None, client=None, **kwds): """Create a new Download object from a stream and serialized data.""" info = json.loads(json_data) missing_keys = cls._REQUIRED_SERIALIZATION_KEYS - set(info.keys()) if missing_keys: raise exceptions.InvalidDataError( 'Invalid serialization data, missing keys: %s' % ( ', '.join(missing_keys))) download = cls.FromStream(stream, **kwds) if auto_transfer is not None: download.auto_transfer = auto_transfer else: download.auto_transfer = info['auto_transfer'] if client is not None: url = client.FinalizeTransferUrl(info['url']) else: url = info['url'] setattr(download, '_Download__progress', info['progress']) setattr(download, '_Download__total_size', info['total_size']) download._Initialize( # pylint: disable=protected-access http, url) return download @property def serialization_data(self): self.EnsureInitialized() return { 'auto_transfer': self.auto_transfer, 'progress': self.progress, 'total_size': self.total_size, 'url': self.url, } @property def total_size(self): return self.__total_size def __str__(self): if not self.initialized: return 'Download (uninitialized)' return 'Download with %d/%s bytes transferred from url %s' % ( self.progress, self.total_size, self.url) def ConfigureRequest(self, http_request, url_builder): url_builder.query_params['alt'] = 'media' # TODO(craigcitro): We need to send range requests because by # default httplib2 stores entire reponses in memory. Override # httplib2's download method (as gsutil does) so that this is not # necessary. http_request.headers['Range'] = 'bytes=0-%d' % (self.chunksize - 1,) def __SetTotal(self, info): """Sets the total size based off info if possible otherwise 0.""" if 'content-range' in info: _, _, total = info['content-range'].rpartition('/') if total != '*': self.__total_size = int(total) # Note "total_size is None" means we don't know it; if no size # info was returned on our initial range request, that means we # have a 0-byte file. (That last statement has been verified # empirically, but is not clearly documented anywhere.) if self.total_size is None: self.__total_size = 0 def InitializeDownload(self, http_request, http=None, client=None): """Initialize this download by making a request. Args: http_request: The HttpRequest to use to initialize this download. http: The httplib2.Http instance for this request. client: If provided, let this client process the final URL before sending any additional requests. If client is provided and http is not, client.http will be used instead. """ self.EnsureUninitialized() if http is None and client is None: raise exceptions.UserError('Must provide client or http.') http = http or client.http if client is not None: http_request.url = client.FinalizeTransferUrl(http_request.url) url = http_request.url if self.auto_transfer: end_byte = self.__ComputeEndByte(0) self.__SetRangeHeader(http_request, 0, end_byte) response = http_wrapper.MakeRequest( self.bytes_http or http, http_request) if response.status_code not in self._ACCEPTABLE_STATUSES: raise exceptions.HttpError.FromResponse(response) self.__initial_response = response self.__SetTotal(response.info) url = response.info.get('content-location', response.request_url) if client is not None: url = client.FinalizeTransferUrl(url) self._Initialize(http, url) # Unless the user has requested otherwise, we want to just # go ahead and pump the bytes now. if self.auto_transfer: self.StreamInChunks() def __NormalizeStartEnd(self, start, end=None): """Normalizes start and end values based on total size.""" if end is not None: if start < 0: raise exceptions.TransferInvalidError( 'Cannot have end index with negative start index ' + '[start=%d, end=%d]' % (start, end)) elif start >= self.total_size: raise exceptions.TransferInvalidError( 'Cannot have start index greater than total size ' + '[start=%d, total_size=%d]' % (start, self.total_size)) end = min(end, self.total_size - 1) if end < start: raise exceptions.TransferInvalidError( 'Range requested with end[%s] < start[%s]' % (end, start)) return start, end else: if start < 0: start = max(0, start + self.total_size) return start, self.total_size - 1 def __SetRangeHeader(self, request, start, end=None): if start < 0: request.headers['range'] = 'bytes=%d' % start elif end is None or end < start: request.headers['range'] = 'bytes=%d-' % start else: request.headers['range'] = 'bytes=%d-%d' % (start, end) def __ComputeEndByte(self, start, end=None, use_chunks=True): """Compute the last byte to fetch for this request. This is all based on the HTTP spec for Range and Content-Range. Note that this is potentially confusing in several ways: * the value for the last byte is 0-based, eg "fetch 10 bytes from the beginning" would return 9 here. * if we have no information about size, and don't want to use the chunksize, we'll return None. See the tests for more examples. Args: start: byte to start at. end: (int or None, default: None) Suggested last byte. use_chunks: (bool, default: True) If False, ignore self.chunksize. Returns: Last byte to use in a Range header, or None. """ end_byte = end if start < 0 and not self.total_size: return end_byte if use_chunks: alternate = start + self.chunksize - 1 if end_byte is not None: end_byte = min(end_byte, alternate) else: end_byte = alternate if self.total_size: alternate = self.total_size - 1 if end_byte is not None: end_byte = min(end_byte, alternate) else: end_byte = alternate return end_byte def __GetChunk(self, start, end, additional_headers=None): """Retrieve a chunk, and return the full response.""" self.EnsureInitialized() request = http_wrapper.Request(url=self.url) self.__SetRangeHeader(request, start, end=end) if additional_headers is not None: request.headers.update(additional_headers) return http_wrapper.MakeRequest( self.bytes_http, request, retry_func=self.retry_func, retries=self.num_retries) def __ProcessResponse(self, response): """Process response (by updating self and writing to self.stream).""" if response.status_code not in self._ACCEPTABLE_STATUSES: # We distinguish errors that mean we made a mistake in setting # up the transfer versus something we should attempt again. if response.status_code in (http_client.FORBIDDEN, http_client.NOT_FOUND): raise exceptions.HttpError.FromResponse(response) else: raise exceptions.TransferRetryError(response.content) if response.status_code in (http_client.OK, http_client.PARTIAL_CONTENT): try: self.stream.write(six.ensure_binary(response.content)) except TypeError: self.stream.write(six.ensure_text(response.content)) self.__progress += response.length if response.info and 'content-encoding' in response.info: # TODO(craigcitro): Handle the case where this changes over a # download. self.__encoding = response.info['content-encoding'] elif response.status_code == http_client.NO_CONTENT: # It's important to write something to the stream for the case # of a 0-byte download to a file, as otherwise python won't # create the file. self.stream.write('') return response def GetRange(self, start, end=None, additional_headers=None, use_chunks=True): """Retrieve a given byte range from this download, inclusive. Range must be of one of these three forms: * 0 <= start, end = None: Fetch from start to the end of the file. * 0 <= start <= end: Fetch the bytes from start to end. * start < 0, end = None: Fetch the last -start bytes of the file. (These variations correspond to those described in the HTTP 1.1 protocol for range headers in RFC 2616, sec. 14.35.1.) Args: start: (int) Where to start fetching bytes. (See above.) end: (int, optional) Where to stop fetching bytes. (See above.) additional_headers: (bool, optional) Any additional headers to pass with the request. use_chunks: (bool, default: True) If False, ignore self.chunksize and fetch this range in a single request. Returns: None. Streams bytes into self.stream. """ self.EnsureInitialized() progress_end_normalized = False if self.total_size is not None: progress, end_byte = self.__NormalizeStartEnd(start, end) progress_end_normalized = True else: progress = start end_byte = end while (not progress_end_normalized or end_byte is None or progress <= end_byte): end_byte = self.__ComputeEndByte(progress, end=end_byte, use_chunks=use_chunks) response = self.__GetChunk(progress, end_byte, additional_headers=additional_headers) if not progress_end_normalized: self.__SetTotal(response.info) progress, end_byte = self.__NormalizeStartEnd(start, end) progress_end_normalized = True response = self.__ProcessResponse(response) progress += response.length if response.length == 0: if response.status_code == http_client.OK: # There can legitimately be no Content-Length header sent # in some cases (e.g., when there's a Transfer-Encoding # header) and if this was a 200 response (as opposed to # 206 Partial Content) we know we're done now without # looping further on received length. return raise exceptions.TransferRetryError( 'Zero bytes unexpectedly returned in download response') def StreamInChunks(self, callback=None, finish_callback=None, additional_headers=None): """Stream the entire download in chunks.""" self.StreamMedia(callback=callback, finish_callback=finish_callback, additional_headers=additional_headers, use_chunks=True) def StreamMedia(self, callback=None, finish_callback=None, additional_headers=None, use_chunks=True): """Stream the entire download. Args: callback: (default: None) Callback to call as each chunk is completed. finish_callback: (default: None) Callback to call when the download is complete. additional_headers: (default: None) Additional headers to include in fetching bytes. use_chunks: (bool, default: True) If False, ignore self.chunksize and stream this download in a single request. Returns: None. Streams bytes into self.stream. """ callback = callback or self.progress_callback finish_callback = finish_callback or self.finish_callback self.EnsureInitialized() while True: if self.__initial_response is not None: response = self.__initial_response self.__initial_response = None else: end_byte = self.__ComputeEndByte(self.progress, use_chunks=use_chunks) response = self.__GetChunk( self.progress, end_byte, additional_headers=additional_headers) if self.total_size is None: self.__SetTotal(response.info) response = self.__ProcessResponse(response) self._ExecuteCallback(callback, response) if (response.status_code == http_client.OK or self.progress >= self.total_size): break self._ExecuteCallback(finish_callback, response) if six.PY3: class MultipartBytesGenerator(email_generator.BytesGenerator): """Generates a bytes Message object tree for multipart messages This is a BytesGenerator that has been modified to not attempt line termination character modification in the bytes payload. Known to work with the compat32 policy only. It may work on others, but not tested. The outfp object must accept bytes in its write method. """ def _handle_text(self, msg): # If the string has surrogates the original source was bytes, so # just write it back out. if msg._payload is None: return self.write(msg._payload) def _encode(self, s): return s.encode('ascii', 'surrogateescape') # Default body handler _writeBody = _handle_text class Upload(_Transfer): """Data for a single Upload. Fields: stream: The stream to upload. mime_type: MIME type of the upload. total_size: (optional) Total upload size for the stream. close_stream: (default: False) Whether or not we should close the stream when finished with the upload. auto_transfer: (default: True) If True, stream all bytes as soon as the upload is created. """ _REQUIRED_SERIALIZATION_KEYS = set(( 'auto_transfer', 'mime_type', 'total_size', 'url')) def __init__(self, stream, mime_type, total_size=None, http=None, close_stream=False, chunksize=None, auto_transfer=True, progress_callback=None, finish_callback=None, gzip_encoded=False, **kwds): super(Upload, self).__init__( stream, close_stream=close_stream, chunksize=chunksize, auto_transfer=auto_transfer, http=http, **kwds) self.__complete = False self.__final_response = None self.__mime_type = mime_type self.__progress = 0 self.__server_chunk_granularity = None self.__strategy = None self.__total_size = None self.__gzip_encoded = gzip_encoded self.progress_callback = progress_callback self.finish_callback = finish_callback self.total_size = total_size @property def progress(self): return self.__progress @classmethod def FromFile(cls, filename, mime_type=None, auto_transfer=True, gzip_encoded=False, **kwds): """Create a new Upload object from a filename.""" path = os.path.expanduser(filename) if not os.path.exists(path): raise exceptions.NotFoundError('Could not find file %s' % path) if not mime_type: mime_type, _ = mimetypes.guess_type(path) if mime_type is None: raise exceptions.InvalidUserInputError( 'Could not guess mime type for %s' % path) size = os.stat(path).st_size return cls(open(path, 'rb'), mime_type, total_size=size, close_stream=True, auto_transfer=auto_transfer, gzip_encoded=gzip_encoded, **kwds) @classmethod def FromStream(cls, stream, mime_type, total_size=None, auto_transfer=True, gzip_encoded=False, **kwds): """Create a new Upload object from a stream.""" if mime_type is None: raise exceptions.InvalidUserInputError( 'No mime_type specified for stream') return cls(stream, mime_type, total_size=total_size, close_stream=False, auto_transfer=auto_transfer, gzip_encoded=gzip_encoded, **kwds) @classmethod def FromData(cls, stream, json_data, http, auto_transfer=None, gzip_encoded=False, client=None, **kwds): """Create a new Upload of stream from serialized json_data and http.""" info = json.loads(json_data) missing_keys = cls._REQUIRED_SERIALIZATION_KEYS - set(info.keys()) if missing_keys: raise exceptions.InvalidDataError( 'Invalid serialization data, missing keys: %s' % ( ', '.join(missing_keys))) if 'total_size' in kwds: raise exceptions.InvalidUserInputError( 'Cannot override total_size on serialized Upload') upload = cls.FromStream(stream, info['mime_type'], total_size=info.get('total_size'), gzip_encoded=gzip_encoded, **kwds) if isinstance(stream, io.IOBase) and not stream.seekable(): raise exceptions.InvalidUserInputError( 'Cannot restart resumable upload on non-seekable stream') if auto_transfer is not None: upload.auto_transfer = auto_transfer else: upload.auto_transfer = info['auto_transfer'] if client is not None: url = client.FinalizeTransferUrl(info['url']) else: url = info['url'] upload.strategy = RESUMABLE_UPLOAD upload._Initialize( # pylint: disable=protected-access http, url) upload.RefreshResumableUploadState() upload.EnsureInitialized() if upload.auto_transfer: upload.StreamInChunks() return upload @property def serialization_data(self): self.EnsureInitialized() if self.strategy != RESUMABLE_UPLOAD: raise exceptions.InvalidDataError( 'Serialization only supported for resumable uploads') return { 'auto_transfer': self.auto_transfer, 'mime_type': self.mime_type, 'total_size': self.total_size, 'url': self.url, } @property def complete(self): return self.__complete @property def mime_type(self): return self.__mime_type def __str__(self): if not self.initialized: return 'Upload (uninitialized)' return 'Upload with %d/%s bytes transferred for url %s' % ( self.progress, self.total_size or '???', self.url) @property def strategy(self): return self.__strategy @strategy.setter def strategy(self, value): if value not in (SIMPLE_UPLOAD, RESUMABLE_UPLOAD): raise exceptions.UserError(( 'Invalid value "%s" for upload strategy, must be one of ' '"simple" or "resumable".') % value) self.__strategy = value @property def total_size(self): return self.__total_size @total_size.setter def total_size(self, value): self.EnsureUninitialized() self.__total_size = value def __SetDefaultUploadStrategy(self, upload_config, http_request): """Determine and set the default upload strategy for this upload. We generally prefer simple or multipart, unless we're forced to use resumable. This happens when any of (1) the upload is too large, (2) the simple endpoint doesn't support multipart requests and we have metadata, or (3) there is no simple upload endpoint. Args: upload_config: Configuration for the upload endpoint. http_request: The associated http request. Returns: None. """ if upload_config.resumable_path is None: self.strategy = SIMPLE_UPLOAD if self.strategy is not None: return strategy = SIMPLE_UPLOAD if (self.total_size is not None and self.total_size > _RESUMABLE_UPLOAD_THRESHOLD): strategy = RESUMABLE_UPLOAD if http_request.body and not upload_config.simple_multipart: strategy = RESUMABLE_UPLOAD if not upload_config.simple_path: strategy = RESUMABLE_UPLOAD self.strategy = strategy def ConfigureRequest(self, upload_config, http_request, url_builder): """Configure the request and url for this upload.""" # Validate total_size vs. max_size if (self.total_size and upload_config.max_size and self.total_size > upload_config.max_size): raise exceptions.InvalidUserInputError( 'Upload too big: %s larger than max size %s' % ( self.total_size, upload_config.max_size)) # Validate mime type if not util.AcceptableMimeType(upload_config.accept, self.mime_type): raise exceptions.InvalidUserInputError( 'MIME type %s does not match any accepted MIME ranges %s' % ( self.mime_type, upload_config.accept)) self.__SetDefaultUploadStrategy(upload_config, http_request) if self.strategy == SIMPLE_UPLOAD: url_builder.relative_path = upload_config.simple_path if http_request.body: url_builder.query_params['uploadType'] = 'multipart' self.__ConfigureMultipartRequest(http_request) else: url_builder.query_params['uploadType'] = 'media' self.__ConfigureMediaRequest(http_request) # Once the entire body is written, compress the body if configured # to. Both multipart and media request uploads will read the # entire stream into memory, which means full compression is also # safe to perform. Because the strategy is set to SIMPLE_UPLOAD, # StreamInChunks throws an exception, meaning double compression # cannot happen. if self.__gzip_encoded: http_request.headers['Content-Encoding'] = 'gzip' # Turn the body into a stream so that we can compress it, then # read the compressed bytes. In the event of a retry (e.g. if # our access token has expired), we need to be able to re-read # the body, which we can't do with a stream. So, we consume the # bytes from the stream now and store them in a re-readable # bytes container. http_request.body = ( compression.CompressStream( six.BytesIO(http_request.body))[0].read()) else: url_builder.relative_path = upload_config.resumable_path url_builder.query_params['uploadType'] = 'resumable' self.__ConfigureResumableRequest(http_request) def __ConfigureMediaRequest(self, http_request): """Configure http_request as a simple request for this upload.""" http_request.headers['content-type'] = self.mime_type http_request.body = self.stream.read() http_request.loggable_body = '<media body>' def __ConfigureMultipartRequest(self, http_request): """Configure http_request as a multipart request for this upload.""" # This is a multipart/related upload. msg_root = mime_multipart.MIMEMultipart('related') # msg_root should not write out its own headers setattr(msg_root, '_write_headers', lambda self: None) # attach the body as one part msg = mime_nonmultipart.MIMENonMultipart( *http_request.headers['content-type'].split('/')) msg.set_payload(http_request.body) msg_root.attach(msg) # attach the media as the second part msg = mime_nonmultipart.MIMENonMultipart(*self.mime_type.split('/')) msg['Content-Transfer-Encoding'] = 'binary' msg.set_payload(self.stream.read()) msg_root.attach(msg) # NOTE: We encode the body, but can't use # `email.message.Message.as_string` because it prepends # `> ` to `From ` lines. fp = six.BytesIO() if six.PY3: generator_class = MultipartBytesGenerator else: generator_class = email_generator.Generator g = generator_class(fp, mangle_from_=False) g.flatten(msg_root, unixfrom=False) http_request.body = fp.getvalue() multipart_boundary = msg_root.get_boundary() http_request.headers['content-type'] = ( 'multipart/related; boundary=%r' % multipart_boundary) if isinstance(multipart_boundary, six.text_type): multipart_boundary = multipart_boundary.encode('ascii') body_components = http_request.body.split(multipart_boundary) headers, _, _ = body_components[-2].partition(b'\n\n') body_components[-2] = b'\n\n'.join([headers, b'<media body>\n\n--']) http_request.loggable_body = multipart_boundary.join(body_components) def __ConfigureResumableRequest(self, http_request): http_request.headers['X-Upload-Content-Type'] = self.mime_type if self.total_size is not None: http_request.headers[ 'X-Upload-Content-Length'] = str(self.total_size) def RefreshResumableUploadState(self): """Talk to the server and refresh the state of this resumable upload. Returns: Response if the upload is complete. """ if self.strategy != RESUMABLE_UPLOAD: return self.EnsureInitialized() refresh_request = http_wrapper.Request( url=self.url, http_method='PUT', headers={'Content-Range': 'bytes */*'}) refresh_response = http_wrapper.MakeRequest( self.http, refresh_request, redirections=0, retries=self.num_retries) range_header = self._GetRangeHeaderFromResponse(refresh_response) if refresh_response.status_code in (http_client.OK, http_client.CREATED): self.__complete = True self.__progress = self.total_size self.stream.seek(self.progress) # If we're finished, the refresh response will contain the metadata # originally requested. Cache it so it can be returned in # StreamInChunks. self.__final_response = refresh_response elif refresh_response.status_code == http_wrapper.RESUME_INCOMPLETE: if range_header is None: self.__progress = 0 else: self.__progress = self.__GetLastByte(range_header) + 1 self.stream.seek(self.progress) else: raise exceptions.HttpError.FromResponse(refresh_response) def _GetRangeHeaderFromResponse(self, response): return response.info.get('Range', response.info.get('range')) def InitializeUpload(self, http_request, http=None, client=None): """Initialize this upload from the given http_request.""" if self.strategy is None: raise exceptions.UserError( 'No upload strategy set; did you call ConfigureRequest?') if http is None and client is None: raise exceptions.UserError('Must provide client or http.') if self.strategy != RESUMABLE_UPLOAD: return http = http or client.http if client is not None: http_request.url = client.FinalizeTransferUrl(http_request.url) self.EnsureUninitialized() http_response = http_wrapper.MakeRequest(http, http_request, retries=self.num_retries) if http_response.status_code != http_client.OK: raise exceptions.HttpError.FromResponse(http_response) self.__server_chunk_granularity = http_response.info.get( 'X-Goog-Upload-Chunk-Granularity') url = http_response.info['location'] if client is not None: url = client.FinalizeTransferUrl(url) self._Initialize(http, url) # Unless the user has requested otherwise, we want to just # go ahead and pump the bytes now. if self.auto_transfer: return self.StreamInChunks() return http_response def __GetLastByte(self, range_header): _, _, end = range_header.partition('-') # TODO(craigcitro): Validate start == 0? return int(end) def __ValidateChunksize(self, chunksize=None): if self.__server_chunk_granularity is None: return chunksize = chunksize or self.chunksize if chunksize % self.__server_chunk_granularity: raise exceptions.ConfigurationValueError( 'Server requires chunksize to be a multiple of %d' % self.__server_chunk_granularity) def __IsRetryable(self, response): return (response.status_code >= 500 or response.status_code == http_wrapper.TOO_MANY_REQUESTS or response.retry_after) def __StreamMedia(self, callback=None, finish_callback=None, additional_headers=None, use_chunks=True): """Helper function for StreamMedia / StreamInChunks.""" if self.strategy != RESUMABLE_UPLOAD: raise exceptions.InvalidUserInputError( 'Cannot stream non-resumable upload') callback = callback or self.progress_callback finish_callback = finish_callback or self.finish_callback # final_response is set if we resumed an already-completed upload. response = self.__final_response def CallSendChunk(start): return self.__SendChunk( start, additional_headers=additional_headers) def CallSendMediaBody(start): return self.__SendMediaBody( start, additional_headers=additional_headers) send_func = CallSendChunk if use_chunks else CallSendMediaBody if not use_chunks and self.__gzip_encoded: raise exceptions.InvalidUserInputError( 'Cannot gzip encode non-chunked upload') if use_chunks: self.__ValidateChunksize(self.chunksize) self.EnsureInitialized() while not self.complete: response = send_func(self.stream.tell()) if response.status_code in (http_client.OK, http_client.CREATED): self.__complete = True break if response.status_code not in ( http_client.OK, http_client.CREATED, http_wrapper.RESUME_INCOMPLETE): # Only raise an exception if the error is something we can't # recover from. if (self.strategy != RESUMABLE_UPLOAD or not self.__IsRetryable(response)): raise exceptions.HttpError.FromResponse(response) # We want to reset our state to wherever the server left us # before this failed request, and then raise. self.RefreshResumableUploadState() self._ExecuteCallback(callback, response) continue self.__progress = self.__GetLastByte( self._GetRangeHeaderFromResponse(response)) if self.progress + 1 != self.stream.tell(): # TODO(craigcitro): Add a better way to recover here. raise exceptions.CommunicationError( 'Failed to transfer all bytes in chunk, upload paused at ' 'byte %d' % self.progress) self._ExecuteCallback(callback, response) if self.__complete and hasattr(self.stream, 'seek'): current_pos = self.stream.tell() self.stream.seek(0, os.SEEK_END) end_pos = self.stream.tell() self.stream.seek(current_pos) if current_pos != end_pos: raise exceptions.TransferInvalidError( 'Upload complete with %s additional bytes left in stream' % (int(end_pos) - int(current_pos))) self._ExecuteCallback(finish_callback, response) return response def StreamMedia(self, callback=None, finish_callback=None, additional_headers=None): """Send this resumable upload in a single request. Args: callback: Progress callback function with inputs (http_wrapper.Response, transfer.Upload) finish_callback: Final callback function with inputs (http_wrapper.Response, transfer.Upload) additional_headers: Dict of headers to include with the upload http_wrapper.Request. Returns: http_wrapper.Response of final response. """ return self.__StreamMedia( callback=callback, finish_callback=finish_callback, additional_headers=additional_headers, use_chunks=False) def StreamInChunks(self, callback=None, finish_callback=None, additional_headers=None): """Send this (resumable) upload in chunks.""" return self.__StreamMedia( callback=callback, finish_callback=finish_callback, additional_headers=additional_headers) def __SendMediaRequest(self, request, end): """Request helper function for SendMediaBody & SendChunk.""" def CheckResponse(response): if response is None: # Caller shouldn't call us if the response is None, # but handle anyway. raise exceptions.RequestError( 'Request to url %s did not return a response.' % response.request_url) response = http_wrapper.MakeRequest( self.bytes_http, request, retry_func=self.retry_func, retries=self.num_retries, check_response_func=CheckResponse) if response.status_code == http_wrapper.RESUME_INCOMPLETE: last_byte = self.__GetLastByte( self._GetRangeHeaderFromResponse(response)) if last_byte + 1 != end: self.stream.seek(last_byte + 1) return response def __SendMediaBody(self, start, additional_headers=None): """Send the entire media stream in a single request.""" self.EnsureInitialized() if self.total_size is None: raise exceptions.TransferInvalidError( 'Total size must be known for SendMediaBody') body_stream = stream_slice.StreamSlice( self.stream, self.total_size - start) request = http_wrapper.Request(url=self.url, http_method='PUT', body=body_stream) request.headers['Content-Type'] = self.mime_type if start == self.total_size: # End of an upload with 0 bytes left to send; just finalize. range_string = 'bytes */%s' % self.total_size else: range_string = 'bytes %s-%s/%s' % (start, self.total_size - 1, self.total_size) request.headers['Content-Range'] = range_string if additional_headers: request.headers.update(additional_headers) return self.__SendMediaRequest(request, self.total_size) def __SendChunk(self, start, additional_headers=None): """Send the specified chunk.""" self.EnsureInitialized() no_log_body = self.total_size is None request = http_wrapper.Request(url=self.url, http_method='PUT') if self.__gzip_encoded: request.headers['Content-Encoding'] = 'gzip' body_stream, read_length, exhausted = compression.CompressStream( self.stream, self.chunksize) end = start + read_length # If the stream length was previously unknown and the input stream # is exhausted, then we're at the end of the stream. if self.total_size is None and exhausted: self.__total_size = end elif self.total_size is None: # For the streaming resumable case, we need to detect when # we're at the end of the stream. body_stream = buffered_stream.BufferedStream( self.stream, start, self.chunksize) end = body_stream.stream_end_position if body_stream.stream_exhausted: self.__total_size = end # TODO: Here, change body_stream from a stream to a string object, # which means reading a chunk into memory. This works around # https://code.google.com/p/httplib2/issues/detail?id=176 which can # cause httplib2 to skip bytes on 401's for file objects. # Rework this solution to be more general. body_stream = body_stream.read(self.chunksize) else: end = min(start + self.chunksize, self.total_size) body_stream = stream_slice.StreamSlice(self.stream, end - start) # TODO(craigcitro): Think about clearer errors on "no data in # stream". request.body = body_stream request.headers['Content-Type'] = self.mime_type if no_log_body: # Disable logging of streaming body. # TODO: Remove no_log_body and rework as part of a larger logs # refactor. request.loggable_body = '<media body>' if self.total_size is None: # Streaming resumable upload case, unknown total size. range_string = 'bytes %s-%s/*' % (start, end - 1) elif end == start: # End of an upload with 0 bytes left to send; just finalize. range_string = 'bytes */%s' % self.total_size else: # Normal resumable upload case with known sizes. range_string = 'bytes %s-%s/%s' % (start, end - 1, self.total_size) request.headers['Content-Range'] = range_string if additional_headers: request.headers.update(additional_headers) return self.__SendMediaRequest(request, end) py/buffered_stream_test.py 0000644 00000004626 15025317163 0011755 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for buffered_stream.""" import string import unittest import six from apitools.base.py import buffered_stream from apitools.base.py import exceptions class BufferedStreamTest(unittest.TestCase): def setUp(self): self.stream = six.StringIO(string.ascii_letters) self.value = self.stream.getvalue() self.stream.seek(0) def testEmptyBuffer(self): bs = buffered_stream.BufferedStream(self.stream, 0, 0) self.assertEqual('', bs.read(0)) self.assertEqual(0, bs.stream_end_position) def testOffsetStream(self): bs = buffered_stream.BufferedStream(self.stream, 50, 100) self.assertEqual(len(self.value), len(bs)) self.assertEqual(self.value, bs.read(len(self.value))) self.assertEqual(50 + len(self.value), bs.stream_end_position) def testUnexhaustedStream(self): bs = buffered_stream.BufferedStream(self.stream, 0, 50) self.assertEqual(50, bs.stream_end_position) self.assertEqual(False, bs.stream_exhausted) self.assertEqual(self.value[0:50], bs.read(50)) self.assertEqual(False, bs.stream_exhausted) self.assertEqual('', bs.read(0)) self.assertEqual('', bs.read(100)) def testExhaustedStream(self): bs = buffered_stream.BufferedStream(self.stream, 0, 100) self.assertEqual(len(self.value), bs.stream_end_position) self.assertEqual(True, bs.stream_exhausted) self.assertEqual(self.value, bs.read(100)) self.assertEqual('', bs.read(0)) self.assertEqual('', bs.read(100)) def testArbitraryLengthRead(self): bs = buffered_stream.BufferedStream(self.stream, 0, 20) with self.assertRaises(exceptions.NotYetImplementedError): bs.read() with self.assertRaises(exceptions.NotYetImplementedError): bs.read(size=-1) py/list_pager_test.py 0000644 00000032121 15025317163 0010740 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for list_pager.""" import unittest from apitools.base.py import list_pager from apitools.base.py.testing import mock from samples.fusiontables_sample.fusiontables_v1 \ import fusiontables_v1_client as fusiontables from samples.fusiontables_sample.fusiontables_v1 \ import fusiontables_v1_messages as messages from samples.iam_sample.iam_v1 import iam_v1_client as iam_client from samples.iam_sample.iam_v1 import iam_v1_messages as iam_messages class Example(object): def __init__(self): self.a = 'aaa' self.b = 'bbb' self.c = 'ccc' class GetterSetterTest(unittest.TestCase): def testGetattrNested(self): o = Example() self.assertEqual(list_pager._GetattrNested(o, 'a'), 'aaa') self.assertEqual(list_pager._GetattrNested(o, ('a',)), 'aaa') o.b = Example() self.assertEqual(list_pager._GetattrNested(o, ('b', 'c')), 'ccc') def testSetattrNested(self): o = Example() list_pager._SetattrNested(o, 'b', Example()) self.assertEqual(o.b.a, 'aaa') list_pager._SetattrNested(o, ('b', 'a'), 'AAA') self.assertEqual(o.b.a, 'AAA') list_pager._SetattrNested(o, ('c',), 'CCC') self.assertEqual(o.c, 'CCC') class ListPagerTest(unittest.TestCase): def _AssertInstanceSequence(self, results, n): counter = 0 for instance in results: self.assertEqual(instance.name, 'c' + str(counter)) counter += 1 self.assertEqual(counter, n) def setUp(self): self.mocked_client = mock.Client(fusiontables.FusiontablesV1) self.mocked_client.Mock() self.addCleanup(self.mocked_client.Unmock) def testYieldFromList(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=100, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0'), messages.Column(name='c1'), messages.Column(name='c2'), messages.Column(name='c3'), ], nextPageToken='x', )) self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=100, pageToken='x', tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c4'), messages.Column(name='c5'), messages.Column(name='c6'), messages.Column(name='c7'), ], )) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request) self._AssertInstanceSequence(results, 8) def testYieldNoRecords(self): client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request, limit=False) self.assertEqual(0, len(list(results))) def testYieldFromListPartial(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=6, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0'), messages.Column(name='c1'), messages.Column(name='c2'), messages.Column(name='c3'), ], nextPageToken='x', )) self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=2, pageToken='x', tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c4'), messages.Column(name='c5'), messages.Column(name='c6'), messages.Column(name='c7'), ], )) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request, limit=6) self._AssertInstanceSequence(results, 6) def testYieldFromListPaging(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=5, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0'), messages.Column(name='c1'), messages.Column(name='c2'), messages.Column(name='c3'), messages.Column(name='c4'), ], nextPageToken='x', )) self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=4, pageToken='x', tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c5'), messages.Column(name='c6'), messages.Column(name='c7'), messages.Column(name='c8'), ], )) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request, limit=9, batch_size=5) self._AssertInstanceSequence(results, 9) def testYieldFromListBatchSizeNone(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=None, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0'), messages.Column(name='c1'), messages.Column(name='c2'), messages.Column(name='c3'), messages.Column(name='c4'), messages.Column(name='c5'), messages.Column(name='c6'), ], nextPageToken='x', )) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request, limit=5, batch_size=None) self._AssertInstanceSequence(results, 5) def testYieldFromListEmpty(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=6, pageToken=None, tableId='mytable', ), messages.ColumnList()) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList(client.column, request, limit=6) self._AssertInstanceSequence(results, 0) def testYieldFromListWithPredicate(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=100, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0'), messages.Column(name='bad0'), messages.Column(name='c1'), messages.Column(name='bad1'), ], nextPageToken='x', )) self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=100, pageToken='x', tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c2'), ], )) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList( client.column, request, predicate=lambda x: 'c' in x.name) self._AssertInstanceSequence(results, 3) def testYieldFromListWithCustomGetFieldFunction(self): self.mocked_client.column.List.Expect( messages.FusiontablesColumnListRequest( maxResults=100, pageToken=None, tableId='mytable', ), messages.ColumnList( items=[ messages.Column(name='c0') ] )) custom_getter_called = [] def Custom_Getter(message, attribute): custom_getter_called.append(True) return getattr(message, attribute) client = fusiontables.FusiontablesV1(get_credentials=False) request = messages.FusiontablesColumnListRequest(tableId='mytable') results = list_pager.YieldFromList( client.column, request, get_field_func=Custom_Getter) self._AssertInstanceSequence(results, 1) self.assertEqual(1, len(custom_getter_called)) class ListPagerAttributeTest(unittest.TestCase): def setUp(self): self.mocked_client = mock.Client(iam_client.IamV1) self.mocked_client.Mock() self.addCleanup(self.mocked_client.Unmock) def testYieldFromListWithAttributes(self): self.mocked_client.iamPolicies.GetPolicyDetails.Expect( iam_messages.GetPolicyDetailsRequest( pageSize=100, pageToken=None, fullResourcePath='myresource', ), iam_messages.GetPolicyDetailsResponse( policies=[ iam_messages.PolicyDetail(fullResourcePath='c0'), iam_messages.PolicyDetail(fullResourcePath='c1'), ], nextPageToken='x', )) self.mocked_client.iamPolicies.GetPolicyDetails.Expect( iam_messages.GetPolicyDetailsRequest( pageSize=100, pageToken='x', fullResourcePath='myresource', ), iam_messages.GetPolicyDetailsResponse( policies=[ iam_messages.PolicyDetail(fullResourcePath='c2'), ], )) client = iam_client.IamV1(get_credentials=False) request = iam_messages.GetPolicyDetailsRequest( fullResourcePath='myresource') results = list_pager.YieldFromList( client.iamPolicies, request, batch_size_attribute='pageSize', method='GetPolicyDetails', field='policies') i = 0 for i, instance in enumerate(results): self.assertEqual('c{0}'.format(i), instance.fullResourcePath) self.assertEqual(2, i) def testYieldFromListWithNoBatchSizeAttribute(self): self.mocked_client.iamPolicies.GetPolicyDetails.Expect( iam_messages.GetPolicyDetailsRequest( pageToken=None, fullResourcePath='myresource', ), iam_messages.GetPolicyDetailsResponse( policies=[ iam_messages.PolicyDetail(fullResourcePath='c0'), iam_messages.PolicyDetail(fullResourcePath='c1'), ], )) client = iam_client.IamV1(get_credentials=False) request = iam_messages.GetPolicyDetailsRequest( fullResourcePath='myresource') results = list_pager.YieldFromList( client.iamPolicies, request, batch_size_attribute=None, method='GetPolicyDetails', field='policies') i = 0 for i, instance in enumerate(results): self.assertEqual('c{0}'.format(i), instance.fullResourcePath) self.assertEqual(1, i) py/compression.py 0000644 00000012020 15025317163 0010105 0 ustar 00 #!/usr/bin/env python # # Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Compression support for apitools.""" from collections import deque from apitools.base.py import gzip __all__ = [ 'CompressStream', ] # pylint: disable=invalid-name # Note: Apitools only uses the default chunksize when compressing. def CompressStream(in_stream, length=None, compresslevel=2, chunksize=16777216): """Compresses an input stream into a file-like buffer. This reads from the input stream until either we've stored at least length compressed bytes, or the input stream has been exhausted. This supports streams of unknown size. Args: in_stream: The input stream to read from. length: The target number of compressed bytes to buffer in the output stream. If length is none, the input stream will be compressed until it's exhausted. The actual length of the output buffer can vary from the target. If the input stream is exhaused, the output buffer may be smaller than expected. If the data is incompressible, the maximum length can be exceeded by can be calculated to be: chunksize + 5 * (floor((chunksize - 1) / 16383) + 1) + 17 This accounts for additional header data gzip adds. For the default 16MiB chunksize, this results in the max size of the output buffer being: length + 16Mib + 5142 bytes compresslevel: Optional, defaults to 2. The desired compression level. chunksize: Optional, defaults to 16MiB. The chunk size used when reading data from the input stream to write into the output buffer. Returns: A file-like output buffer of compressed bytes, the number of bytes read from the input stream, and a flag denoting if the input stream was exhausted. """ in_read = 0 in_exhausted = False out_stream = StreamingBuffer() with gzip.GzipFile(mode='wb', fileobj=out_stream, compresslevel=compresslevel) as compress_stream: # Read until we've written at least length bytes to the output stream. while not length or out_stream.length < length: data = in_stream.read(chunksize) data_length = len(data) compress_stream.write(data) in_read += data_length # If we read less than requested, the stream is exhausted. if data_length < chunksize: in_exhausted = True break return out_stream, in_read, in_exhausted class StreamingBuffer(object): """Provides a file-like object that writes to a temporary buffer. When data is read from the buffer, it is permanently removed. This is useful when there are memory constraints preventing the entire buffer from being stored in memory. """ def __init__(self): # The buffer of byte arrays. self.__buf = deque() # The number of bytes in __buf. self.__size = 0 def __len__(self): return self.__size def __nonzero__(self): # For 32-bit python2.x, len() cannot exceed a 32-bit number; avoid # accidental len() calls from httplib in the form of "if this_object:". return bool(self.__size) @property def length(self): # For 32-bit python2.x, len() cannot exceed a 32-bit number. return self.__size def write(self, data): # Gzip can write many 0 byte chunks for highly compressible data. # Prevent them from being added internally. if data is not None and data: self.__buf.append(data) self.__size += len(data) def read(self, size=None): """Read at most size bytes from this buffer. Bytes read from this buffer are consumed and are permanently removed. Args: size: If provided, read no more than size bytes from the buffer. Otherwise, this reads the entire buffer. Returns: The bytes read from this buffer. """ if size is None: size = self.__size ret_list = [] while size > 0 and self.__buf: data = self.__buf.popleft() size -= len(data) ret_list.append(data) if size < 0: ret_list[-1], remainder = ret_list[-1][:size], ret_list[-1][size:] self.__buf.appendleft(remainder) ret = b''.join(ret_list) self.__size -= len(ret) return ret py/batch.py 0000644 00000043674 15025317163 0006650 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Library for handling batch HTTP requests for apitools.""" import collections import email.generator as generator import email.mime.multipart as mime_multipart import email.mime.nonmultipart as mime_nonmultipart import email.parser as email_parser import itertools import time import uuid import six from six.moves import http_client from six.moves import urllib_parse from six.moves import range # pylint: disable=redefined-builtin from apitools.base.py import exceptions from apitools.base.py import http_wrapper __all__ = [ 'BatchApiRequest', ] class RequestResponseAndHandler(collections.namedtuple( 'RequestResponseAndHandler', ['request', 'response', 'handler'])): """Container for data related to completing an HTTP request. This contains an HTTP request, its response, and a callback for handling the response from the server. Attributes: request: An http_wrapper.Request object representing the HTTP request. response: The http_wrapper.Response object returned from the server. handler: A callback function accepting two arguments, response and exception. Response is an http_wrapper.Response object, and exception is an apiclient.errors.HttpError object if an error occurred, or otherwise None. """ class BatchApiRequest(object): """Batches multiple api requests into a single request.""" class ApiCall(object): """Holds request and response information for each request. ApiCalls are ultimately exposed to the client once the HTTP batch request has been completed. Attributes: http_request: A client-supplied http_wrapper.Request to be submitted to the server. response: A http_wrapper.Response object given by the server as a response to the user request, or None if an error occurred. exception: An apiclient.errors.HttpError object if an error occurred, or None. """ def __init__(self, request, retryable_codes, service, method_config): """Initialize an individual API request. Args: request: An http_wrapper.Request object. retryable_codes: A list of integer HTTP codes that can be retried. service: A service inheriting from base_api.BaseApiService. method_config: Method config for the desired API request. """ self.__retryable_codes = list( set(retryable_codes + [http_client.UNAUTHORIZED])) self.__http_response = None self.__service = service self.__method_config = method_config self.http_request = request # TODO(user): Add some validation to these fields. self.__response = None self.__exception = None @property def is_error(self): return self.exception is not None @property def response(self): return self.__response @property def exception(self): return self.__exception @property def authorization_failed(self): return (self.__http_response and ( self.__http_response.status_code == http_client.UNAUTHORIZED)) @property def terminal_state(self): if self.__http_response is None: return False response_code = self.__http_response.status_code return response_code not in self.__retryable_codes def HandleResponse(self, http_response, exception): """Handles incoming http response to the request in http_request. This is intended to be used as a callback function for BatchHttpRequest.Add. Args: http_response: Deserialized http_wrapper.Response object. exception: apiclient.errors.HttpError object if an error occurred. """ self.__http_response = http_response self.__exception = exception if self.terminal_state and not self.__exception: self.__response = self.__service.ProcessHttpResponse( self.__method_config, self.__http_response) def __init__(self, batch_url=None, retryable_codes=None, response_encoding=None): """Initialize a batch API request object. Args: batch_url: Base URL for batch API calls. retryable_codes: A list of integer HTTP codes that can be retried. response_encoding: The encoding type of response content. """ self.api_requests = [] self.retryable_codes = retryable_codes or [] self.batch_url = batch_url or 'https://www.googleapis.com/batch' self.response_encoding = response_encoding def Add(self, service, method, request, global_params=None): """Add a request to the batch. Args: service: A class inheriting base_api.BaseApiService. method: A string indicated desired method from the service. See the example in the class docstring. request: An input message appropriate for the specified service.method. global_params: Optional additional parameters to pass into method.PrepareHttpRequest. Returns: None """ # Retrieve the configs for the desired method and service. method_config = service.GetMethodConfig(method) upload_config = service.GetUploadConfig(method) # Prepare the HTTP Request. http_request = service.PrepareHttpRequest( method_config, request, global_params=global_params, upload_config=upload_config) # Create the request and add it to our master list. api_request = self.ApiCall( http_request, self.retryable_codes, service, method_config) self.api_requests.append(api_request) def Execute(self, http, sleep_between_polls=5, max_retries=5, max_batch_size=None, batch_request_callback=None): """Execute all of the requests in the batch. Args: http: httplib2.Http object for use in the request. sleep_between_polls: Integer number of seconds to sleep between polls. max_retries: Max retries. Any requests that have not succeeded by this number of retries simply report the last response or exception, whatever it happened to be. max_batch_size: int, if specified requests will be split in batches of given size. batch_request_callback: function of (http_response, exception) passed to BatchHttpRequest which will be run on any given results. Returns: List of ApiCalls. """ requests = [request for request in self.api_requests if not request.terminal_state] batch_size = max_batch_size or len(requests) for attempt in range(max_retries): if attempt: time.sleep(sleep_between_polls) for i in range(0, len(requests), batch_size): # Create a batch_http_request object and populate it with # incomplete requests. batch_http_request = BatchHttpRequest( batch_url=self.batch_url, callback=batch_request_callback, response_encoding=self.response_encoding ) for request in itertools.islice(requests, i, i + batch_size): batch_http_request.Add( request.http_request, request.HandleResponse) batch_http_request.Execute(http) if hasattr(http.request, 'credentials'): if any(request.authorization_failed for request in itertools.islice(requests, i, i + batch_size)): http.request.credentials.refresh(http) # Collect retryable requests. requests = [request for request in self.api_requests if not request.terminal_state] if not requests: break return self.api_requests class BatchHttpRequest(object): """Batches multiple http_wrapper.Request objects into a single request.""" def __init__(self, batch_url, callback=None, response_encoding=None): """Constructor for a BatchHttpRequest. Args: batch_url: URL to send batch requests to. callback: A callback to be called for each response, of the form callback(response, exception). The first parameter is the deserialized Response object. The second is an apiclient.errors.HttpError exception object if an HTTP error occurred while processing the request, or None if no error occurred. response_encoding: The encoding type of response content. """ # Endpoint to which these requests are sent. self.__batch_url = batch_url # Global callback to be called for each individual response in the # batch. self.__callback = callback # Response content will be decoded if this is provided. self.__response_encoding = response_encoding # List of requests, responses and handlers. self.__request_response_handlers = {} # The last auto generated id. self.__last_auto_id = itertools.count() # Unique ID on which to base the Content-ID headers. self.__base_id = uuid.uuid4() def _ConvertIdToHeader(self, request_id): """Convert an id to a Content-ID header value. Args: request_id: String identifier for a individual request. Returns: A Content-ID header with the id_ encoded into it. A UUID is prepended to the value because Content-ID headers are supposed to be universally unique. """ return '<%s+%s>' % (self.__base_id, urllib_parse.quote(request_id)) @staticmethod def _ConvertHeaderToId(header): """Convert a Content-ID header value to an id. Presumes the Content-ID header conforms to the format that _ConvertIdToHeader() returns. Args: header: A string indicating the Content-ID header value. Returns: The extracted id value. Raises: BatchError if the header is not in the expected format. """ if not (header.startswith('<') or header.endswith('>')): raise exceptions.BatchError( 'Invalid value for Content-ID: %s' % header) if '+' not in header: raise exceptions.BatchError( 'Invalid value for Content-ID: %s' % header) _, request_id = header[1:-1].rsplit('+', 1) return urllib_parse.unquote(request_id) def _SerializeRequest(self, request): """Convert a http_wrapper.Request object into a string. Args: request: A http_wrapper.Request to serialize. Returns: The request as a string in application/http format. """ # Construct status line parsed = urllib_parse.urlsplit(request.url) request_line = urllib_parse.urlunsplit( ('', '', parsed.path, parsed.query, '')) if not isinstance(request_line, six.text_type): request_line = request_line.decode('utf-8') status_line = u' '.join(( request.http_method, request_line, u'HTTP/1.1\n' )) major, minor = request.headers.get( 'content-type', 'application/json').split('/') msg = mime_nonmultipart.MIMENonMultipart(major, minor) # MIMENonMultipart adds its own Content-Type header. # Keep all of the other headers in `request.headers`. for key, value in request.headers.items(): if key == 'content-type': continue msg[key] = value msg['Host'] = parsed.netloc msg.set_unixfrom(None) if request.body is not None: msg.set_payload(request.body) # Serialize the mime message. str_io = six.StringIO() # maxheaderlen=0 means don't line wrap headers. gen = generator.Generator(str_io, maxheaderlen=0) gen.flatten(msg, unixfrom=False) body = str_io.getvalue() return status_line + body def _DeserializeResponse(self, payload): """Convert string into Response and content. Args: payload: Header and body string to be deserialized. Returns: A Response object """ # Strip off the status line. status_line, payload = payload.split('\n', 1) _, status, _ = status_line.split(' ', 2) # Parse the rest of the response. parser = email_parser.Parser() msg = parser.parsestr(payload) # Get the headers. info = dict(msg) info['status'] = status # Create Response from the parsed headers. content = msg.get_payload() return http_wrapper.Response(info, content, self.__batch_url) def _NewId(self): """Create a new id. Auto incrementing number that avoids conflicts with ids already used. Returns: A new unique id string. """ return str(next(self.__last_auto_id)) def Add(self, request, callback=None): """Add a new request. Args: request: A http_wrapper.Request to add to the batch. callback: A callback to be called for this response, of the form callback(response, exception). The first parameter is the deserialized response object. The second is an apiclient.errors.HttpError exception object if an HTTP error occurred while processing the request, or None if no errors occurred. Returns: None """ handler = RequestResponseAndHandler(request, None, callback) self.__request_response_handlers[self._NewId()] = handler def _Execute(self, http): """Serialize batch request, send to server, process response. Args: http: A httplib2.Http object to be used to make the request with. Raises: httplib2.HttpLib2Error if a transport error has occured. apiclient.errors.BatchError if the response is the wrong format. """ message = mime_multipart.MIMEMultipart('mixed') # Message should not write out its own headers. setattr(message, '_write_headers', lambda self: None) # Add all the individual requests. for key in self.__request_response_handlers: msg = mime_nonmultipart.MIMENonMultipart('application', 'http') msg['Content-Transfer-Encoding'] = 'binary' msg['Content-ID'] = self._ConvertIdToHeader(key) body = self._SerializeRequest( self.__request_response_handlers[key].request) msg.set_payload(body) message.attach(msg) request = http_wrapper.Request(self.__batch_url, 'POST') request.body = message.as_string() request.headers['content-type'] = ( 'multipart/mixed; boundary="%s"') % message.get_boundary() response = http_wrapper.MakeRequest(http, request) if response.status_code >= 300: raise exceptions.HttpError.FromResponse(response) # Prepend with a content-type header so Parser can handle it. header = 'content-type: %s\r\n\r\n' % response.info['content-type'] content = response.content if isinstance(content, bytes) and self.__response_encoding: content = response.content.decode(self.__response_encoding) parser = email_parser.Parser() mime_response = parser.parsestr(header + content) if not mime_response.is_multipart(): raise exceptions.BatchError( 'Response not in multipart/mixed format.') for part in mime_response.get_payload(): request_id = self._ConvertHeaderToId(part['Content-ID']) response = self._DeserializeResponse(part.get_payload()) # Disable protected access because namedtuple._replace(...) # is not actually meant to be protected. # pylint: disable=protected-access self.__request_response_handlers[request_id] = ( self.__request_response_handlers[request_id]._replace( response=response)) def Execute(self, http): """Execute all the requests as a single batched HTTP request. Args: http: A httplib2.Http object to be used with the request. Returns: None Raises: BatchError if the response is the wrong format. """ self._Execute(http) for key in self.__request_response_handlers: response = self.__request_response_handlers[key].response callback = self.__request_response_handlers[key].handler exception = None if response.status_code >= 300: exception = exceptions.HttpError.FromResponse(response) if callback is not None: callback(response, exception) if self.__callback is not None: self.__callback(response, exception) py/encoding_helper.py 0000644 00000073774 15025317163 0010720 0 ustar 00 #!/usr/bin/env python # # Copyright 2018 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Common code for converting proto to other formats, such as JSON.""" import base64 import collections import datetime import json import six from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import protojson from apitools.base.py import exceptions _Codec = collections.namedtuple('_Codec', ['encoder', 'decoder']) CodecResult = collections.namedtuple('CodecResult', ['value', 'complete']) class EdgeType(object): """The type of transition made by an edge.""" SCALAR = 1 REPEATED = 2 MAP = 3 class ProtoEdge(collections.namedtuple('ProtoEdge', ['type_', 'field', 'index'])): """A description of a one-level transition from a message to a value. Protobuf messages can be arbitrarily nested as fields can be defined with any "message" type. This nesting property means that there are often many levels of proto messages within a single message instance. This class can unambiguously describe a single step from a message to some nested value. Properties: type_: EdgeType, The type of transition represented by this edge. field: str, The name of the message-typed field. index: Any, Additional data needed to make the transition. The semantics of the "index" property change based on the value of "type_": SCALAR: ignored. REPEATED: a numeric index into "field"'s list. MAP: a key into "field"'s mapping. """ __slots__ = () def __str__(self): if self.type_ == EdgeType.SCALAR: return self.field else: return '{}[{}]'.format(self.field, self.index) # TODO(craigcitro): Make these non-global. _UNRECOGNIZED_FIELD_MAPPINGS = {} _CUSTOM_MESSAGE_CODECS = {} _CUSTOM_FIELD_CODECS = {} _FIELD_TYPE_CODECS = {} def MapUnrecognizedFields(field_name): """Register field_name as a container for unrecognized fields.""" def Register(cls): _UNRECOGNIZED_FIELD_MAPPINGS[cls] = field_name return cls return Register def RegisterCustomMessageCodec(encoder, decoder): """Register a custom encoder/decoder for this message class.""" def Register(cls): _CUSTOM_MESSAGE_CODECS[cls] = _Codec(encoder=encoder, decoder=decoder) return cls return Register def RegisterCustomFieldCodec(encoder, decoder): """Register a custom encoder/decoder for this field.""" def Register(field): _CUSTOM_FIELD_CODECS[field] = _Codec(encoder=encoder, decoder=decoder) return field return Register def RegisterFieldTypeCodec(encoder, decoder): """Register a custom encoder/decoder for all fields of this type.""" def Register(field_type): _FIELD_TYPE_CODECS[field_type] = _Codec( encoder=encoder, decoder=decoder) return field_type return Register def CopyProtoMessage(message): """Make a deep copy of a message.""" return JsonToMessage(type(message), MessageToJson(message)) def MessageToJson(message, include_fields=None): """Convert the given message to JSON.""" result = _ProtoJsonApiTools.Get().encode_message(message) return _IncludeFields(result, message, include_fields) def JsonToMessage(message_type, message): """Convert the given JSON to a message of type message_type.""" return _ProtoJsonApiTools.Get().decode_message(message_type, message) # TODO(craigcitro): Do this directly, instead of via JSON. def DictToMessage(d, message_type): """Convert the given dictionary to a message of type message_type.""" return JsonToMessage(message_type, json.dumps(d)) def MessageToDict(message): """Convert the given message to a dictionary.""" return json.loads(MessageToJson(message)) def DictToAdditionalPropertyMessage(properties, additional_property_type, sort_items=False): """Convert the given dictionary to an AdditionalProperty message.""" items = properties.items() if sort_items: items = sorted(items) map_ = [] for key, value in items: map_.append(additional_property_type.AdditionalProperty( key=key, value=value)) return additional_property_type(additionalProperties=map_) def PyValueToMessage(message_type, value): """Convert the given python value to a message of type message_type.""" return JsonToMessage(message_type, json.dumps(value)) def MessageToPyValue(message): """Convert the given message to a python value.""" return json.loads(MessageToJson(message)) def MessageToRepr(msg, multiline=False, **kwargs): """Return a repr-style string for a protorpc message. protorpc.Message.__repr__ does not return anything that could be considered python code. Adding this function lets us print a protorpc message in such a way that it could be pasted into code later, and used to compare against other things. Args: msg: protorpc.Message, the message to be repr'd. multiline: bool, True if the returned string should have each field assignment on its own line. **kwargs: {str:str}, Additional flags for how to format the string. Known **kwargs: shortstrings: bool, True if all string values should be truncated at 100 characters, since when mocking the contents typically don't matter except for IDs, and IDs are usually less than 100 characters. no_modules: bool, True if the long module name should not be printed with each type. Returns: str, A string of valid python (assuming the right imports have been made) that recreates the message passed into this function. """ # TODO(jasmuth): craigcitro suggests a pretty-printer from apitools/gen. indent = kwargs.get('indent', 0) def IndentKwargs(kwargs): kwargs = dict(kwargs) kwargs['indent'] = kwargs.get('indent', 0) + 4 return kwargs if isinstance(msg, list): s = '[' for item in msg: if multiline: s += '\n' + ' ' * (indent + 4) s += MessageToRepr( item, multiline=multiline, **IndentKwargs(kwargs)) + ',' if multiline: s += '\n' + ' ' * indent s += ']' return s if isinstance(msg, messages.Message): s = type(msg).__name__ + '(' if not kwargs.get('no_modules'): s = msg.__module__ + '.' + s names = sorted([field.name for field in msg.all_fields()]) for name in names: field = msg.field_by_name(name) if multiline: s += '\n' + ' ' * (indent + 4) value = getattr(msg, field.name) s += field.name + '=' + MessageToRepr( value, multiline=multiline, **IndentKwargs(kwargs)) + ',' if multiline: s += '\n' + ' ' * indent s += ')' return s if isinstance(msg, six.string_types): if kwargs.get('shortstrings') and len(msg) > 100: msg = msg[:100] if isinstance(msg, datetime.datetime): class SpecialTZInfo(datetime.tzinfo): def __init__(self, offset): super(SpecialTZInfo, self).__init__() self.offset = offset def __repr__(self): s = 'TimeZoneOffset(' + repr(self.offset) + ')' if not kwargs.get('no_modules'): s = 'apitools.base.protorpclite.util.' + s return s msg = datetime.datetime( msg.year, msg.month, msg.day, msg.hour, msg.minute, msg.second, msg.microsecond, SpecialTZInfo(msg.tzinfo.utcoffset(0))) return repr(msg) def _GetField(message, field_path): for field in field_path: if field not in dir(message): raise KeyError('no field "%s"' % field) message = getattr(message, field) return message def _SetField(dictblob, field_path, value): for field in field_path[:-1]: dictblob = dictblob.setdefault(field, {}) dictblob[field_path[-1]] = value def _IncludeFields(encoded_message, message, include_fields): """Add the requested fields to the encoded message.""" if include_fields is None: return encoded_message result = json.loads(encoded_message) for field_name in include_fields: try: value = _GetField(message, field_name.split('.')) nullvalue = None if isinstance(value, list): nullvalue = [] except KeyError: raise exceptions.InvalidDataError( 'No field named %s in message of type %s' % ( field_name, type(message))) _SetField(result, field_name.split('.'), nullvalue) return json.dumps(result) def _GetFieldCodecs(field, attr): result = [ getattr(_CUSTOM_FIELD_CODECS.get(field), attr, None), getattr(_FIELD_TYPE_CODECS.get(type(field)), attr, None), ] return [x for x in result if x is not None] class _ProtoJsonApiTools(protojson.ProtoJson): """JSON encoder used by apitools clients.""" _INSTANCE = None @classmethod def Get(cls): if cls._INSTANCE is None: cls._INSTANCE = cls() return cls._INSTANCE def decode_message(self, message_type, encoded_message): if message_type in _CUSTOM_MESSAGE_CODECS: return _CUSTOM_MESSAGE_CODECS[ message_type].decoder(encoded_message) result = _DecodeCustomFieldNames(message_type, encoded_message) result = super(_ProtoJsonApiTools, self).decode_message( message_type, result) result = _ProcessUnknownEnums(result, encoded_message) result = _ProcessUnknownMessages(result, encoded_message) return _DecodeUnknownFields(result, encoded_message) def decode_field(self, field, value): """Decode the given JSON value. Args: field: a messages.Field for the field we're decoding. value: a python value we'd like to decode. Returns: A value suitable for assignment to field. """ for decoder in _GetFieldCodecs(field, 'decoder'): result = decoder(field, value) value = result.value if result.complete: return value if isinstance(field, messages.MessageField): field_value = self.decode_message( field.message_type, json.dumps(value)) elif isinstance(field, messages.EnumField): value = GetCustomJsonEnumMapping( field.type, json_name=value) or value try: field_value = super( _ProtoJsonApiTools, self).decode_field(field, value) except messages.DecodeError: if not isinstance(value, six.string_types): raise field_value = None else: field_value = super( _ProtoJsonApiTools, self).decode_field(field, value) return field_value def encode_message(self, message): if isinstance(message, messages.FieldList): return '[%s]' % (', '.join(self.encode_message(x) for x in message)) # pylint: disable=unidiomatic-typecheck if type(message) in _CUSTOM_MESSAGE_CODECS: return _CUSTOM_MESSAGE_CODECS[type(message)].encoder(message) message = _EncodeUnknownFields(message) result = super(_ProtoJsonApiTools, self).encode_message(message) result = _EncodeCustomFieldNames(message, result) return json.dumps(json.loads(result), sort_keys=True) def encode_field(self, field, value): """Encode the given value as JSON. Args: field: a messages.Field for the field we're encoding. value: a value for field. Returns: A python value suitable for json.dumps. """ for encoder in _GetFieldCodecs(field, 'encoder'): result = encoder(field, value) value = result.value if result.complete: return value if isinstance(field, messages.EnumField): if field.repeated: remapped_value = [GetCustomJsonEnumMapping( field.type, python_name=e.name) or e.name for e in value] else: remapped_value = GetCustomJsonEnumMapping( field.type, python_name=value.name) if remapped_value: return remapped_value if (isinstance(field, messages.MessageField) and not isinstance(field, message_types.DateTimeField)): value = json.loads(self.encode_message(value)) return super(_ProtoJsonApiTools, self).encode_field(field, value) # TODO(craigcitro): Fold this and _IncludeFields in as codecs. def _DecodeUnknownFields(message, encoded_message): """Rewrite unknown fields in message into message.destination.""" destination = _UNRECOGNIZED_FIELD_MAPPINGS.get(type(message)) if destination is None: return message pair_field = message.field_by_name(destination) if not isinstance(pair_field, messages.MessageField): raise exceptions.InvalidDataFromServerError( 'Unrecognized fields must be mapped to a compound ' 'message type.') pair_type = pair_field.message_type # TODO(craigcitro): Add more error checking around the pair # type being exactly what we suspect (field names, etc). if isinstance(pair_type.value, messages.MessageField): new_values = _DecodeUnknownMessages( message, json.loads(encoded_message), pair_type) else: new_values = _DecodeUnrecognizedFields(message, pair_type) setattr(message, destination, new_values) # We could probably get away with not setting this, but # why not clear it? setattr(message, '_Message__unrecognized_fields', {}) return message def _DecodeUnknownMessages(message, encoded_message, pair_type): """Process unknown fields in encoded_message of a message type.""" field_type = pair_type.value.type new_values = [] all_field_names = [x.name for x in message.all_fields()] for name, value_dict in six.iteritems(encoded_message): if name in all_field_names: continue value = PyValueToMessage(field_type, value_dict) if pair_type.value.repeated: value = _AsMessageList(value) new_pair = pair_type(key=name, value=value) new_values.append(new_pair) return new_values def _DecodeUnrecognizedFields(message, pair_type): """Process unrecognized fields in message.""" new_values = [] codec = _ProtoJsonApiTools.Get() for unknown_field in message.all_unrecognized_fields(): # TODO(craigcitro): Consider validating the variant if # the assignment below doesn't take care of it. It may # also be necessary to check it in the case that the # type has multiple encodings. value, _ = message.get_unrecognized_field_info(unknown_field) value_type = pair_type.field_by_name('value') if isinstance(value_type, messages.MessageField): decoded_value = DictToMessage(value, pair_type.value.message_type) else: decoded_value = codec.decode_field( pair_type.value, value) try: new_pair_key = str(unknown_field) except UnicodeEncodeError: new_pair_key = protojson.ProtoJson().decode_field( pair_type.key, unknown_field) new_pair = pair_type(key=new_pair_key, value=decoded_value) new_values.append(new_pair) return new_values def _CopyProtoMessageVanillaProtoJson(message): codec = protojson.ProtoJson() return codec.decode_message(type(message), codec.encode_message(message)) def _EncodeUnknownFields(message): """Remap unknown fields in message out of message.source.""" source = _UNRECOGNIZED_FIELD_MAPPINGS.get(type(message)) if source is None: return message # CopyProtoMessage uses _ProtoJsonApiTools, which uses this message. Use # the vanilla protojson-based copy function to avoid infinite recursion. result = _CopyProtoMessageVanillaProtoJson(message) pairs_field = message.field_by_name(source) if not isinstance(pairs_field, messages.MessageField): raise exceptions.InvalidUserInputError( 'Invalid pairs field %s' % pairs_field) pairs_type = pairs_field.message_type value_field = pairs_type.field_by_name('value') value_variant = value_field.variant pairs = getattr(message, source) codec = _ProtoJsonApiTools.Get() for pair in pairs: encoded_value = codec.encode_field(value_field, pair.value) result.set_unrecognized_field(pair.key, encoded_value, value_variant) setattr(result, source, []) return result def _SafeEncodeBytes(field, value): """Encode the bytes in value as urlsafe base64.""" try: if field.repeated: result = [base64.urlsafe_b64encode(byte) for byte in value] else: result = base64.urlsafe_b64encode(value) complete = True except TypeError: result = value complete = False return CodecResult(value=result, complete=complete) def _SafeDecodeBytes(unused_field, value): """Decode the urlsafe base64 value into bytes.""" try: result = base64.urlsafe_b64decode(str(value)) complete = True except TypeError: result = value complete = False return CodecResult(value=result, complete=complete) def _ProcessUnknownEnums(message, encoded_message): """Add unknown enum values from encoded_message as unknown fields. ProtoRPC diverges from the usual protocol buffer behavior here and doesn't allow unknown fields. Throwing on unknown fields makes it impossible to let servers add new enum values and stay compatible with older clients, which isn't reasonable for us. We simply store unrecognized enum values as unknown fields, and all is well. Args: message: Proto message we've decoded thus far. encoded_message: JSON string we're decoding. Returns: message, with any unknown enums stored as unrecognized fields. """ if not encoded_message: return message decoded_message = json.loads(six.ensure_str(encoded_message)) for field in message.all_fields(): if (isinstance(field, messages.EnumField) and field.name in decoded_message): value = message.get_assigned_value(field.name) if ((field.repeated and len(value) != len(decoded_message[field.name])) or value is None): message.set_unrecognized_field( field.name, decoded_message[field.name], messages.Variant.ENUM) return message def _ProcessUnknownMessages(message, encoded_message): """Store any remaining unknown fields as strings. ProtoRPC currently ignores unknown values for which no type can be determined (and logs a "No variant found" message). For the purposes of reserializing, this is quite harmful (since it throws away information). Here we simply add those as unknown fields of type string (so that they can easily be reserialized). Args: message: Proto message we've decoded thus far. encoded_message: JSON string we're decoding. Returns: message, with any remaining unrecognized fields saved. """ if not encoded_message: return message decoded_message = json.loads(six.ensure_str(encoded_message)) message_fields = [x.name for x in message.all_fields()] + list( message.all_unrecognized_fields()) missing_fields = [x for x in decoded_message.keys() if x not in message_fields] for field_name in missing_fields: message.set_unrecognized_field(field_name, decoded_message[field_name], messages.Variant.STRING) return message RegisterFieldTypeCodec(_SafeEncodeBytes, _SafeDecodeBytes)(messages.BytesField) # Note that these could share a dictionary, since they're keyed by # distinct types, but it's not really worth it. _JSON_ENUM_MAPPINGS = {} _JSON_FIELD_MAPPINGS = {} def AddCustomJsonEnumMapping(enum_type, python_name, json_name, package=None): # pylint: disable=unused-argument """Add a custom wire encoding for a given enum value. This is primarily used in generated code, to handle enum values which happen to be Python keywords. Args: enum_type: (messages.Enum) An enum type python_name: (basestring) Python name for this value. json_name: (basestring) JSON name to be used on the wire. package: (NoneType, optional) No effect, exists for legacy compatibility. """ if not issubclass(enum_type, messages.Enum): raise exceptions.TypecheckError( 'Cannot set JSON enum mapping for non-enum "%s"' % enum_type) if python_name not in enum_type.names(): raise exceptions.InvalidDataError( 'Enum value %s not a value for type %s' % (python_name, enum_type)) field_mappings = _JSON_ENUM_MAPPINGS.setdefault(enum_type, {}) _CheckForExistingMappings('enum', enum_type, python_name, json_name) field_mappings[python_name] = json_name def AddCustomJsonFieldMapping(message_type, python_name, json_name, package=None): # pylint: disable=unused-argument """Add a custom wire encoding for a given message field. This is primarily used in generated code, to handle enum values which happen to be Python keywords. Args: message_type: (messages.Message) A message type python_name: (basestring) Python name for this value. json_name: (basestring) JSON name to be used on the wire. package: (NoneType, optional) No effect, exists for legacy compatibility. """ if not issubclass(message_type, messages.Message): raise exceptions.TypecheckError( 'Cannot set JSON field mapping for ' 'non-message "%s"' % message_type) try: _ = message_type.field_by_name(python_name) except KeyError: raise exceptions.InvalidDataError( 'Field %s not recognized for type %s' % ( python_name, message_type)) field_mappings = _JSON_FIELD_MAPPINGS.setdefault(message_type, {}) _CheckForExistingMappings('field', message_type, python_name, json_name) field_mappings[python_name] = json_name def GetCustomJsonEnumMapping(enum_type, python_name=None, json_name=None): """Return the appropriate remapping for the given enum, or None.""" return _FetchRemapping(enum_type, 'enum', python_name=python_name, json_name=json_name, mappings=_JSON_ENUM_MAPPINGS) def GetCustomJsonFieldMapping(message_type, python_name=None, json_name=None): """Return the appropriate remapping for the given field, or None.""" return _FetchRemapping(message_type, 'field', python_name=python_name, json_name=json_name, mappings=_JSON_FIELD_MAPPINGS) def _FetchRemapping(type_name, mapping_type, python_name=None, json_name=None, mappings=None): """Common code for fetching a key or value from a remapping dict.""" if python_name and json_name: raise exceptions.InvalidDataError( 'Cannot specify both python_name and json_name ' 'for %s remapping' % mapping_type) if not (python_name or json_name): raise exceptions.InvalidDataError( 'Must specify either python_name or json_name for %s remapping' % ( mapping_type,)) field_remappings = mappings.get(type_name, {}) if field_remappings: if python_name: return field_remappings.get(python_name) elif json_name: if json_name in list(field_remappings.values()): return [k for k in field_remappings if field_remappings[k] == json_name][0] return None def _CheckForExistingMappings(mapping_type, message_type, python_name, json_name): """Validate that no mappings exist for the given values.""" if mapping_type == 'field': getter = GetCustomJsonFieldMapping elif mapping_type == 'enum': getter = GetCustomJsonEnumMapping remapping = getter(message_type, python_name=python_name) if remapping is not None and remapping != json_name: raise exceptions.InvalidDataError( 'Cannot add mapping for %s "%s", already mapped to "%s"' % ( mapping_type, python_name, remapping)) remapping = getter(message_type, json_name=json_name) if remapping is not None and remapping != python_name: raise exceptions.InvalidDataError( 'Cannot add mapping for %s "%s", already mapped to "%s"' % ( mapping_type, json_name, remapping)) def _EncodeCustomFieldNames(message, encoded_value): field_remappings = list(_JSON_FIELD_MAPPINGS.get(type(message), {}) .items()) if field_remappings: decoded_value = json.loads(encoded_value) for python_name, json_name in field_remappings: if python_name in encoded_value: decoded_value[json_name] = decoded_value.pop(python_name) encoded_value = json.dumps(decoded_value) return encoded_value def _DecodeCustomFieldNames(message_type, encoded_message): field_remappings = _JSON_FIELD_MAPPINGS.get(message_type, {}) if field_remappings: decoded_message = json.loads(encoded_message) for python_name, json_name in list(field_remappings.items()): if json_name in decoded_message: decoded_message[python_name] = decoded_message.pop(json_name) encoded_message = json.dumps(decoded_message) return encoded_message def _AsMessageList(msg): """Convert the provided list-as-JsonValue to a list.""" # This really needs to live in extra_types, but extra_types needs # to import this file to be able to register codecs. # TODO(craigcitro): Split out a codecs module and fix this ugly # import. from apitools.base.py import extra_types def _IsRepeatedJsonValue(msg): """Return True if msg is a repeated value as a JsonValue.""" if isinstance(msg, extra_types.JsonArray): return True if isinstance(msg, extra_types.JsonValue) and msg.array_value: return True return False if not _IsRepeatedJsonValue(msg): raise ValueError('invalid argument to _AsMessageList') if isinstance(msg, extra_types.JsonValue): msg = msg.array_value if isinstance(msg, extra_types.JsonArray): msg = msg.entries return msg def _IsMap(message, field): """Returns whether the "field" is actually a map-type.""" value = message.get_assigned_value(field.name) if not isinstance(value, messages.Message): return False try: additional_properties = value.field_by_name('additionalProperties') except KeyError: return False else: return additional_properties.repeated def _MapItems(message, field): """Yields the (key, value) pair of the map values.""" assert _IsMap(message, field) map_message = message.get_assigned_value(field.name) additional_properties = map_message.get_assigned_value( 'additionalProperties') for kv_pair in additional_properties: yield kv_pair.key, kv_pair.value def UnrecognizedFieldIter(message, _edges=()): # pylint: disable=invalid-name """Yields the locations of unrecognized fields within "message". If a sub-message is found to have unrecognized fields, that sub-message will not be searched any further. We prune the search of the sub-message because we assume it is malformed and further checks will not yield productive errors. Args: message: The Message instance to search. _edges: Internal arg for passing state. Yields: (edges_to_message, field_names): edges_to_message: List[ProtoEdge], The edges (relative to "message") describing the path to the sub-message where the unrecognized fields were found. field_names: List[Str], The names of the field(s) that were unrecognized in the sub-message. """ if not isinstance(message, messages.Message): # This is a primitive leaf, no errors found down this path. return field_names = message.all_unrecognized_fields() if field_names: # This message is malformed. Stop recursing and report it. yield _edges, field_names return # Recurse through all fields in the current message. for field in message.all_fields(): value = message.get_assigned_value(field.name) if field.repeated: for i, item in enumerate(value): repeated_edge = ProtoEdge(EdgeType.REPEATED, field.name, i) iter_ = UnrecognizedFieldIter(item, _edges + (repeated_edge,)) for (e, y) in iter_: yield e, y elif _IsMap(message, field): for key, item in _MapItems(message, field): map_edge = ProtoEdge(EdgeType.MAP, field.name, key) iter_ = UnrecognizedFieldIter(item, _edges + (map_edge,)) for (e, y) in iter_: yield e, y else: scalar_edge = ProtoEdge(EdgeType.SCALAR, field.name, None) iter_ = UnrecognizedFieldIter(value, _edges + (scalar_edge,)) for (e, y) in iter_: yield e, y py/batch_test.py 0000644 00000061360 15025317163 0007677 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for apitools.base.py.batch.""" import textwrap import unittest import mock from six.moves import http_client from six.moves import range # pylint:disable=redefined-builtin from six.moves.urllib import parse from apitools.base.py import batch from apitools.base.py import exceptions from apitools.base.py import http_wrapper class FakeCredentials(object): def __init__(self): self.num_refreshes = 0 def refresh(self, _): self.num_refreshes += 1 class FakeHttp(object): class FakeRequest(object): def __init__(self, credentials=None): if credentials is not None: self.credentials = credentials def __init__(self, credentials=None): self.request = FakeHttp.FakeRequest(credentials=credentials) class FakeService(object): """A service for testing.""" def GetMethodConfig(self, _): return {} def GetUploadConfig(self, _): return {} # pylint: disable=unused-argument def PrepareHttpRequest( self, method_config, request, global_params, upload_config): return global_params['desired_request'] # pylint: enable=unused-argument def ProcessHttpResponse(self, _, http_response): return http_response class BatchTest(unittest.TestCase): def assertUrlEqual(self, expected_url, provided_url): def parse_components(url): parsed = parse.urlsplit(url) query = parse.parse_qs(parsed.query) return parsed._replace(query=''), query expected_parse, expected_query = parse_components(expected_url) provided_parse, provided_query = parse_components(provided_url) self.assertEqual(expected_parse, provided_parse) self.assertEqual(expected_query, provided_query) def __ConfigureMock(self, mock_request, expected_request, response): if isinstance(response, list): response = list(response) def CheckRequest(_, request, **unused_kwds): self.assertUrlEqual(expected_request.url, request.url) self.assertEqual(expected_request.http_method, request.http_method) if isinstance(response, list): return response.pop(0) return response mock_request.side_effect = CheckRequest def testRequestServiceUnavailable(self): mock_service = FakeService() desired_url = 'https://www.example.com' batch_api_request = batch.BatchApiRequest(batch_url=desired_url, retryable_codes=[]) # The request to be added. The actual request sent will be somewhat # larger, as this is added to a batch. desired_request = http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 419, }, 'x' * 419), http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+0> HTTP/1.1 503 SERVICE UNAVAILABLE nope --boundary--"""), None)) batch_api_request.Add( mock_service, 'unused', None, global_params={'desired_request': desired_request}) api_request_responses = batch_api_request.Execute( FakeHttp(), sleep_between_polls=0) self.assertEqual(1, len(api_request_responses)) # Make sure we didn't retry non-retryable code 503. self.assertEqual(1, mock_request.call_count) self.assertTrue(api_request_responses[0].is_error) self.assertIsNone(api_request_responses[0].response) self.assertIsInstance(api_request_responses[0].exception, exceptions.HttpError) def testSingleRequestInBatch(self): desired_url = 'https://www.example.com' callback_was_called = [] def _Callback(response, exception): self.assertEqual({'status': '200'}, response.info) self.assertEqual('content', response.content) self.assertEqual(desired_url, response.request_url) self.assertIsNone(exception) callback_was_called.append(1) mock_service = FakeService() batch_api_request = batch.BatchApiRequest(batch_url=desired_url) # The request to be added. The actual request sent will be somewhat # larger, as this is added to a batch. desired_request = http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 419, }, 'x' * 419), http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+0> HTTP/1.1 200 OK content --boundary--"""), None)) batch_api_request.Add(mock_service, 'unused', None, { 'desired_request': desired_request, }) api_request_responses = batch_api_request.Execute( FakeHttp(), batch_request_callback=_Callback) self.assertEqual(1, len(api_request_responses)) self.assertEqual(1, mock_request.call_count) self.assertFalse(api_request_responses[0].is_error) response = api_request_responses[0].response self.assertEqual({'status': '200'}, response.info) self.assertEqual('content', response.content) self.assertEqual(desired_url, response.request_url) self.assertEqual(1, len(callback_was_called)) def _MakeResponse(self, number_of_parts): return http_wrapper.Response( info={ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, content='--boundary\n' + '--boundary\n'.join( textwrap.dedent("""\ content-type: text/plain content-id: <id+{0}> HTTP/1.1 200 OK response {0} content """) .format(i) for i in range(number_of_parts)) + '--boundary--', request_url=None, ) def _MakeSampleRequest(self, url, name): return http_wrapper.Request(url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, '{0} {1}'.format(name, 'x' * (79 - len(name)))) def testMultipleRequestInBatchWithMax(self): mock_service = FakeService() desired_url = 'https://www.example.com' batch_api_request = batch.BatchApiRequest(batch_url=desired_url) number_of_requests = 10 max_batch_size = 3 for i in range(number_of_requests): batch_api_request.Add( mock_service, 'unused', None, {'desired_request': self._MakeSampleRequest( desired_url, 'Sample-{0}'.format(i))}) responses = [] for i in range(0, number_of_requests, max_batch_size): responses.append( self._MakeResponse( min(number_of_requests - i, max_batch_size))) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, expected_request=http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 1142, }, 'x' * 1142), response=responses) api_request_responses = batch_api_request.Execute( FakeHttp(), max_batch_size=max_batch_size) self.assertEqual(number_of_requests, len(api_request_responses)) self.assertEqual( -(-number_of_requests // max_batch_size), mock_request.call_count) def testRefreshOnAuthFailure(self): mock_service = FakeService() desired_url = 'https://www.example.com' batch_api_request = batch.BatchApiRequest(batch_url=desired_url) # The request to be added. The actual request sent will be somewhat # larger, as this is added to a batch. desired_request = http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80) with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 419, }, 'x' * 419), [ http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+0> HTTP/1.1 401 UNAUTHORIZED Invalid grant --boundary--"""), None), http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+0> HTTP/1.1 200 OK content --boundary--"""), None) ]) batch_api_request.Add(mock_service, 'unused', None, { 'desired_request': desired_request, }) credentials = FakeCredentials() api_request_responses = batch_api_request.Execute( FakeHttp(credentials=credentials), sleep_between_polls=0) self.assertEqual(1, len(api_request_responses)) self.assertEqual(2, mock_request.call_count) self.assertEqual(1, credentials.num_refreshes) self.assertFalse(api_request_responses[0].is_error) response = api_request_responses[0].response self.assertEqual({'status': '200'}, response.info) self.assertEqual('content', response.content) self.assertEqual(desired_url, response.request_url) def testNoAttempts(self): desired_url = 'https://www.example.com' batch_api_request = batch.BatchApiRequest(batch_url=desired_url) batch_api_request.Add(FakeService(), 'unused', None, { 'desired_request': http_wrapper.Request(desired_url, 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80), }) api_request_responses = batch_api_request.Execute(None, max_retries=0) self.assertEqual(1, len(api_request_responses)) self.assertIsNone(api_request_responses[0].response) self.assertIsNone(api_request_responses[0].exception) def _DoTestConvertIdToHeader(self, test_id, expected_result): batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertEqual( expected_result % batch_request._BatchHttpRequest__base_id, batch_request._ConvertIdToHeader(test_id)) def testConvertIdSimple(self): self._DoTestConvertIdToHeader('blah', '<%s+blah>') def testConvertIdThatNeedsEscaping(self): self._DoTestConvertIdToHeader(' space1', '<%s+%%20space1>') def _DoTestConvertHeaderToId(self, header, expected_id): batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertEqual(expected_id, batch_request._ConvertHeaderToId(header)) def testConvertHeaderToIdSimple(self): self._DoTestConvertHeaderToId('<hello+blah>', 'blah') def testConvertHeaderToIdWithLotsOfPlus(self): self._DoTestConvertHeaderToId('<a+++++plus>', 'plus') def _DoTestConvertInvalidHeaderToId(self, invalid_header): batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertRaises(exceptions.BatchError, batch_request._ConvertHeaderToId, invalid_header) def testHeaderWithoutAngleBrackets(self): self._DoTestConvertInvalidHeaderToId('1+1') def testHeaderWithoutPlus(self): self._DoTestConvertInvalidHeaderToId('<HEADER>') def testSerializeRequest(self): request = http_wrapper.Request(body='Hello World', headers={ 'content-type': 'protocol/version', }) expected_serialized_request = '\n'.join([ 'GET HTTP/1.1', 'Content-Type: protocol/version', 'MIME-Version: 1.0', 'content-length: 11', 'Host: ', '', 'Hello World', ]) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertEqual(expected_serialized_request, batch_request._SerializeRequest(request)) def testSerializeRequestPreservesHeaders(self): # Now confirm that if an additional, arbitrary header is added # that it is successfully serialized to the request. Merely # check that it is included, because the order of the headers # in the request is arbitrary. request = http_wrapper.Request(body='Hello World', headers={ 'content-type': 'protocol/version', 'key': 'value', }) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertTrue( 'key: value\n' in batch_request._SerializeRequest(request)) def testSerializeRequestNoBody(self): request = http_wrapper.Request(body=None, headers={ 'content-type': 'protocol/version', }) expected_serialized_request = '\n'.join([ 'GET HTTP/1.1', 'Content-Type: protocol/version', 'MIME-Version: 1.0', 'Host: ', '', '', ]) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertEqual(expected_serialized_request, batch_request._SerializeRequest(request)) def testSerializeRequestWithPathAndQueryParams(self): request = http_wrapper.Request( url='my/path?query=param', body='Hello World', headers={'content-type': 'protocol/version'}) expected_serialized_request = '\n'.join([ 'GET my/path?query=param HTTP/1.1', 'Content-Type: protocol/version', 'MIME-Version: 1.0', 'content-length: 11', 'Host: ', '', 'Hello World', ]) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertEqual(expected_serialized_request, batch_request._SerializeRequest(request)) def testDeserializeRequest(self): serialized_payload = '\n'.join([ 'GET HTTP/1.1', 'Content-Type: protocol/version', 'MIME-Version: 1.0', 'content-length: 11', 'key: value', 'Host: ', '', 'Hello World', ]) example_url = 'https://www.example.com' expected_response = http_wrapper.Response({ 'content-length': str(len('Hello World')), 'Content-Type': 'protocol/version', 'key': 'value', 'MIME-Version': '1.0', 'status': '', 'Host': '' }, 'Hello World', example_url) batch_request = batch.BatchHttpRequest(example_url) self.assertEqual( expected_response, batch_request._DeserializeResponse(serialized_payload)) def testNewId(self): batch_request = batch.BatchHttpRequest('https://www.example.com') for i in range(100): self.assertEqual(str(i), batch_request._NewId()) def testAdd(self): batch_request = batch.BatchHttpRequest('https://www.example.com') for x in range(100): batch_request.Add(http_wrapper.Request(body=str(x))) for key in batch_request._BatchHttpRequest__request_response_handlers: value = batch_request._BatchHttpRequest__request_response_handlers[ key] self.assertEqual(key, value.request.body) self.assertFalse(value.request.url) self.assertEqual('GET', value.request.http_method) self.assertIsNone(value.response) self.assertIsNone(value.handler) def testInternalExecuteWithFailedRequest(self): with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request('https://www.example.com', 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80), http_wrapper.Response({'status': '300'}, None, None)) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertRaises( exceptions.HttpError, batch_request._Execute, None) def testInternalExecuteWithNonMultipartResponse(self): with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request('https://www.example.com', 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 80, }, 'x' * 80), http_wrapper.Response({ 'status': '200', 'content-type': 'blah/blah' }, '', None)) batch_request = batch.BatchHttpRequest('https://www.example.com') self.assertRaises( exceptions.BatchError, batch_request._Execute, None) def testInternalExecute(self): with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request('https://www.example.com', 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 583, }, 'x' * 583), http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+2> HTTP/1.1 200 OK Second response --boundary content-type: text/plain content-id: <id+1> HTTP/1.1 401 UNAUTHORIZED First response --boundary--"""), None)) test_requests = { '1': batch.RequestResponseAndHandler( http_wrapper.Request(body='first'), None, None), '2': batch.RequestResponseAndHandler( http_wrapper.Request(body='second'), None, None), } batch_request = batch.BatchHttpRequest('https://www.example.com') batch_request._BatchHttpRequest__request_response_handlers = ( test_requests) batch_request._Execute(FakeHttp()) test_responses = ( batch_request._BatchHttpRequest__request_response_handlers) self.assertEqual(http_client.UNAUTHORIZED, test_responses['1'].response.status_code) self.assertEqual(http_client.OK, test_responses['2'].response.status_code) self.assertIn( 'First response', test_responses['1'].response.content) self.assertIn( 'Second response', test_responses['2'].response.content) def testInternalExecuteWithEncodedResponse(self): with mock.patch.object(http_wrapper, 'MakeRequest', autospec=True) as mock_request: self.__ConfigureMock( mock_request, http_wrapper.Request('https://www.example.com', 'POST', { 'content-type': 'multipart/mixed; boundary="None"', 'content-length': 274, }, 'x' * 274), http_wrapper.Response({ 'status': '200', 'content-type': 'multipart/mixed; boundary="boundary"', }, textwrap.dedent("""\ --boundary content-type: text/plain content-id: <id+1> HTTP/1.1 200 OK response --boundary--""").encode('utf-8'), None)) test_request = { '1': batch.RequestResponseAndHandler( http_wrapper.Request(body='first'), None, None), } batch_request = batch.BatchHttpRequest('https://www.example.com', response_encoding='utf-8') batch_request._BatchHttpRequest__request_response_handlers = ( test_request) batch_request._Execute(FakeHttp()) test_responses = ( batch_request._BatchHttpRequest__request_response_handlers) self.assertEqual(http_client.OK, test_responses['1'].response.status_code) self.assertIn( 'response', test_responses['1'].response.content) def testPublicExecute(self): def LocalCallback(response, exception): self.assertEqual({'status': '418'}, response.info) self.assertEqual('Teapot', response.content) self.assertIsNone(response.request_url) self.assertIsInstance(exception, exceptions.HttpError) global_callback = mock.Mock() batch_request = batch.BatchHttpRequest( 'https://www.example.com', global_callback) with mock.patch.object(batch.BatchHttpRequest, '_Execute', autospec=True) as mock_execute: mock_execute.return_value = None test_requests = { '0': batch.RequestResponseAndHandler( None, http_wrapper.Response({'status': '200'}, 'Hello!', None), None), '1': batch.RequestResponseAndHandler( None, http_wrapper.Response({'status': '418'}, 'Teapot', None), LocalCallback), } batch_request._BatchHttpRequest__request_response_handlers = ( test_requests) batch_request.Execute(None) # Global callback was called once per handler. self.assertEqual(len(test_requests), global_callback.call_count) py/gzip_test.py 0000644 00000042263 15025317163 0007570 0 ustar 00 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, # 2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation; All # Rights Reserved # # This is a backport from python 3.4 into python 2.7. Text and exclusive mode # support are removed as they're unsupported in 2.7. This backport patches a # streaming bug that exists in python 2.7. """Test script for the gzip module. """ import six from six.moves import range import unittest import os import io import struct from apitools.base.py import gzip from io import open data1 = b""" int length=DEFAULTALLOC, err = Z_OK; PyObject *RetVal; int flushmode = Z_FINISH; unsigned long start_total_out; """ data2 = b"""/* zlibmodule.c -- gzip-compatible data compression */ /* See http://www.gzip.org/zlib/ /* See http://www.winimage.com/zLibDll for Windows */ """ def unlink(filename): try: os.unlink(filename) except: pass class UnseekableIO(io.BytesIO): def seekable(self): return False def tell(self): raise io.UnsupportedOperation def seek(self, *args): raise io.UnsupportedOperation class BaseTest(unittest.TestCase): filename = "@test" def setUp(self): unlink(self.filename) def tearDown(self): unlink(self.filename) class TestGzip(BaseTest): def write_and_read_back(self, data, mode='b'): b_data = bytes(data) with gzip.GzipFile(self.filename, 'w' + mode) as f: l = f.write(data) self.assertEqual(l, len(b_data)) with gzip.GzipFile(self.filename, 'r' + mode) as f: self.assertEqual(f.read(), b_data) def test_write(self): with gzip.GzipFile(self.filename, 'wb') as f: f.write(data1 * 50) # Try flush and fileno. f.flush() f.fileno() if hasattr(os, 'fsync'): os.fsync(f.fileno()) f.close() # Test multiple close() calls. f.close() # The following test_write_xy methods test that write accepts # the corresponding bytes-like object type as input # and that the data written equals bytes(xy) in all cases. def test_write_memoryview(self): data = memoryview(data1 * 50) self.write_and_read_back(data.tobytes()) data = memoryview(bytes(range(256))) self.write_and_read_back(data.tobytes()) def test_write_incompatible_type(self): # Test that non-bytes-like types raise TypeError. # Issue #21560: attempts to write incompatible types # should not affect the state of the fileobject with gzip.GzipFile(self.filename, 'wb') as f: if six.PY2: with self.assertRaises(UnicodeEncodeError): f.write(u'\xff') elif six.PY3: with self.assertRaises(TypeError): f.write(u'\xff') with self.assertRaises(TypeError): f.write([1]) f.write(data1) with gzip.GzipFile(self.filename, 'rb') as f: self.assertEqual(f.read(), data1) def test_read(self): self.test_write() # Try reading. with gzip.GzipFile(self.filename, 'r') as f: d = f.read() self.assertEqual(d, data1 * 50) def test_read1(self): self.test_write() blocks = [] nread = 0 with gzip.GzipFile(self.filename, 'r') as f: while True: d = f.read1() if not d: break blocks.append(d) nread += len(d) # Check that position was updated correctly (see issue10791). self.assertEqual(f.tell(), nread) self.assertEqual(b''.join(blocks), data1 * 50) def test_io_on_closed_object(self): # Test that I/O operations on closed GzipFile objects raise a # ValueError, just like the corresponding functions on file objects. # Write to a file, open it for reading, then close it. self.test_write() f = gzip.GzipFile(self.filename, 'r') f.close() with self.assertRaises(ValueError): f.read(1) with self.assertRaises(ValueError): f.seek(0) with self.assertRaises(ValueError): f.tell() # Open the file for writing, then close it. f = gzip.GzipFile(self.filename, 'w') f.close() with self.assertRaises(ValueError): f.write(b'') with self.assertRaises(ValueError): f.flush() def test_append(self): self.test_write() # Append to the previous file with gzip.GzipFile(self.filename, 'ab') as f: f.write(data2 * 15) with gzip.GzipFile(self.filename, 'rb') as f: d = f.read() self.assertEqual(d, (data1 * 50) + (data2 * 15)) def test_many_append(self): # Bug #1074261 was triggered when reading a file that contained # many, many members. Create such a file and verify that reading it # works. with gzip.GzipFile(self.filename, 'wb', 9) as f: f.write(b'a') for i in range(0, 200): with gzip.GzipFile(self.filename, "ab", 9) as f: # append f.write(b'a') # Try reading the file with gzip.GzipFile(self.filename, "rb") as zgfile: contents = b"" while 1: ztxt = zgfile.read(8192) contents += ztxt if not ztxt: break self.assertEqual(contents, b'a' * 201) def test_buffered_reader(self): # Issue #7471: a GzipFile can be wrapped in a BufferedReader for # performance. self.test_write() with gzip.GzipFile(self.filename, 'rb') as f: with io.BufferedReader(f) as r: lines = [line for line in r] self.assertEqual(lines, 50 * data1.splitlines(True)) def test_readline(self): self.test_write() # Try .readline() with varying line lengths with gzip.GzipFile(self.filename, 'rb') as f: line_length = 0 while 1: L = f.readline(line_length) if not L and line_length != 0: break self.assertTrue(len(L) <= line_length) line_length = (line_length + 1) % 50 def test_readlines(self): self.test_write() # Try .readlines() with gzip.GzipFile(self.filename, 'rb') as f: L = f.readlines() with gzip.GzipFile(self.filename, 'rb') as f: while 1: L = f.readlines(150) if L == []: break def test_seek_read(self): self.test_write() # Try seek, read test with gzip.GzipFile(self.filename) as f: while 1: oldpos = f.tell() line1 = f.readline() if not line1: break newpos = f.tell() f.seek(oldpos) # negative seek if len(line1) > 10: amount = 10 else: amount = len(line1) line2 = f.read(amount) self.assertEqual(line1[:amount], line2) f.seek(newpos) # positive seek def test_seek_whence(self): self.test_write() # Try seek(whence=1), read test with gzip.GzipFile(self.filename) as f: f.read(10) f.seek(10, whence=1) y = f.read(10) self.assertEqual(y, data1[20:30]) def test_seek_write(self): # Try seek, write test with gzip.GzipFile(self.filename, 'w') as f: for pos in range(0, 256, 16): f.seek(pos) f.write(b'GZ\n') def test_mode(self): self.test_write() with gzip.GzipFile(self.filename, 'r') as f: self.assertEqual(f.myfileobj.mode, 'rb') def test_1647484(self): for mode in ('wb', 'rb'): with gzip.GzipFile(self.filename, mode) as f: self.assertTrue(hasattr(f, "name")) self.assertEqual(f.name, self.filename) def test_paddedfile_getattr(self): self.test_write() with gzip.GzipFile(self.filename, 'rb') as f: self.assertTrue(hasattr(f.fileobj, "name")) self.assertEqual(f.fileobj.name, self.filename) def test_mtime(self): mtime = 123456789 with gzip.GzipFile(self.filename, 'w', mtime=mtime) as fWrite: fWrite.write(data1) with gzip.GzipFile(self.filename) as fRead: dataRead = fRead.read() self.assertEqual(dataRead, data1) self.assertTrue(hasattr(fRead, 'mtime')) self.assertEqual(fRead.mtime, mtime) def test_metadata(self): mtime = 123456789 with gzip.GzipFile(self.filename, 'w', mtime=mtime) as fWrite: fWrite.write(data1) with open(self.filename, 'rb') as fRead: # see RFC 1952: http://www.faqs.org/rfcs/rfc1952.html idBytes = fRead.read(2) self.assertEqual(idBytes, b'\x1f\x8b') # gzip ID cmByte = fRead.read(1) self.assertEqual(cmByte, b'\x08') # deflate flagsByte = fRead.read(1) self.assertEqual(flagsByte, b'\x08') # only the FNAME flag is set mtimeBytes = fRead.read(4) self.assertEqual(mtimeBytes, struct.pack( '<i', mtime)) # little-endian xflByte = fRead.read(1) self.assertEqual(xflByte, b'\x02') # maximum compression osByte = fRead.read(1) self.assertEqual(osByte, b'\xff') # OS "unknown" (OS-independent) # Since the FNAME flag is set, the zero-terminated filename # follows. RFC 1952 specifies that this is the name of the input # file, if any. However, the gzip module defaults to storing the # name of the output file in this field. expected = self.filename.encode('Latin-1') + b'\x00' nameBytes = fRead.read(len(expected)) self.assertEqual(nameBytes, expected) # Since no other flags were set, the header ends here. Rather than # process the compressed data, let's seek to the trailer. fRead.seek(os.stat(self.filename).st_size - 8) crc32Bytes = fRead.read(4) # CRC32 of uncompressed data [data1] self.assertEqual(crc32Bytes, b'\xaf\xd7d\x83') isizeBytes = fRead.read(4) self.assertEqual(isizeBytes, struct.pack('<i', len(data1))) def test_with_open(self): # GzipFile supports the context management protocol with gzip.GzipFile(self.filename, "wb") as f: f.write(b"xxx") f = gzip.GzipFile(self.filename, "rb") f.close() try: with f: pass except ValueError: pass else: self.fail("__enter__ on a closed file didn't raise an exception") try: with gzip.GzipFile(self.filename, "wb") as f: 1 / 0 except ZeroDivisionError: pass else: self.fail("1/0 didn't raise an exception") def test_zero_padded_file(self): with gzip.GzipFile(self.filename, "wb") as f: f.write(data1 * 50) # Pad the file with zeroes with open(self.filename, "ab") as f: f.write(b"\x00" * 50) with gzip.GzipFile(self.filename, "rb") as f: d = f.read() self.assertEqual(d, data1 * 50, "Incorrect data in file") def test_non_seekable_file(self): uncompressed = data1 * 50 buf = UnseekableIO() with gzip.GzipFile(fileobj=buf, mode="wb") as f: f.write(uncompressed) compressed = buf.getvalue() buf = UnseekableIO(compressed) with gzip.GzipFile(fileobj=buf, mode="rb") as f: self.assertEqual(f.read(), uncompressed) def test_peek(self): uncompressed = data1 * 200 with gzip.GzipFile(self.filename, "wb") as f: f.write(uncompressed) def sizes(): while True: for n in range(5, 50, 10): yield n with gzip.GzipFile(self.filename, "rb") as f: f.max_read_chunk = 33 nread = 0 for n in sizes(): s = f.peek(n) if s == b'': break self.assertEqual(f.read(len(s)), s) nread += len(s) self.assertEqual(f.read(100), b'') self.assertEqual(nread, len(uncompressed)) def test_textio_readlines(self): # Issue #10791: TextIOWrapper.readlines() fails when wrapping GzipFile. lines = (data1 * 50).decode("ascii").splitlines(True) self.test_write() with gzip.GzipFile(self.filename, 'r') as f: with io.TextIOWrapper(f, encoding="ascii") as t: self.assertEqual(t.readlines(), lines) def test_fileobj_from_fdopen(self): # Issue #13781: Opening a GzipFile for writing fails when using a # fileobj created with os.fdopen(). fd = os.open(self.filename, os.O_WRONLY | os.O_CREAT) with os.fdopen(fd, "wb") as f: with gzip.GzipFile(fileobj=f, mode="w") as g: pass def test_bytes_filename(self): str_filename = self.filename try: bytes_filename = str_filename.encode("ascii") except UnicodeEncodeError: self.skipTest("Temporary file name needs to be ASCII") with gzip.GzipFile(bytes_filename, "wb") as f: f.write(data1 * 50) with gzip.GzipFile(bytes_filename, "rb") as f: self.assertEqual(f.read(), data1 * 50) # Sanity check that we are actually operating on the right file. with gzip.GzipFile(str_filename, "rb") as f: self.assertEqual(f.read(), data1 * 50) # Testing compress/decompress shortcut functions def test_compress(self): for data in [data1, data2]: for args in [(), (1,), (6,), (9,)]: datac = gzip.compress(data, *args) self.assertEqual(type(datac), bytes) with gzip.GzipFile(fileobj=io.BytesIO(datac), mode="rb") as f: self.assertEqual(f.read(), data) def test_decompress(self): for data in (data1, data2): buf = io.BytesIO() with gzip.GzipFile(fileobj=buf, mode="wb") as f: f.write(data) self.assertEqual(gzip.decompress(buf.getvalue()), data) # Roundtrip with compress datac = gzip.compress(data) self.assertEqual(gzip.decompress(datac), data) def test_read_truncated(self): data = data1 * 50 # Drop the CRC (4 bytes) and file size (4 bytes). truncated = gzip.compress(data)[:-8] with gzip.GzipFile(fileobj=io.BytesIO(truncated)) as f: self.assertRaises(EOFError, f.read) with gzip.GzipFile(fileobj=io.BytesIO(truncated)) as f: self.assertEqual(f.read(len(data)), data) self.assertRaises(EOFError, f.read, 1) # Incomplete 10-byte header. for i in range(2, 10): with gzip.GzipFile(fileobj=io.BytesIO(truncated[:i])) as f: self.assertRaises(EOFError, f.read, 1) def test_read_with_extra(self): # Gzip data with an extra field gzdata = (b'\x1f\x8b\x08\x04\xb2\x17cQ\x02\xff' b'\x05\x00Extra' b'\x0bI-.\x01\x002\xd1Mx\x04\x00\x00\x00') with gzip.GzipFile(fileobj=io.BytesIO(gzdata)) as f: self.assertEqual(f.read(), b'Test') def test_prepend_error(self): # See issue #20875 with gzip.open(self.filename, "wb") as f: f.write(data1) with gzip.open(self.filename, "rb") as f: f.fileobj.prepend() class TestOpen(BaseTest): def test_binary_modes(self): uncompressed = data1 * 50 with gzip.open(self.filename, "wb") as f: f.write(uncompressed) with open(self.filename, "rb") as f: file_data = gzip.decompress(f.read()) self.assertEqual(file_data, uncompressed) with gzip.open(self.filename, "rb") as f: self.assertEqual(f.read(), uncompressed) with gzip.open(self.filename, "ab") as f: f.write(uncompressed) with open(self.filename, "rb") as f: file_data = gzip.decompress(f.read()) self.assertEqual(file_data, uncompressed * 2) def test_implicit_binary_modes(self): # Test implicit binary modes (no "b" or "t" in mode string). uncompressed = data1 * 50 with gzip.open(self.filename, "w") as f: f.write(uncompressed) with open(self.filename, "rb") as f: file_data = gzip.decompress(f.read()) self.assertEqual(file_data, uncompressed) with gzip.open(self.filename, "r") as f: self.assertEqual(f.read(), uncompressed) with gzip.open(self.filename, "a") as f: f.write(uncompressed) with open(self.filename, "rb") as f: file_data = gzip.decompress(f.read()) self.assertEqual(file_data, uncompressed * 2) py/util_test.py 0000644 00000016014 15025317163 0007567 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for util.py.""" import unittest from apitools.base.protorpclite import messages from apitools.base.py import encoding from apitools.base.py import exceptions from apitools.base.py import util class MockedMethodConfig(object): def __init__(self, relative_path, path_params): self.relative_path = relative_path self.path_params = path_params class MessageWithRemappings(messages.Message): class AnEnum(messages.Enum): value_one = 1 value_two = 2 str_field = messages.StringField(1) enum_field = messages.EnumField('AnEnum', 2) enum_field_remapping = messages.EnumField('AnEnum', 3) encoding.AddCustomJsonFieldMapping( MessageWithRemappings, 'str_field', 'path_field') encoding.AddCustomJsonFieldMapping( MessageWithRemappings, 'enum_field_remapping', 'enum_field_remapped') encoding.AddCustomJsonEnumMapping( MessageWithRemappings.AnEnum, 'value_one', 'ONE') class UtilTest(unittest.TestCase): def testExpand(self): method_config_xy = MockedMethodConfig(relative_path='{x}/y/{z}', path_params=['x', 'z']) self.assertEqual( util.ExpandRelativePath(method_config_xy, {'x': '1', 'z': '2'}), '1/y/2') self.assertEqual( util.ExpandRelativePath( method_config_xy, {'x': '1', 'z': '2'}, relative_path='{x}/y/{z}/q'), '1/y/2/q') def testReservedExpansion(self): method_config_reserved = MockedMethodConfig(relative_path='{+x}/baz', path_params=['x']) self.assertEqual('foo/:bar:/baz', util.ExpandRelativePath( method_config_reserved, {'x': 'foo/:bar:'})) method_config_no_reserved = MockedMethodConfig(relative_path='{x}/baz', path_params=['x']) self.assertEqual('foo%2F%3Abar%3A/baz', util.ExpandRelativePath( method_config_no_reserved, {'x': 'foo/:bar:'})) def testCalculateWaitForRetry(self): try0 = util.CalculateWaitForRetry(0) self.assertTrue(try0 >= 1.0) self.assertTrue(try0 <= 1.5) try1 = util.CalculateWaitForRetry(1) self.assertTrue(try1 >= 1.0) self.assertTrue(try1 <= 3.0) try2 = util.CalculateWaitForRetry(2) self.assertTrue(try2 >= 2.0) self.assertTrue(try2 <= 6.0) try3 = util.CalculateWaitForRetry(3) self.assertTrue(try3 >= 4.0) self.assertTrue(try3 <= 12.0) try4 = util.CalculateWaitForRetry(4) self.assertTrue(try4 >= 8.0) self.assertTrue(try4 <= 24.0) self.assertAlmostEqual(10, util.CalculateWaitForRetry(5, max_wait=10)) def testTypecheck(self): class Class1(object): pass class Class2(object): pass class Class3(object): pass instance_of_class1 = Class1() self.assertEqual( instance_of_class1, util.Typecheck(instance_of_class1, Class1)) self.assertEqual( instance_of_class1, util.Typecheck(instance_of_class1, ((Class1, Class2), Class3))) self.assertEqual( instance_of_class1, util.Typecheck(instance_of_class1, (Class1, (Class2, Class3)))) self.assertEqual( instance_of_class1, util.Typecheck(instance_of_class1, Class1, 'message')) self.assertEqual( instance_of_class1, util.Typecheck( instance_of_class1, ((Class1, Class2), Class3), 'message')) self.assertEqual( instance_of_class1, util.Typecheck( instance_of_class1, (Class1, (Class2, Class3)), 'message')) with self.assertRaises(exceptions.TypecheckError): util.Typecheck(instance_of_class1, Class2) with self.assertRaises(exceptions.TypecheckError): util.Typecheck(instance_of_class1, (Class2, Class3)) with self.assertRaises(exceptions.TypecheckError): util.Typecheck(instance_of_class1, Class2, 'message') with self.assertRaises(exceptions.TypecheckError): util.Typecheck(instance_of_class1, (Class2, Class3), 'message') def testAcceptableMimeType(self): valid_pairs = ( ('*', 'text/plain'), ('*/*', 'text/plain'), ('text/*', 'text/plain'), ('*/plain', 'text/plain'), ('text/plain', 'text/plain'), ) for accept, mime_type in valid_pairs: self.assertTrue(util.AcceptableMimeType([accept], mime_type)) invalid_pairs = ( ('text/*', 'application/json'), ('text/plain', 'application/json'), ) for accept, mime_type in invalid_pairs: self.assertFalse(util.AcceptableMimeType([accept], mime_type)) self.assertTrue(util.AcceptableMimeType(['application/json', '*/*'], 'text/plain')) self.assertFalse(util.AcceptableMimeType(['application/json', 'img/*'], 'text/plain')) def testMalformedMimeType(self): self.assertRaises( exceptions.InvalidUserInputError, util.AcceptableMimeType, ['*/*'], 'abcd') def testUnsupportedMimeType(self): self.assertRaises( exceptions.GeneratedClientError, util.AcceptableMimeType, ['text/html;q=0.9'], 'text/html') def testMapRequestParams(self): params = { 'str_field': 'foo', 'enum_field': MessageWithRemappings.AnEnum.value_one, 'enum_field_remapping': MessageWithRemappings.AnEnum.value_one, } remapped_params = { 'path_field': 'foo', 'enum_field': 'ONE', 'enum_field_remapped': 'ONE', } self.assertEqual(remapped_params, util.MapRequestParams(params, MessageWithRemappings)) params['enum_field'] = MessageWithRemappings.AnEnum.value_two remapped_params['enum_field'] = 'value_two' self.assertEqual(remapped_params, util.MapRequestParams(params, MessageWithRemappings)) def testMapParamNames(self): params = ['path_field', 'enum_field'] remapped_params = ['str_field', 'enum_field'] self.assertEqual(remapped_params, util.MapParamNames(params, MessageWithRemappings)) py/extra_types_test.py 0000644 00000017476 15025317163 0011176 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import datetime import json import math import unittest from apitools.base.protorpclite import messages from apitools.base.py import encoding from apitools.base.py import exceptions from apitools.base.py import extra_types class ExtraTypesTest(unittest.TestCase): def assertRoundTrip(self, value): if isinstance(value, extra_types._JSON_PROTO_TYPES): self.assertEqual( value, extra_types._PythonValueToJsonProto( extra_types._JsonProtoToPythonValue(value))) else: self.assertEqual( value, extra_types._JsonProtoToPythonValue( extra_types._PythonValueToJsonProto(value))) def assertTranslations(self, py_value, json_proto): self.assertEqual( py_value, extra_types._JsonProtoToPythonValue(json_proto)) self.assertEqual( json_proto, extra_types._PythonValueToJsonProto(py_value)) def testInvalidProtos(self): with self.assertRaises(exceptions.InvalidDataError): extra_types._ValidateJsonValue(extra_types.JsonValue()) with self.assertRaises(exceptions.InvalidDataError): extra_types._ValidateJsonValue( extra_types.JsonValue(is_null=True, string_value='a')) with self.assertRaises(exceptions.InvalidDataError): extra_types._ValidateJsonValue( extra_types.JsonValue(integer_value=3, string_value='a')) def testNullEncoding(self): self.assertTranslations(None, extra_types.JsonValue(is_null=True)) def testJsonNumberEncoding(self): seventeen = extra_types.JsonValue(integer_value=17) self.assertRoundTrip(17) self.assertRoundTrip(seventeen) self.assertTranslations(17, seventeen) json_pi = extra_types.JsonValue(double_value=math.pi) self.assertRoundTrip(math.pi) self.assertRoundTrip(json_pi) self.assertTranslations(math.pi, json_pi) def testArrayEncoding(self): array = [3, 'four', False] json_array = extra_types.JsonArray(entries=[ extra_types.JsonValue(integer_value=3), extra_types.JsonValue(string_value='four'), extra_types.JsonValue(boolean_value=False), ]) self.assertRoundTrip(array) self.assertRoundTrip(json_array) self.assertTranslations(array, json_array) def testArrayAsValue(self): array_json = '[3, "four", false]' array = [3, 'four', False] value = encoding.JsonToMessage(extra_types.JsonValue, array_json) self.assertTrue(isinstance(value, extra_types.JsonValue)) self.assertEqual(array, encoding.MessageToPyValue(value)) def testObjectAsValue(self): obj_json = '{"works": true}' obj = {'works': True} value = encoding.JsonToMessage(extra_types.JsonValue, obj_json) self.assertTrue(isinstance(value, extra_types.JsonValue)) self.assertEqual(obj, encoding.MessageToPyValue(value)) def testDictEncoding(self): d = {'a': 6, 'b': 'eleventeen'} json_d = extra_types.JsonObject(properties=[ extra_types.JsonObject.Property( key='a', value=extra_types.JsonValue(integer_value=6)), extra_types.JsonObject.Property( key='b', value=extra_types.JsonValue(string_value='eleventeen')), ]) self.assertRoundTrip(d) # We don't know json_d will round-trip, because of randomness in # python dictionary iteration ordering. We also need to force # comparison as lists, since hashing protos isn't helpful. translated_properties = extra_types._PythonValueToJsonProto( d).properties for p in json_d.properties: self.assertIn(p, translated_properties) for p in translated_properties: self.assertIn(p, json_d.properties) def testJsonObjectPropertyTranslation(self): value = extra_types.JsonValue(string_value='abc') obj = extra_types.JsonObject(properties=[ extra_types.JsonObject.Property(key='attr_name', value=value)]) json_value = '"abc"' json_obj = '{"attr_name": "abc"}' self.assertRoundTrip(value) self.assertRoundTrip(obj) self.assertRoundTrip(json_value) self.assertRoundTrip(json_obj) self.assertEqual(json_value, encoding.MessageToJson(value)) self.assertEqual(json_obj, encoding.MessageToJson(obj)) def testJsonValueAsFieldTranslation(self): class HasJsonValueMsg(messages.Message): some_value = messages.MessageField(extra_types.JsonValue, 1) msg_json = '{"some_value": [1, 2, 3]}' msg = HasJsonValueMsg( some_value=encoding.PyValueToMessage( extra_types.JsonValue, [1, 2, 3])) self.assertEqual(msg, encoding.JsonToMessage(HasJsonValueMsg, msg_json)) self.assertEqual(msg_json, encoding.MessageToJson(msg)) def testDateField(self): class DateMsg(messages.Message): start_date = extra_types.DateField(1) all_dates = extra_types.DateField(2, repeated=True) msg = DateMsg( start_date=datetime.date(1752, 9, 9), all_dates=[ datetime.date(1979, 5, 6), datetime.date(1980, 10, 24), datetime.date(1981, 1, 19), ]) msg_dict = { 'start_date': '1752-09-09', 'all_dates': ['1979-05-06', '1980-10-24', '1981-01-19'], } self.assertEqual(msg_dict, json.loads(encoding.MessageToJson(msg))) self.assertEqual( msg, encoding.JsonToMessage(DateMsg, json.dumps(msg_dict))) def testInt64(self): # Testing roundtrip of type 'long' class DogeMsg(messages.Message): such_string = messages.StringField(1) wow = messages.IntegerField(2, variant=messages.Variant.INT64) very_unsigned = messages.IntegerField( 3, variant=messages.Variant.UINT64) much_repeated = messages.IntegerField( 4, variant=messages.Variant.INT64, repeated=True) def MtoJ(msg): return encoding.MessageToJson(msg) def JtoM(class_type, json_str): return encoding.JsonToMessage(class_type, json_str) def DoRoundtrip(class_type, json_msg=None, message=None, times=4): if json_msg: json_msg = MtoJ(JtoM(class_type, json_msg)) if message: message = JtoM(class_type, MtoJ(message)) if times == 0: result = json_msg if json_msg else message return result return DoRoundtrip(class_type=class_type, json_msg=json_msg, message=message, times=times - 1) # Single json_msg = ('{"such_string": "poot", "wow": "-1234", ' '"very_unsigned": "999", "much_repeated": ["123", "456"]}') out_json = MtoJ(JtoM(DogeMsg, json_msg)) self.assertEqual(json.loads(out_json)['wow'], '-1234') # Repeated test case msg = DogeMsg(such_string='wow', wow=-1234, very_unsigned=800, much_repeated=[123, 456]) self.assertEqual(msg, DoRoundtrip(DogeMsg, message=msg)) py/credentials_lib.py 0000644 00000072654 15025317163 0010712 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Common credentials classes and constructors.""" from __future__ import print_function import argparse import contextlib import datetime import json import os import threading import warnings import httplib2 import oauth2client import oauth2client.client from oauth2client import service_account from oauth2client import tools # for gflags declarations import six from six.moves import http_client from six.moves import urllib from apitools.base.py import exceptions from apitools.base.py import util # App Engine does not support ctypes which are required for the # monotonic time used in fasteners. Conversely, App Engine does # not support colocated concurrent processes, so process locks # are not needed. try: import fasteners _FASTENERS_AVAILABLE = True except ImportError as import_error: server_env = os.environ.get('SERVER_SOFTWARE', '') if not (server_env.startswith('Development') or server_env.startswith('Google App Engine')): raise import_error _FASTENERS_AVAILABLE = False # Note: we try the oauth2client imports two ways, to accomodate layout # changes in oauth2client 2.0+. We can remove these once we no longer # support oauth2client < 2.0. # # pylint: disable=wrong-import-order,ungrouped-imports try: from oauth2client.contrib import gce except ImportError: from oauth2client import gce try: from oauth2client.contrib import multiprocess_file_storage _NEW_FILESTORE = True except ImportError: _NEW_FILESTORE = False try: from oauth2client.contrib import multistore_file except ImportError: from oauth2client import multistore_file try: import gflags FLAGS = gflags.FLAGS except ImportError: FLAGS = None __all__ = [ 'CredentialsFromFile', 'GaeAssertionCredentials', 'GceAssertionCredentials', 'GetCredentials', 'GetUserinfo', 'ServiceAccountCredentialsFromFile', ] # Lock when accessing the cache file to avoid resource contention. cache_file_lock = threading.Lock() def SetCredentialsCacheFileLock(lock): global cache_file_lock # pylint: disable=global-statement cache_file_lock = lock # List of additional methods we use when attempting to construct # credentials. Users can register their own methods here, which we try # before the defaults. _CREDENTIALS_METHODS = [] def _RegisterCredentialsMethod(method, position=None): """Register a new method for fetching credentials. This new method should be a function with signature: client_info, **kwds -> Credentials or None This method can be used as a decorator, unless position needs to be supplied. Note that method must *always* accept arbitrary keyword arguments. Args: method: New credential-fetching method. position: (default: None) Where in the list of methods to add this; if None, we append. In all but rare cases, this should be either 0 or None. Returns: method, for use as a decorator. """ if position is None: position = len(_CREDENTIALS_METHODS) else: position = min(position, len(_CREDENTIALS_METHODS)) _CREDENTIALS_METHODS.insert(position, method) return method def GetCredentials(package_name, scopes, client_id, client_secret, user_agent, credentials_filename=None, api_key=None, # pylint: disable=unused-argument client=None, # pylint: disable=unused-argument oauth2client_args=None, **kwds): """Attempt to get credentials, using an oauth dance as the last resort.""" scopes = util.NormalizeScopes(scopes) client_info = { 'client_id': client_id, 'client_secret': client_secret, 'scope': ' '.join(sorted(scopes)), 'user_agent': user_agent or '%s-generated/0.1' % package_name, } for method in _CREDENTIALS_METHODS: credentials = method(client_info, **kwds) if credentials is not None: return credentials credentials_filename = credentials_filename or os.path.expanduser( '~/.apitools.token') credentials = CredentialsFromFile(credentials_filename, client_info, oauth2client_args=oauth2client_args) if credentials is not None: return credentials raise exceptions.CredentialsError('Could not create valid credentials') def ServiceAccountCredentialsFromFile(filename, scopes, user_agent=None): """Use the credentials in filename to create a token for scopes.""" filename = os.path.expanduser(filename) # We have two options, based on our version of oauth2client. if oauth2client.__version__ > '1.5.2': # oauth2client >= 2.0.0 credentials = ( service_account.ServiceAccountCredentials.from_json_keyfile_name( filename, scopes=scopes)) if credentials is not None: if user_agent is not None: credentials.user_agent = user_agent return credentials else: # oauth2client < 2.0.0 with open(filename) as keyfile: service_account_info = json.load(keyfile) account_type = service_account_info.get('type') if account_type != oauth2client.client.SERVICE_ACCOUNT: raise exceptions.CredentialsError( 'Invalid service account credentials: %s' % (filename,)) # pylint: disable=protected-access credentials = service_account._ServiceAccountCredentials( service_account_id=service_account_info['client_id'], service_account_email=service_account_info['client_email'], private_key_id=service_account_info['private_key_id'], private_key_pkcs8_text=service_account_info['private_key'], scopes=scopes, user_agent=user_agent) # pylint: enable=protected-access return credentials def ServiceAccountCredentialsFromP12File( service_account_name, private_key_filename, scopes, user_agent): """Create a new credential from the named .p12 keyfile.""" private_key_filename = os.path.expanduser(private_key_filename) scopes = util.NormalizeScopes(scopes) if oauth2client.__version__ > '1.5.2': # oauth2client >= 2.0.0 credentials = ( service_account.ServiceAccountCredentials.from_p12_keyfile( service_account_name, private_key_filename, scopes=scopes)) if credentials is not None: credentials.user_agent = user_agent return credentials else: # oauth2client < 2.0.0 with open(private_key_filename, 'rb') as key_file: return oauth2client.client.SignedJwtAssertionCredentials( service_account_name, key_file.read(), scopes, user_agent=user_agent) def _GceMetadataRequest(relative_url, use_metadata_ip=False): """Request the given url from the GCE metadata service.""" if use_metadata_ip: base_url = os.environ.get('GCE_METADATA_IP', '169.254.169.254') else: base_url = os.environ.get( 'GCE_METADATA_ROOT', 'metadata.google.internal') url = 'http://' + base_url + '/computeMetadata/v1/' + relative_url # Extra header requirement can be found here: # https://developers.google.com/compute/docs/metadata headers = {'Metadata-Flavor': 'Google'} request = urllib.request.Request(url, headers=headers) opener = urllib.request.build_opener(urllib.request.ProxyHandler({})) try: response = opener.open(request) except urllib.error.URLError as e: raise exceptions.CommunicationError( 'Could not reach metadata service: %s' % e.reason) return response class GceAssertionCredentials(gce.AppAssertionCredentials): """Assertion credentials for GCE instances.""" def __init__(self, scopes=None, service_account_name='default', **kwds): """Initializes the credentials instance. Args: scopes: The scopes to get. If None, whatever scopes that are available to the instance are used. service_account_name: The service account to retrieve the scopes from. **kwds: Additional keyword args. """ # If there is a connectivity issue with the metadata server, # detection calls may fail even if we've already successfully # identified these scopes in the same execution. However, the # available scopes don't change once an instance is created, # so there is no reason to perform more than one query. self.__service_account_name = six.ensure_text( service_account_name, encoding='utf-8',) cached_scopes = None cache_filename = kwds.get('cache_filename') if cache_filename: cached_scopes = self._CheckCacheFileForMatch( cache_filename, scopes) scopes = cached_scopes or self._ScopesFromMetadataServer(scopes) if cache_filename and not cached_scopes: self._WriteCacheFile(cache_filename, scopes) # We check the scopes above, but don't need them again after # this point. Newer versions of oauth2client let us drop them # here, but since we support older versions as well, we just # catch and squelch the warning. with warnings.catch_warnings(): warnings.simplefilter('ignore') super(GceAssertionCredentials, self).__init__(scope=scopes, **kwds) @classmethod def Get(cls, *args, **kwds): try: return cls(*args, **kwds) except exceptions.Error: return None def _CheckCacheFileForMatch(self, cache_filename, scopes): """Checks the cache file to see if it matches the given credentials. Args: cache_filename: Cache filename to check. scopes: Scopes for the desired credentials. Returns: List of scopes (if cache matches) or None. """ creds = { # Credentials metadata dict. 'scopes': sorted(list(scopes)) if scopes else None, 'svc_acct_name': self.__service_account_name, } cache_file = _MultiProcessCacheFile(cache_filename) try: cached_creds_str = cache_file.LockedRead() if not cached_creds_str: return None cached_creds = json.loads(cached_creds_str) if creds['svc_acct_name'] == cached_creds['svc_acct_name']: if creds['scopes'] in (None, cached_creds['scopes']): return cached_creds['scopes'] except KeyboardInterrupt: raise except: # pylint: disable=bare-except # Treat exceptions as a cache miss. pass def _WriteCacheFile(self, cache_filename, scopes): """Writes the credential metadata to the cache file. This does not save the credentials themselves (CredentialStore class optionally handles that after this class is initialized). Args: cache_filename: Cache filename to check. scopes: Scopes for the desired credentials. """ # Credentials metadata dict. scopes = sorted([six.ensure_text(scope) for scope in scopes]) creds = {'scopes': scopes, 'svc_acct_name': self.__service_account_name} creds_str = json.dumps(creds) cache_file = _MultiProcessCacheFile(cache_filename) try: cache_file.LockedWrite(creds_str) except KeyboardInterrupt: raise except: # pylint: disable=bare-except # Treat exceptions as a cache miss. pass def _ScopesFromMetadataServer(self, scopes): """Returns instance scopes based on GCE metadata server.""" if not util.DetectGce(): raise exceptions.ResourceUnavailableError( 'GCE credentials requested outside a GCE instance') if not self.GetServiceAccount(self.__service_account_name): raise exceptions.ResourceUnavailableError( 'GCE credentials requested but service account ' '%s does not exist.' % self.__service_account_name) if scopes: scope_ls = util.NormalizeScopes(scopes) instance_scopes = self.GetInstanceScopes() if scope_ls > instance_scopes: raise exceptions.CredentialsError( 'Instance did not have access to scopes %s' % ( sorted(list(scope_ls - instance_scopes)),)) else: scopes = self.GetInstanceScopes() return scopes def GetServiceAccount(self, account): relative_url = 'instance/service-accounts' response = _GceMetadataRequest(relative_url) response_lines = [six.ensure_str(line).rstrip(u'/\n\r') for line in response.readlines()] return account in response_lines def GetInstanceScopes(self): relative_url = 'instance/service-accounts/{0}/scopes'.format( self.__service_account_name) response = _GceMetadataRequest(relative_url) return util.NormalizeScopes(six.ensure_str(scope).strip() for scope in response.readlines()) # pylint: disable=arguments-differ def _refresh(self, do_request): """Refresh self.access_token. This function replaces AppAssertionCredentials._refresh, which does not use the credential store and is therefore poorly suited for multi-threaded scenarios. Args: do_request: A function matching httplib2.Http.request's signature. """ # pylint: disable=protected-access oauth2client.client.OAuth2Credentials._refresh(self, do_request) # pylint: enable=protected-access def _do_refresh_request(self, unused_http_request): """Refresh self.access_token by querying the metadata server. If self.store is initialized, store acquired credentials there. """ relative_url = 'instance/service-accounts/{0}/token'.format( self.__service_account_name) try: response = _GceMetadataRequest(relative_url) except exceptions.CommunicationError: self.invalid = True if self.store: self.store.locked_put(self) raise content = six.ensure_str(response.read()) try: credential_info = json.loads(content) except ValueError: raise exceptions.CredentialsError( 'Could not parse response as JSON: %s' % content) self.access_token = credential_info['access_token'] if 'expires_in' in credential_info: expires_in = int(credential_info['expires_in']) self.token_expiry = ( datetime.timedelta(seconds=expires_in) + datetime.datetime.now(tz=datetime.timezone.utc).replace(tzinfo=None)) else: self.token_expiry = None self.invalid = False if self.store: self.store.locked_put(self) def to_json(self): # OAuth2Client made gce.AppAssertionCredentials unserializable as of # v3.0, but we need those credentials to be serializable for use with # this library, so we use AppAssertionCredentials' parent's to_json # method. # pylint: disable=bad-super-call return super(gce.AppAssertionCredentials, self).to_json() @classmethod def from_json(cls, json_data): data = json.loads(json_data) kwargs = {} if 'cache_filename' in data.get('kwargs', []): kwargs['cache_filename'] = data['kwargs']['cache_filename'] # Newer versions of GceAssertionCredentials don't have a "scope" # attribute. scope_list = None if 'scope' in data: scope_list = [data['scope']] credentials = GceAssertionCredentials(scopes=scope_list, **kwargs) if 'access_token' in data: credentials.access_token = data['access_token'] if 'token_expiry' in data: credentials.token_expiry = datetime.datetime.strptime( data['token_expiry'], oauth2client.client.EXPIRY_FORMAT) if 'invalid' in data: credentials.invalid = data['invalid'] return credentials @property def serialization_data(self): raise NotImplementedError( 'Cannot serialize credentials for GCE service accounts.') # TODO(craigcitro): Currently, we can't even *load* # `oauth2client.appengine` without being on appengine, because of how # it handles imports. Fix that by splitting that module into # GAE-specific and GAE-independent bits, and guarding imports. class GaeAssertionCredentials(oauth2client.client.AssertionCredentials): """Assertion credentials for Google App Engine apps.""" def __init__(self, scopes, **kwds): if not util.DetectGae(): raise exceptions.ResourceUnavailableError( 'GCE credentials requested outside a GCE instance') self._scopes = list(util.NormalizeScopes(scopes)) super(GaeAssertionCredentials, self).__init__(None, **kwds) @classmethod def Get(cls, *args, **kwds): try: return cls(*args, **kwds) except exceptions.Error: return None @classmethod def from_json(cls, json_data): data = json.loads(json_data) return GaeAssertionCredentials(data['_scopes']) def _refresh(self, _): """Refresh self.access_token. Args: _: (ignored) A function matching httplib2.Http.request's signature. """ # pylint: disable=import-error from google.appengine.api import app_identity try: token, _ = app_identity.get_access_token(self._scopes) except app_identity.Error as e: raise exceptions.CredentialsError(str(e)) self.access_token = token def sign_blob(self, blob): """Cryptographically sign a blob (of bytes). This method is provided to support a common interface, but the actual key used for a Google Compute Engine service account is not available, so it can't be used to sign content. Args: blob: bytes, Message to be signed. Raises: NotImplementedError, always. """ raise NotImplementedError( 'Compute Engine service accounts cannot sign blobs') def _GetRunFlowFlags(args=None): """Retrieves command line flags based on gflags module.""" # There's one rare situation where gsutil will not have argparse # available, but doesn't need anything depending on argparse anyway, # since they're bringing their own credentials. So we just allow this # to fail with an ImportError in those cases. # parser = argparse.ArgumentParser(parents=[tools.argparser]) # Get command line argparse flags. flags, _ = parser.parse_known_args(args=args) # Allow `gflags` and `argparse` to be used side-by-side. if hasattr(FLAGS, 'auth_host_name'): flags.auth_host_name = FLAGS.auth_host_name if hasattr(FLAGS, 'auth_host_port'): flags.auth_host_port = FLAGS.auth_host_port if hasattr(FLAGS, 'auth_local_webserver'): flags.noauth_local_webserver = (not FLAGS.auth_local_webserver) return flags # TODO(craigcitro): Switch this from taking a path to taking a stream. def CredentialsFromFile(path, client_info, oauth2client_args=None): """Read credentials from a file.""" user_agent = client_info['user_agent'] scope_key = client_info['scope'] if not isinstance(scope_key, six.string_types): scope_key = ':'.join(scope_key) storage_key = client_info['client_id'] + user_agent + scope_key if _NEW_FILESTORE: credential_store = multiprocess_file_storage.MultiprocessFileStorage( path, storage_key) else: credential_store = multistore_file.get_credential_storage_custom_string_key( # noqa path, storage_key) if hasattr(FLAGS, 'auth_local_webserver'): FLAGS.auth_local_webserver = False credentials = credential_store.get() if credentials is None or credentials.invalid: print('Generating new OAuth credentials ...') for _ in range(20): # If authorization fails, we want to retry, rather than let this # cascade up and get caught elsewhere. If users want out of the # retry loop, they can ^C. try: flow = oauth2client.client.OAuth2WebServerFlow(**client_info) flags = _GetRunFlowFlags(args=oauth2client_args) credentials = tools.run_flow(flow, credential_store, flags) break except (oauth2client.client.FlowExchangeError, SystemExit) as e: # Here SystemExit is "no credential at all", and the # FlowExchangeError is "invalid" -- usually because # you reused a token. print('Invalid authorization: %s' % (e,)) except httplib2.HttpLib2Error as e: print('Communication error: %s' % (e,)) raise exceptions.CredentialsError( 'Communication error creating credentials: %s' % e) return credentials class _MultiProcessCacheFile(object): """Simple multithreading and multiprocessing safe cache file. Notes on behavior: * the fasteners.InterProcessLock object cannot reliably prevent threads from double-acquiring a lock. A threading lock is used in addition to the InterProcessLock. The threading lock is always acquired first and released last. * The interprocess lock will not deadlock. If a process can not acquire the interprocess lock within `_lock_timeout` the call will return as a cache miss or unsuccessful cache write. * App Engine environments cannot be process locked because (1) the runtime does not provide monotonic time and (2) different processes may or may not share the same machine. Because of this, process locks are disabled and locking is only guaranteed to protect against multithreaded access. """ _lock_timeout = 1 _encoding = 'utf-8' _thread_lock = threading.Lock() def __init__(self, filename): self._file = None self._filename = filename if _FASTENERS_AVAILABLE: self._process_lock_getter = self._ProcessLockAcquired self._process_lock = fasteners.InterProcessLock( '{0}.lock'.format(filename)) else: self._process_lock_getter = self._DummyLockAcquired self._process_lock = None @contextlib.contextmanager def _ProcessLockAcquired(self): """Context manager for process locks with timeout.""" try: is_locked = self._process_lock.acquire(timeout=self._lock_timeout) yield is_locked finally: if is_locked: self._process_lock.release() @contextlib.contextmanager def _DummyLockAcquired(self): """Lock context manager for environments without process locks.""" yield True def LockedRead(self): """Acquire an interprocess lock and dump cache contents. This method safely acquires the locks then reads a string from the cache file. If the file does not exist and cannot be created, it will return None. If the locks cannot be acquired, this will also return None. Returns: cache data - string if present, None on failure. """ file_contents = None with self._thread_lock: if not self._EnsureFileExists(): return None with self._process_lock_getter() as acquired_plock: if not acquired_plock: return None with open(self._filename, 'rb') as f: file_contents = f.read().decode(encoding=self._encoding) return file_contents def LockedWrite(self, cache_data): """Acquire an interprocess lock and write a string. This method safely acquires the locks then writes a string to the cache file. If the string is written successfully the function will return True, if the write fails for any reason it will return False. Args: cache_data: string or bytes to write. Returns: bool: success """ if isinstance(cache_data, six.text_type): cache_data = cache_data.encode(encoding=self._encoding) with self._thread_lock: if not self._EnsureFileExists(): return False with self._process_lock_getter() as acquired_plock: if not acquired_plock: return False with open(self._filename, 'wb') as f: f.write(cache_data) return True def _EnsureFileExists(self): """Touches a file; returns False on error, True on success.""" if not os.path.exists(self._filename): old_umask = os.umask(0o177) try: open(self._filename, 'a+b').close() except OSError: return False finally: os.umask(old_umask) return True # TODO(craigcitro): Push this into oauth2client. def GetUserinfo(credentials, http=None): # pylint: disable=invalid-name """Get the userinfo associated with the given credentials. This is dependent on the token having either the userinfo.email or userinfo.profile scope for the given token. Args: credentials: (oauth2client.client.Credentials) incoming credentials http: (httplib2.Http, optional) http instance to use Returns: The email address for this token, or None if the required scopes aren't available. """ http = http or httplib2.Http() url = _GetUserinfoUrl(credentials) # We ignore communication woes here (i.e. SSL errors, socket # timeout), as handling these should be done in a common location. response, content = http.request(url) if response.status == http_client.BAD_REQUEST: credentials.refresh(http) url = _GetUserinfoUrl(credentials) response, content = http.request(url) return json.loads(content or '{}') # Save ourselves from an empty reply. def _GetUserinfoUrl(credentials): url_root = 'https://oauth2.googleapis.com/tokeninfo' query_args = {'access_token': credentials.access_token} return '?'.join((url_root, urllib.parse.urlencode(query_args))) @_RegisterCredentialsMethod def _GetServiceAccountCredentials( client_info, service_account_name=None, service_account_keyfile=None, service_account_json_keyfile=None, **unused_kwds): """Returns ServiceAccountCredentials from give file.""" scopes = client_info['scope'].split() user_agent = client_info['user_agent'] # Use the .json credentials, if provided. if service_account_json_keyfile: return ServiceAccountCredentialsFromFile( service_account_json_keyfile, scopes, user_agent=user_agent) # Fall back to .p12 if there's no .json credentials. if ((service_account_name and not service_account_keyfile) or (service_account_keyfile and not service_account_name)): raise exceptions.CredentialsError( 'Service account name or keyfile provided without the other') if service_account_name is not None: return ServiceAccountCredentialsFromP12File( service_account_name, service_account_keyfile, scopes, user_agent) @_RegisterCredentialsMethod def _GetGaeServiceAccount(client_info, **unused_kwds): scopes = client_info['scope'].split(' ') return GaeAssertionCredentials.Get(scopes=scopes) @_RegisterCredentialsMethod def _GetGceServiceAccount(client_info, **unused_kwds): scopes = client_info['scope'].split(' ') return GceAssertionCredentials.Get(scopes=scopes) @_RegisterCredentialsMethod def _GetApplicationDefaultCredentials( client_info, skip_application_default_credentials=False, **unused_kwds): """Returns ADC with right scopes.""" scopes = client_info['scope'].split() if skip_application_default_credentials: return None gc = oauth2client.client.GoogleCredentials with cache_file_lock: try: # pylint: disable=protected-access # We've already done our own check for GAE/GCE # credentials, we don't want to pay for checking again. credentials = gc._implicit_credentials_from_files() except oauth2client.client.ApplicationDefaultCredentialsError: return None # If we got back a non-service account credential, we need to use # a heuristic to decide whether or not the application default # credential will work for us. We assume that if we're requesting # cloud-platform, our scopes are a subset of cloud scopes, and the # ADC will work. cp = 'https://www.googleapis.com/auth/cloud-platform' if credentials is None: return None if not isinstance(credentials, gc) or cp in scopes: return credentials.create_scoped(scopes) return None py/exceptions.py 0000644 00000011752 15025317163 0007740 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Exceptions for generated client libraries.""" class Error(Exception): """Base class for all exceptions.""" class TypecheckError(Error, TypeError): """An object of an incorrect type is provided.""" class NotFoundError(Error): """A specified resource could not be found.""" class UserError(Error): """Base class for errors related to user input.""" class InvalidDataError(Error): """Base class for any invalid data error.""" class CommunicationError(Error): """Any communication error talking to an API server.""" class HttpError(CommunicationError): """Error making a request. Soon to be HttpError.""" def __init__(self, response, content, url, method_config=None, request=None): error_message = HttpError._build_message(response, content, url) super(HttpError, self).__init__(error_message) self.response = response self.content = content self.url = url self.method_config = method_config self.request = request def __str__(self): return HttpError._build_message(self.response, self.content, self.url) @staticmethod def _build_message(response, content, url): if isinstance(content, bytes): content = content.decode('ascii', 'replace') return 'HttpError accessing <%s>: response: <%s>, content <%s>' % ( url, response, content) @property def status_code(self): # TODO(craigcitro): Turn this into something better than a # KeyError if there is no status. return int(self.response['status']) @classmethod def FromResponse(cls, http_response, **kwargs): try: status_code = int(http_response.info.get('status')) error_cls = _HTTP_ERRORS.get(status_code, cls) except ValueError: error_cls = cls return error_cls(http_response.info, http_response.content, http_response.request_url, **kwargs) class HttpBadRequestError(HttpError): """HTTP 400 Bad Request.""" class HttpUnauthorizedError(HttpError): """HTTP 401 Unauthorized.""" class HttpForbiddenError(HttpError): """HTTP 403 Forbidden.""" class HttpNotFoundError(HttpError): """HTTP 404 Not Found.""" class HttpConflictError(HttpError): """HTTP 409 Conflict.""" _HTTP_ERRORS = { 400: HttpBadRequestError, 401: HttpUnauthorizedError, 403: HttpForbiddenError, 404: HttpNotFoundError, 409: HttpConflictError, } class InvalidUserInputError(InvalidDataError): """User-provided input is invalid.""" class InvalidDataFromServerError(InvalidDataError, CommunicationError): """Data received from the server is malformed.""" class BatchError(Error): """Error generated while constructing a batch request.""" class ConfigurationError(Error): """Base class for configuration errors.""" class GeneratedClientError(Error): """The generated client configuration is invalid.""" class ConfigurationValueError(UserError): """Some part of the user-specified client configuration is invalid.""" class ResourceUnavailableError(Error): """User requested an unavailable resource.""" class CredentialsError(Error): """Errors related to invalid credentials.""" class TransferError(CommunicationError): """Errors related to transfers.""" class TransferRetryError(TransferError): """Retryable errors related to transfers.""" class TransferInvalidError(TransferError): """The given transfer is invalid.""" class RequestError(CommunicationError): """The request was not successful.""" class RetryAfterError(HttpError): """The response contained a retry-after header.""" def __init__(self, response, content, url, retry_after, **kwargs): super(RetryAfterError, self).__init__(response, content, url, **kwargs) self.retry_after = int(retry_after) @classmethod def FromResponse(cls, http_response, **kwargs): return cls(http_response.info, http_response.content, http_response.request_url, http_response.retry_after, **kwargs) class BadStatusCodeError(HttpError): """The request completed but returned a bad status code.""" class NotYetImplementedError(GeneratedClientError): """This functionality is not yet implemented.""" class StreamExhausted(Error): """Attempted to read more bytes from a stream than were available.""" py/exceptions_test.py 0000644 00000005611 15025317163 0010774 0 ustar 00 # Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import unittest from apitools.base.py import exceptions from apitools.base.py import http_wrapper def _MakeResponse(status_code): return http_wrapper.Response( info={'status': status_code}, content='{"field": "abc"}', request_url='http://www.google.com') class HttpErrorFromResponseTest(unittest.TestCase): """Tests for exceptions.HttpError.FromResponse.""" def testBadRequest(self): err = exceptions.HttpError.FromResponse(_MakeResponse(400)) self.assertIsInstance(err, exceptions.HttpError) self.assertIsInstance(err, exceptions.HttpBadRequestError) self.assertEqual(err.status_code, 400) def testUnauthorized(self): err = exceptions.HttpError.FromResponse(_MakeResponse(401)) self.assertIsInstance(err, exceptions.HttpError) self.assertIsInstance(err, exceptions.HttpUnauthorizedError) self.assertEqual(err.status_code, 401) def testForbidden(self): err = exceptions.HttpError.FromResponse(_MakeResponse(403)) self.assertIsInstance(err, exceptions.HttpError) self.assertIsInstance(err, exceptions.HttpForbiddenError) self.assertEqual(err.status_code, 403) def testExceptionMessageIncludesErrorDetails(self): err = exceptions.HttpError.FromResponse(_MakeResponse(403)) self.assertIn('403', repr(err)) self.assertIn('http://www.google.com', repr(err)) self.assertIn('{"field": "abc"}', repr(err)) def testNotFound(self): err = exceptions.HttpError.FromResponse(_MakeResponse(404)) self.assertIsInstance(err, exceptions.HttpError) self.assertIsInstance(err, exceptions.HttpNotFoundError) self.assertEqual(err.status_code, 404) def testConflict(self): err = exceptions.HttpError.FromResponse(_MakeResponse(409)) self.assertIsInstance(err, exceptions.HttpError) self.assertIsInstance(err, exceptions.HttpConflictError) self.assertEqual(err.status_code, 409) def testUnknownStatus(self): err = exceptions.HttpError.FromResponse(_MakeResponse(499)) self.assertIsInstance(err, exceptions.HttpError) self.assertEqual(err.status_code, 499) def testMalformedStatus(self): err = exceptions.HttpError.FromResponse(_MakeResponse('BAD')) self.assertIsInstance(err, exceptions.HttpError) py/stream_slice_test.py 0000644 00000004315 15025317163 0011265 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for stream_slice.""" import string import unittest import six from apitools.base.py import exceptions from apitools.base.py import stream_slice class StreamSliceTest(unittest.TestCase): def setUp(self): self.stream = six.StringIO(string.ascii_letters) self.value = self.stream.getvalue() self.stream.seek(0) def testSimpleSlice(self): ss = stream_slice.StreamSlice(self.stream, 10) self.assertEqual('', ss.read(0)) self.assertEqual(self.value[0:3], ss.read(3)) self.assertIn('7/10', str(ss)) self.assertEqual(self.value[3:10], ss.read()) self.assertEqual('', ss.read()) self.assertEqual('', ss.read(10)) self.assertEqual(10, self.stream.tell()) def testEmptySlice(self): ss = stream_slice.StreamSlice(self.stream, 0) self.assertEqual('', ss.read(5)) self.assertEqual('', ss.read()) self.assertEqual(0, self.stream.tell()) def testOffsetStream(self): self.stream.seek(26) ss = stream_slice.StreamSlice(self.stream, 26) self.assertEqual(self.value[26:36], ss.read(10)) self.assertEqual(self.value[36:], ss.read()) self.assertEqual('', ss.read()) def testTooShortStream(self): ss = stream_slice.StreamSlice(self.stream, 1000) self.assertEqual(self.value, ss.read()) self.assertEqual('', ss.read(0)) with self.assertRaises(exceptions.StreamExhausted) as e: ss.read() with self.assertRaises(exceptions.StreamExhausted) as e: ss.read(10) self.assertIn('exhausted after %d' % len(self.value), str(e.exception)) py/buffered_stream.py 0000644 00000005025 15025317163 0010710 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Small helper class to provide a small slice of a stream. This class reads ahead to detect if we are at the end of the stream. """ from apitools.base.py import exceptions # TODO(user): Consider replacing this with a StringIO. class BufferedStream(object): """Buffers a stream, reading ahead to determine if we're at the end.""" def __init__(self, stream, start, size): self.__stream = stream self.__start_pos = start self.__buffer_pos = 0 self.__buffered_data = self.__stream.read(size) self.__stream_at_end = len(self.__buffered_data) < size self.__end_pos = self.__start_pos + len(self.__buffered_data) def __str__(self): return ('Buffered stream %s from position %s-%s with %s ' 'bytes remaining' % (self.__stream, self.__start_pos, self.__end_pos, self._bytes_remaining)) def __len__(self): return len(self.__buffered_data) @property def stream_exhausted(self): return self.__stream_at_end @property def stream_end_position(self): return self.__end_pos @property def _bytes_remaining(self): return len(self.__buffered_data) - self.__buffer_pos def read(self, size=None): # pylint: disable=invalid-name """Reads from the buffer.""" if size is None or size < 0: raise exceptions.NotYetImplementedError( 'Illegal read of size %s requested on BufferedStream. ' 'Wrapped stream %s is at position %s-%s, ' '%s bytes remaining.' % (size, self.__stream, self.__start_pos, self.__end_pos, self._bytes_remaining)) data = '' if self._bytes_remaining: size = min(size, self._bytes_remaining) data = self.__buffered_data[ self.__buffer_pos:self.__buffer_pos + size] self.__buffer_pos += size return data py/encoding.py 0000644 00000002237 15025317163 0007343 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Common code for converting proto to other formats, such as JSON.""" # pylint:disable=wildcard-import from apitools.base.py.encoding_helper import * import apitools.base.py.extra_types # pylint:disable=unused-import # pylint:disable=undefined-all-variable __all__ = [ 'CopyProtoMessage', 'JsonToMessage', 'MessageToJson', 'DictToMessage', 'MessageToDict', 'PyValueToMessage', 'MessageToPyValue', 'MessageToRepr', 'GetCustomJsonFieldMapping', 'AddCustomJsonFieldMapping', 'GetCustomJsonEnumMapping', 'AddCustomJsonEnumMapping', ] py/base_api.py 0000644 00000072454 15025317163 0007330 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Base class for api services.""" import base64 import contextlib import datetime import logging import pprint import six from six.moves import http_client from six.moves import urllib from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.py import encoding from apitools.base.py import exceptions from apitools.base.py import http_wrapper from apitools.base.py import util __all__ = [ 'ApiMethodInfo', 'ApiUploadInfo', 'BaseApiClient', 'BaseApiService', 'NormalizeApiEndpoint', ] # TODO(craigcitro): Remove this once we quiet the spurious logging in # oauth2client (or drop oauth2client). logging.getLogger('oauth2client.util').setLevel(logging.ERROR) _MAX_URL_LENGTH = 2048 class ApiUploadInfo(messages.Message): """Media upload information for a method. Fields: accept: (repeated) MIME Media Ranges for acceptable media uploads to this method. max_size: (integer) Maximum size of a media upload, such as 3MB or 1TB (converted to an integer). resumable_path: Path to use for resumable uploads. resumable_multipart: (boolean) Whether or not the resumable endpoint supports multipart uploads. simple_path: Path to use for simple uploads. simple_multipart: (boolean) Whether or not the simple endpoint supports multipart uploads. """ accept = messages.StringField(1, repeated=True) max_size = messages.IntegerField(2) resumable_path = messages.StringField(3) resumable_multipart = messages.BooleanField(4) simple_path = messages.StringField(5) simple_multipart = messages.BooleanField(6) class ApiMethodInfo(messages.Message): """Configuration info for an API method. All fields are strings unless noted otherwise. Fields: relative_path: Relative path for this method. flat_path: Expanded version (if any) of relative_path. method_id: ID for this method. http_method: HTTP verb to use for this method. path_params: (repeated) path parameters for this method. query_params: (repeated) query parameters for this method. ordered_params: (repeated) ordered list of parameters for this method. description: description of this method. request_type_name: name of the request type. response_type_name: name of the response type. request_field: if not null, the field to pass as the body of this POST request. may also be the REQUEST_IS_BODY value below to indicate the whole message is the body. upload_config: (ApiUploadInfo) Information about the upload configuration supported by this method. supports_download: (boolean) If True, this method supports downloading the request via the `alt=media` query parameter. api_version_param: API version system parameter for this method. """ relative_path = messages.StringField(1) flat_path = messages.StringField(2) method_id = messages.StringField(3) http_method = messages.StringField(4) path_params = messages.StringField(5, repeated=True) query_params = messages.StringField(6, repeated=True) ordered_params = messages.StringField(7, repeated=True) description = messages.StringField(8) request_type_name = messages.StringField(9) response_type_name = messages.StringField(10) request_field = messages.StringField(11, default='') upload_config = messages.MessageField(ApiUploadInfo, 12) supports_download = messages.BooleanField(13, default=False) api_version_param = messages.StringField(14) REQUEST_IS_BODY = '<request>' def _LoadClass(name, messages_module): if name.startswith('message_types.'): _, _, classname = name.partition('.') return getattr(message_types, classname) elif '.' not in name: return getattr(messages_module, name) else: raise exceptions.GeneratedClientError('Unknown class %s' % name) def _RequireClassAttrs(obj, attrs): for attr in attrs: attr_name = attr.upper() if not hasattr(obj, '%s' % attr_name) or not getattr(obj, attr_name): msg = 'No %s specified for object of class %s.' % ( attr_name, type(obj).__name__) raise exceptions.GeneratedClientError(msg) def NormalizeApiEndpoint(api_endpoint): if not api_endpoint.endswith('/'): api_endpoint += '/' return api_endpoint def _urljoin(base, url): # pylint: disable=invalid-name """Custom urljoin replacement supporting : before / in url.""" # In general, it's unsafe to simply join base and url. However, for # the case of discovery documents, we know: # * base will never contain params, query, or fragment # * url will never contain a scheme or net_loc. # In general, this means we can safely join on /; we just need to # ensure we end up with precisely one / joining base and url. The # exception here is the case of media uploads, where url will be an # absolute url. if url.startswith('http://') or url.startswith('https://'): return urllib.parse.urljoin(base, url) new_base = base if base.endswith('/') else base + '/' new_url = url[1:] if url.startswith('/') else url return new_base + new_url class _UrlBuilder(object): """Convenient container for url data.""" def __init__(self, base_url, relative_path=None, query_params=None): components = urllib.parse.urlsplit(_urljoin( base_url, relative_path or '')) if components.fragment: raise exceptions.ConfigurationValueError( 'Unexpected url fragment: %s' % components.fragment) self.query_params = urllib.parse.parse_qs(components.query or '') if query_params is not None: self.query_params.update(query_params) self.__scheme = components.scheme self.__netloc = components.netloc self.relative_path = components.path or '' @classmethod def FromUrl(cls, url): urlparts = urllib.parse.urlsplit(url) query_params = urllib.parse.parse_qs(urlparts.query) base_url = urllib.parse.urlunsplit(( urlparts.scheme, urlparts.netloc, '', None, None)) relative_path = urlparts.path or '' return cls( base_url, relative_path=relative_path, query_params=query_params) @property def base_url(self): return urllib.parse.urlunsplit( (self.__scheme, self.__netloc, '', '', '')) @base_url.setter def base_url(self, value): components = urllib.parse.urlsplit(value) if components.path or components.query or components.fragment: raise exceptions.ConfigurationValueError( 'Invalid base url: %s' % value) self.__scheme = components.scheme self.__netloc = components.netloc @property def query(self): # TODO(craigcitro): In the case that some of the query params are # non-ASCII, we may silently fail to encode correctly. We should # figure out who is responsible for owning the object -> str # conversion. return urllib.parse.urlencode(self.query_params, True) @property def url(self): if '{' in self.relative_path or '}' in self.relative_path: raise exceptions.ConfigurationValueError( 'Cannot create url with relative path %s' % self.relative_path) return urllib.parse.urlunsplit(( self.__scheme, self.__netloc, self.relative_path, self.query, '')) def _SkipGetCredentials(): """Hook for skipping credentials. For internal use.""" return False class BaseApiClient(object): """Base class for client libraries.""" MESSAGES_MODULE = None _API_KEY = '' _CLIENT_ID = '' _CLIENT_SECRET = '' _PACKAGE = '' _SCOPES = [] _USER_AGENT = '' def __init__(self, url, credentials=None, get_credentials=True, http=None, model=None, log_request=False, log_response=False, num_retries=5, max_retry_wait=60, credentials_args=None, default_global_params=None, additional_http_headers=None, check_response_func=None, retry_func=None, response_encoding=None): _RequireClassAttrs(self, ('_package', '_scopes', 'messages_module')) if default_global_params is not None: util.Typecheck(default_global_params, self.params_type) self.__default_global_params = default_global_params self.log_request = log_request self.log_response = log_response self.__num_retries = 5 self.__max_retry_wait = 60 # We let the @property machinery below do our validation. self.num_retries = num_retries self.max_retry_wait = max_retry_wait self._credentials = credentials get_credentials = get_credentials and not _SkipGetCredentials() if get_credentials and not credentials: credentials_args = credentials_args or {} self._SetCredentials(**credentials_args) self._url = NormalizeApiEndpoint(url) self._http = http or http_wrapper.GetHttp() # Note that "no credentials" is totally possible. if self._credentials is not None: self._http = self._credentials.authorize(self._http) # TODO(craigcitro): Remove this field when we switch to proto2. self.__include_fields = None self.additional_http_headers = additional_http_headers or {} self.check_response_func = check_response_func self.retry_func = retry_func self.response_encoding = response_encoding # Since we can't change the init arguments without regenerating clients, # offer this hook to affect FinalizeTransferUrl behavior. self.overwrite_transfer_urls_with_client_base = False # TODO(craigcitro): Finish deprecating these fields. _ = model self.__response_type_model = 'proto' def _SetCredentials(self, **kwds): """Fetch credentials, and set them for this client. Note that we can't simply return credentials, since creating them may involve side-effecting self. Args: **kwds: Additional keyword arguments are passed on to GetCredentials. Returns: None. Sets self._credentials. """ args = { 'api_key': self._API_KEY, 'client': self, 'client_id': self._CLIENT_ID, 'client_secret': self._CLIENT_SECRET, 'package_name': self._PACKAGE, 'scopes': self._SCOPES, 'user_agent': self._USER_AGENT, } args.update(kwds) # credentials_lib can be expensive to import so do it only if needed. from apitools.base.py import credentials_lib # TODO(craigcitro): It's a bit dangerous to pass this # still-half-initialized self into this method, but we might need # to set attributes on it associated with our credentials. # Consider another way around this (maybe a callback?) and whether # or not it's worth it. self._credentials = credentials_lib.GetCredentials(**args) @classmethod def ClientInfo(cls): return { 'client_id': cls._CLIENT_ID, 'client_secret': cls._CLIENT_SECRET, 'scope': ' '.join(sorted(util.NormalizeScopes(cls._SCOPES))), 'user_agent': cls._USER_AGENT, } @property def base_model_class(self): return None @property def http(self): return self._http @property def url(self): return self._url @classmethod def GetScopes(cls): return cls._SCOPES @property def params_type(self): return _LoadClass('StandardQueryParameters', self.MESSAGES_MODULE) @property def user_agent(self): return self._USER_AGENT @property def _default_global_params(self): if self.__default_global_params is None: # pylint: disable=not-callable self.__default_global_params = self.params_type() return self.__default_global_params def AddGlobalParam(self, name, value): params = self._default_global_params setattr(params, name, value) @property def global_params(self): return encoding.CopyProtoMessage(self._default_global_params) @contextlib.contextmanager def IncludeFields(self, include_fields): self.__include_fields = include_fields yield self.__include_fields = None @property def response_type_model(self): return self.__response_type_model @contextlib.contextmanager def JsonResponseModel(self): """In this context, return raw JSON instead of proto.""" old_model = self.response_type_model self.__response_type_model = 'json' yield self.__response_type_model = old_model @property def num_retries(self): return self.__num_retries @num_retries.setter def num_retries(self, value): util.Typecheck(value, six.integer_types) if value < 0: raise exceptions.InvalidDataError( 'Cannot have negative value for num_retries') self.__num_retries = value @property def max_retry_wait(self): return self.__max_retry_wait @max_retry_wait.setter def max_retry_wait(self, value): util.Typecheck(value, six.integer_types) if value <= 0: raise exceptions.InvalidDataError( 'max_retry_wait must be a postiive integer') self.__max_retry_wait = value @contextlib.contextmanager def WithRetries(self, num_retries): old_num_retries = self.num_retries self.num_retries = num_retries yield self.num_retries = old_num_retries def ProcessRequest(self, method_config, request): """Hook for pre-processing of requests.""" if self.log_request: logging.info( 'Calling method %s with %s: %s', method_config.method_id, method_config.request_type_name, request) return request def ProcessHttpRequest(self, http_request): """Hook for pre-processing of http requests.""" http_request.headers.update(self.additional_http_headers) if self.log_request: logging.info('Making http %s to %s', http_request.http_method, http_request.url) logging.info('Headers: %s', pprint.pformat(http_request.headers)) if http_request.body: # TODO(craigcitro): Make this safe to print in the case of # non-printable body characters. logging.info('Body:\n%s', http_request.loggable_body or http_request.body) else: logging.info('Body: (none)') return http_request def ProcessResponse(self, method_config, response): if self.log_response: logging.info('Response of type %s: %s', method_config.response_type_name, response) return response # TODO(craigcitro): Decide where these two functions should live. def SerializeMessage(self, message): return encoding.MessageToJson( message, include_fields=self.__include_fields) def DeserializeMessage(self, response_type, data): """Deserialize the given data as method_config.response_type.""" try: message = encoding.JsonToMessage(response_type, data) except (exceptions.InvalidDataFromServerError, messages.ValidationError, ValueError) as e: raise exceptions.InvalidDataFromServerError( 'Error decoding response "%s" as type %s: %s' % ( data, response_type.__name__, e)) return message def FinalizeTransferUrl(self, url): """Modify the url for a given transfer, based on auth and version.""" url_builder = _UrlBuilder.FromUrl(url) if getattr(self.global_params, 'key', None): url_builder.query_params['key'] = self.global_params.key if self.overwrite_transfer_urls_with_client_base: client_url_builder = _UrlBuilder.FromUrl(self._url) url_builder.base_url = client_url_builder.base_url return url_builder.url class BaseApiService(object): """Base class for generated API services.""" def __init__(self, client): self.__client = client self._method_configs = {} self._upload_configs = {} @property def _client(self): return self.__client @property def client(self): return self.__client def GetMethodConfig(self, method): """Returns service cached method config for given method.""" method_config = self._method_configs.get(method) if method_config: return method_config func = getattr(self, method, None) if func is None: raise KeyError(method) method_config = getattr(func, 'method_config', None) if method_config is None: raise KeyError(method) self._method_configs[method] = config = method_config() return config @classmethod def GetMethodsList(cls): return [f.__name__ for f in six.itervalues(cls.__dict__) if getattr(f, 'method_config', None)] def GetUploadConfig(self, method): return self._upload_configs.get(method) def GetRequestType(self, method): method_config = self.GetMethodConfig(method) return getattr(self.client.MESSAGES_MODULE, method_config.request_type_name) def GetResponseType(self, method): method_config = self.GetMethodConfig(method) return getattr(self.client.MESSAGES_MODULE, method_config.response_type_name) def __CombineGlobalParams(self, global_params, default_params): """Combine the given params with the defaults.""" util.Typecheck(global_params, (type(None), self.__client.params_type)) result = self.__client.params_type() global_params = global_params or self.__client.params_type() for field in result.all_fields(): value = global_params.get_assigned_value(field.name) if value is None: value = default_params.get_assigned_value(field.name) if value not in (None, [], ()): setattr(result, field.name, value) return result def __EncodePrettyPrint(self, query_info): # The prettyPrint flag needs custom encoding: it should be encoded # as 0 if False, and ignored otherwise (True is the default). if not query_info.pop('prettyPrint', True): query_info['prettyPrint'] = 0 # The One Platform equivalent of prettyPrint is pp, which also needs # custom encoding. if not query_info.pop('pp', True): query_info['pp'] = 0 return query_info def __FinalUrlValue(self, value, field): """Encode value for the URL, using field to skip encoding for bytes.""" if isinstance(field, messages.BytesField) and value is not None: return base64.urlsafe_b64encode(value) elif isinstance(value, six.text_type): return value.encode('utf8') elif isinstance(value, six.binary_type): return value.decode('utf8') elif isinstance(value, datetime.datetime): return value.isoformat() return value def __ConstructQueryParams(self, query_params, request, global_params): """Construct a dictionary of query parameters for this request.""" # First, handle the global params. global_params = self.__CombineGlobalParams( global_params, self.__client.global_params) global_param_names = util.MapParamNames( [x.name for x in self.__client.params_type.all_fields()], self.__client.params_type) global_params_type = type(global_params) query_info = dict( (param, self.__FinalUrlValue(getattr(global_params, param), getattr(global_params_type, param))) for param in global_param_names) # Next, add the query params. query_param_names = util.MapParamNames(query_params, type(request)) request_type = type(request) query_info.update( (param, self.__FinalUrlValue(getattr(request, param, None), getattr(request_type, param))) for param in query_param_names) query_info = dict((k, v) for k, v in query_info.items() if v is not None) query_info = self.__EncodePrettyPrint(query_info) query_info = util.MapRequestParams(query_info, type(request)) return query_info def __ConstructRelativePath(self, method_config, request, relative_path=None): """Determine the relative path for request.""" python_param_names = util.MapParamNames( method_config.path_params, type(request)) params = dict([(param, getattr(request, param, None)) for param in python_param_names]) params = util.MapRequestParams(params, type(request)) return util.ExpandRelativePath(method_config, params, relative_path=relative_path) def __FinalizeRequest(self, http_request, url_builder): """Make any final general adjustments to the request.""" if (http_request.http_method == 'GET' and len(http_request.url) > _MAX_URL_LENGTH): http_request.http_method = 'POST' http_request.headers['x-http-method-override'] = 'GET' http_request.headers[ 'content-type'] = 'application/x-www-form-urlencoded' http_request.body = url_builder.query url_builder.query_params = {} http_request.url = url_builder.url def __ProcessHttpResponse(self, method_config, http_response, request): """Process the given http response.""" if http_response.status_code not in (http_client.OK, http_client.CREATED, http_client.NO_CONTENT): raise exceptions.HttpError.FromResponse( http_response, method_config=method_config, request=request) if http_response.status_code == http_client.NO_CONTENT: # TODO(craigcitro): Find out why _replace doesn't seem to work # here. http_response = http_wrapper.Response( info=http_response.info, content='{}', request_url=http_response.request_url) content = http_response.content if self._client.response_encoding and isinstance(content, bytes): content = content.decode(self._client.response_encoding) if self.__client.response_type_model == 'json': return content response_type = _LoadClass(method_config.response_type_name, self.__client.MESSAGES_MODULE) return self.__client.DeserializeMessage(response_type, content) def __SetBaseHeaders(self, http_request, client): """Fill in the basic headers on http_request.""" # TODO(craigcitro): Make the default a little better here, and # include the apitools version. user_agent = client.user_agent or 'apitools-client/1.0' http_request.headers['user-agent'] = user_agent http_request.headers['accept'] = 'application/json' http_request.headers['accept-encoding'] = 'gzip, deflate' def __SetBaseSystemParams(self, http_request, method_config): """Fill in the system parameters to always set for the method.""" if method_config.api_version_param: http_request.headers['X-Goog-Api-Version'] = ( method_config.api_version_param) def __SetBody(self, http_request, method_config, request, upload): """Fill in the body on http_request.""" if not method_config.request_field: return request_type = _LoadClass( method_config.request_type_name, self.__client.MESSAGES_MODULE) if method_config.request_field == REQUEST_IS_BODY: body_value = request body_type = request_type else: body_value = getattr(request, method_config.request_field) body_field = request_type.field_by_name( method_config.request_field) util.Typecheck(body_field, messages.MessageField) body_type = body_field.type # If there was no body provided, we use an empty message of the # appropriate type. body_value = body_value or body_type() if upload and not body_value: # We're going to fill in the body later. return util.Typecheck(body_value, body_type) http_request.headers['content-type'] = 'application/json' http_request.body = self.__client.SerializeMessage(body_value) def PrepareHttpRequest(self, method_config, request, global_params=None, upload=None, upload_config=None, download=None): """Prepares an HTTP request to be sent.""" request_type = _LoadClass( method_config.request_type_name, self.__client.MESSAGES_MODULE) util.Typecheck(request, request_type) request = self.__client.ProcessRequest(method_config, request) http_request = http_wrapper.Request( http_method=method_config.http_method) self.__SetBaseHeaders(http_request, self.__client) self.__SetBaseSystemParams(http_request, method_config) self.__SetBody(http_request, method_config, request, upload) url_builder = _UrlBuilder( self.__client.url, relative_path=method_config.relative_path) url_builder.query_params = self.__ConstructQueryParams( method_config.query_params, request, global_params) # It's important that upload and download go before we fill in the # relative path, so that they can replace it. if upload is not None: upload.ConfigureRequest(upload_config, http_request, url_builder) if download is not None: download.ConfigureRequest(http_request, url_builder) url_builder.relative_path = self.__ConstructRelativePath( method_config, request, relative_path=url_builder.relative_path) self.__FinalizeRequest(http_request, url_builder) return self.__client.ProcessHttpRequest(http_request) def _RunMethod(self, method_config, request, global_params=None, upload=None, upload_config=None, download=None): """Call this method with request.""" if upload is not None and download is not None: # TODO(craigcitro): This just involves refactoring the logic # below into callbacks that we can pass around; in particular, # the order should be that the upload gets the initial request, # and then passes its reply to a download if one exists, and # then that goes to ProcessResponse and is returned. raise exceptions.NotYetImplementedError( 'Cannot yet use both upload and download at once') http_request = self.PrepareHttpRequest( method_config, request, global_params, upload, upload_config, download) # TODO(craigcitro): Make num_retries customizable on Transfer # objects, and pass in self.__client.num_retries when initializing # an upload or download. if download is not None: download.InitializeDownload(http_request, client=self.client) return http_response = None if upload is not None: http_response = upload.InitializeUpload( http_request, client=self.client) if http_response is None: http = self.__client.http if upload and upload.bytes_http: http = upload.bytes_http opts = { 'retries': self.__client.num_retries, 'max_retry_wait': self.__client.max_retry_wait, } if self.__client.check_response_func: opts['check_response_func'] = self.__client.check_response_func if self.__client.retry_func: opts['retry_func'] = self.__client.retry_func http_response = http_wrapper.MakeRequest( http, http_request, **opts) return self.ProcessHttpResponse(method_config, http_response, request) def ProcessHttpResponse(self, method_config, http_response, request=None): """Convert an HTTP response to the expected message type.""" return self.__client.ProcessResponse( method_config, self.__ProcessHttpResponse(method_config, http_response, request)) py/credentials_lib_test.py 0000644 00000017122 15025317163 0011736 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import json import os.path import shutil import tempfile import unittest import mock import six from apitools.base.py import credentials_lib from apitools.base.py import util class MetadataMock(object): def __init__(self, scopes=None, service_account_name=None): self._scopes = scopes or ['scope1'] self._sa = service_account_name or 'default' def __call__(self, request_url): if request_url.endswith('scopes'): return six.StringIO(''.join(self._scopes)) elif request_url.endswith('service-accounts'): return six.StringIO(self._sa) elif request_url.endswith( '/service-accounts/%s/token' % self._sa): return six.StringIO('{"access_token": "token"}') self.fail('Unexpected HTTP request to %s' % request_url) class CredentialsLibTest(unittest.TestCase): def _RunGceAssertionCredentials( self, service_account_name=None, scopes=None, cache_filename=None): kwargs = {} if service_account_name is not None: kwargs['service_account_name'] = service_account_name if cache_filename is not None: kwargs['cache_filename'] = cache_filename service_account_name = service_account_name or 'default' credentials = credentials_lib.GceAssertionCredentials( scopes, **kwargs) self.assertIsNone(credentials._refresh(None)) return credentials def _GetServiceCreds(self, service_account_name=None, scopes=None): metadatamock = MetadataMock(scopes, service_account_name) with mock.patch.object(util, 'DetectGce', autospec=True) as gce_detect: gce_detect.return_value = True with mock.patch.object(credentials_lib, '_GceMetadataRequest', side_effect=metadatamock, autospec=True) as opener_mock: credentials = self._RunGceAssertionCredentials( service_account_name=service_account_name, scopes=scopes) self.assertEqual(3, opener_mock.call_count) return credentials def testGceServiceAccounts(self): scopes = ['scope1'] self._GetServiceCreds(service_account_name=None, scopes=None) self._GetServiceCreds(service_account_name=None, scopes=scopes) self._GetServiceCreds( service_account_name='my_service_account', scopes=scopes) def testGceAssertionCredentialsToJson(self): scopes = ['scope1'] service_account_name = 'my_service_account' # Ensure that we can obtain a JSON representation of # GceAssertionCredentials to put in a credential Storage object, and # that the JSON representation is valid. original_creds = self._GetServiceCreds( service_account_name=service_account_name, scopes=scopes) original_creds_json_str = original_creds.to_json() json.loads(original_creds_json_str) @mock.patch.object(util, 'DetectGce', autospec=True) def testGceServiceAccountsCached(self, mock_detect): mock_detect.return_value = True tempd = tempfile.mkdtemp() tempname = os.path.join(tempd, 'creds') scopes = ['scope1'] service_account_name = 'some_service_account_name' metadatamock = MetadataMock(scopes, service_account_name) with mock.patch.object(credentials_lib, '_GceMetadataRequest', side_effect=metadatamock, autospec=True) as opener_mock: try: creds1 = self._RunGceAssertionCredentials( service_account_name=service_account_name, cache_filename=tempname, scopes=scopes) pre_cache_call_count = opener_mock.call_count creds2 = self._RunGceAssertionCredentials( service_account_name=service_account_name, cache_filename=tempname, scopes=None) finally: shutil.rmtree(tempd) self.assertEqual(creds1.client_id, creds2.client_id) self.assertEqual(pre_cache_call_count, 3) # Caching obviates the need for extra metadata server requests. # Only one metadata request is made if the cache is hit. self.assertEqual(opener_mock.call_count, 4) def testGetServiceAccount(self): # We'd also like to test the metadata calls, which requires # having some knowledge about how HTTP calls are made (so that # we can mock them). It's unfortunate, but there's no way # around it. creds = self._GetServiceCreds() opener = mock.MagicMock() opener.open = mock.MagicMock() opener.open.return_value = six.StringIO('default/\nanother') with mock.patch.object(six.moves.urllib.request, 'build_opener', return_value=opener, autospec=True) as build_opener: creds.GetServiceAccount('default') self.assertEqual(1, build_opener.call_count) self.assertEqual(1, opener.open.call_count) req = opener.open.call_args[0][0] self.assertTrue(req.get_full_url().startswith( 'http://metadata.google.internal/')) # The urllib module does weird things with header case. self.assertEqual('Google', req.get_header('Metadata-flavor')) def testGetAdcNone(self): # Tests that we correctly return None when ADC aren't present in # the well-known file. creds = credentials_lib._GetApplicationDefaultCredentials( client_info={'scope': ''}) self.assertIsNone(creds) class TestGetRunFlowFlags(unittest.TestCase): def setUp(self): self._flags_actual = credentials_lib.FLAGS def tearDown(self): credentials_lib.FLAGS = self._flags_actual def test_with_gflags(self): HOST = 'myhostname' PORT = '144169' class MockFlags(object): auth_host_name = HOST auth_host_port = PORT auth_local_webserver = False credentials_lib.FLAGS = MockFlags flags = credentials_lib._GetRunFlowFlags([ '--auth_host_name=%s' % HOST, '--auth_host_port=%s' % PORT, '--noauth_local_webserver', ]) self.assertEqual(flags.auth_host_name, HOST) self.assertEqual(flags.auth_host_port, PORT) self.assertEqual(flags.logging_level, 'ERROR') self.assertEqual(flags.noauth_local_webserver, True) def test_without_gflags(self): credentials_lib.FLAGS = None flags = credentials_lib._GetRunFlowFlags([]) self.assertEqual(flags.auth_host_name, 'localhost') self.assertEqual(flags.auth_host_port, [8080, 8090]) self.assertEqual(flags.logging_level, 'ERROR') self.assertEqual(flags.noauth_local_webserver, False) py/__init__.py 0000644 00000002337 15025317163 0007315 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Top-level imports for apitools base files.""" # pylint:disable=wildcard-import # pylint:disable=redefined-builtin from apitools.base.py.base_api import * from apitools.base.py.batch import * from apitools.base.py.credentials_lib import * from apitools.base.py.encoding import * from apitools.base.py.exceptions import * from apitools.base.py.extra_types import * from apitools.base.py.http_wrapper import * from apitools.base.py.list_pager import * from apitools.base.py.transfer import * from apitools.base.py.util import * try: # pylint:disable=no-name-in-module from apitools.base.py.internal import * except ImportError: pass py/list_pager.py 0000644 00000012762 15025317163 0007712 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """A helper function that executes a series of List queries for many APIs.""" from apitools.base.py import encoding import six __all__ = [ 'YieldFromList', ] def _GetattrNested(message, attribute): """Gets a possibly nested attribute. Same as getattr() if attribute is a string; if attribute is a tuple, returns the nested attribute referred to by the fields in the tuple as if they were a dotted accessor path. (ex _GetattrNested(msg, ('foo', 'bar', 'baz')) gets msg.foo.bar.baz """ if isinstance(attribute, six.string_types): return getattr(message, attribute) elif len(attribute) == 0: return message else: return _GetattrNested(getattr(message, attribute[0]), attribute[1:]) def _SetattrNested(message, attribute, value): """Sets a possibly nested attribute. Same as setattr() if attribute is a string; if attribute is a tuple, sets the nested attribute referred to by the fields in the tuple as if they were a dotted accessor path. (ex _SetattrNested(msg, ('foo', 'bar', 'baz'), 'v') sets msg.foo.bar.baz to 'v' """ if isinstance(attribute, six.string_types): return setattr(message, attribute, value) elif len(attribute) < 1: raise ValueError("Need an attribute to set") elif len(attribute) == 1: return setattr(message, attribute[0], value) else: return setattr(_GetattrNested(message, attribute[:-1]), attribute[-1], value) def YieldFromList( service, request, global_params=None, limit=None, batch_size=100, method='List', field='items', predicate=None, current_token_attribute='pageToken', next_token_attribute='nextPageToken', batch_size_attribute='maxResults', get_field_func=_GetattrNested): """Make a series of List requests, keeping track of page tokens. Args: service: apitools_base.BaseApiService, A service with a .List() method. request: protorpc.messages.Message, The request message corresponding to the service's .List() method, with all the attributes populated except the .maxResults and .pageToken attributes. global_params: protorpc.messages.Message, The global query parameters to provide when calling the given method. limit: int, The maximum number of records to yield. None if all available records should be yielded. batch_size: int, The number of items to retrieve per request. method: str, The name of the method used to fetch resources. field: str, The field in the response that will be a list of items. predicate: lambda, A function that returns true for items to be yielded. current_token_attribute: str or tuple, The name of the attribute in a request message holding the page token for the page being requested. If a tuple, path to attribute. next_token_attribute: str or tuple, The name of the attribute in a response message holding the page token for the next page. If a tuple, path to the attribute. batch_size_attribute: str or tuple, The name of the attribute in a response message holding the maximum number of results to be returned. None if caller-specified batch size is unsupported. If a tuple, path to the attribute. get_field_func: Function that returns the items to be yielded. Argument is response message, and field. Yields: protorpc.message.Message, The resources listed by the service. """ request = encoding.CopyProtoMessage(request) _SetattrNested(request, current_token_attribute, None) while limit is None or limit: if batch_size_attribute: # On Py3, None is not comparable so min() below will fail. # On Py2, None is always less than any number so if batch_size # is None, the request_batch_size will always be None regardless # of the value of limit. This doesn't generally strike me as the # correct behavior, but this change preserves the existing Py2 # behavior on Py3. if batch_size is None: request_batch_size = None else: request_batch_size = min(batch_size, limit or batch_size) _SetattrNested(request, batch_size_attribute, request_batch_size) response = getattr(service, method)(request, global_params=global_params) items = get_field_func(response, field) if predicate: items = list(filter(predicate, items)) for item in items: yield item if limit is None: continue limit -= 1 if not limit: return token = _GetattrNested(response, next_token_attribute) if not token: return _SetattrNested(request, current_token_attribute, token) py/gzip.py 0000644 00000052613 15025317163 0006531 0 ustar 00 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, # 2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation; All # Rights Reserved # # This is a backport from python 3.4 into python 2.7. Text and exclusive mode # support are removed as they're unsupported in 2.7. This backport patches a # streaming bug that exists in python 2.7. """Functions that read and write gzipped files. The user of the file doesn't have to worry about the compression, but random access is not allowed.""" # based on Andrew Kuchling's minigzip.py distributed with the zlib module import six from six.moves import builtins from six.moves import range import struct import sys import time import os import zlib import io __all__ = ["GzipFile", "open", "compress", "decompress"] FTEXT, FHCRC, FEXTRA, FNAME, FCOMMENT = 1, 2, 4, 8, 16 READ, WRITE = 1, 2 def open(filename, mode="rb", compresslevel=9): """Shorthand for GzipFile(filename, mode, compresslevel). The filename argument is required; mode defaults to 'rb' and compresslevel defaults to 9. """ return GzipFile(filename, mode, compresslevel) def write32u(output, value): # The L format writes the bit pattern correctly whether signed # or unsigned. output.write(struct.pack("<L", value)) class _PaddedFile(object): """Minimal read-only file object that prepends a string to the contents of an actual file. Shouldn't be used outside of gzip.py, as it lacks essential functionality.""" def __init__(self, f, prepend=b''): self._buffer = prepend self._length = len(prepend) self.file = f self._read = 0 def read(self, size): if self._read is None: return self.file.read(size) if self._read + size <= self._length: read = self._read self._read += size return self._buffer[read:self._read] else: read = self._read self._read = None return self._buffer[read:] + \ self.file.read(size - self._length + read) def prepend(self, prepend=b'', readprevious=False): if self._read is None: self._buffer = prepend elif readprevious and len(prepend) <= self._read: self._read -= len(prepend) return else: self._buffer = self._buffer[self._read:] + prepend self._length = len(self._buffer) self._read = 0 def unused(self): if self._read is None: return b'' return self._buffer[self._read:] def seek(self, offset, whence=0): # This is only ever called with offset=whence=0 if whence == 1 and self._read is not None: if 0 <= offset + self._read <= self._length: self._read += offset return else: offset += self._length - self._read self._read = None self._buffer = None return self.file.seek(offset, whence) def __getattr__(self, name): return getattr(self.file, name) class GzipFile(io.BufferedIOBase): """The GzipFile class simulates most of the methods of a file object with the exception of the readinto() and truncate() methods. This class only supports opening files in binary mode. If you need to open a compressed file in text mode, use the gzip.open() function. """ myfileobj = None max_read_chunk = 10 * 1024 * 1024 # 10Mb def __init__(self, filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None): """Constructor for the GzipFile class. At least one of fileobj and filename must be given a non-trivial value. The new class instance is based on fileobj, which can be a regular file, an io.BytesIO object, or any other object which simulates a file. It defaults to None, in which case filename is opened to provide a file object. When fileobj is not None, the filename argument is only used to be included in the gzip file header, which may includes the original filename of the uncompressed file. It defaults to the filename of fileobj, if discernible; otherwise, it defaults to the empty string, and in this case the original filename is not included in the header. The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', or 'wb', depending on whether the file will be read or written. The default is the mode of fileobj if discernible; otherwise, the default is 'rb'. A mode of 'r' is equivalent to one of 'rb', and similarly for 'w' and 'wb', and 'a' and 'ab'. The compresslevel argument is an integer from 0 to 9 controlling the level of compression; 1 is fastest and produces the least compression, and 9 is slowest and produces the most compression. 0 is no compression at all. The default is 9. The mtime argument is an optional numeric timestamp to be written to the stream when compressing. All gzip compressed streams are required to contain a timestamp. If omitted or None, the current time is used. This module ignores the timestamp when decompressing; however, some programs, such as gunzip, make use of it. The format of the timestamp is the same as that of the return value of time.time() and of the st_mtime member of the object returned by os.stat(). """ if mode and ('t' in mode or 'U' in mode): raise ValueError("Invalid mode: {!r}".format(mode)) if mode and 'b' not in mode: mode += 'b' if fileobj is None: fileobj = self.myfileobj = builtins.open(filename, mode or 'rb') if filename is None: filename = getattr(fileobj, 'name', '') if not isinstance(filename, six.string_types): filename = '' if mode is None: mode = getattr(fileobj, 'mode', 'rb') if mode.startswith('r'): self.mode = READ # Set flag indicating start of a new member self._new_member = True # Buffer data read from gzip file. extrastart is offset in # stream where buffer starts. extrasize is number of # bytes remaining in buffer from current stream position. self.extrabuf = b"" self.extrasize = 0 self.extrastart = 0 self.name = filename # Starts small, scales exponentially self.min_readsize = 100 fileobj = _PaddedFile(fileobj) elif mode.startswith(('w', 'a')): self.mode = WRITE self._init_write(filename) self.compress = zlib.compressobj(compresslevel, zlib.DEFLATED, -zlib.MAX_WBITS, zlib.DEF_MEM_LEVEL, 0) else: raise ValueError("Invalid mode: {!r}".format(mode)) self.fileobj = fileobj self.offset = 0 self.mtime = mtime if self.mode == WRITE: self._write_gzip_header() @property def filename(self): import warnings warnings.warn("use the name attribute", DeprecationWarning, 2) if self.mode == WRITE and self.name[-3:] != ".gz": return self.name + ".gz" return self.name def __repr__(self): fileobj = self.fileobj if isinstance(fileobj, _PaddedFile): fileobj = fileobj.file s = repr(fileobj) return '<gzip ' + s[1:-1] + ' ' + hex(id(self)) + '>' def _check_closed(self): """Raises a ValueError if the underlying file object has been closed. """ if self.closed: raise ValueError('I/O operation on closed file.') def _init_write(self, filename): self.name = filename self.crc = zlib.crc32(b"") & 0xffffffff self.size = 0 self.writebuf = [] self.bufsize = 0 def _write_gzip_header(self): self.fileobj.write(b'\037\213') # magic header self.fileobj.write(b'\010') # compression method try: # RFC 1952 requires the FNAME field to be Latin-1. Do not # include filenames that cannot be represented that way. fname = os.path.basename(self.name) if not isinstance(fname, six.binary_type): fname = fname.encode('latin-1') if fname.endswith(b'.gz'): fname = fname[:-3] except UnicodeEncodeError: fname = b'' flags = 0 if fname: flags = FNAME self.fileobj.write(six.unichr(flags).encode('latin-1')) mtime = self.mtime if mtime is None: mtime = time.time() write32u(self.fileobj, int(mtime)) self.fileobj.write(b'\002') self.fileobj.write(b'\377') if fname: self.fileobj.write(fname + b'\000') def _init_read(self): self.crc = zlib.crc32(b"") & 0xffffffff self.size = 0 def _read_exact(self, n): data = self.fileobj.read(n) while len(data) < n: b = self.fileobj.read(n - len(data)) if not b: raise EOFError("Compressed file ended before the " "end-of-stream marker was reached") data += b return data def _read_gzip_header(self): magic = self.fileobj.read(2) if magic == b'': return False if magic != b'\037\213': raise OSError('Not a gzipped file') method, flag, self.mtime = struct.unpack("<BBIxx", self._read_exact(8)) if method != 8: raise OSError('Unknown compression method') if flag & FEXTRA: # Read & discard the extra field, if present extra_len, = struct.unpack("<H", self._read_exact(2)) self._read_exact(extra_len) if flag & FNAME: # Read and discard a null-terminated string containing the filename while True: s = self.fileobj.read(1) if not s or s == b'\000': break if flag & FCOMMENT: # Read and discard a null-terminated string containing a comment while True: s = self.fileobj.read(1) if not s or s == b'\000': break if flag & FHCRC: self._read_exact(2) # Read & discard the 16-bit header CRC unused = self.fileobj.unused() if unused: uncompress = self.decompress.decompress(unused) self._add_read_data(uncompress) return True def write(self, data): self._check_closed() if self.mode != WRITE: import errno raise OSError(errno.EBADF, "write() on read-only GzipFile object") if self.fileobj is None: raise ValueError("write() on closed GzipFile object") # Convert data type if called by io.BufferedWriter. if isinstance(data, memoryview): data = data.tobytes() if len(data) > 0: self.fileobj.write(self.compress.compress(data)) self.size += len(data) self.crc = zlib.crc32(data, self.crc) & 0xffffffff self.offset += len(data) return len(data) def read(self, size=-1): self._check_closed() if self.mode != READ: import errno raise OSError(errno.EBADF, "read() on write-only GzipFile object") if self.extrasize <= 0 and self.fileobj is None: return b'' readsize = 1024 if size < 0: # get the whole thing while self._read(readsize): readsize = min(self.max_read_chunk, readsize * 2) size = self.extrasize else: # just get some more of it while size > self.extrasize: if not self._read(readsize): if size > self.extrasize: size = self.extrasize break readsize = min(self.max_read_chunk, readsize * 2) offset = self.offset - self.extrastart chunk = self.extrabuf[offset: offset + size] self.extrasize = self.extrasize - size self.offset += size return chunk def read1(self, size=-1): self._check_closed() if self.mode != READ: import errno raise OSError(errno.EBADF, "read1() on write-only GzipFile object") if self.extrasize <= 0 and self.fileobj is None: return b'' # For certain input data, a single call to _read() may not return # any data. In this case, retry until we get some data or reach EOF. while self.extrasize <= 0 and self._read(): pass if size < 0 or size > self.extrasize: size = self.extrasize offset = self.offset - self.extrastart chunk = self.extrabuf[offset: offset + size] self.extrasize -= size self.offset += size return chunk def peek(self, n): if self.mode != READ: import errno raise OSError(errno.EBADF, "peek() on write-only GzipFile object") # Do not return ridiculously small buffers, for one common idiom # is to call peek(1) and expect more bytes in return. if n < 100: n = 100 if self.extrasize == 0: if self.fileobj is None: return b'' # Ensure that we don't return b"" if we haven't reached EOF. # 1024 is the same buffering heuristic used in read() while self.extrasize == 0 and self._read(max(n, 1024)): pass offset = self.offset - self.extrastart remaining = self.extrasize assert remaining == len(self.extrabuf) - offset return self.extrabuf[offset:offset + n] def _unread(self, buf): self.extrasize = len(buf) + self.extrasize self.offset -= len(buf) def _read(self, size=1024): if self.fileobj is None: return False if self._new_member: # If the _new_member flag is set, we have to # jump to the next member, if there is one. self._init_read() if not self._read_gzip_header(): return False self.decompress = zlib.decompressobj(-zlib.MAX_WBITS) self._new_member = False # Read a chunk of data from the file buf = self.fileobj.read(size) # If the EOF has been reached, flush the decompression object # and mark this object as finished. if buf == b"": uncompress = self.decompress.flush() # Prepend the already read bytes to the fileobj to they can be # seen by _read_eof() self.fileobj.prepend(self.decompress.unused_data, True) self._read_eof() self._add_read_data(uncompress) return False uncompress = self.decompress.decompress(buf) self._add_read_data(uncompress) if self.decompress.unused_data != b"": # Ending case: we've come to the end of a member in the file, # so seek back to the start of the unused data, finish up # this member, and read a new gzip header. # Prepend the already read bytes to the fileobj to they can be # seen by _read_eof() and _read_gzip_header() self.fileobj.prepend(self.decompress.unused_data, True) # Check the CRC and file size, and set the flag so we read # a new member on the next call self._read_eof() self._new_member = True return True def _add_read_data(self, data): self.crc = zlib.crc32(data, self.crc) & 0xffffffff offset = self.offset - self.extrastart self.extrabuf = self.extrabuf[offset:] + data self.extrasize = self.extrasize + len(data) self.extrastart = self.offset self.size = self.size + len(data) def _read_eof(self): # We've read to the end of the file # We check the that the computed CRC and size of the # uncompressed data matches the stored values. Note that the size # stored is the true file size mod 2**32. crc32, isize = struct.unpack("<II", self._read_exact(8)) if crc32 != self.crc: raise OSError("CRC check failed %s != %s" % (hex(crc32), hex(self.crc))) elif isize != (self.size & 0xffffffff): raise OSError("Incorrect length of data produced") # Gzip files can be padded with zeroes and still have archives. # Consume all zero bytes and set the file position to the first # non-zero byte. See http://www.gzip.org/#faq8 c = b"\x00" while c == b"\x00": c = self.fileobj.read(1) if c: self.fileobj.prepend(c, True) @property def closed(self): return self.fileobj is None def close(self): fileobj = self.fileobj if fileobj is None: return self.fileobj = None try: if self.mode == WRITE: fileobj.write(self.compress.flush()) write32u(fileobj, self.crc) # self.size may exceed 2GB, or even 4GB write32u(fileobj, self.size & 0xffffffff) finally: myfileobj = self.myfileobj if myfileobj: self.myfileobj = None myfileobj.close() def flush(self, zlib_mode=zlib.Z_SYNC_FLUSH): self._check_closed() if self.mode == WRITE: # Ensure the compressor's buffer is flushed self.fileobj.write(self.compress.flush(zlib_mode)) self.fileobj.flush() def fileno(self): """Invoke the underlying file object's fileno() method. This will raise AttributeError if the underlying file object doesn't support fileno(). """ return self.fileobj.fileno() def rewind(self): '''Return the uncompressed stream file position indicator to the beginning of the file''' if self.mode != READ: raise OSError("Can't rewind in write mode") self.fileobj.seek(0) self._new_member = True self.extrabuf = b"" self.extrasize = 0 self.extrastart = 0 self.offset = 0 def readable(self): return self.mode == READ def writable(self): return self.mode == WRITE def seekable(self): return True def seek(self, offset, whence=0): if whence: if whence == 1: offset = self.offset + offset else: raise ValueError('Seek from end not supported') if self.mode == WRITE: if offset < self.offset: raise OSError('Negative seek in write mode') count = offset - self.offset chunk = bytes(1024) for i in range(count // 1024): self.write(chunk) self.write(bytes(count % 1024)) elif self.mode == READ: if offset < self.offset: # for negative seek, rewind and do positive seek self.rewind() count = offset - self.offset for i in range(count // 1024): self.read(1024) self.read(count % 1024) return self.offset def readline(self, size=-1): if size < 0: # Shortcut common case - newline found in buffer. offset = self.offset - self.extrastart i = self.extrabuf.find(b'\n', offset) + 1 if i > 0: self.extrasize -= i - offset self.offset += i - offset return self.extrabuf[offset: i] size = sys.maxsize readsize = self.min_readsize else: readsize = size bufs = [] while size != 0: c = self.read(readsize) i = c.find(b'\n') # We set i=size to break out of the loop under two # conditions: 1) there's no newline, and the chunk is # larger than size, or 2) there is a newline, but the # resulting line would be longer than 'size'. if (size <= i) or (i == -1 and len(c) > size): i = size - 1 if i >= 0 or c == b'': bufs.append(c[:i + 1]) # Add portion of last chunk self._unread(c[i + 1:]) # Push back rest of chunk break # Append chunk to list, decrease 'size', bufs.append(c) size = size - len(c) readsize = min(size, readsize * 2) if readsize > self.min_readsize: self.min_readsize = min(readsize, self.min_readsize * 2, 512) return b''.join(bufs) # Return resulting line def compress(data, compresslevel=9): """Compress data in one shot and return the compressed string. Optional argument is the compression level, in range of 0-9. """ buf = io.BytesIO() with GzipFile(fileobj=buf, mode='wb', compresslevel=compresslevel) as f: f.write(data) return buf.getvalue() def decompress(data): """Decompress a gzip compressed string in one shot. Return the decompressed string. """ with GzipFile(fileobj=io.BytesIO(data)) as f: return f.read() protorpclite/__pycache__/protojson.cpython-39.pyc 0000644 00000022647 15025317163 0016206 0 ustar 00 a vyg�4 � @ s� d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ g d�Z dd� Z e � Z G d d � d e j �Z G d d � d e�ZejZejZe�� jZe�� jZdS ) z�JSON support for message types. Public classes: MessageJSONEncoder: JSON encoder for message objects. Public functions: encode_message: Encodes a message in to a JSON string. decode_message: Merge from a JSON string in to a message. � N)� message_types)�messages)�util)�ALTERNATIVE_CONTENT_TYPES� CONTENT_TYPE�MessageJSONEncoder�encode_message�decode_message� ProtoJsonc C s� d} dD ]t}zBt |i i d�}t|d�sBd| }t�|� t|��n |W S W q tyz } z| sf|} W Y d}~qd}~0 0 qt�d� | �dS )a Try to load a valid json module. There are more than one json modules that might be installed. They are mostly compatible with one another but some versions may be different. This function attempts to load various json modules in a preferred order. It does a basic check to guess if a loaded version of json is compatible. Returns: Compatible json module. Raises: ImportError if there are no json modules or the loaded json module is not compatible with ProtoRPC. N)�jsonZ simplejsonr � JSONEncoderz1json library "%s" is not compatible with ProtoRPCz0Must use valid json library (json or simplejson))� __import__�hasattr�logging�warning� ImportError�error)Zfirst_import_error� module_name�module�message�err� r �H/opt/gsutil/third_party/apitools/apitools/base/protorpclite/protojson.py�_load_json_module/ s" �� r c s. e Zd ZdZd� fdd� Z� fdd�Z� ZS )r ziMessage JSON encoder class. Extension of JSONEncoder that can build JSON from a message object. Nc s( t t| �jf i |�� |p t�� | _dS )zVConstructor. Args: protojson_protocol: ProtoJson instance. N)�superr �__init__r � get_default�'_MessageJSONEncoder__protojson_protocol)�self�protojson_protocol�kwargs�� __class__r r r ] s �zMessageJSONEncoder.__init__c s� t |tj�rt|�S tjr.t |t�r.|�d�S t |tj�r�i }|� � D ]2}|� |j �}|dg dfvrF| j � ||�||j < qF|�� D ]}|�|�\}}|||< q�|S tt| ��|�S )z�Return dictionary instance from a message object. Args: value: Value to get dictionary for. If not encodable, will call superclasses default method. �utf8Nr )� isinstancer �Enum�str�six�PY3�bytes�decode�Message� all_fields�get_assigned_value�namer � encode_field�all_unrecognized_fields�get_unrecognized_field_infor r �default)r �value�result�field�itemZ unknown_keyZunrecognized_field�_r! r r r2 g s$ � � zMessageJSONEncoder.default)N)�__name__� __module__� __qualname__�__doc__r r2 � __classcell__r r r! r r W s r c @ sd e Zd ZdZdZg d�Zdd� Zdd� Zdd � Zd d � Z d d � Z dd� Z e dd� �Z e dd� �ZdS )r a ProtoRPC JSON implementation class. Implementation of JSON based protocol used for serializing and deserializing message objects. Instances of remote.ProtocolConfig constructor or used with remote.Protocols.add_protocol. See the remote.py module for more details. zapplication/json)zapplication/x-javascriptztext/javascriptztext/x-javascriptz text/x-jsonz text/jsonc C s\ t |tj�r.|jr"dd� |D �}qXt�|�}n*t |tj�rX|jrPdd� |D �}n|�� }|S )z�Encode a python field value to a JSON value. Args: field: A ProtoRPC field instance. value: A python value supported by field. Returns: A JSON serializable value appropriate for field. c S s g | ]}t �|��qS r )�base64� b64encode)�.0�byter r r � <listcomp>� � z*ProtoJson.encode_field.<locals>.<listcomp>c S s g | ] }|� � �qS r )� isoformat)r? �ir r r rA � rB ) r$ r � BytesField�repeatedr= r> r � DateTimeFieldrC )r r5 r3 r r r r/ � s zProtoJson.encode_fieldc C s |� � tj|t| d�S )a# Encode Message instance to JSON string. Args: Message instance to encode in to JSON string. Returns: String encoding of Message instance in protocol JSON format. Raises: messages.ValidationError if message is not initialized. )�clsr )�check_initializedr �dumpsr )r r r r r r � s �zProtoJson.encode_messagec C s: t �|�}|�� s|� S t�|�}| �||�}|�� |S )a� Merge JSON structure to Message instance. Args: message_type: Message to decode data to. encoded_message: JSON encoded version of message. Returns: Decoded instance of message_type. Raises: ValueError: If encoded_message is not valid JSON. messages.ValidationError if merged message is not initialized. )r' � ensure_str�stripr �loads� _ProtoJson__decode_dictionaryrI )r � message_type�encoded_message� dictionaryr r r r r � s zProtoJson.decode_messagec C s� t |t�rtjjS t |tj�r&tjjS t |t�r8tjj S t |tj �rLtjj S t |t t f�r�dtjjtjj tjj g}d}|D ]@}| �|�}z|�|�}W n ty� d}Y n0 ||krz|}qz|| S dS )a, Find the messages.Variant type that describes this value. Args: value: The value whose variant type is being determined. Returns: The messages.Variant value that best describes value's type, or None if it's a type we don't know how to handle. Nr ���)r$ �boolr �Variant�BOOLr' � integer_types�INT64�float�DOUBLE� string_types�STRING�list�tuple�_ProtoJson__find_variant�index� IndexError)r r3 Zvariant_priorityZchosen_priority�v�variant�priorityr r r Z__find_variant� s2 � zProtoJson.__find_variantc C s� |� }t �|�D �]�\}}|du rFz|�|� W q tyB Y q0 qz|�|�}W n2 ty� | �|�}|r~|�|||� Y qY n0 t|t j �}d} |j �r<t|t �s�|g}g } |D ]R} z | � || �} |r�| du r�W q�W n" t jy� |s� d} Y q�Y n0 | �| � q�t||j| � | r| �|�}|r|�|||� q|g k�rHqzt||j| � ||�� W q t j�y� |�s|� | �|�}|�r�|�|||� Y q0 q|S )a Merge dictionary in to message. Args: message: Message to merge dictionary in to. dictionary: Dictionary to extract information from. Dictionary is as parsed from JSON. Nested objects will also be dictionaries. NFT)r' � iteritems�reset�AttributeError� field_by_name�KeyErrorr^ �set_unrecognized_fieldr$ r � EnumFieldrF r\ � decode_field� DecodeError�append�setattrr. ) r rO rQ r �keyr3 r5 rb Z is_enum_fieldZis_unrecognized_fieldZ valid_valuer6 ra r r r Z__decode_dictionary sb z ProtoJson.__decode_dictionaryc C s� t |tj�rBz |�|�W S ty< t�d|p2d ��Y n0 �n>t |tj�r�z t�|�W S t j tfy� } zt�d| ��W Y d}~n d}~0 0 n�t |t j �r�zt j|dd�W S ty� } zt�|��W Y d}~n d}~0 0 n�t |tj��rt|jtj��r| �|j|�S t |tj��rLt |tjtjf��rLz t|�W S Y n0 n4t |tj��r�t |tj��r�z t|�W S Y n0 |S )z�Decode a JSON value to a python value. Args: field: A ProtoRPC field instance. value: A serialized JSON value. Return: A Python value compatible with field. zInvalid enum value "%s"� zBase64 decoding error: %sNT)� truncate_time)r$ r rj �type� TypeErrorrl rE r= � b64decode�binascii�Errorr rG r �decode_datetime� ValueError� MessageField� issubclassr+ rN � FloatFieldr' rV rZ rX � IntegerField�int)r r5 r3 r r r r rk D sH � & " �� � zProtoJson.decode_fieldc C s. zt jW S ty( t � t _t j Y S 0 dS )z!Get default instanceof ProtoJson.N)r �_ProtoJson__defaultrf r r r r r u s zProtoJson.get_defaultc C s t | t�std��| t_dS )zhSet the default instance of ProtoJson. Args: protocol: A ProtoJson instance. z#Expected protocol of type ProtoJsonN)r$ r rs r~ )�protocolr r r � set_default~ s zProtoJson.set_defaultN)r8 r9 r: r; r r r/ r r r^ rN rk � staticmethodr r� r r r r r � s &D1 r )r; r= ru r r' �apitools.base.protorpcliter r r �__all__r r r r �objectr r r r r r r r r r �<module> s$ $1 protorpclite/__pycache__/util.cpython-39.pyc 0000644 00000020372 15025317163 0015117 0 ustar 00 a vyg�' � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl Z ddl Z g d�Z G dd� de �Z dZe�eejejB �Zdd � Zed �d d � �Zd d� ZG dd� dej�Zddd�ZdS )zCommon utility library.� )�with_statementN)�Error�decode_datetime�get_package_for_module� positional�TimeZoneOffset� total_secondsc @ s e Zd ZdZdS )r z#Base class for protorpc exceptions.N)�__name__� __module__� __qualname__�__doc__� r r �C/opt/gsutil/third_party/apitools/apitools/base/protorpclite/util.pyr ( s r z # Examples: # +01:00 # -05:30 # Z12:00 ((?P<z>Z) | (?P<sign>[-+]) (?P<hours>\d\d) : (?P<minutes>\d\d))$ c s\ � fdd�}t � tj�r |S t�� �^}}}}}|du r@td��tt|�t|� �� �S dS )a A decorator that declares only the first N arguments may be positional. This decorator makes it easy to support Python 3 style keyword-only parameters. For example, in Python 3 it is possible to write: def fn(pos1, *, kwonly1=None, kwonly1=None): ... All named parameters after * must be a keyword: fn(10, 'kw1', 'kw2') # Raises exception. fn(10, kwonly1='kw1') # Ok. Example: To define a function like above, do: @positional(1) def fn(pos1, kwonly1=None, kwonly2=None): ... If no default value is provided to a keyword argument, it becomes a required keyword argument: @positional(0) def fn(required_kw): ... This must be called with the keyword parameter: fn() # Raises exception. fn(10) # Raises exception. fn(required_kw=10) # Ok. When defining instance or class methods always remember to account for 'self' and 'cls': class MyClass(object): @positional(2) def my_method(self, pos1, kwonly1=None): ... @classmethod @positional(2) def my_method(cls, pos1, kwonly1=None): ... One can omit the argument to 'positional' altogether, and then no arguments with default values may be passed positionally. This would be equivalent to placing a '*' before the first argument with a default value in Python 3. If there are no arguments with default values, and no argument is given to 'positional', an error is raised. @positional def fn(arg1, arg2, required_kw1=None, required_kw2=0): ... fn(1, 3, 5) # Raises exception. fn(1, 3) # Ok. fn(1, 3, required_kw1=5) # Ok. Args: max_positional_arguments: Maximum number of positional arguments. All parameters after the this index must be keyword only. Returns: A decorator that prevents using arguments after max_positional_args from being used as positional parameters. Raises: TypeError if a keyword-only argument is provided as a positional parameter. ValueError if no maximum number of arguments is provided and the function has no arguments with default values. c s t �� ��� fdd��}|S )z9Creates a function wraper to enforce number of arguments.c sD t | �� kr6d}� dkr d}td�j� |t | �f ���| i |��S )N� � �sz6%s() takes at most %d positional argument%s (%d given))�len� TypeErrorr )�args�kwargs�plural_s)�max_positional_args�wrappedr r �positional_wrapper� s ��zDpositional.<locals>.positional_decorator.<locals>.positional_wrapper)� functools�wraps)r r �r )r r �positional_decorator� s z(positional.<locals>.positional_decoratorNzDFunctions with no keyword arguments must specify max_positional_args)� isinstance�six� integer_types�inspect�getfullargspec� ValueErrorr r )r r r �_�defaultsr r r r 8 s M �r r c C s� t | tj�r0ztj| } W n ty. Y dS 0 zt�| j�W S ty� | j dkr�z | j }W n tyr Y nJ0 t j � |�}t j �|�}t|�dkr�t�|� Y S d�|dd� � Y S t�| j � Y S 0 dS )a� Get package name for a module. Helper calculates the package name of a module. Args: module: Module to get name for. If module is a string, try to find module in sys.modules. Returns: If module contains 'package' attribute, uses that as package name. Else, if module is not the '__main__' module, the module __name__. Else, the base name of the module file name. Else None. N�__main__r �.���)r r � string_types�sys�modules�KeyError� text_type�package�AttributeErrorr �__file__�os�path�basename�splitextr �join)�module� file_name� base_nameZ split_namer r r r � s& r c C s. | j d d d | j }|d | j }|d S )z4Backport of offset.total_seconds() from python 2.7+.� �< i@B g ��.A)�days�seconds� microseconds)�offsetr< r= r r r r � s r c s0 e Zd ZdZ� fdd�Zdd� Zdd� Z� ZS )r z<Time zone information as encoded/decoded for DateTimeFields.c s0 t t| ��� t|tj�r&t|�d }|| _dS )z�Initialize a time zone offset. Args: offset: Integer or timedelta time zone offset, in minutes from UTC. This can be negative. r: N)�superr �__init__r �datetime� timedeltar �_TimeZoneOffset__offset)�selfr> �� __class__r r r@ � s zTimeZoneOffset.__init__c C s t j| jd�S )z�Get the a timedelta with the time zone's offset from UTC. Returns: The time zone offset from UTC, as a timedelta. )�minutes)rA rB rC �rD r$ r r r � utcoffset� s zTimeZoneOffset.utcoffsetc C s t �d�S )a Get the daylight savings time offset. The formats that ProtoRPC uses to encode/decode time zone information don't contain any information about daylight savings time. So this always returns a timedelta of 0. Returns: A timedelta of 0. r )rA rB rH r r r �dst� s zTimeZoneOffset.dst)r r r r r@ rI rJ � __classcell__r r rE r r � s r Fc C sH t �| �}|r&| d|�d�� �� }n| �� }d|v r<d}nd}ztj�||�}W np ty� |r�d|v r�|�d�\}}t|�dkr�d� ||dd� �}tj�||�}t � d||� q�� n� Y n0 |s�|S |� d �r�d } nB|� d �} d d � |� dd�D �\} } | d | } | dk�r | d9 } t�|j |j|j|j|j|j|jt| ��S )a� Decode a DateTimeField parameter from a string to a python datetime. Args: encoded_datetime: A string in RFC 3339 format. truncate_time: If true, truncate time string with precision higher than microsecs. Returns: A datetime object with the date and time specified in encoded_datetime. Raises: ValueError: If the string is not in a recognized format. Nr r' z%Y-%m-%dT%H:%M:%S.%fz%Y-%m-%dT%H:%M:%S� z{}.{}z,Truncating the datetime string from %s to %s�zr �signc S s g | ] }t |��qS r )�int)�.0�valuer r r � <listcomp>- � z#decode_datetime.<locals>.<listcomp>�hoursrG r: �-r( )� _TIME_ZONE_RE�search�start�upperrA �strptimer# �splitr �format�logging�warning�group�year�month�day�hour�minute�second� microsecondr ) Zencoded_datetimeZ truncate_timeZtime_zone_match� time_string� format_stringZdecoded_datetimeZdatetime_stringZ decimal_secsZtruncated_time_stringZoffset_minutesrN rT rG r r r r � s` � ��� � �r )F)r � __future__r rA r r! r] r1 �rer* r �__all__� Exceptionr Z_TIME_ZONE_RE_STRING�compile� IGNORECASE�VERBOSErV r r r �tzinfor r r r r r �<module> s& g &% protorpclite/__pycache__/__init__.cpython-39.pyc 0000644 00000000436 15025317163 0015700 0 ustar 00 a vyg� � @ s d Z ddlmZ eee�ZdS )z Shared __init__.py for apitools.� )� extend_pathN)�__doc__�pkgutilr �__path__�__name__� r r �G/opt/gsutil/third_party/apitools/apitools/base/protorpclite/__init__.py�<module> s protorpclite/__pycache__/messages.cpython-39.pyc 0000644 00000157761 15025317163 0015766 0 ustar 00 a vyg� � @ sL d Z ddlZddlZddlZddlmZ g d�ZejZG dd� de�ZG dd� de�Z G d d � d e �Z G d d � d e �Z G d d� de �Z G dd� de�Z G dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Zeg d��Zeg d ��Zed g�Zd Zd Zd Zd ZG d!d"� d"e�Z G d#d$� d$e �Z G d%d&� d&e� e e ��Z G d'd(� d(e �Z!G d)d*� d*e �Z"G d+d,� d,e� e"e ��Z#G d-d.� d.e$�Z%G d/d0� d0e�Z&G d1d2� d2e� e&e ��Z'G d3d4� d4e'�Z(G d5d6� d6e'�Z)G d7d8� d8e'�Z*G d9d:� d:e'�Z+G d;d<� d<e'�Z,G d=d>� d>e'�Z-G d?d@� d@e'�Z.e�/dA�de0fdBdC��Z1dS )Da� Stand-alone implementation of in memory protocol messages. Public Classes: Enum: Represents an enumerated type. Variant: Hint for wire format to determine how to serialize. Message: Base class for user defined messages. IntegerField: Field for integer values. FloatField: Field for float values. BooleanField: Field for boolean values. BytesField: Field for binary string values. StringField: Field for UTF-8 string values. MessageField: Field for other message type values. EnumField: Field for enumerated type values. Public Exceptions (indentation indications class hierarchy): EnumDefinitionError: Raised when enumeration is incorrectly defined. FieldDefinitionError: Raised when field is incorrectly defined. InvalidVariantError: Raised when variant is not compatible with field type. InvalidDefaultError: Raised when default is not compatiable with field. InvalidNumberError: Raised when field number is out of range or reserved. MessageDefinitionError: Raised when message is incorrectly defined. DuplicateNumberError: Raised when field has duplicate number with another. ValidationError: Raised when a message or field is not valid. DefinitionNotFoundError: Raised when definition not found. � N)�util) �MAX_ENUM_VALUE�MAX_FIELD_NUMBER�FIRST_RESERVED_FIELD_NUMBER�LAST_RESERVED_FIELD_NUMBER�Enum�Field� FieldList�Variant�Message� IntegerField� FloatField� BooleanField� BytesField� StringField� MessageField� EnumField�find_definition�Error� DecodeError� EncodeError�EnumDefinitionError�FieldDefinitionError�InvalidVariantError�InvalidDefaultError�InvalidNumberError�MessageDefinitionError�DuplicateNumberError�ValidationError�DefinitionNotFoundErrorc @ s e Zd ZdZdS )r z Enumeration definition error.N��__name__� __module__� __qualname__�__doc__� r% r% �G/opt/gsutil/third_party/apitools/apitools/base/protorpclite/messages.pyr _ s r c @ s e Zd ZdZdS )r zField definition error.Nr r% r% r% r& r c s r c @ s e Zd ZdZdS )r z"Invalid variant provided to field.Nr r% r% r% r& r g s r c @ s e Zd ZdZdS )r z"Invalid default provided to field.Nr r% r% r% r& r k s r c @ s e Zd ZdZdS )r z!Invalid number provided to field.Nr r% r% r% r& r o s r c @ s e Zd ZdZdS )r zMessage definition error.Nr r% r% r% r& r s s r c @ s e Zd ZdZdS )r z#Duplicate number assigned to field.Nr r% r% r% r& r w s r c @ s e Zd ZdZdS )r z$Raised when definition is not found.Nr r% r% r% r& r { s r c @ s e Zd ZdZdS )r z/Error found decoding message from encoded form.Nr r% r% r% r& r s r c @ s e Zd ZdZdS )r z"Error found when encoding message.Nr r% r% r% r& r � s r c @ s e Zd ZdZdd� ZdS )r z Invalid value for message error.c C s t �| �S )z6Prints string with field name if present on exception.)r �__str__��selfr% r% r& r' � s zValidationError.__str__N)r! r" r# r$ r' r% r% r% r& r � s r )r" r$ r# Z__static_attributes__Z__firstlineno__)�name�_message_definition�_MessageField__type�_EnumField__type� _EnumField__resolved_defaultr+ i��� i8J i N c @ sL e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dS )�_DefinitionClassau Base meta-class used for definition meta-classes. The Enum and Message definition classes share some basic functionality. Both of these classes may be contained by a Message definition. After initialization, neither class may have attributes changed except for the protected _message_definition attribute, and that attribute may change only once. Fc C s& t �| |||� | jtfkr"d| _dS )z Constructor.TN)�type�__init__� __bases__�object� _DefinitionClass__initialized��clsr* �bases�dctr% r% r& r1 � s z_DefinitionClass.__init__c C s$ z | � � W S ty Y dS 0 dS )z�Get outer Message definition that contains this definition. Returns: Containing Message definition if definition is contained within one, else None. N�r+ �AttributeError�r6 r% r% r& �message_definition� s z#_DefinitionClass.message_definitionc C s. | j r |tvr td| ��nt�| ||� dS )a� Overridden to avoid setting variables after init. Setting attributes on a class must work during the period of initialization to set the enumation value class variables and build the name/number maps. Once __init__ has set the __initialized flag to True prohibits setting any more values on the class. The class is in effect frozen. Args: name: Name of value to set. value: Value to set. zMay not change values: %sN)r4 �_POST_INIT_ATTRIBUTE_NAMESr: r0 � __setattr__)r6 r* �valuer% r% r& r> � s z _DefinitionClass.__setattr__c C s t d��dS )zAOverridden so that cannot delete varaibles on definition classes.z-May not delete attributes on definition classN�� TypeError�r6 r* r% r% r& � __delattr__� s z _DefinitionClass.__delattr__c C s* | � � }|du r t�| j�S d|| jf S )a� Helper method for creating definition name. Names will be generated to include the classes package name, scope (if the class is nested in another definition) and class name. By default, the package name for a definition is derived from its module name. However, this value can be overriden by placing a 'package' attribute in the module that contains the definition class. For example: package = 'some.alternate.package' class MyMessage(Message): ... >>> MyMessage.definition_name() some.alternate.package.MyMessage Returns: Dot-separated fully qualified name of definition. N�%s.%s)�outer_definition_name�six� text_typer! )r6 rE r% r% r& �definition_name� s z _DefinitionClass.definition_namec C s | � � }|st�| j�S |�� S )z�Helper method for creating outer definition name. Returns: If definition is nested, will return the outer definitions name, else the package name. )r< r �get_package_for_moduler" rH �r6 Zouter_definitionr% r% r& rE s z&_DefinitionClass.outer_definition_namec C s | � � }|st�| j�S |�� S )z�Helper method for creating creating the package of a definition. Returns: Name of package that definition belongs to. )r< r rI r" �definition_packagerJ r% r% r& rK s z#_DefinitionClass.definition_packageN) r! r" r# r$ r4 r1 r< r> rC rH rE rK r% r% r% r& r/ � s r/ c @ sH e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dS )� _EnumClassaF Meta-class used for defining the Enum base class. Meta-class enables very specific behavior for any defined Enum class. All attributes defined on an Enum sub-class must be integers. Each attribute defined on an Enum sub-class is translated into an instance of that sub-class, with the name of the attribute as its name, and the number provided as its value. It also ensures that only one level of Enum class hierarchy is possible. In other words it is not possible to delcare sub-classes of sub-classes of Enum. This class also defines some functions in order to restrict the behavior of the Enum class and its sub-classes. It is not possible to change the behavior of the Enum class in later classes since any new classes may be defined with only integer values, and no methods. c C s |t fks |tfks td| ��i | _i | _|t fk�r|�� D ]�\}}|tv rRq@t|tj �sntd||f ��|dk r�td||f ��|t kr�tdt ||f ��|| jv r�td||| j| j f ��t � | �}| � |||� || j|j < || j|j< t| ||� q@t� | |||� d S )Nz'Enum type %s may only inherit from Enumz:May only use integers in Enum definitions. Found: %s = %sr z2Must use non-negative enum values. Found: %s = %dz;Must use enum values less than or equal %d. Found: %s = %dz(Value for %s = %d is already defined: %s)r3 r r �_EnumClass__by_number�_EnumClass__by_name�items�_RESERVED_ATTRIBUTE_NAMES� isinstancerF � integer_typesr r* �__new__r1 �number�setattrr/ )r6 r* r7 r8 � attributer? �instancer% r% r& r1 + sP � ������ �� z_EnumClass.__init__c C s t | j�� �S )z�Iterate over all values of enum. Yields: Enumeration instances of the Enum class in arbitrary order. )�iterrM �valuesr; r% r% r& �__iter__` s z_EnumClass.__iter__c C s | j �� S )zyGet all names for Enum. Returns: An iterator for names of the enumeration in arbitrary order. )rN �keysr; r% r% r& �namesh s z_EnumClass.namesc C s | j �� S )z�Get all numbers for Enum. Returns: An iterator for all numbers of the enumeration in arbitrary order. )rM r[ r; r% r% r& �numbersp s z_EnumClass.numbersc C s | j | S )z�Look up Enum by name. Args: name: Name of enum to find. Returns: Enum sub-class instance of that value. )rN rB r% r% r& �lookup_by_namex s z_EnumClass.lookup_by_namec C s | j | S )z�Look up Enum by number. Args: number: Number of enum to find. Returns: Enum sub-class instance of that value. )rM �r6 rT r% r% r& �lookup_by_number� s z_EnumClass.lookup_by_numberc C s t | j�S �N)�lenrN r; r% r% r& �__len__� s z_EnumClass.__len__N) r! r" r# r$ r1 rZ r\ r] r^ r` rc r% r% r% r& rL s 5 rL c @ s� e Zd ZdZed�Zdd� Zd&dd�Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zed"d#� �Zed$d%� �ZdS )'r z$Base class for all enumerated types.�r* rT c C s| t || �r|S t |tj�r:z | �|�W S ty8 Y n0 t |tj�rfz | �|�W S tyd Y n0 td|| jf ��dS )aG Acts as look-up routine after class is initialized. The purpose of overriding __new__ is to provide a way to treat Enum subclasses as casting types, similar to how the int type functions. A program can pass a string or an integer and this method with "convert" that value in to an appropriate Enum instance. Args: index: Name or number to look up. During initialization this is always the name of the new enum value. Raises: TypeError: When an inappropriate index value is passed provided. z No such value for %s in Enum %sN) rQ rF rR r` �KeyError� string_typesr^ rA r! )r6 �indexr% r% r& rS � s �z Enum.__new__Nc C s2 t t| �d�rdS t�| d|� t�| d|� dS )z�Initialize new Enum instance. Since this should only be called during class initialization any calls that happen after the class is frozen raises an exception. r4 Nr* rT )�getattrr0 r3 r> )r) r* rT r% r% r& r1 � s z Enum.__init__c C s t d��d S )NzMay not change enum valuesr@ �r) r* r? r% r% r& r> � s zEnum.__setattr__c C s | j S ra )r* r( r% r% r& r' � s z Enum.__str__c C s | j S ra �rT r( r% r% r& �__int__� s z Enum.__int__c C s dt | �j| j| jf S )Nz %s(%s, %d))r0 r! r* rT r( r% r% r& �__repr__� s z Enum.__repr__c C s | j | jffS )z�Enable pickling. Returns: A 2-tuple containing the class and __new__ args to be used for restoring a pickled instance. )� __class__rT r( r% r% r& � __reduce__� s zEnum.__reduce__c C s t |t| ��r t| j|j�S tS �zOrder is by number.)rQ r0 �cmprT �NotImplemented�r) �otherr% r% r& �__cmp__� s z Enum.__cmp__c C s t |t| ��r| j|jk S tS ro �rQ r0 rT rq rr r% r% r& �__lt__� s z Enum.__lt__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__le__� s z Enum.__le__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__eq__� s z Enum.__eq__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__ne__� s z Enum.__ne__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__ge__� s z Enum.__ge__c C s t |t| ��r| j|jkS tS ro ru rr r% r% r& �__gt__ s z Enum.__gt__c C s t | j�S )zHash by number.)�hashrT r( r% r% r& �__hash__ s z Enum.__hash__c C s t dd� t| �D ��S )z�Make dictionary version of enumerated class. Dictionary created this way can be used with def_num. Returns: A dict (name) -> number c s s | ]}|j |jfV qd S ra rd )�.0�itemr% r% r& � <genexpr> � z Enum.to_dict.<locals>.<genexpr>)�dictrX r; r% r% r& �to_dict s z Enum.to_dictc C s t |tf| �S )z�Define enum class from dictionary. Args: dct: Dictionary of enumerated values for type. name: Name of enum. )r0 r )r8 r* r% r% r& �def_enum s z Enum.def_enum)N)r! r" r# r$ �set� __slots__rS r1 r> r' rk rl rn rt rv rw rx ry rz r{ r} � classmethodr� � staticmethodr� r% r% r% r& r � s* $ r c @ sD e Zd ZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdS )r a( Wire format variant. Used by the 'protobuf' wire format to determine how to transmit a single piece of data. May be used by other formats. See: http://code.google.com/apis/protocolbuffers/docs/encoding.html Values: DOUBLE: 64-bit floating point number. FLOAT: 32-bit floating point number. INT64: 64-bit signed integer. UINT64: 64-bit unsigned integer. INT32: 32-bit signed integer. BOOL: Boolean value (True or False). STRING: String of UTF-8 encoded text. MESSAGE: Embedded message as byte string. BYTES: String of 8-bit bytes. UINT32: 32-bit unsigned integer. ENUM: Enum value as integer. SINT32: 32-bit signed integer. Uses "zig-zag" encoding. SINT64: 64-bit signed integer. Uses "zig-zag" encoding. � � � � � � � � � � � � � N)r! r" r# r$ �DOUBLE�FLOAT�INT64�UINT64�INT32�BOOL�STRING�MESSAGE�BYTES�UINT32�ENUM�SINT32�SINT64r% r% r% r& r % s r c @ s e Zd ZdZdd� Zdd� ZdS )� _MessageClassa Meta-class used for defining the Message base class. For more details about Message classes, see the Message class docstring. Information contained there may help understanding this class. Meta-class enables very specific behavior for any defined Message class. All attributes defined on an Message sub-class must be field instances, Enum class definitions or other Message class definitions. Each field attribute defined on an Message sub-class is added to the set of field definitions and the attribute is translated in to a slot. It also ensures that only one level of Message class hierarchy is possible. In other words it is not possible to declare sub-classes of sub-classes of Message. This class also defines some functions in order to restrict the behavior of the Message class and its sub-classes. It is not possible to change the behavior of the Message class in later classes since any new classes may be defined with only field, Enums and Messages, and no methods. c C s4 i }i }i }|t fk�r|tfkr*td��g }g }|�� D ]�\} } | tv rLq:t| t�rlt| t�rl|� | � q:t| t�r�t| t�r�| tur�|� | � q:t| �t u s�t| t �s�td| | f ��| j |v r�t d| j |f ��| | _ | || < | || j < q:|�rt|�|d< |�rt|�|d< ||d< ||d< t�| |||�S )z�Create new Message class instance. The __new__ method of the _MessageClass type is overridden so as to allow the translation of Field instances to slots. z+Message types may only inherit from Messagez;May only use fields in message definitions. Found: %s = %sz2Field with number %d declared more than once in %sZ __enums__Z __messages__�_Message__by_number�_Message__by_name)r3 r r rO rP rQ r0 � issubclassr �appendr rT r r* �sortedr/ rS ) r6 r* r7 r8 Z by_numberZby_nameZ variant_mapZenums�messages�key�fieldr% r% r& rS c sZ � �� �� �� z_MessageClass.__new__c C sd |t fkrP|�� D ]"}t|t�r|turt�| �|_q| �� D ]}t�| �|_q>t� | |||� dS )z7Initializer required to assign references to new class.N) r3 rY rQ r/ r �weakref�refr+ � all_fieldsr1 )r6 r* r7 r8 �vr� r% r% r& r1 � s z_MessageClass.__init__N)r! r" r# r$ rS r1 r% r% r% r& r� K s Dr� c @ s� e Zd ZdZdd� Zdd� Zdd� Zedd � �Zed d � �Z ed d � �Z dd� Z dd� Z dd� Z d!dd�Zdd� Zdd� Zdd � Zd d � Zd d � ZdS )"r a� Base class for user defined message objects. Used to define messages for efficient transmission across network or process space. Messages are defined using the field classes (IntegerField, FloatField, EnumField, etc.). Messages are more restricted than normal classes in that they may only contain field attributes and other Message and Enum definitions. These restrictions are in place because the structure of the Message class is intentended to itself be transmitted across network or process space and used directly by clients or even other servers. As such methods and non-field attributes could not be transmitted with the structural information causing discrepancies between different languages and implementations. Initialization and validation: A Message object is considered to be initialized if it has all required fields and any nested messages are also initialized. Calling 'check_initialized' will raise a ValidationException if it is not initialized; 'is_initialized' returns a boolean value indicating if it is valid. Validation automatically occurs when Message objects are created and populated. Validation that a given value will be compatible with a field that it is assigned to can be done through the Field instances validate() method. The validate method used on a message will check that all values of a message and its sub-messages are valid. Assingning an invalid value to a field will raise a ValidationException. Example: # Trade type. class TradeType(Enum): BUY = 1 SELL = 2 SHORT = 3 CALL = 4 class Lot(Message): price = IntegerField(1, required=True) quantity = IntegerField(2, required=True) class Order(Message): symbol = StringField(1, required=True) total_quantity = IntegerField(2, required=True) trade_type = EnumField(TradeType, 3, required=True) lots = MessageField(Lot, 4, repeated=True) limit = IntegerField(5) order = Order(symbol='GOOG', total_quantity=10, trade_type=TradeType.BUY) lot1 = Lot(price=304, quantity=7) lot2 = Lot(price = 305, quantity=3) order.lots = [lot1, lot2] # Now object is initialized! order.check_initialized() c K sj i | _ i | _t� }|�� D ] \}}t| ||� |�|� q| �� D ]"}|jrB|j|vrBt| |jg � qBdS )a. Initialize internal messages state. Args: A message can be initialized via the constructor by passing in keyword arguments corresponding to fields. For example: class Date(Message): day = IntegerField(1) month = IntegerField(2) year = IntegerField(3) Invoking: date = Date(day=6, month=6, year=1911) is the same as doing: date = Date() date.day = 6 date.month = 6 date.year = 1911 N) �_Message__tags� _Message__unrecognized_fieldsr� rO rU �addr� �repeatedr* )r) �kwargs�assignedr* r? r� r% r% r& r1 � s zMessage.__init__c C s� | j �� D ]�\}}t| |�}|du rB|jr�tdt| �j|f ��q zPt|t�r�t |j t �r�|j r~|D ]}|� |�}|�� qdn|� |�}|�� W q ty� } z$t|d�s�t| �j|_� W Y d}~q d}~0 0 q dS )z�Check class for initialization status. Check that all required fields are initialized Raises: ValidationError: If message is not initialized. Nz'Message %s is missing required field %s� message_name)r� rO rh �requiredr r0 r! rQ r r� � message_typer r� �value_to_message�check_initialized�hasattrr� )r) r* r� r? r Zitem_message_valueZ message_value�errr% r% r& r� s2 �� �� zMessage.check_initializedc C s* z | � � W n ty Y dS 0 dS dS )zeGet initialization status. Returns: True if message is valid, else False. FTN)r� r r( r% r% r& �is_initialized? s zMessage.is_initializedc C s | j �� S )z�Get all field definition objects. Ordering is arbitrary. Returns: Iterator over all values in arbitrary order. )r� rY r; r% r% r& r� L s zMessage.all_fieldsc C s | j | S )z�Get field by name. Returns: Field object associated with name. Raises: KeyError if no field found by that name. )r� rB r% r% r& � field_by_nameW s zMessage.field_by_namec C s | j | S )z�Get field by number. Returns: Field object associated with number. Raises: KeyError if no field found by that number. )r� r_ r% r% r& �field_by_numberc s zMessage.field_by_numberc C sJ t | �}z|�|�}W n$ ty: td|j|f ��Y n0 | j�|j�S )a8 Get the assigned value of an attribute. Get the underlying value of an attribute. If value has not been set, will not return the default for the field. Args: name: Name of attribute to get. Returns: Value of attribute, None if it has not been set. �Message %s has no field %s)r0 r� re r: r! r� �getrT �r) r* r� r� r% r% r& �get_assigned_valueo s �zMessage.get_assigned_valuec C st t | �}z|�|�}W n. tyD ||jvr@td|j|f ��Y n0 |jr`t|g �| j|j < n| j� |j d� dS )z�Reset assigned value for field. Resetting a field will return it to its default value or None. Args: name: Name of field to reset. r� N) r0 r� re r� r: r! r� r r� rT �popr� r% r% r& �reset� s �z Message.resetc C s t | j�� �S )z9Get the names of all unrecognized fields in this message.)�listr� r[ r( r% r% r& �all_unrecognized_fields� s z Message.all_unrecognized_fieldsNc C s | j �|||f�\}}||fS )a� Get the value and variant of an unknown field in this message. Args: key: The name or number of the field to retrieve. value_default: Value to be returned if the key isn't found. variant_default: Value to be returned as variant if the key isn't found. Returns: (value, variant), where value and variant are whatever was passed to set_unrecognized_field. )r� r� )r) r� Z value_defaultZvariant_defaultr? �variantr% r% r& �get_unrecognized_field_info� s � z#Message.get_unrecognized_field_infoc C s( t |t�std| ��||f| j|< dS )a| Set an unrecognized field, used when decoding a message. Args: key: The name or number used to refer to this unknown value. value: The value of the field. variant: Type information needed to interpret the value or re-encode it. Raises: TypeError: If the variant is not an instance of messages.Variant. z Variant type %s is not valid.N)rQ r rA r� )r) r� r? r� r% r% r& �set_unrecognized_field� s z Message.set_unrecognized_fieldc C s> || j v s|�d�r$t�| ||� ntd|t| �jf ��dS )a\ Change set behavior for messages. Messages may only be assigned values that are fields. Does not try to validate field when set. Args: name: Name of field to assign to. value: Value to assign to field. Raises: AttributeError when trying to assign value that is not a field. Z _Message__z/May not assign arbitrary value %s to message %sN)r� � startswithr3 r> r: r0 r! ri r% r% r& r> � s �zMessage.__setattr__c C sl dt | �jg}t| �� dd� d�D ]4}|j}| �|j�}|dur"|�d|t|�f � q"|�d� d�|�S ) a\ Make string representation of message. Example: class MyMessage(messages.Message): integer_value = messages.IntegerField(1) string_value = messages.StringField(2) my_message = MyMessage() my_message.integer_value = 42 my_message.string_value = u'A string' print my_message >>> <MyMessage ... integer_value: 42 ... string_value: u'A string'> Returns: String representation of message, including the values of all fields and repr of all sub-messages. �<c S s | j S ra rj )�fr% r% r& �<lambda>� r� z"Message.__repr__.<locals>.<lambda>)r� Nz %s: %s�>� ) r0 r! r� r� r* r� r� �repr�join)r) �bodyr� rV r? r% r% r& rl � s � zMessage.__repr__c C s, | |u r dS t | �t |�ur dS | j|jkS )a� Equality operator. Does field by field comparison with other message. For equality, must be same type and values of all fields must be equal. Messages not required to be initialized for comparison. Does not attempt to determine equality for values that have default values that are not set. In other words: class HasDefault(Message): attr1 = StringField(1, default='default value') message1 = HasDefault() message2 = HasDefault() message2.attr1 = 'default value' message1 != message2 Does not compare unknown values. Args: other: Other message to compare with. TF)r0 r� rr r% r% r& rx � s zMessage.__eq__c C s | � |� S )af Not equals operator. Does field by field comparison with other message. For non-equality, must be different type or any value of a field must be non-equal to the same field in the other instance. Messages not required to be initialized for comparison. Args: other: Other message to compare with. )rx rr r% r% r& ry s zMessage.__ne__)NN)r! r" r# r$ r1 r� r� r� r� r� r� r� r� r� r� r� r> rl rx ry r% r% r% r& r � s* D& � %r c @ s\ e Zd ZdZdd� Zdd� Zdd� Zedd � �Zd d � Z d d � Z dd� Z dd� Z dd� Z dS )r a List implementation that validates field values. This list implementation overrides all methods that add values in to a list in order to validate those new elements. Attempting to add or set list values that are not of the correct type will raise ValidationError. c C s0 |j std��|| _| j�|� t�| |� dS )z�Constructor. Args: field_instance: Instance of field that validates the list. sequence: List or tuple to construct list from. z)FieldList may only accept repeated fieldsN)r� r �_FieldList__field�validater� r1 )r) �field_instance�sequencer% r% r& r1 0 s � zFieldList.__init__c C s, | j �� }|du r | j ddfS d|| j jfS )a Enable pickling. The assigned field instance can't be pickled if it belongs to a Message definition (message_definition uses a weakref), so the Message class and field number are returned in that case. Returns: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. N)r� r< rT )r) � message_classr% r% r& � __getstate__> s zFieldList.__getstate__c C s* |\}}}|du r |� |�| _n|| _dS )aO Enable unpickling. Args: state: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. N)r� r� )r) �stater� r� rT r% r% r& � __setstate__R s zFieldList.__setstate__c C s | j S )zField that validates list.)r� r( r% r% r& r� b s zFieldList.fieldc C s | j �|� t�| |||� dS )z"Validate slice assignment to list.N)r� r� r� � __setslice__)r) �i�jr� r% r% r& r� g s zFieldList.__setslice__c C s6 t |t�r| j�|� n | j�|� t�| ||� dS )z!Validate item assignment to list.N)rQ �slicer� r� �validate_elementr� � __setitem__�r) rg r? r% r% r& r� l s zFieldList.__setitem__c C s$ t | dd�r| j�|� t�| |�S )z Validate item appending to list.r� N)rh r� r� r� r� �r) r? r% r% r& r� t s zFieldList.appendc C s$ t | dd�r| j�|� t�| |�S )zValidate extension of list.r� N)rh r� r� r� �extend)r) r� r% r% r& r� z s zFieldList.extendc C s | j �|� t�| ||�S )z Validate item insertion to list.)r� r� r� �insertr� r% r% r& r� � s zFieldList.insertN)r! r" r# r$ r1 r� r� �propertyr� r� r� r� r� r� r% r% r% r& r & s r c @ s e Zd Zdd� ZdS )� _FieldMetac s: t � d��� fdd�|�dg �D �� t�� |||� d S )N�_Field__variant_to_typec 3 s | ]}|� fV qd S ra r% )r~ r� r; r% r& r� � s z&_FieldMeta.__init__.<locals>.<genexpr>�VARIANTS)rh �updater� r0 r1 r5 r% r; r& r1 � s �z_FieldMeta.__init__N)r! r" r# r1 r% r% r% r& r� � s r� c @ s� e Zd ZdZdZi Ze�d�d dd��Zdd� Z d d � Z d d � Z d d� Z dd� Z dd� Zdd� Zdd� Zdd� Zedd� �Zedd � �ZdS ) r z Definition for message field.Fr� Nc C sd t |t�r d| kr tks0n td|tf ��t| krDtkrZn ntd|ttf ��|rj|rjtd��|du rx| j}|r�|dur�td��|| jvr�t d|t | �j t | j�f ��|| _ || _|| _|| _|du�rTz| �|� W nn t�yR } zTz | j}W n* t�y* td| jj ||f ��Y n0 td |||f ��W Y d}~n d}~0 0 || _d | _dS ) a� Constructor. The required and repeated parameters are mutually exclusive. Setting both to True will raise a FieldDefinitionError. Sub-class Attributes: Each sub-class of Field must define the following: VARIANTS: Set of variant types accepted by that field. DEFAULT_VARIANT: Default variant type if not specified in constructor. Args: number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive with 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive with 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: InvalidVariantError when invalid variant for field is provided. InvalidDefaultError when invalid default for field is provided. FieldDefinitionError when invalid number provided or mutually exclusive fields are used. InvalidNumberError when the field number is out of range or reserved. r� zGInvalid number for field: %s Number must be 1 or greater and %d or lesszATag number %d is a reserved number. Numbers %d to %d are reservedz%Cannot set both repeated and requiredNz%Repeated fields may not have defaultsz0Invalid variant: %s Valid variants for %s are %rz$Invalid default value for %s: %r: %sz*Invalid default value for field %s: %r: %sT)rQ �intr r r r r �DEFAULT_VARIANTr� r r0 r! r� rT r� r� r� �validate_defaultr r* r: r rm �_Field__default�_Field__initialized)r) rT r� r� r� �defaultr� r* r% r% r& r1 � s^ # ���� �� �� ��zField.__init__c C s< |t v rt�| ||� dS | js0t�| ||� ntd��dS )z�Setter overidden to prevent assignment to fields after creation. Args: name: Name of attribute to set. value: Value to assign. NzField objects are read-only)� _POST_INIT_FIELD_ATTRIBUTE_NAMESr3 r> r� r: ri r% r% r& r> � s zField.__setattr__c C s\ |du r0| j r td| j ��qX|j�| jd� n(| j rBt| |�}n | �|�}||j| j< dS )��Set value on message. Args: message_instance: Message instance to set value on. value: Value to set on message. Nz(May not assign None to repeated field %s)r� r r* r� r� rT r r� �r) �message_instancer? r% r% r& �__set__� s � z Field.__set__c C s, |d u r | S |j �| j�}|d u r(| jS |S ra )r� r� rT r� )r) r� r� �resultr% r% r& �__get__ s z Field.__get__c C s� t || j�s�t |tj�r*| jtkr*t|�S |du rB| jr�td��nVz | j}W n0 ty| td| j| j j |t|�f ��Y n 0 td| j||t|�f ��|S )aW Validate single element of field. This is different from validate in that it is used on individual values of repeated fields. Args: value: Value to validate. Returns: The value casted in the expected type. Raises: ValidationError if value is not expected type. NzRequired field is missingz+Expected type %s for %s, found %s (type %s)z1Expected type %s for field %s, found %s (type %s)) rQ r0 rF rR �floatr� r r* r: rm r! )r) r? r* r% r% r& r� s( �� ��zField.validate_elementc C s� | j s||�S t|ttf�r~g }|D ]T}|du rjz | j}W n" ty\ td| jj ��Y n0 td| ��|� ||�� q$|S |dur�z | j}W n& ty� td| jj|f ��Y n0 td||f ��|S )aO Internal validation function. Validate an internal value using a function to validate individual elements. Args: value: Value to validate. validate_element: Function to use to validate individual elements. Raises: ValidationError if value is not expected type. Nz&Repeated values for %s may not be Nonez,Repeated values for field %s may not be Nonez%s is repeated. Found: %sz Field %s is repeated. Found: %s) r� rQ r� �tupler* r: r rm r! r� )r) r? r� r� �elementr* r% r% r& Z __validateA s@ �� �� � �zField.__validatec C s | � || j�S )z�Validate value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )�_Field__validater� r� r% r% r& r� n s zField.validatec C s | � |�S )a& Validate value as assigned to field default field. Some fields may allow for delayed resolution of default types necessary in the case of circular definition references. In this case, the default value might be a place holder that is resolved when needed after all the message classes are defined. Args: value: Default value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )r� r� r% r% r& �validate_default_element| s z Field.validate_default_elementc C s | � || j�S )z�Validate default value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. )r� r� r� r% r% r& r� � s zField.validate_defaultc C s$ z | � � W S ty Y dS 0 dS )z�Get Message definition that contains this Field definition. Returns: Containing Message definition for Field. Will return None if for some reason Field is defined outside of a Message class. Nr9 r( r% r% r& r< � s zField.message_definitionc C s | j S )z Get default value for field.)r� r( r% r% r& r� � s z Field.defaultc C s | j | S ra )r� )r6 r� r% r% r& � lookup_field_type_by_variant� s z"Field.lookup_field_type_by_variant)FFNN)r! r" r# r$ r� r� r � positionalr1 r> r� r� r� r� r� r� r� r< r� r� r� r� r% r% r% r& r � s, � T &- r c @ s< e Zd ZdZeejejejej ej ej g�Z ejZ ejZdS )r z$Field definition for integer values.N)r! r" r# r$ � frozensetr r� r� r� r� r� r� r� r� rF rR r0 r% r% r% r& r � s � r c @ s* e Zd ZdZeejejg�ZejZ e Z dS )r z"Field definition for float values.N) r! r" r# r$ r� r r� r� r� r� r� r0 r% r% r% r& r � s �r c @ s& e Zd ZdZeejg�ZejZe Z dS )r z$Field definition for boolean values.N) r! r" r# r$ r� r r� r� r� �boolr0 r% r% r% r& r � s r c @ s& e Zd ZdZeejg�ZejZe Z dS )r z(Field definition for byte string values.N) r! r" r# r$ r� r r� r� r� �bytesr0 r% r% r% r& r � s r c s8 e Zd ZdZeejg�ZejZe j Z � fdd�Z � Z S )r z+Field definition for unicode string values.c s� t |t�r�zt�|d� W q� ty� } zZz | j}W n" tyV td||f �}Y n 0 td| j||f �}| j|_|�W Y d}~q�d}~0 0 nt t | �� |�S |S )z�Validate StringField allowing for str and unicode. Raises: ValidationError if a str value is not UTF-8. zUTF-8z)Field encountered non-UTF-8 string %r: %sz,Field %s encountered non-UTF-8 string %r: %sN) rQ r rF rG �UnicodeDecodeErrorr* r: r � field_name�superr r� )r) r? r� �_Zvalidation_error�rm r% r& r� � s* �� �� z StringField.validate_element)r! r" r# r$ r� r r� r� r� rF rG r0 r� � __classcell__r% r% r r& r � s r c sr e Zd ZdZeejg�ZejZe � d�d� fdd� �Z � fdd�Z e d d � �Ze d d � �Zd d� Zdd� Z� ZS )r a Field definition for sub-message values. Message fields contain instance of other messages. Instances stored on messages stored on message fields are considered to be owned by the containing message instance and should not be shared between owning instances. Message fields must be defined to reference a single type of message. Normally message field are defined by passing the referenced message class in to the constructor. It is possible to define a message field for a type that does not yet exist by passing the name of the message in to the constructor instead of a message class. Resolution of the actual type of the message is deferred until it is needed, for example, during message verification. Names provided to the constructor must refer to a class within the same python module as the class that is using it. Names refer to messages relative to the containing messages scope. For example, the two fields of OuterMessage refer to the same message type: class Outer(Message): inner_relative = MessageField('Inner', 1) inner_absolute = MessageField('Outer.Inner', 2) class Inner(Message): ... When resolving an actual type, MessageField will traverse the entire scope of nested messages to match a message name. This makes it easy for siblings to reference siblings: class Outer(Message): class Inner(Message): sibling = MessageField('Sibling', 1) class Sibling(Message): ... r� FNc st t |tj�p&|tuo&t |t�o&t|t�}|s8td| ��t |tj�rR|| _d| _n|| _t t | �j ||||d� dS )a Constructor. Args: message_type: Message type for field. Must be subclass of Message. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. Raises: FieldDefinitionError when invalid message_type is provided. �Invalid message class: %sN)r� r� r� ) rQ rF rf r r0 r� r �_MessageField__type_namer, r r r1 )r) r� rT r� r� r� � valid_typer r% r& r1 > s& ��� �zMessageField.__init__c st | j � t� t �r^t� t�r^| jrF|r^t|ttf�r^� fdd�|D �}nt|t�r^� f i |��}tt | �� ||� dS )r� c s( g | ] }t |t�r � f i |��n|�qS r% )rQ r� )r~ r� ��tr% r& � <listcomp>r s �z(MessageField.__set__.<locals>.<listcomp>N) r0 rQ r� r r� r� r� r� r r r� r� r r r& r� g s � zMessageField.__set__c C sN | j du rHt| j| �� �}|tur6t|t�r6t|t�sBtd| ��|| _ | j S )z Message type used for field.Nr ) r, r r r< r rQ r0 r� r )r) r� r% r% r& r0 x s ����zMessageField.typec C s | j S )z�Underlying message type used for serialization. Will always be a sub-class of Message. This is different from type which represents the python value that message_type is mapped to for use by the user. )r0 r( r% r% r& r� � s zMessageField.message_typec C s, t || j�s(td| jjt|�j|f ��|S )a" Convert a message to a value instance. Used by deserializers to convert from underlying messages to value of expected user type. Args: message: A message instance of type self.message_type. Returns: Value of self.message_type. � Expected type %s, got %s: %r)rQ r� r r! r0 )r) �messager% r% r& �value_from_message� s ��z MessageField.value_from_messagec C s, t || j�s(td| jjt|�j|f ��|S )a Convert a value instance to a message. Used by serializers to convert Python user types to underlying messages for transmission. Args: value: A value of type self.type. Returns: An instance of type self.message_type. r )rQ r0 r r! r� r% r% r& r� � s ��z MessageField.value_to_message)FFN)r! r" r# r$ r� r r� r� r� r r� r1 r� r� r0 r� r r� r r% r% r r& r s , �( r c sZ e Zd ZdZeejg�ZejZ� fdd�Z � fdd�Z e dd� �Z e � fdd ��Z � ZS ) r a Field definition for enum values. Enum fields may have default values that are delayed until the associated enum type is resolved. This is necessary to support certain circular references. For example: class Message1(Message): class Color(Enum): RED = 1 GREEN = 2 BLUE = 3 # This field default value will be validated when default is accessed. animal = EnumField('Message2.Animal', 1, default='HORSE') class Message2(Message): class Animal(Enum): DOG = 1 CAT = 2 HORSE = 3 # This fields default value will be validated right away since Color # is already fully resolved. color = EnumField(Message1.Color, 1, default='RED') c st t |tj�p&|tuo&t |t�o&t|t�}|s8td| ��t |tj�rR|| _d| _n|| _t t | �j |fi |�� dS )a= Constructor. Args: enum_type: Enum type for field. Must be subclass of Enum. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: FieldDefinitionError when invalid enum_type is provided. �Invalid enum type: %sN) rQ rF rf r r0 r� r �_EnumField__type_namer- r r r1 )r) Z enum_typerT r� r r r% r& r1 � s �� zEnumField.__init__c s6 t |tjtjf�r&| jr"| �|� |S tt| ��|�S )a� Validate default element of Enum field. Enum fields allow for delayed resolution of default values when the type of the field has not been resolved. The default value of a field may be a string or an integer. If the Enum type of the field has been resolved, the default value is validated against that type. Args: value: Value to validate. Raises: ValidationError if value is not expected message type. )rQ rF rf rR r- r r r� r� r r% r& r� � s z"EnumField.validate_default_elementc C sN | j du rHt| j| �� �}|tur6t|t�r6t|t�sBtd| ��|| _ | j S )zEnum type used for field.Nr ) r- r r r< r rQ r0 r� r )r) Z found_typer% r% r& r0 s ����zEnumField.typec sT z| j W S tyN tt| �j}t|tjtjf�r>| � |�}|| _ | j Y S 0 dS )zjDefault for enum field. Will cause resolution of Enum type and unresolved default value. N) r. r: r r r� rQ rF rf rR r0 )r) Zresolved_defaultr r% r& r� $ s � zEnumField.default)r! r" r# r$ r� r r� r� r� r1 r� r� r0 r� r r% r% r r& r � s r r� c s8 �du s4t �tj�s4t �t�r(t�t�s4td� ��| �d���d sVd��dd� �� ��fdd�}|� }t |t�r�t|ttf�r�|S �du r�t d| ��qft �tj�r�j �d�dd � }|s�d�n� d� |�d d |d g��qft �t�rft�t�rf�� � }|du �r.�j �d�d }� �j d d |g��qf|�qfdS ) az Find definition by name in module-space. The find algorthm will look for definitions by name relative to a message definition or by fully qualfied name. If no definition is found relative to the relative_to parameter it will do the same search against the container of relative_to. If relative_to is a nested Message, it will search its message_definition(). If that message has no message_definition() it will search its module. If relative_to is a module, it will attempt to look for the containing module and search relative to it. If the module is a top-level module, it will look for the a message using a fully qualified name. If no message is found then, the search fails and DefinitionNotFoundError is raised. For example, when looking for any definition 'foo.bar.ADefinition' relative to an actual message definition abc.xyz.SomeMessage: find_definition('foo.bar.ADefinition', SomeMessage) It is like looking for the following fully qualified names: abc.xyz.SomeMessage. foo.bar.ADefinition abc.xyz. foo.bar.ADefinition abc. foo.bar.ADefinition foo.bar.ADefinition When resolving the name relative to Message definitions and modules, the algorithm searches any Messages or sub-modules found in its path. Non-Message values are not searched. A name that begins with '.' is considered to be a fully qualified name. The name is always searched for from the topmost package. For example, assume two message types: abc.xyz.SomeMessage xyz.SomeMessage Searching for '.xyz.SomeMessage' relative to 'abc' will resolve to 'xyz.SomeMessage' and not 'abc.xyz.SomeMessage'. For this kind of name, the relative_to parameter is effectively ignored and always set to None. For more information about package name resolution, please see: http://code.google.com/apis/protocolbuffers/docs/proto.html#packages Args: name: Name of definition to find. May be fully qualified or relative name. relative_to: Search for definition relative to message definition or module. None will cause a fully qualified name search. importer: Import function to use for resolving modules. Returns: Enum or Message class definition associated with name. Raises: DefinitionNotFoundError if no definition is found in any search path. NzBrelative_to must be None, Message definition or module. Found: %s�.r r� c s� �} �D ]�}t | |d�}|dur&|} nv| du s:t| tj�r�| du rH|}nd| j|f }z&|�d�d }� |ddt|�g�} W q� ty� Y dS 0 n dS t| tj�st| t�r�t | t t f�s dS q| S )a Performs a single iteration searching the path from relative_to. This is the function that searches up the path from a relative object. fully.qualified.object . relative.or.nested.Definition ----------------------------> ^ | this part of search --+ Returns: Message or Enum at the end of name_path, else None. NrD r ���r� ) rh rQ �types� ModuleTyper! �split�str� ImportErrorr0 r� r r )Z next_part�noderV � module_nameZfromitem��importerZ name_path� relative_tor% r& � search_path� s2 �� �z$find_definition.<locals>.search_pathz Could not find definition for %sr r� )rQ r r r0 r� r rA r r r r! r� r< r" )r* r r r �foundZ module_path�parentZlast_module_namer% r r& r 6 sZ > ����� / � � � �� �r )2r$ r r� rF �apitools.base.protorpcliter �__all__r r r r r r r r r r r r r� rP r� r= r r r r r0 r/ rL �with_metaclassr3 r r r� r r� r r� r r r r r r r r r� � __import__r r% r% r% r& �<module> sl ( ���ly &i t` ) % + protorpclite/__pycache__/message_types.cpython-39.pyc 0000644 00000005542 15025317163 0017014 0 ustar 00 a vyg6 � @ sf d Z ddlZddlmZ ddlmZ g d�ZG dd� dej�ZG dd � d ej�ZG d d � d ej �Z dS ) z�Simple protocol message types. Includes new message and field types that are outside what is defined by the protocol buffers standard. � N)�messages)�util)� DateTimeField�DateTimeMessage� VoidMessagec @ s e Zd ZdZdS )r zEmpty message.N)�__name__� __module__� __qualname__�__doc__� r r �L/opt/gsutil/third_party/apitools/apitools/base/protorpclite/message_types.pyr # s r c @ s( e Zd ZdZejddd�Ze�d�ZdS )r z�Message to store/transmit a DateTime. Fields: milliseconds: Milliseconds since Jan 1st 1970 local time. time_zone_offset: Optional time zone offset, in minutes from UTC. � T)�required� N)r r r r r � IntegerField� milliseconds�time_zone_offsetr r r r r ' s r c sL e Zd ZdZejZeZe� d�� fdd��Z � fdd�Z � fdd�Z � Z S ) r z�Field definition for datetime values. Stores a python datetime object as a field. If time zone information is included in the datetime object, it will be included in the encoded data when this is encoded/decoded. � c s t t| �j| j|fi |�� d S )N)�superr �__init__� message_type)�self�number�kwargs�� __class__r r r > s ��zDateTimeField.__init__c sl t t| ��|�}|jdu r<tjj|jd tjjd�j dd�S |jd|j }t � |j�}tjj|d |d�S )z�Convert DateTimeMessage to a datetime. Args: A DateTimeMessage instance. Returns: A datetime instance. Ng @�@��tz��tzinfoi`� ) r r �value_from_messager �datetime� fromtimestampr �timezone�utc�replacer ZTimeZoneOffset)r �messager r# r r r r F s ��� �z DateTimeField.value_from_messagec s� t t| ��|�}|jd u r<d}tjjdtjjd�jd d�}n&t � |j� |��}tjj| |jd�}|| }t � }t t � |�d �|_|jd ur�|j� |�}|d ur�t t � |j� |��d �|_|S )Nr r r i� �< )r r �value_to_messager r! r" r# r$ r% r � total_seconds� utcoffsetr �intr r )r �valuer Z local_epoch�deltar& Z utc_offsetr r r r( ^ s( � � �z DateTimeField.value_to_message)r r r r r! �typer r r � positionalr r r( � __classcell__r r r r r 2 s r ) r r! �apitools.base.protorpcliter r �__all__�Messager r � MessageFieldr r r r r �<module> s protorpclite/messages_test.py 0000644 00000234435 15025317163 0012530 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Tests for apitools.base.protorpclite.messages.""" import pickle import re import sys import types import unittest import six from apitools.base.protorpclite import descriptor from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import test_util # This package plays lots of games with modifying global variables inside # test cases. Hence: # pylint:disable=function-redefined # pylint:disable=global-variable-not-assigned # pylint:disable=global-variable-undefined # pylint:disable=redefined-outer-name # pylint:disable=undefined-variable # pylint:disable=unused-variable # pylint:disable=too-many-lines try: long # Python 2 except NameError: long = int # Python 3 class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = messages class ValidationErrorTest(test_util.TestCase): def testStr_NoFieldName(self): """Test string version of ValidationError when no name provided.""" self.assertEqual('Validation error', str(messages.ValidationError('Validation error'))) def testStr_FieldName(self): """Test string version of ValidationError when no name provided.""" validation_error = messages.ValidationError('Validation error') validation_error.field_name = 'a_field' self.assertEqual('Validation error', str(validation_error)) class EnumTest(test_util.TestCase): def setUp(self): """Set up tests.""" # Redefine Color class in case so that changes to it (an # error) in one test does not affect other tests. global Color # pylint:disable=global-variable-not-assigned # pylint:disable=unused-variable class Color(messages.Enum): RED = 20 ORANGE = 2 YELLOW = 40 GREEN = 4 BLUE = 50 INDIGO = 5 VIOLET = 80 def testNames(self): """Test that names iterates over enum names.""" self.assertEqual( set(['BLUE', 'GREEN', 'INDIGO', 'ORANGE', 'RED', 'VIOLET', 'YELLOW']), set(Color.names())) def testNumbers(self): """Tests that numbers iterates of enum numbers.""" self.assertEqual(set([2, 4, 5, 20, 40, 50, 80]), set(Color.numbers())) def testIterate(self): """Test that __iter__ iterates over all enum values.""" self.assertEqual(set(Color), set([Color.RED, Color.ORANGE, Color.YELLOW, Color.GREEN, Color.BLUE, Color.INDIGO, Color.VIOLET])) def testNaturalOrder(self): """Test that natural order enumeration is in numeric order.""" self.assertEqual([Color.ORANGE, Color.GREEN, Color.INDIGO, Color.RED, Color.YELLOW, Color.BLUE, Color.VIOLET], sorted(Color)) def testByName(self): """Test look-up by name.""" self.assertEqual(Color.RED, Color.lookup_by_name('RED')) self.assertRaises(KeyError, Color.lookup_by_name, 20) self.assertRaises(KeyError, Color.lookup_by_name, Color.RED) def testByNumber(self): """Test look-up by number.""" self.assertRaises(KeyError, Color.lookup_by_number, 'RED') self.assertEqual(Color.RED, Color.lookup_by_number(20)) self.assertRaises(KeyError, Color.lookup_by_number, Color.RED) def testConstructor(self): """Test that constructor look-up by name or number.""" self.assertEqual(Color.RED, Color('RED')) self.assertEqual(Color.RED, Color(u'RED')) self.assertEqual(Color.RED, Color(20)) if six.PY2: self.assertEqual(Color.RED, Color(long(20))) self.assertEqual(Color.RED, Color(Color.RED)) self.assertRaises(TypeError, Color, 'Not exists') self.assertRaises(TypeError, Color, 'Red') self.assertRaises(TypeError, Color, 100) self.assertRaises(TypeError, Color, 10.0) def testLen(self): """Test that len function works to count enums.""" self.assertEqual(7, len(Color)) def testNoSubclasses(self): """Test that it is not possible to sub-class enum classes.""" def declare_subclass(): class MoreColor(Color): pass self.assertRaises(messages.EnumDefinitionError, declare_subclass) def testClassNotMutable(self): """Test that enum classes themselves are not mutable.""" self.assertRaises(AttributeError, setattr, Color, 'something_new', 10) def testInstancesMutable(self): """Test that enum instances are not mutable.""" self.assertRaises(TypeError, setattr, Color.RED, 'something_new', 10) def testDefEnum(self): """Test def_enum works by building enum class from dict.""" WeekDay = messages.Enum.def_enum({'Monday': 1, 'Tuesday': 2, 'Wednesday': 3, 'Thursday': 4, 'Friday': 6, 'Saturday': 7, 'Sunday': 8}, 'WeekDay') self.assertEqual('Wednesday', WeekDay(3).name) self.assertEqual(6, WeekDay('Friday').number) self.assertEqual(WeekDay.Sunday, WeekDay('Sunday')) def testNonInt(self): """Test that non-integer values rejection by enum def.""" self.assertRaises(messages.EnumDefinitionError, messages.Enum.def_enum, {'Bad': '1'}, 'BadEnum') def testNegativeInt(self): """Test that negative numbers rejection by enum def.""" self.assertRaises(messages.EnumDefinitionError, messages.Enum.def_enum, {'Bad': -1}, 'BadEnum') def testLowerBound(self): """Test that zero is accepted by enum def.""" class NotImportant(messages.Enum): """Testing for value zero""" VALUE = 0 self.assertEqual(0, int(NotImportant.VALUE)) def testTooLargeInt(self): """Test that numbers too large are rejected.""" self.assertRaises(messages.EnumDefinitionError, messages.Enum.def_enum, {'Bad': (2 ** 29)}, 'BadEnum') def testRepeatedInt(self): """Test duplicated numbers are forbidden.""" self.assertRaises(messages.EnumDefinitionError, messages.Enum.def_enum, {'Ok': 1, 'Repeated': 1}, 'BadEnum') def testStr(self): """Test converting to string.""" self.assertEqual('RED', str(Color.RED)) self.assertEqual('ORANGE', str(Color.ORANGE)) def testInt(self): """Test converting to int.""" self.assertEqual(20, int(Color.RED)) self.assertEqual(2, int(Color.ORANGE)) def testRepr(self): """Test enum representation.""" self.assertEqual('Color(RED, 20)', repr(Color.RED)) self.assertEqual('Color(YELLOW, 40)', repr(Color.YELLOW)) def testDocstring(self): """Test that docstring is supported ok.""" class NotImportant(messages.Enum): """I have a docstring.""" VALUE1 = 1 self.assertEqual('I have a docstring.', NotImportant.__doc__) def testDeleteEnumValue(self): """Test that enum values cannot be deleted.""" self.assertRaises(TypeError, delattr, Color, 'RED') def testEnumName(self): """Test enum name.""" module_name = test_util.get_module_name(EnumTest) self.assertEqual('%s.Color' % module_name, Color.definition_name()) self.assertEqual(module_name, Color.outer_definition_name()) self.assertEqual(module_name, Color.definition_package()) def testDefinitionName_OverrideModule(self): """Test enum module is overriden by module package name.""" global package try: package = 'my.package' self.assertEqual('my.package.Color', Color.definition_name()) self.assertEqual('my.package', Color.outer_definition_name()) self.assertEqual('my.package', Color.definition_package()) finally: del package def testDefinitionName_NoModule(self): """Test what happens when there is no module for enum.""" class Enum1(messages.Enum): pass original_modules = sys.modules sys.modules = dict(sys.modules) try: del sys.modules[__name__] self.assertEqual('Enum1', Enum1.definition_name()) self.assertEqual(None, Enum1.outer_definition_name()) self.assertEqual(None, Enum1.definition_package()) self.assertEqual(six.text_type, type(Enum1.definition_name())) finally: sys.modules = original_modules def testDefinitionName_Nested(self): """Test nested Enum names.""" class MyMessage(messages.Message): class NestedEnum(messages.Enum): pass class NestedMessage(messages.Message): class NestedEnum(messages.Enum): pass module_name = test_util.get_module_name(EnumTest) self.assertEqual('%s.MyMessage.NestedEnum' % module_name, MyMessage.NestedEnum.definition_name()) self.assertEqual('%s.MyMessage' % module_name, MyMessage.NestedEnum.outer_definition_name()) self.assertEqual(module_name, MyMessage.NestedEnum.definition_package()) self.assertEqual( '%s.MyMessage.NestedMessage.NestedEnum' % module_name, MyMessage.NestedMessage.NestedEnum.definition_name()) self.assertEqual( '%s.MyMessage.NestedMessage' % module_name, MyMessage.NestedMessage.NestedEnum.outer_definition_name()) self.assertEqual( module_name, MyMessage.NestedMessage.NestedEnum.definition_package()) def testMessageDefinition(self): """Test that enumeration knows its enclosing message definition.""" class OuterEnum(messages.Enum): pass self.assertEqual(None, OuterEnum.message_definition()) class OuterMessage(messages.Message): class InnerEnum(messages.Enum): pass self.assertEqual( OuterMessage, OuterMessage.InnerEnum.message_definition()) def testComparison(self): """Test comparing various enums to different types.""" class Enum1(messages.Enum): VAL1 = 1 VAL2 = 2 class Enum2(messages.Enum): VAL1 = 1 self.assertEqual(Enum1.VAL1, Enum1.VAL1) self.assertNotEqual(Enum1.VAL1, Enum1.VAL2) self.assertNotEqual(Enum1.VAL1, Enum2.VAL1) self.assertNotEqual(Enum1.VAL1, 'VAL1') self.assertNotEqual(Enum1.VAL1, 1) self.assertNotEqual(Enum1.VAL1, 2) self.assertNotEqual(Enum1.VAL1, None) self.assertNotEqual(Enum1.VAL1, Enum2.VAL1) self.assertTrue(Enum1.VAL1 < Enum1.VAL2) self.assertTrue(Enum1.VAL2 > Enum1.VAL1) self.assertNotEqual(1, Enum2.VAL1) def testPickle(self): """Testing pickling and unpickling of Enum instances.""" colors = list(Color) unpickled = pickle.loads(pickle.dumps(colors)) self.assertEqual(colors, unpickled) # Unpickling shouldn't create new enum instances. for i, color in enumerate(colors): self.assertTrue(color is unpickled[i]) class FieldListTest(test_util.TestCase): def setUp(self): self.integer_field = messages.IntegerField(1, repeated=True) def testConstructor(self): self.assertEqual([1, 2, 3], messages.FieldList(self.integer_field, [1, 2, 3])) self.assertEqual([1, 2, 3], messages.FieldList(self.integer_field, (1, 2, 3))) self.assertEqual([], messages.FieldList(self.integer_field, [])) def testNone(self): self.assertRaises(TypeError, messages.FieldList, self.integer_field, None) def testDoNotAutoConvertString(self): string_field = messages.StringField(1, repeated=True) self.assertRaises(messages.ValidationError, messages.FieldList, string_field, 'abc') def testConstructorCopies(self): a_list = [1, 3, 6] field_list = messages.FieldList(self.integer_field, a_list) self.assertFalse(a_list is field_list) self.assertFalse(field_list is messages.FieldList(self.integer_field, field_list)) def testNonRepeatedField(self): self.assertRaisesWithRegexpMatch( messages.FieldDefinitionError, 'FieldList may only accept repeated fields', messages.FieldList, messages.IntegerField(1), []) def testConstructor_InvalidValues(self): self.assertRaisesWithRegexpMatch( messages.ValidationError, re.escape("Expected type %r " "for IntegerField, found 1 (type %r)" % (six.integer_types, str)), messages.FieldList, self.integer_field, ["1", "2", "3"]) def testConstructor_Scalars(self): self.assertRaisesWithRegexpMatch( messages.ValidationError, "IntegerField is repeated. Found: 3", messages.FieldList, self.integer_field, 3) self.assertRaisesWithRegexpMatch( messages.ValidationError, ("IntegerField is repeated. Found: " "<(list[_]?|sequence)iterator object"), messages.FieldList, self.integer_field, iter([1, 2, 3])) def testSetSlice(self): field_list = messages.FieldList(self.integer_field, [1, 2, 3, 4, 5]) field_list[1:3] = [10, 20] self.assertEqual([1, 10, 20, 4, 5], field_list) def testSetSlice_InvalidValues(self): field_list = messages.FieldList(self.integer_field, [1, 2, 3, 4, 5]) def setslice(): field_list[1:3] = ['10', '20'] msg_re = re.escape("Expected type %r " "for IntegerField, found 10 (type %r)" % (six.integer_types, str)) self.assertRaisesWithRegexpMatch( messages.ValidationError, msg_re, setslice) def testSetItem(self): field_list = messages.FieldList(self.integer_field, [2]) field_list[0] = 10 self.assertEqual([10], field_list) def testSetItem_InvalidValues(self): field_list = messages.FieldList(self.integer_field, [2]) def setitem(): field_list[0] = '10' self.assertRaisesWithRegexpMatch( messages.ValidationError, re.escape("Expected type %r " "for IntegerField, found 10 (type %r)" % (six.integer_types, str)), setitem) def testAppend(self): field_list = messages.FieldList(self.integer_field, [2]) field_list.append(10) self.assertEqual([2, 10], field_list) def testAppend_InvalidValues(self): field_list = messages.FieldList(self.integer_field, [2]) field_list.name = 'a_field' def append(): field_list.append('10') self.assertRaisesWithRegexpMatch( messages.ValidationError, re.escape("Expected type %r " "for IntegerField, found 10 (type %r)" % (six.integer_types, str)), append) def testExtend(self): field_list = messages.FieldList(self.integer_field, [2]) field_list.extend([10]) self.assertEqual([2, 10], field_list) def testExtend_InvalidValues(self): field_list = messages.FieldList(self.integer_field, [2]) def extend(): field_list.extend(['10']) self.assertRaisesWithRegexpMatch( messages.ValidationError, re.escape("Expected type %r " "for IntegerField, found 10 (type %r)" % (six.integer_types, str)), extend) def testInsert(self): field_list = messages.FieldList(self.integer_field, [2, 3]) field_list.insert(1, 10) self.assertEqual([2, 10, 3], field_list) def testInsert_InvalidValues(self): field_list = messages.FieldList(self.integer_field, [2, 3]) def insert(): field_list.insert(1, '10') self.assertRaisesWithRegexpMatch( messages.ValidationError, re.escape("Expected type %r " "for IntegerField, found 10 (type %r)" % (six.integer_types, str)), insert) def testPickle(self): """Testing pickling and unpickling of FieldList instances.""" field_list = messages.FieldList(self.integer_field, [1, 2, 3, 4, 5]) unpickled = pickle.loads(pickle.dumps(field_list)) self.assertEqual(field_list, unpickled) self.assertIsInstance(unpickled.field, messages.IntegerField) self.assertEqual(1, unpickled.field.number) self.assertTrue(unpickled.field.repeated) class FieldTest(test_util.TestCase): def ActionOnAllFieldClasses(self, action): """Test all field classes except Message and Enum. Message and Enum require separate tests. Args: action: Callable that takes the field class as a parameter. """ classes = (messages.IntegerField, messages.FloatField, messages.BooleanField, messages.BytesField, messages.StringField) for field_class in classes: action(field_class) def testNumberAttribute(self): """Test setting the number attribute.""" def action(field_class): # Check range. self.assertRaises(messages.InvalidNumberError, field_class, 0) self.assertRaises(messages.InvalidNumberError, field_class, -1) self.assertRaises(messages.InvalidNumberError, field_class, messages.MAX_FIELD_NUMBER + 1) # Check reserved. self.assertRaises(messages.InvalidNumberError, field_class, messages.FIRST_RESERVED_FIELD_NUMBER) self.assertRaises(messages.InvalidNumberError, field_class, messages.LAST_RESERVED_FIELD_NUMBER) self.assertRaises(messages.InvalidNumberError, field_class, '1') # This one should work. field_class(number=1) self.ActionOnAllFieldClasses(action) def testRequiredAndRepeated(self): """Test setting the required and repeated fields.""" def action(field_class): field_class(1, required=True) field_class(1, repeated=True) self.assertRaises(messages.FieldDefinitionError, field_class, 1, required=True, repeated=True) self.ActionOnAllFieldClasses(action) def testInvalidVariant(self): """Test field with invalid variants.""" def action(field_class): if field_class is not message_types.DateTimeField: self.assertRaises(messages.InvalidVariantError, field_class, 1, variant=messages.Variant.ENUM) self.ActionOnAllFieldClasses(action) def testDefaultVariant(self): """Test that default variant is used when not set.""" def action(field_class): field = field_class(1) self.assertEqual(field_class.DEFAULT_VARIANT, field.variant) self.ActionOnAllFieldClasses(action) def testAlternateVariant(self): """Test that default variant is used when not set.""" field = messages.IntegerField(1, variant=messages.Variant.UINT32) self.assertEqual(messages.Variant.UINT32, field.variant) def testDefaultFields_Single(self): """Test default field is correct type (single).""" defaults = { messages.IntegerField: 10, messages.FloatField: 1.5, messages.BooleanField: False, messages.BytesField: b'abc', messages.StringField: u'abc', } def action(field_class): field_class(1, default=defaults[field_class]) self.ActionOnAllFieldClasses(action) # Run defaults test again checking for str/unicode compatiblity. defaults[messages.StringField] = 'abc' self.ActionOnAllFieldClasses(action) def testStringField_BadUnicodeInDefault(self): """Test binary values in string field.""" self.assertRaisesWithRegexpMatch( messages.InvalidDefaultError, r"Invalid default value for StringField:.*: " r"Field encountered non-UTF-8 string .*: " r"'utf.?8' codec can't decode byte 0xc3 in position 0: " r"invalid continuation byte", messages.StringField, 1, default=b'\xc3\x28') def testDefaultFields_InvalidSingle(self): """Test default field is correct type (invalid single).""" def action(field_class): self.assertRaises(messages.InvalidDefaultError, field_class, 1, default=object()) self.ActionOnAllFieldClasses(action) def testDefaultFields_InvalidRepeated(self): """Test default field does not accept defaults.""" self.assertRaisesWithRegexpMatch( messages.FieldDefinitionError, 'Repeated fields may not have defaults', messages.StringField, 1, repeated=True, default=[1, 2, 3]) def testDefaultFields_None(self): """Test none is always acceptable.""" def action(field_class): field_class(1, default=None) field_class(1, required=True, default=None) field_class(1, repeated=True, default=None) self.ActionOnAllFieldClasses(action) def testDefaultFields_Enum(self): """Test the default for enum fields.""" class Symbol(messages.Enum): ALPHA = 1 BETA = 2 GAMMA = 3 field = messages.EnumField(Symbol, 1, default=Symbol.ALPHA) self.assertEqual(Symbol.ALPHA, field.default) def testDefaultFields_EnumStringDelayedResolution(self): """Test that enum fields resolve default strings.""" field = messages.EnumField( 'apitools.base.protorpclite.descriptor.FieldDescriptor.Label', 1, default='OPTIONAL') self.assertEqual( descriptor.FieldDescriptor.Label.OPTIONAL, field.default) def testDefaultFields_EnumIntDelayedResolution(self): """Test that enum fields resolve default integers.""" field = messages.EnumField( 'apitools.base.protorpclite.descriptor.FieldDescriptor.Label', 1, default=2) self.assertEqual( descriptor.FieldDescriptor.Label.REQUIRED, field.default) def testDefaultFields_EnumOkIfTypeKnown(self): """Test enum fields accept valid default values when type is known.""" field = messages.EnumField(descriptor.FieldDescriptor.Label, 1, default='REPEATED') self.assertEqual( descriptor.FieldDescriptor.Label.REPEATED, field.default) def testDefaultFields_EnumForceCheckIfTypeKnown(self): """Test that enum fields validate default values if type is known.""" self.assertRaisesWithRegexpMatch(TypeError, 'No such value for NOT_A_LABEL in ' 'Enum Label', messages.EnumField, descriptor.FieldDescriptor.Label, 1, default='NOT_A_LABEL') def testDefaultFields_EnumInvalidDelayedResolution(self): """Test that enum fields raise errors upon delayed resolution error.""" field = messages.EnumField( 'apitools.base.protorpclite.descriptor.FieldDescriptor.Label', 1, default=200) self.assertRaisesWithRegexpMatch(TypeError, 'No such value for 200 in Enum Label', getattr, field, 'default') def testValidate_Valid(self): """Test validation of valid values.""" values = { messages.IntegerField: 10, messages.FloatField: 1.5, messages.BooleanField: False, messages.BytesField: b'abc', messages.StringField: u'abc', } def action(field_class): # Optional. field = field_class(1) field.validate(values[field_class]) # Required. field = field_class(1, required=True) field.validate(values[field_class]) # Repeated. field = field_class(1, repeated=True) field.validate([]) field.validate(()) field.validate([values[field_class]]) field.validate((values[field_class],)) # Right value, but not repeated. self.assertRaises(messages.ValidationError, field.validate, values[field_class]) self.assertRaises(messages.ValidationError, field.validate, values[field_class]) self.ActionOnAllFieldClasses(action) def testValidate_Invalid(self): """Test validation of valid values.""" values = { messages.IntegerField: "10", messages.FloatField: "blah", messages.BooleanField: 0, messages.BytesField: 10.20, messages.StringField: 42, } def action(field_class): # Optional. field = field_class(1) self.assertRaises(messages.ValidationError, field.validate, values[field_class]) # Required. field = field_class(1, required=True) self.assertRaises(messages.ValidationError, field.validate, values[field_class]) # Repeated. field = field_class(1, repeated=True) self.assertRaises(messages.ValidationError, field.validate, [values[field_class]]) self.assertRaises(messages.ValidationError, field.validate, (values[field_class],)) self.ActionOnAllFieldClasses(action) def testValidate_None(self): """Test that None is valid for non-required fields.""" def action(field_class): # Optional. field = field_class(1) field.validate(None) # Required. field = field_class(1, required=True) self.assertRaisesWithRegexpMatch(messages.ValidationError, 'Required field is missing', field.validate, None) # Repeated. field = field_class(1, repeated=True) field.validate(None) self.assertRaisesWithRegexpMatch( messages.ValidationError, 'Repeated values for %s may ' 'not be None' % field_class.__name__, field.validate, [None]) self.assertRaises(messages.ValidationError, field.validate, (None,)) self.ActionOnAllFieldClasses(action) def testValidateElement(self): """Test validation of valid values.""" values = { messages.IntegerField: (10, -1, 0), messages.FloatField: (1.5, -1.5, 3), # for json it is all a number messages.BooleanField: (True, False), messages.BytesField: (b'abc',), messages.StringField: (u'abc',), } def action(field_class): # Optional. field = field_class(1) for value in values[field_class]: field.validate_element(value) # Required. field = field_class(1, required=True) for value in values[field_class]: field.validate_element(value) # Repeated. field = field_class(1, repeated=True) self.assertRaises(messages.ValidationError, field.validate_element, []) self.assertRaises(messages.ValidationError, field.validate_element, ()) for value in values[field_class]: field.validate_element(value) # Right value, but repeated. self.assertRaises(messages.ValidationError, field.validate_element, list(values[field_class])) # testing list self.assertRaises(messages.ValidationError, field.validate_element, values[field_class]) # testing tuple self.ActionOnAllFieldClasses(action) def testValidateCastingElement(self): field = messages.FloatField(1) self.assertEqual(type(field.validate_element(12)), float) self.assertEqual(type(field.validate_element(12.0)), float) field = messages.IntegerField(1) self.assertEqual(type(field.validate_element(12)), int) self.assertRaises(messages.ValidationError, field.validate_element, 12.0) # should fails from float to int def testReadOnly(self): """Test that objects are all read-only.""" def action(field_class): field = field_class(10) self.assertRaises(AttributeError, setattr, field, 'number', 20) self.assertRaises(AttributeError, setattr, field, 'anything_else', 'whatever') self.ActionOnAllFieldClasses(action) def testMessageField(self): """Test the construction of message fields.""" self.assertRaises(messages.FieldDefinitionError, messages.MessageField, str, 10) self.assertRaises(messages.FieldDefinitionError, messages.MessageField, messages.Message, 10) class MyMessage(messages.Message): pass field = messages.MessageField(MyMessage, 10) self.assertEqual(MyMessage, field.type) def testMessageField_ForwardReference(self): """Test the construction of forward reference message fields.""" global MyMessage global ForwardMessage try: class MyMessage(messages.Message): self_reference = messages.MessageField('MyMessage', 1) forward = messages.MessageField('ForwardMessage', 2) nested = messages.MessageField( 'ForwardMessage.NestedMessage', 3) inner = messages.MessageField('Inner', 4) class Inner(messages.Message): sibling = messages.MessageField('Sibling', 1) class Sibling(messages.Message): pass class ForwardMessage(messages.Message): class NestedMessage(messages.Message): pass self.assertEqual(MyMessage, MyMessage.field_by_name('self_reference').type) self.assertEqual(ForwardMessage, MyMessage.field_by_name('forward').type) self.assertEqual(ForwardMessage.NestedMessage, MyMessage.field_by_name('nested').type) self.assertEqual(MyMessage.Inner, MyMessage.field_by_name('inner').type) self.assertEqual(MyMessage.Sibling, MyMessage.Inner.field_by_name('sibling').type) finally: try: del MyMessage del ForwardMessage except: # pylint:disable=bare-except pass def testMessageField_WrongType(self): """Test that forward referencing the wrong type raises an error.""" global AnEnum try: class AnEnum(messages.Enum): pass class AnotherMessage(messages.Message): a_field = messages.MessageField('AnEnum', 1) self.assertRaises(messages.FieldDefinitionError, getattr, AnotherMessage.field_by_name('a_field'), 'type') finally: del AnEnum def testMessageFieldValidate(self): """Test validation on message field.""" class MyMessage(messages.Message): pass class AnotherMessage(messages.Message): pass field = messages.MessageField(MyMessage, 10) field.validate(MyMessage()) self.assertRaises(messages.ValidationError, field.validate, AnotherMessage()) def testMessageFieldMessageType(self): """Test message_type property.""" class MyMessage(messages.Message): pass class HasMessage(messages.Message): field = messages.MessageField(MyMessage, 1) self.assertEqual(HasMessage.field.type, HasMessage.field.message_type) def testMessageFieldValueFromMessage(self): class MyMessage(messages.Message): pass class HasMessage(messages.Message): field = messages.MessageField(MyMessage, 1) instance = MyMessage() self.assertTrue( instance is HasMessage.field.value_from_message(instance)) def testMessageFieldValueFromMessageWrongType(self): class MyMessage(messages.Message): pass class HasMessage(messages.Message): field = messages.MessageField(MyMessage, 1) self.assertRaisesWithRegexpMatch( messages.DecodeError, 'Expected type MyMessage, got int: 10', HasMessage.field.value_from_message, 10) def testMessageFieldValueToMessage(self): class MyMessage(messages.Message): pass class HasMessage(messages.Message): field = messages.MessageField(MyMessage, 1) instance = MyMessage() self.assertTrue( instance is HasMessage.field.value_to_message(instance)) def testMessageFieldValueToMessageWrongType(self): class MyMessage(messages.Message): pass class MyOtherMessage(messages.Message): pass class HasMessage(messages.Message): field = messages.MessageField(MyMessage, 1) instance = MyOtherMessage() self.assertRaisesWithRegexpMatch( messages.EncodeError, 'Expected type MyMessage, got MyOtherMessage: <MyOtherMessage>', HasMessage.field.value_to_message, instance) def testIntegerField_AllowLong(self): """Test that the integer field allows for longs.""" if six.PY2: messages.IntegerField(10, default=long(10)) def testMessageFieldValidate_Initialized(self): """Test validation on message field.""" class MyMessage(messages.Message): field1 = messages.IntegerField(1, required=True) field = messages.MessageField(MyMessage, 10) # Will validate messages where is_initialized() is False. message = MyMessage() field.validate(message) message.field1 = 20 field.validate(message) def testEnumField(self): """Test the construction of enum fields.""" self.assertRaises(messages.FieldDefinitionError, messages.EnumField, str, 10) self.assertRaises(messages.FieldDefinitionError, messages.EnumField, messages.Enum, 10) class Color(messages.Enum): RED = 1 GREEN = 2 BLUE = 3 field = messages.EnumField(Color, 10) self.assertEqual(Color, field.type) class Another(messages.Enum): VALUE = 1 self.assertRaises(messages.InvalidDefaultError, messages.EnumField, Color, 10, default=Another.VALUE) def testEnumField_ForwardReference(self): """Test the construction of forward reference enum fields.""" global MyMessage global ForwardEnum global ForwardMessage try: class MyMessage(messages.Message): forward = messages.EnumField('ForwardEnum', 1) nested = messages.EnumField('ForwardMessage.NestedEnum', 2) inner = messages.EnumField('Inner', 3) class Inner(messages.Enum): pass class ForwardEnum(messages.Enum): pass class ForwardMessage(messages.Message): class NestedEnum(messages.Enum): pass self.assertEqual(ForwardEnum, MyMessage.field_by_name('forward').type) self.assertEqual(ForwardMessage.NestedEnum, MyMessage.field_by_name('nested').type) self.assertEqual(MyMessage.Inner, MyMessage.field_by_name('inner').type) finally: try: del MyMessage del ForwardEnum del ForwardMessage except: # pylint:disable=bare-except pass def testEnumField_WrongType(self): """Test that forward referencing the wrong type raises an error.""" global AMessage try: class AMessage(messages.Message): pass class AnotherMessage(messages.Message): a_field = messages.EnumField('AMessage', 1) self.assertRaises(messages.FieldDefinitionError, getattr, AnotherMessage.field_by_name('a_field'), 'type') finally: del AMessage def testMessageDefinition(self): """Test that message definition is set on fields.""" class MyMessage(messages.Message): my_field = messages.StringField(1) self.assertEqual( MyMessage, MyMessage.field_by_name('my_field').message_definition()) def testNoneAssignment(self): """Test that assigning None does not change comparison.""" class MyMessage(messages.Message): my_field = messages.StringField(1) m1 = MyMessage() m2 = MyMessage() m2.my_field = None self.assertEqual(m1, m2) def testNonUtf8Str(self): """Test validation fails for non-UTF-8 StringField values.""" class Thing(messages.Message): string_field = messages.StringField(2) thing = Thing() self.assertRaisesWithRegexpMatch( messages.ValidationError, 'Field string_field encountered non-UTF-8 string', setattr, thing, 'string_field', test_util.BINARY) class MessageTest(test_util.TestCase): """Tests for message class.""" def CreateMessageClass(self): """Creates a simple message class with 3 fields. Fields are defined in alphabetical order but with conflicting numeric order. """ class ComplexMessage(messages.Message): a3 = messages.IntegerField(3) b1 = messages.StringField(1) c2 = messages.StringField(2) return ComplexMessage def testSameNumbers(self): """Test that cannot assign two fields with same numbers.""" def action(): class BadMessage(messages.Message): f1 = messages.IntegerField(1) f2 = messages.IntegerField(1) self.assertRaises(messages.DuplicateNumberError, action) def testStrictAssignment(self): """Tests that cannot assign to unknown or non-reserved attributes.""" class SimpleMessage(messages.Message): field = messages.IntegerField(1) simple_message = SimpleMessage() self.assertRaises(AttributeError, setattr, simple_message, 'does_not_exist', 10) def testListAssignmentDoesNotCopy(self): class SimpleMessage(messages.Message): repeated = messages.IntegerField(1, repeated=True) message = SimpleMessage() original = message.repeated message.repeated = [] self.assertFalse(original is message.repeated) def testValidate_Optional(self): """Tests validation of optional fields.""" class SimpleMessage(messages.Message): non_required = messages.IntegerField(1) simple_message = SimpleMessage() simple_message.check_initialized() simple_message.non_required = 10 simple_message.check_initialized() def testValidate_Required(self): """Tests validation of required fields.""" class SimpleMessage(messages.Message): required = messages.IntegerField(1, required=True) simple_message = SimpleMessage() self.assertRaises(messages.ValidationError, simple_message.check_initialized) simple_message.required = 10 simple_message.check_initialized() def testValidate_Repeated(self): """Tests validation of repeated fields.""" class SimpleMessage(messages.Message): repeated = messages.IntegerField(1, repeated=True) simple_message = SimpleMessage() # Check valid values. for valid_value in [], [10], [10, 20], (), (10,), (10, 20): simple_message.repeated = valid_value simple_message.check_initialized() # Check cleared. simple_message.repeated = [] simple_message.check_initialized() # Check invalid values. for invalid_value in 10, ['10', '20'], [None], (None,): self.assertRaises( messages.ValidationError, setattr, simple_message, 'repeated', invalid_value) def testIsInitialized(self): """Tests is_initialized.""" class SimpleMessage(messages.Message): required = messages.IntegerField(1, required=True) simple_message = SimpleMessage() self.assertFalse(simple_message.is_initialized()) simple_message.required = 10 self.assertTrue(simple_message.is_initialized()) def testIsInitializedNestedField(self): """Tests is_initialized for nested fields.""" class SimpleMessage(messages.Message): required = messages.IntegerField(1, required=True) class NestedMessage(messages.Message): simple = messages.MessageField(SimpleMessage, 1) simple_message = SimpleMessage() self.assertFalse(simple_message.is_initialized()) nested_message = NestedMessage(simple=simple_message) self.assertFalse(nested_message.is_initialized()) simple_message.required = 10 self.assertTrue(simple_message.is_initialized()) self.assertTrue(nested_message.is_initialized()) def testInitializeNestedFieldFromDict(self): """Tests initializing nested fields from dict.""" class SimpleMessage(messages.Message): required = messages.IntegerField(1, required=True) class NestedMessage(messages.Message): simple = messages.MessageField(SimpleMessage, 1) class RepeatedMessage(messages.Message): simple = messages.MessageField(SimpleMessage, 1, repeated=True) nested_message1 = NestedMessage(simple={'required': 10}) self.assertTrue(nested_message1.is_initialized()) self.assertTrue(nested_message1.simple.is_initialized()) nested_message2 = NestedMessage() nested_message2.simple = {'required': 10} self.assertTrue(nested_message2.is_initialized()) self.assertTrue(nested_message2.simple.is_initialized()) repeated_values = [{}, {'required': 10}, SimpleMessage(required=20)] repeated_message1 = RepeatedMessage(simple=repeated_values) self.assertEqual(3, len(repeated_message1.simple)) self.assertFalse(repeated_message1.is_initialized()) repeated_message1.simple[0].required = 0 self.assertTrue(repeated_message1.is_initialized()) repeated_message2 = RepeatedMessage() repeated_message2.simple = repeated_values self.assertEqual(3, len(repeated_message2.simple)) self.assertFalse(repeated_message2.is_initialized()) repeated_message2.simple[0].required = 0 self.assertTrue(repeated_message2.is_initialized()) def testNestedMethodsNotAllowed(self): """Test that method definitions on Message classes are not allowed.""" def action(): class WithMethods(messages.Message): def not_allowed(self): pass self.assertRaises(messages.MessageDefinitionError, action) def testNestedAttributesNotAllowed(self): """Test attribute assignment on Message classes is not allowed.""" def int_attribute(): class WithMethods(messages.Message): not_allowed = 1 def string_attribute(): class WithMethods(messages.Message): not_allowed = 'not allowed' def enum_attribute(): class WithMethods(messages.Message): not_allowed = Color.RED for action in (int_attribute, string_attribute, enum_attribute): self.assertRaises(messages.MessageDefinitionError, action) def testNameIsSetOnFields(self): """Make sure name is set on fields after Message class init.""" class HasNamedFields(messages.Message): field = messages.StringField(1) self.assertEqual('field', HasNamedFields.field_by_number(1).name) def testSubclassingMessageDisallowed(self): """Not permitted to create sub-classes of message classes.""" class SuperClass(messages.Message): pass def action(): class SubClass(SuperClass): pass self.assertRaises(messages.MessageDefinitionError, action) def testAllFields(self): """Test all_fields method.""" ComplexMessage = self.CreateMessageClass() fields = list(ComplexMessage.all_fields()) # Order does not matter, so sort now. fields = sorted(fields, key=lambda f: f.name) self.assertEqual(3, len(fields)) self.assertEqual('a3', fields[0].name) self.assertEqual('b1', fields[1].name) self.assertEqual('c2', fields[2].name) def testFieldByName(self): """Test getting field by name.""" ComplexMessage = self.CreateMessageClass() self.assertEqual(3, ComplexMessage.field_by_name('a3').number) self.assertEqual(1, ComplexMessage.field_by_name('b1').number) self.assertEqual(2, ComplexMessage.field_by_name('c2').number) self.assertRaises(KeyError, ComplexMessage.field_by_name, 'unknown') def testFieldByNumber(self): """Test getting field by number.""" ComplexMessage = self.CreateMessageClass() self.assertEqual('a3', ComplexMessage.field_by_number(3).name) self.assertEqual('b1', ComplexMessage.field_by_number(1).name) self.assertEqual('c2', ComplexMessage.field_by_number(2).name) self.assertRaises(KeyError, ComplexMessage.field_by_number, 4) def testGetAssignedValue(self): """Test getting the assigned value of a field.""" class SomeMessage(messages.Message): a_value = messages.StringField(1, default=u'a default') message = SomeMessage() self.assertEqual(None, message.get_assigned_value('a_value')) message.a_value = u'a string' self.assertEqual(u'a string', message.get_assigned_value('a_value')) message.a_value = u'a default' self.assertEqual(u'a default', message.get_assigned_value('a_value')) self.assertRaisesWithRegexpMatch( AttributeError, 'Message SomeMessage has no field no_such_field', message.get_assigned_value, 'no_such_field') def testReset(self): """Test resetting a field value.""" class SomeMessage(messages.Message): a_value = messages.StringField(1, default=u'a default') repeated = messages.IntegerField(2, repeated=True) message = SomeMessage() self.assertRaises(AttributeError, message.reset, 'unknown') self.assertEqual(u'a default', message.a_value) message.reset('a_value') self.assertEqual(u'a default', message.a_value) message.a_value = u'a new value' self.assertEqual(u'a new value', message.a_value) message.reset('a_value') self.assertEqual(u'a default', message.a_value) message.repeated = [1, 2, 3] self.assertEqual([1, 2, 3], message.repeated) saved = message.repeated message.reset('repeated') self.assertEqual([], message.repeated) self.assertIsInstance(message.repeated, messages.FieldList) self.assertEqual([1, 2, 3], saved) def testAllowNestedEnums(self): """Test allowing nested enums in a message definition.""" class Trade(messages.Message): class Duration(messages.Enum): GTC = 1 DAY = 2 class Currency(messages.Enum): USD = 1 GBP = 2 INR = 3 # Sorted by name order seems to be the only feasible option. self.assertEqual(['Currency', 'Duration'], Trade.__enums__) # Message definition will now be set on Enumerated objects. self.assertEqual(Trade, Trade.Duration.message_definition()) def testAllowNestedMessages(self): """Test allowing nested messages in a message definition.""" class Trade(messages.Message): class Lot(messages.Message): pass class Agent(messages.Message): pass # Sorted by name order seems to be the only feasible option. self.assertEqual(['Agent', 'Lot'], Trade.__messages__) self.assertEqual(Trade, Trade.Agent.message_definition()) self.assertEqual(Trade, Trade.Lot.message_definition()) # But not Message itself. def action(): class Trade(messages.Message): NiceTry = messages.Message self.assertRaises(messages.MessageDefinitionError, action) def testDisallowClassAssignments(self): """Test setting class attributes may not happen.""" class MyMessage(messages.Message): pass self.assertRaises(AttributeError, setattr, MyMessage, 'x', 'do not assign') def testEquality(self): """Test message class equality.""" # Comparison against enums must work. class MyEnum(messages.Enum): val1 = 1 val2 = 2 # Comparisons against nested messages must work. class AnotherMessage(messages.Message): string = messages.StringField(1) class MyMessage(messages.Message): field1 = messages.IntegerField(1) field2 = messages.EnumField(MyEnum, 2) field3 = messages.MessageField(AnotherMessage, 3) message1 = MyMessage() self.assertNotEqual('hi', message1) self.assertNotEqual(AnotherMessage(), message1) self.assertEqual(message1, message1) message2 = MyMessage() self.assertEqual(message1, message2) message1.field1 = 10 self.assertNotEqual(message1, message2) message2.field1 = 20 self.assertNotEqual(message1, message2) message2.field1 = 10 self.assertEqual(message1, message2) message1.field2 = MyEnum.val1 self.assertNotEqual(message1, message2) message2.field2 = MyEnum.val2 self.assertNotEqual(message1, message2) message2.field2 = MyEnum.val1 self.assertEqual(message1, message2) message1.field3 = AnotherMessage() message1.field3.string = 'value1' self.assertNotEqual(message1, message2) message2.field3 = AnotherMessage() message2.field3.string = 'value2' self.assertNotEqual(message1, message2) message2.field3.string = 'value1' self.assertEqual(message1, message2) def testEqualityWithUnknowns(self): """Test message class equality with unknown fields.""" class MyMessage(messages.Message): field1 = messages.IntegerField(1) message1 = MyMessage() message2 = MyMessage() self.assertEqual(message1, message2) message1.set_unrecognized_field('unknown1', 'value1', messages.Variant.STRING) self.assertEqual(message1, message2) message1.set_unrecognized_field('unknown2', ['asdf', 3], messages.Variant.STRING) message1.set_unrecognized_field('unknown3', 4.7, messages.Variant.DOUBLE) self.assertEqual(message1, message2) def testUnrecognizedFieldInvalidVariant(self): class MyMessage(messages.Message): field1 = messages.IntegerField(1) message1 = MyMessage() self.assertRaises( TypeError, message1.set_unrecognized_field, 'unknown4', {'unhandled': 'type'}, None) self.assertRaises( TypeError, message1.set_unrecognized_field, 'unknown4', {'unhandled': 'type'}, 123) def testRepr(self): """Test represtation of Message object.""" class MyMessage(messages.Message): integer_value = messages.IntegerField(1) string_value = messages.StringField(2) unassigned = messages.StringField(3) unassigned_with_default = messages.StringField( 4, default=u'a default') my_message = MyMessage() my_message.integer_value = 42 my_message.string_value = u'A string' pat = re.compile(r"<MyMessage\n integer_value: 42\n" " string_value: [u]?'A string'>") self.assertTrue(pat.match(repr(my_message)) is not None) def testValidation(self): """Test validation of message values.""" # Test optional. class SubMessage(messages.Message): pass class Message(messages.Message): val = messages.MessageField(SubMessage, 1) message = Message() message_field = messages.MessageField(Message, 1) message_field.validate(message) message.val = SubMessage() message_field.validate(message) self.assertRaises(messages.ValidationError, setattr, message, 'val', [SubMessage()]) # Test required. class Message(messages.Message): val = messages.MessageField(SubMessage, 1, required=True) message = Message() message_field = messages.MessageField(Message, 1) message_field.validate(message) message.val = SubMessage() message_field.validate(message) self.assertRaises(messages.ValidationError, setattr, message, 'val', [SubMessage()]) # Test repeated. class Message(messages.Message): val = messages.MessageField(SubMessage, 1, repeated=True) message = Message() message_field = messages.MessageField(Message, 1) message_field.validate(message) self.assertRaisesWithRegexpMatch( messages.ValidationError, "Field val is repeated. Found: <SubMessage>", setattr, message, 'val', SubMessage()) message.val = [SubMessage()] message_field.validate(message) def testDefinitionName(self): """Test message name.""" class MyMessage(messages.Message): pass module_name = test_util.get_module_name(FieldTest) self.assertEqual('%s.MyMessage' % module_name, MyMessage.definition_name()) self.assertEqual(module_name, MyMessage.outer_definition_name()) self.assertEqual(module_name, MyMessage.definition_package()) self.assertEqual(six.text_type, type(MyMessage.definition_name())) self.assertEqual(six.text_type, type( MyMessage.outer_definition_name())) self.assertEqual(six.text_type, type(MyMessage.definition_package())) def testDefinitionName_OverrideModule(self): """Test message module is overriden by module package name.""" class MyMessage(messages.Message): pass global package package = 'my.package' try: self.assertEqual('my.package.MyMessage', MyMessage.definition_name()) self.assertEqual('my.package', MyMessage.outer_definition_name()) self.assertEqual('my.package', MyMessage.definition_package()) self.assertEqual(six.text_type, type(MyMessage.definition_name())) self.assertEqual(six.text_type, type( MyMessage.outer_definition_name())) self.assertEqual(six.text_type, type( MyMessage.definition_package())) finally: del package def testDefinitionName_NoModule(self): """Test what happens when there is no module for message.""" class MyMessage(messages.Message): pass original_modules = sys.modules sys.modules = dict(sys.modules) try: del sys.modules[__name__] self.assertEqual('MyMessage', MyMessage.definition_name()) self.assertEqual(None, MyMessage.outer_definition_name()) self.assertEqual(None, MyMessage.definition_package()) self.assertEqual(six.text_type, type(MyMessage.definition_name())) finally: sys.modules = original_modules def testDefinitionName_Nested(self): """Test nested message names.""" class MyMessage(messages.Message): class NestedMessage(messages.Message): class NestedMessage(messages.Message): pass module_name = test_util.get_module_name(MessageTest) self.assertEqual('%s.MyMessage.NestedMessage' % module_name, MyMessage.NestedMessage.definition_name()) self.assertEqual('%s.MyMessage' % module_name, MyMessage.NestedMessage.outer_definition_name()) self.assertEqual(module_name, MyMessage.NestedMessage.definition_package()) self.assertEqual( '%s.MyMessage.NestedMessage.NestedMessage' % module_name, MyMessage.NestedMessage.NestedMessage.definition_name()) self.assertEqual( '%s.MyMessage.NestedMessage' % module_name, MyMessage.NestedMessage.NestedMessage.outer_definition_name()) self.assertEqual( module_name, MyMessage.NestedMessage.NestedMessage.definition_package()) def testMessageDefinition(self): """Test that enumeration knows its enclosing message definition.""" class OuterMessage(messages.Message): class InnerMessage(messages.Message): pass self.assertEqual(None, OuterMessage.message_definition()) self.assertEqual(OuterMessage, OuterMessage.InnerMessage.message_definition()) def testConstructorKwargs(self): """Test kwargs via constructor.""" class SomeMessage(messages.Message): name = messages.StringField(1) number = messages.IntegerField(2) expected = SomeMessage() expected.name = 'my name' expected.number = 200 self.assertEqual(expected, SomeMessage(name='my name', number=200)) def testConstructorNotAField(self): """Test kwargs via constructor with wrong names.""" class SomeMessage(messages.Message): pass self.assertRaisesWithRegexpMatch( AttributeError, ('May not assign arbitrary value does_not_exist to message ' 'SomeMessage'), SomeMessage, does_not_exist=10) def testGetUnsetRepeatedValue(self): class SomeMessage(messages.Message): repeated = messages.IntegerField(1, repeated=True) instance = SomeMessage() self.assertEqual([], instance.repeated) self.assertTrue(isinstance(instance.repeated, messages.FieldList)) def testCompareAutoInitializedRepeatedFields(self): class SomeMessage(messages.Message): repeated = messages.IntegerField(1, repeated=True) message1 = SomeMessage(repeated=[]) message2 = SomeMessage() self.assertEqual(message1, message2) def testUnknownValues(self): """Test message class equality with unknown fields.""" class MyMessage(messages.Message): field1 = messages.IntegerField(1) message = MyMessage() self.assertEqual([], message.all_unrecognized_fields()) self.assertEqual((None, None), message.get_unrecognized_field_info('doesntexist')) self.assertEqual((None, None), message.get_unrecognized_field_info( 'doesntexist', None, None)) self.assertEqual(('defaultvalue', 'defaultwire'), message.get_unrecognized_field_info( 'doesntexist', 'defaultvalue', 'defaultwire')) self.assertEqual((3, None), message.get_unrecognized_field_info( 'doesntexist', value_default=3)) message.set_unrecognized_field('exists', 9.5, messages.Variant.DOUBLE) self.assertEqual(1, len(message.all_unrecognized_fields())) self.assertTrue('exists' in message.all_unrecognized_fields()) self.assertEqual((9.5, messages.Variant.DOUBLE), message.get_unrecognized_field_info('exists')) self.assertEqual((9.5, messages.Variant.DOUBLE), message.get_unrecognized_field_info('exists', 'type', 1234)) self.assertEqual( (1234, None), message.get_unrecognized_field_info('doesntexist', 1234)) message.set_unrecognized_field( 'another', 'value', messages.Variant.STRING) self.assertEqual(2, len(message.all_unrecognized_fields())) self.assertTrue('exists' in message.all_unrecognized_fields()) self.assertTrue('another' in message.all_unrecognized_fields()) self.assertEqual((9.5, messages.Variant.DOUBLE), message.get_unrecognized_field_info('exists')) self.assertEqual(('value', messages.Variant.STRING), message.get_unrecognized_field_info('another')) message.set_unrecognized_field('typetest1', ['list', 0, ('test',)], messages.Variant.STRING) self.assertEqual((['list', 0, ('test',)], messages.Variant.STRING), message.get_unrecognized_field_info('typetest1')) message.set_unrecognized_field( 'typetest2', '', messages.Variant.STRING) self.assertEqual(('', messages.Variant.STRING), message.get_unrecognized_field_info('typetest2')) def testPickle(self): """Testing pickling and unpickling of Message instances.""" global MyEnum global AnotherMessage global MyMessage class MyEnum(messages.Enum): val1 = 1 val2 = 2 class AnotherMessage(messages.Message): string = messages.StringField(1, repeated=True) class MyMessage(messages.Message): field1 = messages.IntegerField(1) field2 = messages.EnumField(MyEnum, 2) field3 = messages.MessageField(AnotherMessage, 3) message = MyMessage(field1=1, field2=MyEnum.val2, field3=AnotherMessage(string=['a', 'b', 'c'])) message.set_unrecognized_field( 'exists', 'value', messages.Variant.STRING) message.set_unrecognized_field('repeated', ['list', 0, ('test',)], messages.Variant.STRING) unpickled = pickle.loads(pickle.dumps(message)) self.assertEqual(message, unpickled) self.assertTrue(AnotherMessage.string is unpickled.field3.string.field) self.assertTrue('exists' in message.all_unrecognized_fields()) self.assertEqual(('value', messages.Variant.STRING), message.get_unrecognized_field_info('exists')) self.assertEqual((['list', 0, ('test',)], messages.Variant.STRING), message.get_unrecognized_field_info('repeated')) class FindDefinitionTest(test_util.TestCase): """Test finding definitions relative to various definitions and modules.""" def setUp(self): """Set up module-space. Starts off empty.""" self.modules = {} def DefineModule(self, name): """Define a module and its parents in module space. Modules that are already defined in self.modules are not re-created. Args: name: Fully qualified name of modules to create. Returns: Deepest nested module. For example: DefineModule('a.b.c') # Returns c. """ name_path = name.split('.') full_path = [] for node in name_path: full_path.append(node) full_name = '.'.join(full_path) self.modules.setdefault(full_name, types.ModuleType(full_name)) return self.modules[name] def DefineMessage(self, module, name, children=None, add_to_module=True): """Define a new Message class in the context of a module. Used for easily describing complex Message hierarchy. Message is defined including all child definitions. Args: module: Fully qualified name of module to place Message class in. name: Name of Message to define within module. children: Define any level of nesting of children definitions. To define a message, map the name to another dictionary. The dictionary can itself contain additional definitions, and so on. To map to an Enum, define the Enum class separately and map it by name. add_to_module: If True, new Message class is added to module. If False, new Message is not added. """ children = children or {} # Make sure module exists. module_instance = self.DefineModule(module) # Recursively define all child messages. for attribute, value in children.items(): if isinstance(value, dict): children[attribute] = self.DefineMessage( module, attribute, value, False) # Override default __module__ variable. children['__module__'] = module # Instantiate and possibly add to module. message_class = type(name, (messages.Message,), dict(children)) if add_to_module: setattr(module_instance, name, message_class) return message_class # pylint:disable=unused-argument # pylint:disable=redefined-builtin def Importer(self, module, globals='', locals='', fromlist=None): """Importer function. Acts like __import__. Only loads modules from self.modules. Does not try to load real modules defined elsewhere. Does not try to handle relative imports. Args: module: Fully qualified name of module to load from self.modules. """ if fromlist is None: module = module.split('.')[0] try: return self.modules[module] except KeyError: raise ImportError() # pylint:disable=unused-argument def testNoSuchModule(self): """Test searching for definitions that do no exist.""" self.assertRaises(messages.DefinitionNotFoundError, messages.find_definition, 'does.not.exist', importer=self.Importer) def testRefersToModule(self): """Test that referring to a module does not return that module.""" self.DefineModule('i.am.a.module') self.assertRaises(messages.DefinitionNotFoundError, messages.find_definition, 'i.am.a.module', importer=self.Importer) def testNoDefinition(self): """Test not finding a definition in an existing module.""" self.DefineModule('i.am.a.module') self.assertRaises(messages.DefinitionNotFoundError, messages.find_definition, 'i.am.a.module.MyMessage', importer=self.Importer) def testNotADefinition(self): """Test trying to fetch something that is not a definition.""" module = self.DefineModule('i.am.a.module') setattr(module, 'A', 'a string') self.assertRaises(messages.DefinitionNotFoundError, messages.find_definition, 'i.am.a.module.A', importer=self.Importer) def testGlobalFind(self): """Test finding definitions from fully qualified module names.""" A = self.DefineMessage('a.b.c', 'A', {}) self.assertEqual(A, messages.find_definition('a.b.c.A', importer=self.Importer)) B = self.DefineMessage('a.b.c', 'B', {'C': {}}) self.assertEqual( B.C, messages.find_definition('a.b.c.B.C', importer=self.Importer)) def testRelativeToModule(self): """Test finding definitions relative to modules.""" # Define modules. a = self.DefineModule('a') b = self.DefineModule('a.b') c = self.DefineModule('a.b.c') # Define messages. A = self.DefineMessage('a', 'A') B = self.DefineMessage('a.b', 'B') C = self.DefineMessage('a.b.c', 'C') D = self.DefineMessage('a.b.d', 'D') # Find A, B, C and D relative to a. self.assertEqual(A, messages.find_definition( 'A', a, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'b.B', a, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'b.c.C', a, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'b.d.D', a, importer=self.Importer)) # Find A, B, C and D relative to b. self.assertEqual(A, messages.find_definition( 'A', b, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'B', b, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'c.C', b, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'd.D', b, importer=self.Importer)) # Find A, B, C and D relative to c. Module d is the same case as c. self.assertEqual(A, messages.find_definition( 'A', c, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'B', c, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'C', c, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'd.D', c, importer=self.Importer)) def testRelativeToMessages(self): """Test finding definitions relative to Message definitions.""" A = self.DefineMessage('a.b', 'A', {'B': {'C': {}, 'D': {}}}) B = A.B C = A.B.C D = A.B.D # Find relative to A. self.assertEqual(A, messages.find_definition( 'A', A, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'B', A, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'B.C', A, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'B.D', A, importer=self.Importer)) # Find relative to B. self.assertEqual(A, messages.find_definition( 'A', B, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'B', B, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'C', B, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'D', B, importer=self.Importer)) # Find relative to C. self.assertEqual(A, messages.find_definition( 'A', C, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'B', C, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'C', C, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'D', C, importer=self.Importer)) # Find relative to C searching from c. self.assertEqual(A, messages.find_definition( 'b.A', C, importer=self.Importer)) self.assertEqual(B, messages.find_definition( 'b.A.B', C, importer=self.Importer)) self.assertEqual(C, messages.find_definition( 'b.A.B.C', C, importer=self.Importer)) self.assertEqual(D, messages.find_definition( 'b.A.B.D', C, importer=self.Importer)) def testAbsoluteReference(self): """Test finding absolute definition names.""" # Define modules. a = self.DefineModule('a') b = self.DefineModule('a.a') # Define messages. aA = self.DefineMessage('a', 'A') aaA = self.DefineMessage('a.a', 'A') # Always find a.A. self.assertEqual(aA, messages.find_definition('.a.A', None, importer=self.Importer)) self.assertEqual(aA, messages.find_definition('.a.A', a, importer=self.Importer)) self.assertEqual(aA, messages.find_definition('.a.A', aA, importer=self.Importer)) self.assertEqual(aA, messages.find_definition('.a.A', aaA, importer=self.Importer)) def testFindEnum(self): """Test that Enums are found.""" class Color(messages.Enum): pass A = self.DefineMessage('a', 'A', {'Color': Color}) self.assertEqual( Color, messages.find_definition('Color', A, importer=self.Importer)) def testFalseScope(self): """Test Message definitions nested in strange objects are hidden.""" global X class X(object): class A(messages.Message): pass self.assertRaises(TypeError, messages.find_definition, 'A', X) self.assertRaises(messages.DefinitionNotFoundError, messages.find_definition, 'X.A', sys.modules[__name__]) def testSearchAttributeFirst(self): """Make sure not faked out by module, but continues searching.""" A = self.DefineMessage('a', 'A') module_A = self.DefineModule('a.A') self.assertEqual(A, messages.find_definition( 'a.A', None, importer=self.Importer)) def main(): unittest.main() if __name__ == '__main__': main() protorpclite/util.py 0000644 00000023753 15025317163 0010636 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Common utility library.""" from __future__ import with_statement import datetime import functools import inspect import logging import os import re import sys import six __all__ = [ 'Error', 'decode_datetime', 'get_package_for_module', 'positional', 'TimeZoneOffset', 'total_seconds', ] class Error(Exception): """Base class for protorpc exceptions.""" _TIME_ZONE_RE_STRING = r""" # Examples: # +01:00 # -05:30 # Z12:00 ((?P<z>Z) | (?P<sign>[-+]) (?P<hours>\d\d) : (?P<minutes>\d\d))$ """ _TIME_ZONE_RE = re.compile(_TIME_ZONE_RE_STRING, re.IGNORECASE | re.VERBOSE) def positional(max_positional_args): """A decorator that declares only the first N arguments may be positional. This decorator makes it easy to support Python 3 style keyword-only parameters. For example, in Python 3 it is possible to write: def fn(pos1, *, kwonly1=None, kwonly1=None): ... All named parameters after * must be a keyword: fn(10, 'kw1', 'kw2') # Raises exception. fn(10, kwonly1='kw1') # Ok. Example: To define a function like above, do: @positional(1) def fn(pos1, kwonly1=None, kwonly2=None): ... If no default value is provided to a keyword argument, it becomes a required keyword argument: @positional(0) def fn(required_kw): ... This must be called with the keyword parameter: fn() # Raises exception. fn(10) # Raises exception. fn(required_kw=10) # Ok. When defining instance or class methods always remember to account for 'self' and 'cls': class MyClass(object): @positional(2) def my_method(self, pos1, kwonly1=None): ... @classmethod @positional(2) def my_method(cls, pos1, kwonly1=None): ... One can omit the argument to 'positional' altogether, and then no arguments with default values may be passed positionally. This would be equivalent to placing a '*' before the first argument with a default value in Python 3. If there are no arguments with default values, and no argument is given to 'positional', an error is raised. @positional def fn(arg1, arg2, required_kw1=None, required_kw2=0): ... fn(1, 3, 5) # Raises exception. fn(1, 3) # Ok. fn(1, 3, required_kw1=5) # Ok. Args: max_positional_arguments: Maximum number of positional arguments. All parameters after the this index must be keyword only. Returns: A decorator that prevents using arguments after max_positional_args from being used as positional parameters. Raises: TypeError if a keyword-only argument is provided as a positional parameter. ValueError if no maximum number of arguments is provided and the function has no arguments with default values. """ def positional_decorator(wrapped): """Creates a function wraper to enforce number of arguments.""" @functools.wraps(wrapped) def positional_wrapper(*args, **kwargs): if len(args) > max_positional_args: plural_s = '' if max_positional_args != 1: plural_s = 's' raise TypeError('%s() takes at most %d positional argument%s ' '(%d given)' % (wrapped.__name__, max_positional_args, plural_s, len(args))) return wrapped(*args, **kwargs) return positional_wrapper if isinstance(max_positional_args, six.integer_types): return positional_decorator else: args, _, _, defaults, *_ = inspect.getfullargspec(max_positional_args) if defaults is None: raise ValueError( 'Functions with no keyword arguments must specify ' 'max_positional_args') return positional(len(args) - len(defaults))(max_positional_args) @positional(1) def get_package_for_module(module): """Get package name for a module. Helper calculates the package name of a module. Args: module: Module to get name for. If module is a string, try to find module in sys.modules. Returns: If module contains 'package' attribute, uses that as package name. Else, if module is not the '__main__' module, the module __name__. Else, the base name of the module file name. Else None. """ if isinstance(module, six.string_types): try: module = sys.modules[module] except KeyError: return None try: return six.text_type(module.package) except AttributeError: if module.__name__ == '__main__': try: file_name = module.__file__ except AttributeError: pass else: base_name = os.path.basename(file_name) split_name = os.path.splitext(base_name) if len(split_name) == 1: return six.text_type(base_name) return u'.'.join(split_name[:-1]) return six.text_type(module.__name__) def total_seconds(offset): """Backport of offset.total_seconds() from python 2.7+.""" seconds = offset.days * 24 * 60 * 60 + offset.seconds microseconds = seconds * 10**6 + offset.microseconds return microseconds / (10**6 * 1.0) class TimeZoneOffset(datetime.tzinfo): """Time zone information as encoded/decoded for DateTimeFields.""" def __init__(self, offset): """Initialize a time zone offset. Args: offset: Integer or timedelta time zone offset, in minutes from UTC. This can be negative. """ super(TimeZoneOffset, self).__init__() if isinstance(offset, datetime.timedelta): offset = total_seconds(offset) / 60 self.__offset = offset def utcoffset(self, _): """Get the a timedelta with the time zone's offset from UTC. Returns: The time zone offset from UTC, as a timedelta. """ return datetime.timedelta(minutes=self.__offset) def dst(self, _): """Get the daylight savings time offset. The formats that ProtoRPC uses to encode/decode time zone information don't contain any information about daylight savings time. So this always returns a timedelta of 0. Returns: A timedelta of 0. """ return datetime.timedelta(0) def decode_datetime(encoded_datetime, truncate_time=False): """Decode a DateTimeField parameter from a string to a python datetime. Args: encoded_datetime: A string in RFC 3339 format. truncate_time: If true, truncate time string with precision higher than microsecs. Returns: A datetime object with the date and time specified in encoded_datetime. Raises: ValueError: If the string is not in a recognized format. """ # Check if the string includes a time zone offset. Break out the # part that doesn't include time zone info. Convert to uppercase # because all our comparisons should be case-insensitive. time_zone_match = _TIME_ZONE_RE.search(encoded_datetime) if time_zone_match: time_string = encoded_datetime[:time_zone_match.start(1)].upper() else: time_string = encoded_datetime.upper() if '.' in time_string: format_string = '%Y-%m-%dT%H:%M:%S.%f' else: format_string = '%Y-%m-%dT%H:%M:%S' try: decoded_datetime = datetime.datetime.strptime(time_string, format_string) except ValueError: if truncate_time and '.' in time_string: datetime_string, decimal_secs = time_string.split('.') if len(decimal_secs) > 6: # datetime can handle only microsecs precision. truncated_time_string = '{}.{}'.format( datetime_string, decimal_secs[:6]) decoded_datetime = datetime.datetime.strptime( truncated_time_string, format_string) logging.warning( 'Truncating the datetime string from %s to %s', time_string, truncated_time_string) else: raise else: raise if not time_zone_match: return decoded_datetime # Time zone info was included in the parameter. Add a tzinfo # object to the datetime. Datetimes can't be changed after they're # created, so we'll need to create a new one. if time_zone_match.group('z'): offset_minutes = 0 else: sign = time_zone_match.group('sign') hours, minutes = [int(value) for value in time_zone_match.group('hours', 'minutes')] offset_minutes = hours * 60 + minutes if sign == '-': offset_minutes *= -1 return datetime.datetime(decoded_datetime.year, decoded_datetime.month, decoded_datetime.day, decoded_datetime.hour, decoded_datetime.minute, decoded_datetime.second, decoded_datetime.microsecond, TimeZoneOffset(offset_minutes)) protorpclite/messages.py 0000644 00000204205 15025317163 0011461 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # # pylint: disable=too-many-lines """Stand-alone implementation of in memory protocol messages. Public Classes: Enum: Represents an enumerated type. Variant: Hint for wire format to determine how to serialize. Message: Base class for user defined messages. IntegerField: Field for integer values. FloatField: Field for float values. BooleanField: Field for boolean values. BytesField: Field for binary string values. StringField: Field for UTF-8 string values. MessageField: Field for other message type values. EnumField: Field for enumerated type values. Public Exceptions (indentation indications class hierarchy): EnumDefinitionError: Raised when enumeration is incorrectly defined. FieldDefinitionError: Raised when field is incorrectly defined. InvalidVariantError: Raised when variant is not compatible with field type. InvalidDefaultError: Raised when default is not compatiable with field. InvalidNumberError: Raised when field number is out of range or reserved. MessageDefinitionError: Raised when message is incorrectly defined. DuplicateNumberError: Raised when field has duplicate number with another. ValidationError: Raised when a message or field is not valid. DefinitionNotFoundError: Raised when definition not found. """ import types import weakref import six from apitools.base.protorpclite import util __all__ = [ 'MAX_ENUM_VALUE', 'MAX_FIELD_NUMBER', 'FIRST_RESERVED_FIELD_NUMBER', 'LAST_RESERVED_FIELD_NUMBER', 'Enum', 'Field', 'FieldList', 'Variant', 'Message', 'IntegerField', 'FloatField', 'BooleanField', 'BytesField', 'StringField', 'MessageField', 'EnumField', 'find_definition', 'Error', 'DecodeError', 'EncodeError', 'EnumDefinitionError', 'FieldDefinitionError', 'InvalidVariantError', 'InvalidDefaultError', 'InvalidNumberError', 'MessageDefinitionError', 'DuplicateNumberError', 'ValidationError', 'DefinitionNotFoundError', ] # pylint:disable=attribute-defined-outside-init # pylint:disable=protected-access # TODO(rafek): Add extended module test to ensure all exceptions # in services extends Error. Error = util.Error class EnumDefinitionError(Error): """Enumeration definition error.""" class FieldDefinitionError(Error): """Field definition error.""" class InvalidVariantError(FieldDefinitionError): """Invalid variant provided to field.""" class InvalidDefaultError(FieldDefinitionError): """Invalid default provided to field.""" class InvalidNumberError(FieldDefinitionError): """Invalid number provided to field.""" class MessageDefinitionError(Error): """Message definition error.""" class DuplicateNumberError(Error): """Duplicate number assigned to field.""" class DefinitionNotFoundError(Error): """Raised when definition is not found.""" class DecodeError(Error): """Error found decoding message from encoded form.""" class EncodeError(Error): """Error found when encoding message.""" class ValidationError(Error): """Invalid value for message error.""" def __str__(self): """Prints string with field name if present on exception.""" return Error.__str__(self) # Attributes that are reserved by a class definition that # may not be used by either Enum or Message class definitions. _RESERVED_ATTRIBUTE_NAMES = frozenset( ['__module__', '__doc__', '__qualname__', '__static_attributes__', '__firstlineno__']) _POST_INIT_FIELD_ATTRIBUTE_NAMES = frozenset( ['name', '_message_definition', '_MessageField__type', '_EnumField__type', '_EnumField__resolved_default']) _POST_INIT_ATTRIBUTE_NAMES = frozenset( ['_message_definition']) # Maximum enumeration value as defined by the protocol buffers standard. # All enum values must be less than or equal to this value. MAX_ENUM_VALUE = (2 ** 29) - 1 # Maximum field number as defined by the protocol buffers standard. # All field numbers must be less than or equal to this value. MAX_FIELD_NUMBER = (2 ** 29) - 1 # Field numbers between 19000 and 19999 inclusive are reserved by the # protobuf protocol and may not be used by fields. FIRST_RESERVED_FIELD_NUMBER = 19000 LAST_RESERVED_FIELD_NUMBER = 19999 # pylint: disable=no-value-for-parameter class _DefinitionClass(type): """Base meta-class used for definition meta-classes. The Enum and Message definition classes share some basic functionality. Both of these classes may be contained by a Message definition. After initialization, neither class may have attributes changed except for the protected _message_definition attribute, and that attribute may change only once. """ __initialized = False # pylint:disable=invalid-name def __init__(cls, name, bases, dct): """Constructor.""" type.__init__(cls, name, bases, dct) # Base classes may never be initialized. if cls.__bases__ != (object,): cls.__initialized = True def message_definition(cls): """Get outer Message definition that contains this definition. Returns: Containing Message definition if definition is contained within one, else None. """ try: return cls._message_definition() except AttributeError: return None def __setattr__(cls, name, value): """Overridden to avoid setting variables after init. Setting attributes on a class must work during the period of initialization to set the enumation value class variables and build the name/number maps. Once __init__ has set the __initialized flag to True prohibits setting any more values on the class. The class is in effect frozen. Args: name: Name of value to set. value: Value to set. """ if cls.__initialized and name not in _POST_INIT_ATTRIBUTE_NAMES: raise AttributeError('May not change values: %s' % name) else: type.__setattr__(cls, name, value) def __delattr__(cls, name): """Overridden so that cannot delete varaibles on definition classes.""" raise TypeError('May not delete attributes on definition class') def definition_name(cls): """Helper method for creating definition name. Names will be generated to include the classes package name, scope (if the class is nested in another definition) and class name. By default, the package name for a definition is derived from its module name. However, this value can be overriden by placing a 'package' attribute in the module that contains the definition class. For example: package = 'some.alternate.package' class MyMessage(Message): ... >>> MyMessage.definition_name() some.alternate.package.MyMessage Returns: Dot-separated fully qualified name of definition. """ outer_definition_name = cls.outer_definition_name() if outer_definition_name is None: return six.text_type(cls.__name__) return u'%s.%s' % (outer_definition_name, cls.__name__) def outer_definition_name(cls): """Helper method for creating outer definition name. Returns: If definition is nested, will return the outer definitions name, else the package name. """ outer_definition = cls.message_definition() if not outer_definition: return util.get_package_for_module(cls.__module__) return outer_definition.definition_name() def definition_package(cls): """Helper method for creating creating the package of a definition. Returns: Name of package that definition belongs to. """ outer_definition = cls.message_definition() if not outer_definition: return util.get_package_for_module(cls.__module__) return outer_definition.definition_package() class _EnumClass(_DefinitionClass): """Meta-class used for defining the Enum base class. Meta-class enables very specific behavior for any defined Enum class. All attributes defined on an Enum sub-class must be integers. Each attribute defined on an Enum sub-class is translated into an instance of that sub-class, with the name of the attribute as its name, and the number provided as its value. It also ensures that only one level of Enum class hierarchy is possible. In other words it is not possible to delcare sub-classes of sub-classes of Enum. This class also defines some functions in order to restrict the behavior of the Enum class and its sub-classes. It is not possible to change the behavior of the Enum class in later classes since any new classes may be defined with only integer values, and no methods. """ def __init__(cls, name, bases, dct): # Can only define one level of sub-classes below Enum. if not (bases == (object,) or bases == (Enum,)): raise EnumDefinitionError( 'Enum type %s may only inherit from Enum' % name) cls.__by_number = {} cls.__by_name = {} # Enum base class does not need to be initialized or locked. if bases != (object,): # Replace integer with number. for attribute, value in dct.items(): # Module will be in every enum class. if attribute in _RESERVED_ATTRIBUTE_NAMES: continue # Reject anything that is not an int. if not isinstance(value, six.integer_types): raise EnumDefinitionError( 'May only use integers in Enum definitions. ' 'Found: %s = %s' % (attribute, value)) # Protocol buffer standard recommends non-negative values. # Reject negative values. if value < 0: raise EnumDefinitionError( 'Must use non-negative enum values. Found: %s = %d' % (attribute, value)) if value > MAX_ENUM_VALUE: raise EnumDefinitionError( 'Must use enum values less than or equal %d. ' 'Found: %s = %d' % (MAX_ENUM_VALUE, attribute, value)) if value in cls.__by_number: raise EnumDefinitionError( 'Value for %s = %d is already defined: %s' % (attribute, value, cls.__by_number[value].name)) # Create enum instance and list in new Enum type. instance = object.__new__(cls) # pylint:disable=non-parent-init-called cls.__init__(instance, attribute, value) cls.__by_name[instance.name] = instance cls.__by_number[instance.number] = instance setattr(cls, attribute, instance) _DefinitionClass.__init__(cls, name, bases, dct) def __iter__(cls): """Iterate over all values of enum. Yields: Enumeration instances of the Enum class in arbitrary order. """ return iter(cls.__by_number.values()) def names(cls): """Get all names for Enum. Returns: An iterator for names of the enumeration in arbitrary order. """ return cls.__by_name.keys() def numbers(cls): """Get all numbers for Enum. Returns: An iterator for all numbers of the enumeration in arbitrary order. """ return cls.__by_number.keys() def lookup_by_name(cls, name): """Look up Enum by name. Args: name: Name of enum to find. Returns: Enum sub-class instance of that value. """ return cls.__by_name[name] def lookup_by_number(cls, number): """Look up Enum by number. Args: number: Number of enum to find. Returns: Enum sub-class instance of that value. """ return cls.__by_number[number] def __len__(cls): return len(cls.__by_name) class Enum(six.with_metaclass(_EnumClass, object)): """Base class for all enumerated types.""" __slots__ = set(('name', 'number')) def __new__(cls, index): """Acts as look-up routine after class is initialized. The purpose of overriding __new__ is to provide a way to treat Enum subclasses as casting types, similar to how the int type functions. A program can pass a string or an integer and this method with "convert" that value in to an appropriate Enum instance. Args: index: Name or number to look up. During initialization this is always the name of the new enum value. Raises: TypeError: When an inappropriate index value is passed provided. """ # If is enum type of this class, return it. if isinstance(index, cls): return index # If number, look up by number. if isinstance(index, six.integer_types): try: return cls.lookup_by_number(index) except KeyError: pass # If name, look up by name. if isinstance(index, six.string_types): try: return cls.lookup_by_name(index) except KeyError: pass raise TypeError('No such value for %s in Enum %s' % (index, cls.__name__)) def __init__(self, name, number=None): """Initialize new Enum instance. Since this should only be called during class initialization any calls that happen after the class is frozen raises an exception. """ # Immediately return if __init__ was called after _Enum.__init__(). # It means that casting operator version of the class constructor # is being used. if getattr(type(self), '_DefinitionClass__initialized'): return object.__setattr__(self, 'name', name) object.__setattr__(self, 'number', number) def __setattr__(self, name, value): raise TypeError('May not change enum values') def __str__(self): return self.name def __int__(self): return self.number def __repr__(self): return '%s(%s, %d)' % (type(self).__name__, self.name, self.number) def __reduce__(self): """Enable pickling. Returns: A 2-tuple containing the class and __new__ args to be used for restoring a pickled instance. """ return self.__class__, (self.number,) def __cmp__(self, other): """Order is by number.""" if isinstance(other, type(self)): return cmp(self.number, other.number) return NotImplemented def __lt__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number < other.number return NotImplemented def __le__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number <= other.number return NotImplemented def __eq__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number == other.number return NotImplemented def __ne__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number != other.number return NotImplemented def __ge__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number >= other.number return NotImplemented def __gt__(self, other): """Order is by number.""" if isinstance(other, type(self)): return self.number > other.number return NotImplemented def __hash__(self): """Hash by number.""" return hash(self.number) @classmethod def to_dict(cls): """Make dictionary version of enumerated class. Dictionary created this way can be used with def_num. Returns: A dict (name) -> number """ return dict((item.name, item.number) for item in iter(cls)) @staticmethod def def_enum(dct, name): """Define enum class from dictionary. Args: dct: Dictionary of enumerated values for type. name: Name of enum. """ return type(name, (Enum,), dct) # TODO(rafek): Determine to what degree this enumeration should be compatible # with FieldDescriptor.Type in https://github.com/google/protobuf. class Variant(Enum): """Wire format variant. Used by the 'protobuf' wire format to determine how to transmit a single piece of data. May be used by other formats. See: http://code.google.com/apis/protocolbuffers/docs/encoding.html Values: DOUBLE: 64-bit floating point number. FLOAT: 32-bit floating point number. INT64: 64-bit signed integer. UINT64: 64-bit unsigned integer. INT32: 32-bit signed integer. BOOL: Boolean value (True or False). STRING: String of UTF-8 encoded text. MESSAGE: Embedded message as byte string. BYTES: String of 8-bit bytes. UINT32: 32-bit unsigned integer. ENUM: Enum value as integer. SINT32: 32-bit signed integer. Uses "zig-zag" encoding. SINT64: 64-bit signed integer. Uses "zig-zag" encoding. """ DOUBLE = 1 FLOAT = 2 INT64 = 3 UINT64 = 4 INT32 = 5 BOOL = 8 STRING = 9 MESSAGE = 11 BYTES = 12 UINT32 = 13 ENUM = 14 SINT32 = 17 SINT64 = 18 class _MessageClass(_DefinitionClass): """Meta-class used for defining the Message base class. For more details about Message classes, see the Message class docstring. Information contained there may help understanding this class. Meta-class enables very specific behavior for any defined Message class. All attributes defined on an Message sub-class must be field instances, Enum class definitions or other Message class definitions. Each field attribute defined on an Message sub-class is added to the set of field definitions and the attribute is translated in to a slot. It also ensures that only one level of Message class hierarchy is possible. In other words it is not possible to declare sub-classes of sub-classes of Message. This class also defines some functions in order to restrict the behavior of the Message class and its sub-classes. It is not possible to change the behavior of the Message class in later classes since any new classes may be defined with only field, Enums and Messages, and no methods. """ # pylint:disable=bad-mcs-classmethod-argument def __new__(cls, name, bases, dct): """Create new Message class instance. The __new__ method of the _MessageClass type is overridden so as to allow the translation of Field instances to slots. """ by_number = {} by_name = {} variant_map = {} # pylint:disable=unused-variable if bases != (object,): # Can only define one level of sub-classes below Message. if bases != (Message,): raise MessageDefinitionError( 'Message types may only inherit from Message') enums = [] messages = [] # Must not use iteritems because this loop will change the state of # dct. for key, field in dct.items(): if key in _RESERVED_ATTRIBUTE_NAMES: continue if isinstance(field, type) and issubclass(field, Enum): enums.append(key) continue if (isinstance(field, type) and issubclass(field, Message) and field is not Message): messages.append(key) continue # Reject anything that is not a field. # pylint:disable=unidiomatic-typecheck if type(field) is Field or not isinstance(field, Field): raise MessageDefinitionError( 'May only use fields in message definitions. ' 'Found: %s = %s' % (key, field)) if field.number in by_number: raise DuplicateNumberError( 'Field with number %d declared more than once in %s' % (field.number, name)) field.name = key # Place in name and number maps. by_name[key] = field by_number[field.number] = field # Add enums if any exist. if enums: dct['__enums__'] = sorted(enums) # Add messages if any exist. if messages: dct['__messages__'] = sorted(messages) dct['_Message__by_number'] = by_number dct['_Message__by_name'] = by_name return _DefinitionClass.__new__(cls, name, bases, dct) def __init__(cls, name, bases, dct): """Initializer required to assign references to new class.""" if bases != (object,): for v in dct.values(): if isinstance(v, _DefinitionClass) and v is not Message: v._message_definition = weakref.ref(cls) for field in cls.all_fields(): field._message_definition = weakref.ref(cls) _DefinitionClass.__init__(cls, name, bases, dct) class Message(six.with_metaclass(_MessageClass, object)): """Base class for user defined message objects. Used to define messages for efficient transmission across network or process space. Messages are defined using the field classes (IntegerField, FloatField, EnumField, etc.). Messages are more restricted than normal classes in that they may only contain field attributes and other Message and Enum definitions. These restrictions are in place because the structure of the Message class is intentended to itself be transmitted across network or process space and used directly by clients or even other servers. As such methods and non-field attributes could not be transmitted with the structural information causing discrepancies between different languages and implementations. Initialization and validation: A Message object is considered to be initialized if it has all required fields and any nested messages are also initialized. Calling 'check_initialized' will raise a ValidationException if it is not initialized; 'is_initialized' returns a boolean value indicating if it is valid. Validation automatically occurs when Message objects are created and populated. Validation that a given value will be compatible with a field that it is assigned to can be done through the Field instances validate() method. The validate method used on a message will check that all values of a message and its sub-messages are valid. Assingning an invalid value to a field will raise a ValidationException. Example: # Trade type. class TradeType(Enum): BUY = 1 SELL = 2 SHORT = 3 CALL = 4 class Lot(Message): price = IntegerField(1, required=True) quantity = IntegerField(2, required=True) class Order(Message): symbol = StringField(1, required=True) total_quantity = IntegerField(2, required=True) trade_type = EnumField(TradeType, 3, required=True) lots = MessageField(Lot, 4, repeated=True) limit = IntegerField(5) order = Order(symbol='GOOG', total_quantity=10, trade_type=TradeType.BUY) lot1 = Lot(price=304, quantity=7) lot2 = Lot(price = 305, quantity=3) order.lots = [lot1, lot2] # Now object is initialized! order.check_initialized() """ def __init__(self, **kwargs): """Initialize internal messages state. Args: A message can be initialized via the constructor by passing in keyword arguments corresponding to fields. For example: class Date(Message): day = IntegerField(1) month = IntegerField(2) year = IntegerField(3) Invoking: date = Date(day=6, month=6, year=1911) is the same as doing: date = Date() date.day = 6 date.month = 6 date.year = 1911 """ # Tag being an essential implementation detail must be private. self.__tags = {} self.__unrecognized_fields = {} assigned = set() for name, value in kwargs.items(): setattr(self, name, value) assigned.add(name) # initialize repeated fields. for field in self.all_fields(): if field.repeated and field.name not in assigned: setattr(self, field.name, []) def check_initialized(self): """Check class for initialization status. Check that all required fields are initialized Raises: ValidationError: If message is not initialized. """ for name, field in self.__by_name.items(): value = getattr(self, name) if value is None: if field.required: raise ValidationError( "Message %s is missing required field %s" % (type(self).__name__, name)) else: try: if (isinstance(field, MessageField) and issubclass(field.message_type, Message)): if field.repeated: for item in value: item_message_value = field.value_to_message( item) item_message_value.check_initialized() else: message_value = field.value_to_message(value) message_value.check_initialized() except ValidationError as err: if not hasattr(err, 'message_name'): err.message_name = type(self).__name__ raise def is_initialized(self): """Get initialization status. Returns: True if message is valid, else False. """ try: self.check_initialized() except ValidationError: return False else: return True @classmethod def all_fields(cls): """Get all field definition objects. Ordering is arbitrary. Returns: Iterator over all values in arbitrary order. """ return cls.__by_name.values() @classmethod def field_by_name(cls, name): """Get field by name. Returns: Field object associated with name. Raises: KeyError if no field found by that name. """ return cls.__by_name[name] @classmethod def field_by_number(cls, number): """Get field by number. Returns: Field object associated with number. Raises: KeyError if no field found by that number. """ return cls.__by_number[number] def get_assigned_value(self, name): """Get the assigned value of an attribute. Get the underlying value of an attribute. If value has not been set, will not return the default for the field. Args: name: Name of attribute to get. Returns: Value of attribute, None if it has not been set. """ message_type = type(self) try: field = message_type.field_by_name(name) except KeyError: raise AttributeError('Message %s has no field %s' % ( message_type.__name__, name)) return self.__tags.get(field.number) def reset(self, name): """Reset assigned value for field. Resetting a field will return it to its default value or None. Args: name: Name of field to reset. """ message_type = type(self) try: field = message_type.field_by_name(name) except KeyError: if name not in message_type.__by_name: raise AttributeError('Message %s has no field %s' % ( message_type.__name__, name)) if field.repeated: self.__tags[field.number] = FieldList(field, []) else: self.__tags.pop(field.number, None) def all_unrecognized_fields(self): """Get the names of all unrecognized fields in this message.""" return list(self.__unrecognized_fields.keys()) def get_unrecognized_field_info(self, key, value_default=None, variant_default=None): """Get the value and variant of an unknown field in this message. Args: key: The name or number of the field to retrieve. value_default: Value to be returned if the key isn't found. variant_default: Value to be returned as variant if the key isn't found. Returns: (value, variant), where value and variant are whatever was passed to set_unrecognized_field. """ value, variant = self.__unrecognized_fields.get(key, (value_default, variant_default)) return value, variant def set_unrecognized_field(self, key, value, variant): """Set an unrecognized field, used when decoding a message. Args: key: The name or number used to refer to this unknown value. value: The value of the field. variant: Type information needed to interpret the value or re-encode it. Raises: TypeError: If the variant is not an instance of messages.Variant. """ if not isinstance(variant, Variant): raise TypeError('Variant type %s is not valid.' % variant) self.__unrecognized_fields[key] = value, variant def __setattr__(self, name, value): """Change set behavior for messages. Messages may only be assigned values that are fields. Does not try to validate field when set. Args: name: Name of field to assign to. value: Value to assign to field. Raises: AttributeError when trying to assign value that is not a field. """ if name in self.__by_name or name.startswith('_Message__'): object.__setattr__(self, name, value) else: raise AttributeError("May not assign arbitrary value %s " "to message %s" % (name, type(self).__name__)) def __repr__(self): """Make string representation of message. Example: class MyMessage(messages.Message): integer_value = messages.IntegerField(1) string_value = messages.StringField(2) my_message = MyMessage() my_message.integer_value = 42 my_message.string_value = u'A string' print my_message >>> <MyMessage ... integer_value: 42 ... string_value: u'A string'> Returns: String representation of message, including the values of all fields and repr of all sub-messages. """ body = ['<', type(self).__name__] for field in sorted(self.all_fields(), key=lambda f: f.number): attribute = field.name value = self.get_assigned_value(field.name) if value is not None: body.append('\n %s: %s' % (attribute, repr(value))) body.append('>') return ''.join(body) def __eq__(self, other): """Equality operator. Does field by field comparison with other message. For equality, must be same type and values of all fields must be equal. Messages not required to be initialized for comparison. Does not attempt to determine equality for values that have default values that are not set. In other words: class HasDefault(Message): attr1 = StringField(1, default='default value') message1 = HasDefault() message2 = HasDefault() message2.attr1 = 'default value' message1 != message2 Does not compare unknown values. Args: other: Other message to compare with. """ # TODO(rafek): Implement "equivalent" which does comparisons # taking default values in to consideration. if self is other: return True if type(self) is not type(other): return False return self.__tags == other.__tags def __ne__(self, other): """Not equals operator. Does field by field comparison with other message. For non-equality, must be different type or any value of a field must be non-equal to the same field in the other instance. Messages not required to be initialized for comparison. Args: other: Other message to compare with. """ return not self.__eq__(other) class FieldList(list): """List implementation that validates field values. This list implementation overrides all methods that add values in to a list in order to validate those new elements. Attempting to add or set list values that are not of the correct type will raise ValidationError. """ def __init__(self, field_instance, sequence): """Constructor. Args: field_instance: Instance of field that validates the list. sequence: List or tuple to construct list from. """ if not field_instance.repeated: raise FieldDefinitionError( 'FieldList may only accept repeated fields') self.__field = field_instance self.__field.validate(sequence) list.__init__(self, sequence) def __getstate__(self): """Enable pickling. The assigned field instance can't be pickled if it belongs to a Message definition (message_definition uses a weakref), so the Message class and field number are returned in that case. Returns: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. """ message_class = self.__field.message_definition() if message_class is None: return self.__field, None, None return None, message_class, self.__field.number def __setstate__(self, state): """Enable unpickling. Args: state: A 3-tuple containing: - The field instance, or None if it belongs to a Message class. - The Message class that the field instance belongs to, or None. - The field instance number of the Message class it belongs to, or None. """ field_instance, message_class, number = state if field_instance is None: self.__field = message_class.field_by_number(number) else: self.__field = field_instance @property def field(self): """Field that validates list.""" return self.__field def __setslice__(self, i, j, sequence): """Validate slice assignment to list.""" self.__field.validate(sequence) list.__setslice__(self, i, j, sequence) def __setitem__(self, index, value): """Validate item assignment to list.""" if isinstance(index, slice): self.__field.validate(value) else: self.__field.validate_element(value) list.__setitem__(self, index, value) def append(self, value): """Validate item appending to list.""" if getattr(self, '_FieldList__field', None): self.__field.validate_element(value) return list.append(self, value) def extend(self, sequence): """Validate extension of list.""" if getattr(self, '_FieldList__field', None): self.__field.validate(sequence) return list.extend(self, sequence) def insert(self, index, value): """Validate item insertion to list.""" self.__field.validate_element(value) return list.insert(self, index, value) class _FieldMeta(type): def __init__(cls, name, bases, dct): getattr(cls, '_Field__variant_to_type').update( (variant, cls) for variant in dct.get('VARIANTS', [])) type.__init__(cls, name, bases, dct) # TODO(rafek): Prevent additional field subclasses. class Field(six.with_metaclass(_FieldMeta, object)): """Definition for message field.""" __initialized = False # pylint:disable=invalid-name __variant_to_type = {} # pylint:disable=invalid-name @util.positional(2) def __init__(self, number, required=False, repeated=False, variant=None, default=None): """Constructor. The required and repeated parameters are mutually exclusive. Setting both to True will raise a FieldDefinitionError. Sub-class Attributes: Each sub-class of Field must define the following: VARIANTS: Set of variant types accepted by that field. DEFAULT_VARIANT: Default variant type if not specified in constructor. Args: number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive with 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive with 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: InvalidVariantError when invalid variant for field is provided. InvalidDefaultError when invalid default for field is provided. FieldDefinitionError when invalid number provided or mutually exclusive fields are used. InvalidNumberError when the field number is out of range or reserved. """ if not isinstance(number, int) or not 1 <= number <= MAX_FIELD_NUMBER: raise InvalidNumberError( 'Invalid number for field: %s\n' 'Number must be 1 or greater and %d or less' % (number, MAX_FIELD_NUMBER)) if FIRST_RESERVED_FIELD_NUMBER <= number <= LAST_RESERVED_FIELD_NUMBER: raise InvalidNumberError('Tag number %d is a reserved number.\n' 'Numbers %d to %d are reserved' % (number, FIRST_RESERVED_FIELD_NUMBER, LAST_RESERVED_FIELD_NUMBER)) if repeated and required: raise FieldDefinitionError('Cannot set both repeated and required') if variant is None: variant = self.DEFAULT_VARIANT if repeated and default is not None: raise FieldDefinitionError('Repeated fields may not have defaults') if variant not in self.VARIANTS: raise InvalidVariantError( 'Invalid variant: %s\nValid variants for %s are %r' % (variant, type(self).__name__, sorted(self.VARIANTS))) self.number = number self.required = required self.repeated = repeated self.variant = variant if default is not None: try: self.validate_default(default) except ValidationError as err: try: name = self.name except AttributeError: # For when raising error before name initialization. raise InvalidDefaultError( 'Invalid default value for %s: %r: %s' % (self.__class__.__name__, default, err)) else: raise InvalidDefaultError( 'Invalid default value for field %s: ' '%r: %s' % (name, default, err)) self.__default = default self.__initialized = True def __setattr__(self, name, value): """Setter overidden to prevent assignment to fields after creation. Args: name: Name of attribute to set. value: Value to assign. """ # Special case post-init names. They need to be set after constructor. if name in _POST_INIT_FIELD_ATTRIBUTE_NAMES: object.__setattr__(self, name, value) return # All other attributes must be set before __initialized. if not self.__initialized: # Not initialized yet, allow assignment. object.__setattr__(self, name, value) else: raise AttributeError('Field objects are read-only') def __set__(self, message_instance, value): """Set value on message. Args: message_instance: Message instance to set value on. value: Value to set on message. """ # Reaches in to message instance directly to assign to private tags. if value is None: if self.repeated: raise ValidationError( 'May not assign None to repeated field %s' % self.name) else: message_instance._Message__tags.pop(self.number, None) else: if self.repeated: value = FieldList(self, value) else: value = self.validate(value) message_instance._Message__tags[self.number] = value def __get__(self, message_instance, message_class): if message_instance is None: return self result = message_instance._Message__tags.get(self.number) if result is None: return self.default return result def validate_element(self, value): """Validate single element of field. This is different from validate in that it is used on individual values of repeated fields. Args: value: Value to validate. Returns: The value casted in the expected type. Raises: ValidationError if value is not expected type. """ if not isinstance(value, self.type): # Authorize int values as float. if isinstance(value, six.integer_types) and self.type == float: return float(value) if value is None: if self.required: raise ValidationError('Required field is missing') else: try: name = self.name except AttributeError: raise ValidationError('Expected type %s for %s, ' 'found %s (type %s)' % (self.type, self.__class__.__name__, value, type(value))) else: raise ValidationError( 'Expected type %s for field %s, found %s (type %s)' % (self.type, name, value, type(value))) return value def __validate(self, value, validate_element): """Internal validation function. Validate an internal value using a function to validate individual elements. Args: value: Value to validate. validate_element: Function to use to validate individual elements. Raises: ValidationError if value is not expected type. """ if not self.repeated: return validate_element(value) else: # Must be a list or tuple, may not be a string. if isinstance(value, (list, tuple)): result = [] for element in value: if element is None: try: name = self.name except AttributeError: raise ValidationError( 'Repeated values for %s ' 'may not be None' % self.__class__.__name__) else: raise ValidationError( 'Repeated values for field %s ' 'may not be None' % name) result.append(validate_element(element)) return result elif value is not None: try: name = self.name except AttributeError: raise ValidationError('%s is repeated. Found: %s' % ( self.__class__.__name__, value)) else: raise ValidationError( 'Field %s is repeated. Found: %s' % (name, value)) return value def validate(self, value): """Validate value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. """ return self.__validate(value, self.validate_element) def validate_default_element(self, value): """Validate value as assigned to field default field. Some fields may allow for delayed resolution of default types necessary in the case of circular definition references. In this case, the default value might be a place holder that is resolved when needed after all the message classes are defined. Args: value: Default value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. """ return self.validate_element(value) def validate_default(self, value): """Validate default value assigned to field. Args: value: Value to validate. Returns: the value in casted in the correct type. Raises: ValidationError if value is not expected type. """ return self.__validate(value, self.validate_default_element) def message_definition(self): """Get Message definition that contains this Field definition. Returns: Containing Message definition for Field. Will return None if for some reason Field is defined outside of a Message class. """ try: return self._message_definition() except AttributeError: return None @property def default(self): """Get default value for field.""" return self.__default @classmethod def lookup_field_type_by_variant(cls, variant): return cls.__variant_to_type[variant] class IntegerField(Field): """Field definition for integer values.""" VARIANTS = frozenset([ Variant.INT32, Variant.INT64, Variant.UINT32, Variant.UINT64, Variant.SINT32, Variant.SINT64, ]) DEFAULT_VARIANT = Variant.INT64 type = six.integer_types class FloatField(Field): """Field definition for float values.""" VARIANTS = frozenset([ Variant.FLOAT, Variant.DOUBLE, ]) DEFAULT_VARIANT = Variant.DOUBLE type = float class BooleanField(Field): """Field definition for boolean values.""" VARIANTS = frozenset([Variant.BOOL]) DEFAULT_VARIANT = Variant.BOOL type = bool class BytesField(Field): """Field definition for byte string values.""" VARIANTS = frozenset([Variant.BYTES]) DEFAULT_VARIANT = Variant.BYTES type = bytes class StringField(Field): """Field definition for unicode string values.""" VARIANTS = frozenset([Variant.STRING]) DEFAULT_VARIANT = Variant.STRING type = six.text_type def validate_element(self, value): """Validate StringField allowing for str and unicode. Raises: ValidationError if a str value is not UTF-8. """ # If value is str is it considered valid. Satisfies "required=True". if isinstance(value, bytes): try: six.text_type(value, 'UTF-8') except UnicodeDecodeError as err: try: _ = self.name except AttributeError: validation_error = ValidationError( 'Field encountered non-UTF-8 string %r: %s' % (value, err)) else: validation_error = ValidationError( 'Field %s encountered non-UTF-8 string %r: %s' % ( self.name, value, err)) validation_error.field_name = self.name raise validation_error else: return super(StringField, self).validate_element(value) return value class MessageField(Field): """Field definition for sub-message values. Message fields contain instance of other messages. Instances stored on messages stored on message fields are considered to be owned by the containing message instance and should not be shared between owning instances. Message fields must be defined to reference a single type of message. Normally message field are defined by passing the referenced message class in to the constructor. It is possible to define a message field for a type that does not yet exist by passing the name of the message in to the constructor instead of a message class. Resolution of the actual type of the message is deferred until it is needed, for example, during message verification. Names provided to the constructor must refer to a class within the same python module as the class that is using it. Names refer to messages relative to the containing messages scope. For example, the two fields of OuterMessage refer to the same message type: class Outer(Message): inner_relative = MessageField('Inner', 1) inner_absolute = MessageField('Outer.Inner', 2) class Inner(Message): ... When resolving an actual type, MessageField will traverse the entire scope of nested messages to match a message name. This makes it easy for siblings to reference siblings: class Outer(Message): class Inner(Message): sibling = MessageField('Sibling', 1) class Sibling(Message): ... """ VARIANTS = frozenset([Variant.MESSAGE]) DEFAULT_VARIANT = Variant.MESSAGE @util.positional(3) def __init__(self, message_type, number, required=False, repeated=False, variant=None): """Constructor. Args: message_type: Message type for field. Must be subclass of Message. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. Raises: FieldDefinitionError when invalid message_type is provided. """ valid_type = (isinstance(message_type, six.string_types) or (message_type is not Message and isinstance(message_type, type) and issubclass(message_type, Message))) if not valid_type: raise FieldDefinitionError( 'Invalid message class: %s' % message_type) if isinstance(message_type, six.string_types): self.__type_name = message_type self.__type = None else: self.__type = message_type super(MessageField, self).__init__(number, required=required, repeated=repeated, variant=variant) def __set__(self, message_instance, value): """Set value on message. Args: message_instance: Message instance to set value on. value: Value to set on message. """ t = self.type if isinstance(t, type) and issubclass(t, Message): if self.repeated: if value and isinstance(value, (list, tuple)): value = [(t(**v) if isinstance(v, dict) else v) for v in value] elif isinstance(value, dict): value = t(**value) super(MessageField, self).__set__(message_instance, value) @property def type(self): """Message type used for field.""" if self.__type is None: message_type = find_definition( self.__type_name, self.message_definition()) if not (message_type is not Message and isinstance(message_type, type) and issubclass(message_type, Message)): raise FieldDefinitionError( 'Invalid message class: %s' % message_type) self.__type = message_type return self.__type @property def message_type(self): """Underlying message type used for serialization. Will always be a sub-class of Message. This is different from type which represents the python value that message_type is mapped to for use by the user. """ return self.type def value_from_message(self, message): """Convert a message to a value instance. Used by deserializers to convert from underlying messages to value of expected user type. Args: message: A message instance of type self.message_type. Returns: Value of self.message_type. """ if not isinstance(message, self.message_type): raise DecodeError('Expected type %s, got %s: %r' % (self.message_type.__name__, type(message).__name__, message)) return message def value_to_message(self, value): """Convert a value instance to a message. Used by serializers to convert Python user types to underlying messages for transmission. Args: value: A value of type self.type. Returns: An instance of type self.message_type. """ if not isinstance(value, self.type): raise EncodeError('Expected type %s, got %s: %r' % (self.type.__name__, type(value).__name__, value)) return value class EnumField(Field): """Field definition for enum values. Enum fields may have default values that are delayed until the associated enum type is resolved. This is necessary to support certain circular references. For example: class Message1(Message): class Color(Enum): RED = 1 GREEN = 2 BLUE = 3 # This field default value will be validated when default is accessed. animal = EnumField('Message2.Animal', 1, default='HORSE') class Message2(Message): class Animal(Enum): DOG = 1 CAT = 2 HORSE = 3 # This fields default value will be validated right away since Color # is already fully resolved. color = EnumField(Message1.Color, 1, default='RED') """ VARIANTS = frozenset([Variant.ENUM]) DEFAULT_VARIANT = Variant.ENUM def __init__(self, enum_type, number, **kwargs): """Constructor. Args: enum_type: Enum type for field. Must be subclass of Enum. number: Number of field. Must be unique per message class. required: Whether or not field is required. Mutually exclusive to 'repeated'. repeated: Whether or not field is repeated. Mutually exclusive to 'required'. variant: Wire-format variant hint. default: Default value for field if not found in stream. Raises: FieldDefinitionError when invalid enum_type is provided. """ valid_type = (isinstance(enum_type, six.string_types) or (enum_type is not Enum and isinstance(enum_type, type) and issubclass(enum_type, Enum))) if not valid_type: raise FieldDefinitionError('Invalid enum type: %s' % enum_type) if isinstance(enum_type, six.string_types): self.__type_name = enum_type self.__type = None else: self.__type = enum_type super(EnumField, self).__init__(number, **kwargs) def validate_default_element(self, value): """Validate default element of Enum field. Enum fields allow for delayed resolution of default values when the type of the field has not been resolved. The default value of a field may be a string or an integer. If the Enum type of the field has been resolved, the default value is validated against that type. Args: value: Value to validate. Raises: ValidationError if value is not expected message type. """ if isinstance(value, (six.string_types, six.integer_types)): # Validation of the value does not happen for delayed resolution # enumerated types. Ignore if type is not yet resolved. if self.__type: self.__type(value) return value return super(EnumField, self).validate_default_element(value) @property def type(self): """Enum type used for field.""" if self.__type is None: found_type = find_definition( self.__type_name, self.message_definition()) if not (found_type is not Enum and isinstance(found_type, type) and issubclass(found_type, Enum)): raise FieldDefinitionError( 'Invalid enum type: %s' % found_type) self.__type = found_type return self.__type @property def default(self): """Default for enum field. Will cause resolution of Enum type and unresolved default value. """ try: return self.__resolved_default except AttributeError: resolved_default = super(EnumField, self).default if isinstance(resolved_default, (six.string_types, six.integer_types)): # pylint:disable=not-callable resolved_default = self.type(resolved_default) self.__resolved_default = resolved_default return self.__resolved_default @util.positional(2) def find_definition(name, relative_to=None, importer=__import__): """Find definition by name in module-space. The find algorthm will look for definitions by name relative to a message definition or by fully qualfied name. If no definition is found relative to the relative_to parameter it will do the same search against the container of relative_to. If relative_to is a nested Message, it will search its message_definition(). If that message has no message_definition() it will search its module. If relative_to is a module, it will attempt to look for the containing module and search relative to it. If the module is a top-level module, it will look for the a message using a fully qualified name. If no message is found then, the search fails and DefinitionNotFoundError is raised. For example, when looking for any definition 'foo.bar.ADefinition' relative to an actual message definition abc.xyz.SomeMessage: find_definition('foo.bar.ADefinition', SomeMessage) It is like looking for the following fully qualified names: abc.xyz.SomeMessage. foo.bar.ADefinition abc.xyz. foo.bar.ADefinition abc. foo.bar.ADefinition foo.bar.ADefinition When resolving the name relative to Message definitions and modules, the algorithm searches any Messages or sub-modules found in its path. Non-Message values are not searched. A name that begins with '.' is considered to be a fully qualified name. The name is always searched for from the topmost package. For example, assume two message types: abc.xyz.SomeMessage xyz.SomeMessage Searching for '.xyz.SomeMessage' relative to 'abc' will resolve to 'xyz.SomeMessage' and not 'abc.xyz.SomeMessage'. For this kind of name, the relative_to parameter is effectively ignored and always set to None. For more information about package name resolution, please see: http://code.google.com/apis/protocolbuffers/docs/proto.html#packages Args: name: Name of definition to find. May be fully qualified or relative name. relative_to: Search for definition relative to message definition or module. None will cause a fully qualified name search. importer: Import function to use for resolving modules. Returns: Enum or Message class definition associated with name. Raises: DefinitionNotFoundError if no definition is found in any search path. """ # Check parameters. if not (relative_to is None or isinstance(relative_to, types.ModuleType) or isinstance(relative_to, type) and issubclass(relative_to, Message)): raise TypeError( 'relative_to must be None, Message definition or module.' ' Found: %s' % relative_to) name_path = name.split('.') # Handle absolute path reference. if not name_path[0]: relative_to = None name_path = name_path[1:] def search_path(): """Performs a single iteration searching the path from relative_to. This is the function that searches up the path from a relative object. fully.qualified.object . relative.or.nested.Definition ----------------------------> ^ | this part of search --+ Returns: Message or Enum at the end of name_path, else None. """ next_part = relative_to for node in name_path: # Look for attribute first. attribute = getattr(next_part, node, None) if attribute is not None: next_part = attribute else: # If module, look for sub-module. if (next_part is None or isinstance(next_part, types.ModuleType)): if next_part is None: module_name = node else: module_name = '%s.%s' % (next_part.__name__, node) try: fromitem = module_name.split('.')[-1] next_part = importer(module_name, '', '', [str(fromitem)]) except ImportError: return None else: return None if not isinstance(next_part, types.ModuleType): if not (isinstance(next_part, type) and issubclass(next_part, (Message, Enum))): return None return next_part while True: found = search_path() if isinstance(found, type) and issubclass(found, (Enum, Message)): return found else: # Find next relative_to to search against. # # fully.qualified.object . relative.or.nested.Definition # <--------------------- # ^ # | # does this part of search if relative_to is None: # Fully qualified search was done. Nothing found. Fail. raise DefinitionNotFoundError( 'Could not find definition for %s' % name) else: if isinstance(relative_to, types.ModuleType): # Find parent module. module_path = relative_to.__name__.split('.')[:-1] if not module_path: relative_to = None else: # Should not raise ImportError. If it does... # weird and unexpected. Propagate. relative_to = importer( '.'.join(module_path), '', '', [module_path[-1]]) elif (isinstance(relative_to, type) and issubclass(relative_to, Message)): parent = relative_to.message_definition() if parent is None: last_module_name = relative_to.__module__.split( '.')[-1] relative_to = importer( relative_to.__module__, '', '', [last_module_name]) else: relative_to = parent protorpclite/test_util.py 0000644 00000057604 15025317163 0011677 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Test utilities for message testing. Includes module interface test to ensure that public parts of module are correctly declared in __all__. Includes message types that correspond to those defined in services_test.proto. Includes additional test utilities to make sure encoding/decoding libraries conform. """ import cgi import datetime import inspect import os import re import socket import types import unittest import six from six.moves import range # pylint: disable=redefined-builtin from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import util # Unicode of the word "Russian" in cyrillic. RUSSIAN = u'\u0440\u0443\u0441\u0441\u043a\u0438\u0439' # All characters binary value interspersed with nulls. BINARY = b''.join(six.int2byte(value) + b'\0' for value in range(256)) class TestCase(unittest.TestCase): def assertRaisesWithRegexpMatch(self, exception, regexp, function, *params, **kwargs): """Check that exception is raised and text matches regular expression. Args: exception: Exception type that is expected. regexp: String regular expression that is expected in error message. function: Callable to test. params: Parameters to forward to function. kwargs: Keyword arguments to forward to function. """ try: function(*params, **kwargs) self.fail('Expected exception %s was not raised' % exception.__name__) except exception as err: match = bool(re.match(regexp, str(err))) self.assertTrue(match, 'Expected match "%s", found "%s"' % (regexp, err)) def assertHeaderSame(self, header1, header2): """Check that two HTTP headers are the same. Args: header1: Header value string 1. header2: header value string 2. """ value1, params1 = cgi.parse_header(header1) value2, params2 = cgi.parse_header(header2) self.assertEqual(value1, value2) self.assertEqual(params1, params2) def assertIterEqual(self, iter1, iter2): """Check two iterators or iterables are equal independent of order. Similar to Python 2.7 assertItemsEqual. Named differently in order to avoid potential conflict. Args: iter1: An iterator or iterable. iter2: An iterator or iterable. """ list1 = list(iter1) list2 = list(iter2) unmatched1 = list() while list1: item1 = list1[0] del list1[0] for index in range(len(list2)): if item1 == list2[index]: del list2[index] break else: unmatched1.append(item1) error_message = [] for item in unmatched1: error_message.append( ' Item from iter1 not found in iter2: %r' % item) for item in list2: error_message.append( ' Item from iter2 not found in iter1: %r' % item) if error_message: self.fail('Collections not equivalent:\n' + '\n'.join(error_message)) class ModuleInterfaceTest(object): """Test to ensure module interface is carefully constructed. A module interface is the set of public objects listed in the module __all__ attribute. Modules that that are considered public should have this interface carefully declared. At all times, the __all__ attribute should have objects intended to be publically used and all other objects in the module should be considered unused. Protected attributes (those beginning with '_') and other imported modules should not be part of this set of variables. An exception is for variables that begin and end with '__' which are implicitly part of the interface (eg. __name__, __file__, __all__ itself, etc.). Modules that are imported in to the tested modules are an exception and may be left out of the __all__ definition. The test is done by checking the value of what would otherwise be a public name and not allowing it to be exported if it is an instance of a module. Modules that are explicitly exported are for the time being not permitted. To use this test class a module should define a new class that inherits first from ModuleInterfaceTest and then from test_util.TestCase. No other tests should be added to this test case, making the order of inheritance less important, but if setUp for some reason is overidden, it is important that ModuleInterfaceTest is first in the list so that its setUp method is invoked. Multiple inheritance is required so that ModuleInterfaceTest is not itself a test, and is not itself executed as one. The test class is expected to have the following class attributes defined: MODULE: A reference to the module that is being validated for interface correctness. Example: Module definition (hello.py): import sys __all__ = ['hello'] def _get_outputter(): return sys.stdout def hello(): _get_outputter().write('Hello\n') Test definition: import unittest from protorpc import test_util import hello class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = hello class HelloTest(test_util.TestCase): ... Test 'hello' module ... if __name__ == '__main__': unittest.main() """ def setUp(self): """Set up makes sure that MODULE and IMPORTED_MODULES is defined. This is a basic configuration test for the test itself so does not get it's own test case. """ if not hasattr(self, 'MODULE'): self.fail( "You must define 'MODULE' on ModuleInterfaceTest sub-class " "%s." % type(self).__name__) def testAllExist(self): """Test that all attributes defined in __all__ exist.""" missing_attributes = [] for attribute in self.MODULE.__all__: if not hasattr(self.MODULE, attribute): missing_attributes.append(attribute) if missing_attributes: self.fail('%s of __all__ are not defined in module.' % missing_attributes) def testAllExported(self): """Test that all public attributes not imported are in __all__.""" missing_attributes = [] for attribute in dir(self.MODULE): if not attribute.startswith('_'): if (attribute not in self.MODULE.__all__ and not isinstance(getattr(self.MODULE, attribute), types.ModuleType) and attribute != 'with_statement'): missing_attributes.append(attribute) if missing_attributes: self.fail('%s are not modules and not defined in __all__.' % missing_attributes) def testNoExportedProtectedVariables(self): """Test that there are no protected variables listed in __all__.""" protected_variables = [] for attribute in self.MODULE.__all__: if attribute.startswith('_'): protected_variables.append(attribute) if protected_variables: self.fail('%s are protected variables and may not be exported.' % protected_variables) def testNoExportedModules(self): """Test that no modules exist in __all__.""" exported_modules = [] for attribute in self.MODULE.__all__: try: value = getattr(self.MODULE, attribute) except AttributeError: # This is a different error case tested for in testAllExist. pass else: if isinstance(value, types.ModuleType): exported_modules.append(attribute) if exported_modules: self.fail('%s are modules and may not be exported.' % exported_modules) class NestedMessage(messages.Message): """Simple message that gets nested in another message.""" a_value = messages.StringField(1, required=True) class HasNestedMessage(messages.Message): """Message that has another message nested in it.""" nested = messages.MessageField(NestedMessage, 1) repeated_nested = messages.MessageField(NestedMessage, 2, repeated=True) class HasDefault(messages.Message): """Has a default value.""" a_value = messages.StringField(1, default=u'a default') class OptionalMessage(messages.Message): """Contains all message types.""" class SimpleEnum(messages.Enum): """Simple enumeration type.""" VAL1 = 1 VAL2 = 2 double_value = messages.FloatField(1, variant=messages.Variant.DOUBLE) float_value = messages.FloatField(2, variant=messages.Variant.FLOAT) int64_value = messages.IntegerField(3, variant=messages.Variant.INT64) uint64_value = messages.IntegerField(4, variant=messages.Variant.UINT64) int32_value = messages.IntegerField(5, variant=messages.Variant.INT32) bool_value = messages.BooleanField(6, variant=messages.Variant.BOOL) string_value = messages.StringField(7, variant=messages.Variant.STRING) bytes_value = messages.BytesField(8, variant=messages.Variant.BYTES) enum_value = messages.EnumField(SimpleEnum, 10) class RepeatedMessage(messages.Message): """Contains all message types as repeated fields.""" class SimpleEnum(messages.Enum): """Simple enumeration type.""" VAL1 = 1 VAL2 = 2 double_value = messages.FloatField(1, variant=messages.Variant.DOUBLE, repeated=True) float_value = messages.FloatField(2, variant=messages.Variant.FLOAT, repeated=True) int64_value = messages.IntegerField(3, variant=messages.Variant.INT64, repeated=True) uint64_value = messages.IntegerField(4, variant=messages.Variant.UINT64, repeated=True) int32_value = messages.IntegerField(5, variant=messages.Variant.INT32, repeated=True) bool_value = messages.BooleanField(6, variant=messages.Variant.BOOL, repeated=True) string_value = messages.StringField(7, variant=messages.Variant.STRING, repeated=True) bytes_value = messages.BytesField(8, variant=messages.Variant.BYTES, repeated=True) enum_value = messages.EnumField(SimpleEnum, 10, repeated=True) class HasOptionalNestedMessage(messages.Message): nested = messages.MessageField(OptionalMessage, 1) repeated_nested = messages.MessageField(OptionalMessage, 2, repeated=True) # pylint:disable=anomalous-unicode-escape-in-string class ProtoConformanceTestBase(object): """Protocol conformance test base class. Each supported protocol should implement two methods that support encoding and decoding of Message objects in that format: encode_message(message) - Serialize to encoding. encode_message(message, encoded_message) - Deserialize from encoding. Tests for the modules where these functions are implemented should extend this class in order to support basic behavioral expectations. This ensures that protocols correctly encode and decode message transparently to the caller. In order to support these test, the base class should also extend the TestCase class and implement the following class attributes which define the encoded version of certain protocol buffers: encoded_partial: <OptionalMessage double_value: 1.23 int64_value: -100000000000 string_value: u"a string" enum_value: OptionalMessage.SimpleEnum.VAL2 > encoded_full: <OptionalMessage double_value: 1.23 float_value: -2.5 int64_value: -100000000000 uint64_value: 102020202020 int32_value: 1020 bool_value: true string_value: u"a string\u044f" bytes_value: b"a bytes\xff\xfe" enum_value: OptionalMessage.SimpleEnum.VAL2 > encoded_repeated: <RepeatedMessage double_value: [1.23, 2.3] float_value: [-2.5, 0.5] int64_value: [-100000000000, 20] uint64_value: [102020202020, 10] int32_value: [1020, 718] bool_value: [true, false] string_value: [u"a string\u044f", u"another string"] bytes_value: [b"a bytes\xff\xfe", b"another bytes"] enum_value: [OptionalMessage.SimpleEnum.VAL2, OptionalMessage.SimpleEnum.VAL 1] > encoded_nested: <HasNestedMessage nested: <NestedMessage a_value: "a string" > > encoded_repeated_nested: <HasNestedMessage repeated_nested: [ <NestedMessage a_value: "a string">, <NestedMessage a_value: "another string"> ] > unexpected_tag_message: An encoded message that has an undefined tag or number in the stream. encoded_default_assigned: <HasDefault a_value: "a default" > encoded_nested_empty: <HasOptionalNestedMessage nested: <OptionalMessage> > encoded_invalid_enum: <OptionalMessage enum_value: (invalid value for serialization type) > encoded_invalid_repeated_enum: <RepeatedMessage enum_value: (invalid value for serialization type) > """ encoded_empty_message = '' def testEncodeInvalidMessage(self): message = NestedMessage() self.assertRaises(messages.ValidationError, self.PROTOLIB.encode_message, message) def CompareEncoded(self, expected_encoded, actual_encoded): """Compare two encoded protocol values. Can be overridden by sub-classes to special case comparison. For example, to eliminate white space from output that is not relevant to encoding. Args: expected_encoded: Expected string encoded value. actual_encoded: Actual string encoded value. """ self.assertEqual(expected_encoded, actual_encoded) def EncodeDecode(self, encoded, expected_message): message = self.PROTOLIB.decode_message(type(expected_message), encoded) self.assertEqual(expected_message, message) self.CompareEncoded(encoded, self.PROTOLIB.encode_message(message)) def testEmptyMessage(self): self.EncodeDecode(self.encoded_empty_message, OptionalMessage()) def testPartial(self): """Test message with a few values set.""" message = OptionalMessage() message.double_value = 1.23 message.int64_value = -100000000000 message.int32_value = 1020 message.string_value = u'a string' message.enum_value = OptionalMessage.SimpleEnum.VAL2 self.EncodeDecode(self.encoded_partial, message) def testFull(self): """Test all types.""" message = OptionalMessage() message.double_value = 1.23 message.float_value = -2.5 message.int64_value = -100000000000 message.uint64_value = 102020202020 message.int32_value = 1020 message.bool_value = True message.string_value = u'a string\u044f' message.bytes_value = b'a bytes\xff\xfe' message.enum_value = OptionalMessage.SimpleEnum.VAL2 self.EncodeDecode(self.encoded_full, message) def testRepeated(self): """Test repeated fields.""" message = RepeatedMessage() message.double_value = [1.23, 2.3] message.float_value = [-2.5, 0.5] message.int64_value = [-100000000000, 20] message.uint64_value = [102020202020, 10] message.int32_value = [1020, 718] message.bool_value = [True, False] message.string_value = [u'a string\u044f', u'another string'] message.bytes_value = [b'a bytes\xff\xfe', b'another bytes'] message.enum_value = [RepeatedMessage.SimpleEnum.VAL2, RepeatedMessage.SimpleEnum.VAL1] self.EncodeDecode(self.encoded_repeated, message) def testNested(self): """Test nested messages.""" nested_message = NestedMessage() nested_message.a_value = u'a string' message = HasNestedMessage() message.nested = nested_message self.EncodeDecode(self.encoded_nested, message) def testRepeatedNested(self): """Test repeated nested messages.""" nested_message1 = NestedMessage() nested_message1.a_value = u'a string' nested_message2 = NestedMessage() nested_message2.a_value = u'another string' message = HasNestedMessage() message.repeated_nested = [nested_message1, nested_message2] self.EncodeDecode(self.encoded_repeated_nested, message) def testStringTypes(self): """Test that encoding str on StringField works.""" message = OptionalMessage() message.string_value = 'Latin' self.EncodeDecode(self.encoded_string_types, message) def testEncodeUninitialized(self): """Test that cannot encode uninitialized message.""" required = NestedMessage() self.assertRaisesWithRegexpMatch(messages.ValidationError, "Message NestedMessage is missing " "required field a_value", self.PROTOLIB.encode_message, required) def testUnexpectedField(self): """Test decoding and encoding unexpected fields.""" loaded_message = self.PROTOLIB.decode_message( OptionalMessage, self.unexpected_tag_message) # Message should be equal to an empty message, since unknown # values aren't included in equality. self.assertEqual(OptionalMessage(), loaded_message) # Verify that the encoded message matches the source, including the # unknown value. self.assertEqual(self.unexpected_tag_message, self.PROTOLIB.encode_message(loaded_message)) def testDoNotSendDefault(self): """Test that default is not sent when nothing is assigned.""" self.EncodeDecode(self.encoded_empty_message, HasDefault()) def testSendDefaultExplicitlyAssigned(self): """Test that default is sent when explcitly assigned.""" message = HasDefault() message.a_value = HasDefault.a_value.default self.EncodeDecode(self.encoded_default_assigned, message) def testEncodingNestedEmptyMessage(self): """Test encoding a nested empty message.""" message = HasOptionalNestedMessage() message.nested = OptionalMessage() self.EncodeDecode(self.encoded_nested_empty, message) def testEncodingRepeatedNestedEmptyMessage(self): """Test encoding a nested empty message.""" message = HasOptionalNestedMessage() message.repeated_nested = [OptionalMessage(), OptionalMessage()] self.EncodeDecode(self.encoded_repeated_nested_empty, message) def testContentType(self): self.assertTrue(isinstance(self.PROTOLIB.CONTENT_TYPE, str)) def testDecodeInvalidEnumType(self): # Since protos need to be able to add new enums, a message should be # successfully decoded even if the enum value is invalid. Encoding the # decoded message should result in equivalence with the original # encoded message containing an invalid enum. decoded = self.PROTOLIB.decode_message(OptionalMessage, self.encoded_invalid_enum) message = OptionalMessage() self.assertEqual(message, decoded) encoded = self.PROTOLIB.encode_message(decoded) self.assertEqual(self.encoded_invalid_enum, encoded) def testDecodeInvalidRepeatedEnumType(self): # Since protos need to be able to add new enums, a message should be # successfully decoded even if the enum value is invalid. Encoding the # decoded message should result in equivalence with the original # encoded message containing an invalid enum. decoded = self.PROTOLIB.decode_message(RepeatedMessage, self.encoded_invalid_repeated_enum) message = RepeatedMessage() message.enum_value = [RepeatedMessage.SimpleEnum.VAL1] self.assertEqual(message, decoded) encoded = self.PROTOLIB.encode_message(decoded) self.assertEqual(self.encoded_invalid_repeated_enum, encoded) def testDateTimeNoTimeZone(self): """Test that DateTimeFields are encoded/decoded correctly.""" class MyMessage(messages.Message): value = message_types.DateTimeField(1) value = datetime.datetime(2013, 1, 3, 11, 36, 30, 123000) message = MyMessage(value=value) decoded = self.PROTOLIB.decode_message( MyMessage, self.PROTOLIB.encode_message(message)) self.assertEqual(decoded.value, value) def testDateTimeWithTimeZone(self): """Test DateTimeFields with time zones.""" class MyMessage(messages.Message): value = message_types.DateTimeField(1) value = datetime.datetime(2013, 1, 3, 11, 36, 30, 123000, util.TimeZoneOffset(8 * 60)) message = MyMessage(value=value) decoded = self.PROTOLIB.decode_message( MyMessage, self.PROTOLIB.encode_message(message)) self.assertEqual(decoded.value, value) def pick_unused_port(): """Find an unused port to use in tests. Derived from Damon Kohlers example: http://code.activestate.com/recipes/531822-pick-unused-port """ temp = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: temp.bind(('localhost', 0)) port = temp.getsockname()[1] finally: temp.close() return port def get_module_name(module_attribute): """Get the module name. Args: module_attribute: An attribute of the module. Returns: The fully qualified module name or simple module name where 'module_attribute' is defined if the module name is "__main__". """ if module_attribute.__module__ == '__main__': module_file = inspect.getfile(module_attribute) default = os.path.basename(module_file).split('.')[0] return default return module_attribute.__module__ protorpclite/protojson.py 0000644 00000032374 15025317163 0011715 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """JSON support for message types. Public classes: MessageJSONEncoder: JSON encoder for message objects. Public functions: encode_message: Encodes a message in to a JSON string. decode_message: Merge from a JSON string in to a message. """ import base64 import binascii import logging import six from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import util __all__ = [ 'ALTERNATIVE_CONTENT_TYPES', 'CONTENT_TYPE', 'MessageJSONEncoder', 'encode_message', 'decode_message', 'ProtoJson', ] def _load_json_module(): """Try to load a valid json module. There are more than one json modules that might be installed. They are mostly compatible with one another but some versions may be different. This function attempts to load various json modules in a preferred order. It does a basic check to guess if a loaded version of json is compatible. Returns: Compatible json module. Raises: ImportError if there are no json modules or the loaded json module is not compatible with ProtoRPC. """ first_import_error = None for module_name in ['json', 'simplejson']: try: module = __import__(module_name, {}, {}, 'json') if not hasattr(module, 'JSONEncoder'): message = ( 'json library "%s" is not compatible with ProtoRPC' % module_name) logging.warning(message) raise ImportError(message) else: return module except ImportError as err: if not first_import_error: first_import_error = err logging.error('Must use valid json library (json or simplejson)') raise first_import_error # pylint:disable=raising-bad-type json = _load_json_module() # TODO: Rename this to MessageJsonEncoder. class MessageJSONEncoder(json.JSONEncoder): """Message JSON encoder class. Extension of JSONEncoder that can build JSON from a message object. """ def __init__(self, protojson_protocol=None, **kwargs): """Constructor. Args: protojson_protocol: ProtoJson instance. """ super(MessageJSONEncoder, self).__init__(**kwargs) self.__protojson_protocol = ( protojson_protocol or ProtoJson.get_default()) def default(self, value): """Return dictionary instance from a message object. Args: value: Value to get dictionary for. If not encodable, will call superclasses default method. """ if isinstance(value, messages.Enum): return str(value) if six.PY3 and isinstance(value, bytes): return value.decode('utf8') if isinstance(value, messages.Message): result = {} for field in value.all_fields(): item = value.get_assigned_value(field.name) if item not in (None, [], ()): result[field.name] = ( self.__protojson_protocol.encode_field(field, item)) # Handle unrecognized fields, so they're included when a message is # decoded then encoded. for unknown_key in value.all_unrecognized_fields(): unrecognized_field, _ = value.get_unrecognized_field_info( unknown_key) # Unknown fields are not encoded as they should have been # processed before we get to here. result[unknown_key] = unrecognized_field return result return super(MessageJSONEncoder, self).default(value) class ProtoJson(object): """ProtoRPC JSON implementation class. Implementation of JSON based protocol used for serializing and deserializing message objects. Instances of remote.ProtocolConfig constructor or used with remote.Protocols.add_protocol. See the remote.py module for more details. """ CONTENT_TYPE = 'application/json' ALTERNATIVE_CONTENT_TYPES = [ 'application/x-javascript', 'text/javascript', 'text/x-javascript', 'text/x-json', 'text/json', ] def encode_field(self, field, value): """Encode a python field value to a JSON value. Args: field: A ProtoRPC field instance. value: A python value supported by field. Returns: A JSON serializable value appropriate for field. """ if isinstance(field, messages.BytesField): if field.repeated: value = [base64.b64encode(byte) for byte in value] else: value = base64.b64encode(value) elif isinstance(field, message_types.DateTimeField): # DateTimeField stores its data as a RFC 3339 compliant string. if field.repeated: value = [i.isoformat() for i in value] else: value = value.isoformat() return value def encode_message(self, message): """Encode Message instance to JSON string. Args: Message instance to encode in to JSON string. Returns: String encoding of Message instance in protocol JSON format. Raises: messages.ValidationError if message is not initialized. """ message.check_initialized() return json.dumps(message, cls=MessageJSONEncoder, protojson_protocol=self) def decode_message(self, message_type, encoded_message): """Merge JSON structure to Message instance. Args: message_type: Message to decode data to. encoded_message: JSON encoded version of message. Returns: Decoded instance of message_type. Raises: ValueError: If encoded_message is not valid JSON. messages.ValidationError if merged message is not initialized. """ encoded_message = six.ensure_str(encoded_message) if not encoded_message.strip(): return message_type() dictionary = json.loads(encoded_message) message = self.__decode_dictionary(message_type, dictionary) message.check_initialized() return message def __find_variant(self, value): """Find the messages.Variant type that describes this value. Args: value: The value whose variant type is being determined. Returns: The messages.Variant value that best describes value's type, or None if it's a type we don't know how to handle. """ if isinstance(value, bool): return messages.Variant.BOOL elif isinstance(value, six.integer_types): return messages.Variant.INT64 elif isinstance(value, float): return messages.Variant.DOUBLE elif isinstance(value, six.string_types): return messages.Variant.STRING elif isinstance(value, (list, tuple)): # Find the most specific variant that covers all elements. variant_priority = [None, messages.Variant.INT64, messages.Variant.DOUBLE, messages.Variant.STRING] chosen_priority = 0 for v in value: variant = self.__find_variant(v) try: priority = variant_priority.index(variant) except IndexError: priority = -1 if priority > chosen_priority: chosen_priority = priority return variant_priority[chosen_priority] # Unrecognized type. return None def __decode_dictionary(self, message_type, dictionary): """Merge dictionary in to message. Args: message: Message to merge dictionary in to. dictionary: Dictionary to extract information from. Dictionary is as parsed from JSON. Nested objects will also be dictionaries. """ message = message_type() for key, value in six.iteritems(dictionary): if value is None: try: message.reset(key) except AttributeError: pass # This is an unrecognized field, skip it. continue try: field = message.field_by_name(key) except KeyError: # Save unknown values. variant = self.__find_variant(value) if variant: message.set_unrecognized_field(key, value, variant) continue is_enum_field = isinstance(field, messages.EnumField) is_unrecognized_field = False if field.repeated: # This should be unnecessary? Or in fact become an error. if not isinstance(value, list): value = [value] valid_value = [] for item in value: try: v = self.decode_field(field, item) if is_enum_field and v is None: continue except messages.DecodeError: if not is_enum_field: raise is_unrecognized_field = True continue valid_value.append(v) setattr(message, field.name, valid_value) if is_unrecognized_field: variant = self.__find_variant(value) if variant: message.set_unrecognized_field(key, value, variant) continue # This is just for consistency with the old behavior. if value == []: continue try: setattr(message, field.name, self.decode_field(field, value)) except messages.DecodeError: # Save unknown enum values. if not is_enum_field: raise variant = self.__find_variant(value) if variant: message.set_unrecognized_field(key, value, variant) return message def decode_field(self, field, value): """Decode a JSON value to a python value. Args: field: A ProtoRPC field instance. value: A serialized JSON value. Return: A Python value compatible with field. """ if isinstance(field, messages.EnumField): try: return field.type(value) except TypeError: raise messages.DecodeError( 'Invalid enum value "%s"' % (value or '')) elif isinstance(field, messages.BytesField): try: return base64.b64decode(value) except (binascii.Error, TypeError) as err: raise messages.DecodeError('Base64 decoding error: %s' % err) elif isinstance(field, message_types.DateTimeField): try: return util.decode_datetime(value, truncate_time=True) except ValueError as err: raise messages.DecodeError(err) elif (isinstance(field, messages.MessageField) and issubclass(field.type, messages.Message)): return self.__decode_dictionary(field.type, value) elif (isinstance(field, messages.FloatField) and isinstance(value, (six.integer_types, six.string_types))): try: return float(value) except: # pylint:disable=bare-except pass elif (isinstance(field, messages.IntegerField) and isinstance(value, six.string_types)): try: return int(value) except: # pylint:disable=bare-except pass return value @staticmethod def get_default(): """Get default instanceof ProtoJson.""" try: return ProtoJson.__default except AttributeError: ProtoJson.__default = ProtoJson() return ProtoJson.__default @staticmethod def set_default(protocol): """Set the default instance of ProtoJson. Args: protocol: A ProtoJson instance. """ if not isinstance(protocol, ProtoJson): raise TypeError('Expected protocol of type ProtoJson') ProtoJson.__default = protocol CONTENT_TYPE = ProtoJson.CONTENT_TYPE ALTERNATIVE_CONTENT_TYPES = ProtoJson.ALTERNATIVE_CONTENT_TYPES encode_message = ProtoJson.get_default().encode_message decode_message = ProtoJson.get_default().decode_message protorpclite/util_test.py 0000644 00000022360 15025317163 0011666 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Tests for apitools.base.protorpclite.util.""" import datetime import sys import types import unittest import six from apitools.base.protorpclite import test_util from apitools.base.protorpclite import util class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = util class UtilTest(test_util.TestCase): def testDecoratedFunction_LengthZero(self): @util.positional(0) def fn(kwonly=1): return [kwonly] self.assertEqual([1], fn()) self.assertEqual([2], fn(kwonly=2)) self.assertRaisesWithRegexpMatch(TypeError, r'fn\(\) takes at most 0 positional ' r'arguments \(1 given\)', fn, 1) def testDecoratedFunction_LengthOne(self): @util.positional(1) def fn(pos, kwonly=1): return [pos, kwonly] self.assertEqual([1, 1], fn(1)) self.assertEqual([2, 2], fn(2, kwonly=2)) self.assertRaisesWithRegexpMatch(TypeError, r'fn\(\) takes at most 1 positional ' r'argument \(2 given\)', fn, 2, 3) def testDecoratedFunction_LengthTwoWithDefault(self): @util.positional(2) def fn(pos1, pos2=1, kwonly=1): return [pos1, pos2, kwonly] self.assertEqual([1, 1, 1], fn(1)) self.assertEqual([2, 2, 1], fn(2, 2)) self.assertEqual([2, 3, 4], fn(2, 3, kwonly=4)) self.assertRaisesWithRegexpMatch(TypeError, r'fn\(\) takes at most 2 positional ' r'arguments \(3 given\)', fn, 2, 3, 4) def testDecoratedMethod(self): class MyClass(object): @util.positional(2) def meth(self, pos1, kwonly=1): return [pos1, kwonly] self.assertEqual([1, 1], MyClass().meth(1)) self.assertEqual([2, 2], MyClass().meth(2, kwonly=2)) self.assertRaisesWithRegexpMatch( TypeError, r'meth\(\) takes at most 2 positional arguments \(3 given\)', MyClass().meth, 2, 3) def testDefaultDecoration(self): @util.positional def fn(a, b, c=None): return a, b, c self.assertEqual((1, 2, 3), fn(1, 2, c=3)) self.assertEqual((3, 4, None), fn(3, b=4)) self.assertRaisesWithRegexpMatch(TypeError, r'fn\(\) takes at most 2 positional ' r'arguments \(3 given\)', fn, 2, 3, 4) def testDefaultDecorationNoKwdsFails(self): def fn(a): return a self.assertRaisesRegex( ValueError, ('Functions with no keyword arguments must specify ' 'max_positional_args'), util.positional, fn) def testDecoratedFunctionDocstring(self): @util.positional(0) def fn(kwonly=1): """fn docstring.""" return [kwonly] self.assertEqual('fn docstring.', fn.__doc__) class GetPackageForModuleTest(test_util.TestCase): def setUp(self): self.original_modules = dict(sys.modules) def tearDown(self): sys.modules.clear() sys.modules.update(self.original_modules) def CreateModule(self, name, file_name=None): if file_name is None: file_name = '%s.py' % name module = types.ModuleType(name) sys.modules[name] = module return module def assertPackageEquals(self, expected, actual): self.assertEqual(expected, actual) if actual is not None: self.assertTrue(isinstance(actual, six.text_type)) def testByString(self): module = self.CreateModule('service_module') module.package = 'my_package' self.assertPackageEquals('my_package', util.get_package_for_module('service_module')) def testModuleNameNotInSys(self): self.assertPackageEquals(None, util.get_package_for_module('service_module')) def testHasPackage(self): module = self.CreateModule('service_module') module.package = 'my_package' self.assertPackageEquals( 'my_package', util.get_package_for_module(module)) def testHasModuleName(self): module = self.CreateModule('service_module') self.assertPackageEquals('service_module', util.get_package_for_module(module)) def testIsMain(self): module = self.CreateModule('__main__') module.__file__ = '/bing/blam/bloom/blarm/my_file.py' self.assertPackageEquals( 'my_file', util.get_package_for_module(module)) def testIsMainCompiled(self): module = self.CreateModule('__main__') module.__file__ = '/bing/blam/bloom/blarm/my_file.pyc' self.assertPackageEquals( 'my_file', util.get_package_for_module(module)) def testNoExtension(self): module = self.CreateModule('__main__') module.__file__ = '/bing/blam/bloom/blarm/my_file' self.assertPackageEquals( 'my_file', util.get_package_for_module(module)) def testNoPackageAtAll(self): module = self.CreateModule('__main__') self.assertPackageEquals( '__main__', util.get_package_for_module(module)) class DateTimeTests(test_util.TestCase): def testDecodeDateTime(self): """Test that a RFC 3339 datetime string is decoded properly.""" for datetime_string, datetime_vals in ( ('2012-09-30T15:31:50.262', (2012, 9, 30, 15, 31, 50, 262000)), ('2012-09-30T15:31:50', (2012, 9, 30, 15, 31, 50, 0))): decoded = util.decode_datetime(datetime_string) expected = datetime.datetime(*datetime_vals) self.assertEqual(expected, decoded) def testDecodeDateTimeWithTruncateTime(self): """Test that nanosec time is truncated with truncate_time flag.""" decoded = util.decode_datetime('2012-09-30T15:31:50.262343123', truncate_time=True) expected = datetime.datetime(2012, 9, 30, 15, 31, 50, 262343) self.assertEqual(expected, decoded) def testDateTimeTimeZones(self): """Test that a datetime string with a timezone is decoded correctly.""" tests = ( ('2012-09-30T15:31:50.262-06:00', (2012, 9, 30, 15, 31, 50, 262000, util.TimeZoneOffset(-360))), ('2012-09-30T15:31:50.262+01:30', (2012, 9, 30, 15, 31, 50, 262000, util.TimeZoneOffset(90))), ('2012-09-30T15:31:50+00:05', (2012, 9, 30, 15, 31, 50, 0, util.TimeZoneOffset(5))), ('2012-09-30T15:31:50+00:00', (2012, 9, 30, 15, 31, 50, 0, util.TimeZoneOffset(0))), ('2012-09-30t15:31:50-00:00', (2012, 9, 30, 15, 31, 50, 0, util.TimeZoneOffset(0))), ('2012-09-30t15:31:50z', (2012, 9, 30, 15, 31, 50, 0, util.TimeZoneOffset(0))), ('2012-09-30T15:31:50-23:00', (2012, 9, 30, 15, 31, 50, 0, util.TimeZoneOffset(-1380)))) for datetime_string, datetime_vals in tests: decoded = util.decode_datetime(datetime_string) expected = datetime.datetime(*datetime_vals) self.assertEqual(expected, decoded) def testDecodeDateTimeInvalid(self): """Test that decoding malformed datetime strings raises execptions.""" for datetime_string in ('invalid', '2012-09-30T15:31:50.', '-08:00 2012-09-30T15:31:50.262', '2012-09-30T15:31', '2012-09-30T15:31Z', '2012-09-30T15:31:50ZZ', '2012-09-30T15:31:50.262 blah blah -08:00', '1000-99-99T25:99:99.999-99:99', '2012-09-30T15:31:50.262343123'): self.assertRaises( ValueError, util.decode_datetime, datetime_string) def testTimeZoneOffsetDelta(self): """Test that delta works with TimeZoneOffset.""" time_zone = util.TimeZoneOffset(datetime.timedelta(minutes=3)) epoch = time_zone.utcoffset(datetime.datetime.fromtimestamp(0, tz=datetime.timezone.utc).replace(tzinfo=None)) self.assertEqual(180, util.total_seconds(epoch)) def main(): unittest.main() if __name__ == '__main__': main() protorpclite/message_types_test.py 0000644 00000006171 15025317163 0013563 0 ustar 00 #!/usr/bin/env python # # Copyright 2013 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Tests for apitools.base.protorpclite.message_types.""" import datetime import unittest from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import test_util from apitools.base.protorpclite import util class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = message_types class DateTimeFieldTest(test_util.TestCase): def testValueToMessage(self): field = message_types.DateTimeField(1) message = field.value_to_message( datetime.datetime(2033, 2, 4, 11, 22, 10)) self.assertEqual( message_types.DateTimeMessage(milliseconds=1991128930000), message) def testValueToMessageBadValue(self): field = message_types.DateTimeField(1) self.assertRaisesWithRegexpMatch( messages.EncodeError, 'Expected type datetime, got int: 20', field.value_to_message, 20) def testValueToMessageWithTimeZone(self): time_zone = util.TimeZoneOffset(60 * 10) field = message_types.DateTimeField(1) message = field.value_to_message( datetime.datetime(2033, 2, 4, 11, 22, 10, tzinfo=time_zone)) self.assertEqual( message_types.DateTimeMessage(milliseconds=1991128930000, time_zone_offset=600), message) def testValueFromMessage(self): message = message_types.DateTimeMessage(milliseconds=1991128000000) field = message_types.DateTimeField(1) timestamp = field.value_from_message(message) self.assertEqual(datetime.datetime(2033, 2, 4, 11, 6, 40), timestamp) def testValueFromMessageBadValue(self): field = message_types.DateTimeField(1) self.assertRaisesWithRegexpMatch( messages.DecodeError, 'Expected type DateTimeMessage, got VoidMessage: <VoidMessage>', field.value_from_message, message_types.VoidMessage()) def testValueFromMessageWithTimeZone(self): message = message_types.DateTimeMessage(milliseconds=1991128000000, time_zone_offset=300) field = message_types.DateTimeField(1) timestamp = field.value_from_message(message) time_zone = util.TimeZoneOffset(60 * 5) self.assertEqual( datetime.datetime(2033, 2, 4, 11, 6, 40, tzinfo=time_zone), timestamp) if __name__ == '__main__': unittest.main() protorpclite/protojson_test.py 0000644 00000044362 15025317163 0012754 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Tests for apitools.base.protorpclite.protojson.""" import datetime import json import unittest from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import protojson from apitools.base.protorpclite import test_util class CustomField(messages.MessageField): """Custom MessageField class.""" type = int message_type = message_types.VoidMessage def __init__(self, number, **kwargs): super(CustomField, self).__init__(self.message_type, number, **kwargs) def value_to_message(self, value): return self.message_type() # pylint:disable=not-callable class MyMessage(messages.Message): """Test message containing various types.""" class Color(messages.Enum): RED = 1 GREEN = 2 BLUE = 3 class Nested(messages.Message): nested_value = messages.StringField(1) class NestedDatetime(messages.Message): nested_dt_value = message_types.DateTimeField(1) a_string = messages.StringField(2) an_integer = messages.IntegerField(3) a_float = messages.FloatField(4) a_boolean = messages.BooleanField(5) an_enum = messages.EnumField(Color, 6) a_nested = messages.MessageField(Nested, 7) a_repeated = messages.IntegerField(8, repeated=True) a_repeated_float = messages.FloatField(9, repeated=True) a_datetime = message_types.DateTimeField(10) a_repeated_datetime = message_types.DateTimeField(11, repeated=True) a_custom = CustomField(12) a_repeated_custom = CustomField(13, repeated=True) a_nested_datetime = messages.MessageField(NestedDatetime, 14) class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = protojson # TODO(rafek): Convert this test to the compliance test in test_util. class ProtojsonTest(test_util.TestCase, test_util.ProtoConformanceTestBase): """Test JSON encoding and decoding.""" PROTOLIB = protojson def CompareEncoded(self, expected_encoded, actual_encoded): """JSON encoding will be laundered to remove string differences.""" self.assertEqual(json.loads(expected_encoded), json.loads(actual_encoded)) encoded_empty_message = '{}' encoded_partial = """{ "double_value": 1.23, "int64_value": -100000000000, "int32_value": 1020, "string_value": "a string", "enum_value": "VAL2" } """ # pylint:disable=anomalous-unicode-escape-in-string encoded_full = """{ "double_value": 1.23, "float_value": -2.5, "int64_value": -100000000000, "uint64_value": 102020202020, "int32_value": 1020, "bool_value": true, "string_value": "a string\u044f", "bytes_value": "YSBieXRlc//+", "enum_value": "VAL2" } """ encoded_repeated = """{ "double_value": [1.23, 2.3], "float_value": [-2.5, 0.5], "int64_value": [-100000000000, 20], "uint64_value": [102020202020, 10], "int32_value": [1020, 718], "bool_value": [true, false], "string_value": ["a string\u044f", "another string"], "bytes_value": ["YSBieXRlc//+", "YW5vdGhlciBieXRlcw=="], "enum_value": ["VAL2", "VAL1"] } """ encoded_nested = """{ "nested": { "a_value": "a string" } } """ encoded_repeated_nested = """{ "repeated_nested": [{"a_value": "a string"}, {"a_value": "another string"}] } """ unexpected_tag_message = '{"unknown": "value"}' encoded_default_assigned = '{"a_value": "a default"}' encoded_nested_empty = '{"nested": {}}' encoded_repeated_nested_empty = '{"repeated_nested": [{}, {}]}' encoded_extend_message = '{"int64_value": [400, 50, 6000]}' encoded_string_types = '{"string_value": "Latin"}' encoded_invalid_enum = '{"enum_value": "undefined"}' encoded_invalid_repeated_enum = '{"enum_value": ["VAL1", "undefined"]}' def testConvertIntegerToFloat(self): """Test that integers passed in to float fields are converted. This is necessary because JSON outputs integers for numbers with 0 decimals. """ message = protojson.decode_message(MyMessage, '{"a_float": 10}') self.assertTrue(isinstance(message.a_float, float)) self.assertEqual(10.0, message.a_float) def testConvertStringToNumbers(self): """Test that strings passed to integer fields are converted.""" message = protojson.decode_message(MyMessage, """{"an_integer": "10", "a_float": "3.5", "a_repeated": ["1", "2"], "a_repeated_float": ["1.5", "2", 10] }""") self.assertEqual(MyMessage(an_integer=10, a_float=3.5, a_repeated=[1, 2], a_repeated_float=[1.5, 2.0, 10.0]), message) def testWrongTypeAssignment(self): """Test when wrong type is assigned to a field.""" self.assertRaises(messages.ValidationError, protojson.decode_message, MyMessage, '{"a_string": 10}') self.assertRaises(messages.ValidationError, protojson.decode_message, MyMessage, '{"an_integer": 10.2}') self.assertRaises(messages.ValidationError, protojson.decode_message, MyMessage, '{"an_integer": "10.2"}') def testNumericEnumeration(self): """Test that numbers work for enum values.""" message = protojson.decode_message(MyMessage, '{"an_enum": 2}') expected_message = MyMessage() expected_message.an_enum = MyMessage.Color.GREEN self.assertEqual(expected_message, message) def testNumericEnumerationNegativeTest(self): """Test with an invalid number for the enum value.""" # The message should successfully decode. message = protojson.decode_message(MyMessage, '{"an_enum": 89}') expected_message = MyMessage() self.assertEqual(expected_message, message) # The roundtrip should result in equivalent encoded # message. self.assertEqual('{"an_enum": 89}', protojson.encode_message(message)) def testAlphaEnumeration(self): """Test that alpha enum values work.""" message = protojson.decode_message(MyMessage, '{"an_enum": "RED"}') expected_message = MyMessage() expected_message.an_enum = MyMessage.Color.RED self.assertEqual(expected_message, message) def testAlphaEnumerationNegativeTest(self): """The alpha enum value is invalid.""" # The message should successfully decode. message = protojson.decode_message(MyMessage, '{"an_enum": "IAMINVALID"}') expected_message = MyMessage() self.assertEqual(expected_message, message) # The roundtrip should result in equivalent encoded message. self.assertEqual('{"an_enum": "IAMINVALID"}', protojson.encode_message(message)) def testEnumerationNegativeTestWithEmptyString(self): """The enum value is an empty string.""" # The message should successfully decode. message = protojson.decode_message(MyMessage, '{"an_enum": ""}') expected_message = MyMessage() self.assertEqual(expected_message, message) # The roundtrip should result in equivalent encoded message. self.assertEqual('{"an_enum": ""}', protojson.encode_message(message)) def testNullValues(self): """Test that null values overwrite existing values.""" self.assertEqual(MyMessage(), protojson.decode_message(MyMessage, ('{"an_integer": null,' ' "a_nested": null,' ' "an_enum": null' '}'))) def testEmptyList(self): """Test that empty lists are ignored.""" self.assertEqual(MyMessage(), protojson.decode_message(MyMessage, '{"a_repeated": []}')) def testNotJSON(self): """Test error when string is not valid JSON.""" self.assertRaises( ValueError, protojson.decode_message, MyMessage, '{this is not json}') def testDoNotEncodeStrangeObjects(self): """Test trying to encode a strange object. The main purpose of this test is to complete coverage. It ensures that the default behavior of the JSON encoder is preserved when someone tries to serialized an unexpected type. """ class BogusObject(object): def check_initialized(self): pass self.assertRaises(TypeError, protojson.encode_message, BogusObject()) def testMergeEmptyString(self): """Test merging the empty or space only string.""" message = protojson.decode_message(test_util.OptionalMessage, '') self.assertEqual(test_util.OptionalMessage(), message) message = protojson.decode_message(test_util.OptionalMessage, ' ') self.assertEqual(test_util.OptionalMessage(), message) def testProtojsonUnrecognizedFieldName(self): """Test that unrecognized fields are saved and can be accessed.""" decoded = protojson.decode_message( MyMessage, ('{"an_integer": 1, "unknown_val": 2}')) self.assertEqual(decoded.an_integer, 1) self.assertEqual(1, len(decoded.all_unrecognized_fields())) self.assertEqual('unknown_val', decoded.all_unrecognized_fields()[0]) self.assertEqual((2, messages.Variant.INT64), decoded.get_unrecognized_field_info('unknown_val')) def testProtojsonUnrecognizedFieldNumber(self): """Test that unrecognized fields are saved and can be accessed.""" decoded = protojson.decode_message( MyMessage, '{"an_integer": 1, "1001": "unknown", "-123": "negative", ' '"456_mixed": 2}') self.assertEqual(decoded.an_integer, 1) self.assertEqual(3, len(decoded.all_unrecognized_fields())) self.assertFalse(1001 in decoded.all_unrecognized_fields()) self.assertTrue('1001' in decoded.all_unrecognized_fields()) self.assertEqual(('unknown', messages.Variant.STRING), decoded.get_unrecognized_field_info('1001')) self.assertTrue('-123' in decoded.all_unrecognized_fields()) self.assertEqual(('negative', messages.Variant.STRING), decoded.get_unrecognized_field_info('-123')) self.assertTrue('456_mixed' in decoded.all_unrecognized_fields()) self.assertEqual((2, messages.Variant.INT64), decoded.get_unrecognized_field_info('456_mixed')) def testProtojsonUnrecognizedNull(self): """Test that unrecognized fields that are None are skipped.""" decoded = protojson.decode_message( MyMessage, '{"an_integer": 1, "unrecognized_null": null}') self.assertEqual(decoded.an_integer, 1) self.assertEqual(decoded.all_unrecognized_fields(), []) def testUnrecognizedFieldVariants(self): """Test that unrecognized fields are mapped to the right variants.""" for encoded, expected_variant in ( ('{"an_integer": 1, "unknown_val": 2}', messages.Variant.INT64), ('{"an_integer": 1, "unknown_val": 2.0}', messages.Variant.DOUBLE), ('{"an_integer": 1, "unknown_val": "string value"}', messages.Variant.STRING), ('{"an_integer": 1, "unknown_val": [1, 2, 3]}', messages.Variant.INT64), ('{"an_integer": 1, "unknown_val": [1, 2.0, 3]}', messages.Variant.DOUBLE), ('{"an_integer": 1, "unknown_val": [1, "foo", 3]}', messages.Variant.STRING), ('{"an_integer": 1, "unknown_val": true}', messages.Variant.BOOL)): decoded = protojson.decode_message(MyMessage, encoded) self.assertEqual(decoded.an_integer, 1) self.assertEqual(1, len(decoded.all_unrecognized_fields())) self.assertEqual( 'unknown_val', decoded.all_unrecognized_fields()[0]) _, decoded_variant = decoded.get_unrecognized_field_info( 'unknown_val') self.assertEqual(expected_variant, decoded_variant) def testDecodeDateTime(self): for datetime_string, datetime_vals in ( ('2012-09-30T15:31:50.262', (2012, 9, 30, 15, 31, 50, 262000)), ('2012-09-30T15:31:50', (2012, 9, 30, 15, 31, 50, 0))): message = protojson.decode_message( MyMessage, '{"a_datetime": "%s"}' % datetime_string) expected_message = MyMessage( a_datetime=datetime.datetime(*datetime_vals)) self.assertEqual(expected_message, message) def testDecodeInvalidDateTime(self): self.assertRaises(messages.DecodeError, protojson.decode_message, MyMessage, '{"a_datetime": "invalid"}') def testDecodeInvalidMessage(self): encoded = """{ "a_nested_datetime": { "nested_dt_value": "invalid" } } """ self.assertRaises(messages.DecodeError, protojson.decode_message, MyMessage, encoded) def testEncodeDateTime(self): for datetime_string, datetime_vals in ( ('2012-09-30T15:31:50.262000', (2012, 9, 30, 15, 31, 50, 262000)), ('2012-09-30T15:31:50.262123', (2012, 9, 30, 15, 31, 50, 262123)), ('2012-09-30T15:31:50', (2012, 9, 30, 15, 31, 50, 0))): decoded_message = protojson.encode_message( MyMessage(a_datetime=datetime.datetime(*datetime_vals))) expected_decoding = '{"a_datetime": "%s"}' % datetime_string self.CompareEncoded(expected_decoding, decoded_message) def testDecodeRepeatedDateTime(self): message = protojson.decode_message( MyMessage, '{"a_repeated_datetime": ["2012-09-30T15:31:50.262", ' '"2010-01-21T09:52:00", "2000-01-01T01:00:59.999999"]}') expected_message = MyMessage( a_repeated_datetime=[ datetime.datetime(2012, 9, 30, 15, 31, 50, 262000), datetime.datetime(2010, 1, 21, 9, 52), datetime.datetime(2000, 1, 1, 1, 0, 59, 999999)]) self.assertEqual(expected_message, message) def testDecodeCustom(self): message = protojson.decode_message(MyMessage, '{"a_custom": 1}') self.assertEqual(MyMessage(a_custom=1), message) def testDecodeInvalidCustom(self): self.assertRaises(messages.ValidationError, protojson.decode_message, MyMessage, '{"a_custom": "invalid"}') def testEncodeCustom(self): decoded_message = protojson.encode_message(MyMessage(a_custom=1)) self.CompareEncoded('{"a_custom": 1}', decoded_message) def testDecodeRepeatedCustom(self): message = protojson.decode_message( MyMessage, '{"a_repeated_custom": [1, 2, 3]}') self.assertEqual(MyMessage(a_repeated_custom=[1, 2, 3]), message) def testDecodeRepeatedEmpty(self): message = protojson.decode_message( MyMessage, '{"a_repeated": []}') self.assertEqual(MyMessage(a_repeated=[]), message) def testDecodeNone(self): message = protojson.decode_message( MyMessage, '{"an_integer": []}') self.assertEqual(MyMessage(an_integer=None), message) def testDecodeBadBase64BytesField(self): """Test decoding improperly encoded base64 bytes value.""" self.assertRaisesWithRegexpMatch( messages.DecodeError, 'Base64 decoding error', protojson.decode_message, test_util.OptionalMessage, '{"bytes_value": "abcdefghijklmnopq"}') class CustomProtoJson(protojson.ProtoJson): def encode_field(self, field, value): return '{encoded}' + value def decode_field(self, field, value): return '{decoded}' + value class CustomProtoJsonTest(test_util.TestCase): """Tests for serialization overriding functionality.""" def setUp(self): self.protojson = CustomProtoJson() def testEncode(self): self.assertEqual( '{"a_string": "{encoded}xyz"}', self.protojson.encode_message(MyMessage(a_string='xyz'))) def testDecode(self): self.assertEqual( MyMessage(a_string='{decoded}xyz'), self.protojson.decode_message(MyMessage, '{"a_string": "xyz"}')) def testDecodeEmptyMessage(self): self.assertEqual( MyMessage(a_string='{decoded}'), self.protojson.decode_message(MyMessage, '{"a_string": ""}')) def testDefault(self): self.assertTrue(protojson.ProtoJson.get_default(), protojson.ProtoJson.get_default()) instance = CustomProtoJson() protojson.ProtoJson.set_default(instance) self.assertTrue(instance is protojson.ProtoJson.get_default()) if __name__ == '__main__': unittest.main() protorpclite/descriptor.py 0000644 00000046377 15025317163 0012046 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Services descriptor definitions. Contains message definitions and functions for converting service classes into transmittable message format. Describing an Enum instance, Enum class, Field class or Message class will generate an appropriate descriptor object that describes that class. This message can itself be used to transmit information to clients wishing to know the description of an enum value, enum, field or message without needing to download the source code. This format is also compatible with other, non-Python languages. The descriptors are modeled to be binary compatible with https://github.com/google/protobuf NOTE: The names of types and fields are not always the same between these descriptors and the ones defined in descriptor.proto. This was done in order to make source code files that use these descriptors easier to read. For example, it is not necessary to prefix TYPE to all the values in FieldDescriptor.Variant as is done in descriptor.proto FieldDescriptorProto.Type. Example: class Pixel(messages.Message): x = messages.IntegerField(1, required=True) y = messages.IntegerField(2, required=True) color = messages.BytesField(3) # Describe Pixel class using message descriptor. fields = [] field = FieldDescriptor() field.name = 'x' field.number = 1 field.label = FieldDescriptor.Label.REQUIRED field.variant = FieldDescriptor.Variant.INT64 fields.append(field) field = FieldDescriptor() field.name = 'y' field.number = 2 field.label = FieldDescriptor.Label.REQUIRED field.variant = FieldDescriptor.Variant.INT64 fields.append(field) field = FieldDescriptor() field.name = 'color' field.number = 3 field.label = FieldDescriptor.Label.OPTIONAL field.variant = FieldDescriptor.Variant.BYTES fields.append(field) message = MessageDescriptor() message.name = 'Pixel' message.fields = fields # Describing is the equivalent of building the above message. message == describe_message(Pixel) Public Classes: EnumValueDescriptor: Describes Enum values. EnumDescriptor: Describes Enum classes. FieldDescriptor: Describes field instances. FileDescriptor: Describes a single 'file' unit. FileSet: Describes a collection of file descriptors. MessageDescriptor: Describes Message classes. Public Functions: describe_enum_value: Describe an individual enum-value. describe_enum: Describe an Enum class. describe_field: Describe a Field definition. describe_file: Describe a 'file' unit from a Python module or object. describe_file_set: Describe a file set from a list of modules or objects. describe_message: Describe a Message definition. """ import codecs import types import six from apitools.base.protorpclite import messages from apitools.base.protorpclite import util __all__ = [ 'EnumDescriptor', 'EnumValueDescriptor', 'FieldDescriptor', 'MessageDescriptor', 'FileDescriptor', 'FileSet', 'DescriptorLibrary', 'describe_enum', 'describe_enum_value', 'describe_field', 'describe_message', 'describe_file', 'describe_file_set', 'describe', 'import_descriptor_loader', ] # NOTE: MessageField is missing because message fields cannot have # a default value at this time. # TODO(rafek): Support default message values. # # Map to functions that convert default values of fields of a given type # to a string. The function must return a value that is compatible with # FieldDescriptor.default_value and therefore a unicode string. _DEFAULT_TO_STRING_MAP = { messages.IntegerField: six.text_type, messages.FloatField: six.text_type, messages.BooleanField: lambda value: value and u'true' or u'false', messages.BytesField: lambda value: codecs.escape_encode(value)[0], messages.StringField: lambda value: value, messages.EnumField: lambda value: six.text_type(value.number), } _DEFAULT_FROM_STRING_MAP = { messages.IntegerField: int, messages.FloatField: float, messages.BooleanField: lambda value: value == u'true', messages.BytesField: lambda value: codecs.escape_decode(value)[0], messages.StringField: lambda value: value, messages.EnumField: int, } class EnumValueDescriptor(messages.Message): """Enum value descriptor. Fields: name: Name of enumeration value. number: Number of enumeration value. """ # TODO(rafek): Why are these listed as optional in descriptor.proto. # Harmonize? name = messages.StringField(1, required=True) number = messages.IntegerField(2, required=True, variant=messages.Variant.INT32) class EnumDescriptor(messages.Message): """Enum class descriptor. Fields: name: Name of Enum without any qualification. values: Values defined by Enum class. """ name = messages.StringField(1) values = messages.MessageField(EnumValueDescriptor, 2, repeated=True) class FieldDescriptor(messages.Message): """Field definition descriptor. Enums: Variant: Wire format hint sub-types for field. Label: Values for optional, required and repeated fields. Fields: name: Name of field. number: Number of field. variant: Variant of field. type_name: Type name for message and enum fields. default_value: String representation of default value. """ Variant = messages.Variant # pylint:disable=invalid-name class Label(messages.Enum): """Field label.""" OPTIONAL = 1 REQUIRED = 2 REPEATED = 3 name = messages.StringField(1, required=True) number = messages.IntegerField(3, required=True, variant=messages.Variant.INT32) label = messages.EnumField(Label, 4, default=Label.OPTIONAL) variant = messages.EnumField(Variant, 5) type_name = messages.StringField(6) # For numeric types, contains the original text representation of # the value. # For booleans, "true" or "false". # For strings, contains the default text contents (not escaped in any # way). # For bytes, contains the C escaped value. All bytes < 128 are that are # traditionally considered unprintable are also escaped. default_value = messages.StringField(7) class MessageDescriptor(messages.Message): """Message definition descriptor. Fields: name: Name of Message without any qualification. fields: Fields defined for message. message_types: Nested Message classes defined on message. enum_types: Nested Enum classes defined on message. """ name = messages.StringField(1) fields = messages.MessageField(FieldDescriptor, 2, repeated=True) message_types = messages.MessageField( 'apitools.base.protorpclite.descriptor.MessageDescriptor', 3, repeated=True) enum_types = messages.MessageField(EnumDescriptor, 4, repeated=True) class FileDescriptor(messages.Message): """Description of file containing protobuf definitions. Fields: package: Fully qualified name of package that definitions belong to. message_types: Message definitions contained in file. enum_types: Enum definitions contained in file. """ package = messages.StringField(2) # TODO(rafek): Add dependency field message_types = messages.MessageField(MessageDescriptor, 4, repeated=True) enum_types = messages.MessageField(EnumDescriptor, 5, repeated=True) class FileSet(messages.Message): """A collection of FileDescriptors. Fields: files: Files in file-set. """ files = messages.MessageField(FileDescriptor, 1, repeated=True) def describe_enum_value(enum_value): """Build descriptor for Enum instance. Args: enum_value: Enum value to provide descriptor for. Returns: Initialized EnumValueDescriptor instance describing the Enum instance. """ enum_value_descriptor = EnumValueDescriptor() enum_value_descriptor.name = six.text_type(enum_value.name) enum_value_descriptor.number = enum_value.number return enum_value_descriptor def describe_enum(enum_definition): """Build descriptor for Enum class. Args: enum_definition: Enum class to provide descriptor for. Returns: Initialized EnumDescriptor instance describing the Enum class. """ enum_descriptor = EnumDescriptor() enum_descriptor.name = enum_definition.definition_name().split('.')[-1] values = [] for number in sorted(enum_definition.numbers()): value = enum_definition.lookup_by_number(number) values.append(describe_enum_value(value)) if values: enum_descriptor.values = values return enum_descriptor def describe_field(field_definition): """Build descriptor for Field instance. Args: field_definition: Field instance to provide descriptor for. Returns: Initialized FieldDescriptor instance describing the Field instance. """ field_descriptor = FieldDescriptor() field_descriptor.name = field_definition.name field_descriptor.number = field_definition.number field_descriptor.variant = field_definition.variant if isinstance(field_definition, messages.EnumField): field_descriptor.type_name = field_definition.type.definition_name() if isinstance(field_definition, messages.MessageField): field_descriptor.type_name = ( field_definition.message_type.definition_name()) if field_definition.default is not None: field_descriptor.default_value = _DEFAULT_TO_STRING_MAP[ type(field_definition)](field_definition.default) # Set label. if field_definition.repeated: field_descriptor.label = FieldDescriptor.Label.REPEATED elif field_definition.required: field_descriptor.label = FieldDescriptor.Label.REQUIRED else: field_descriptor.label = FieldDescriptor.Label.OPTIONAL return field_descriptor def describe_message(message_definition): """Build descriptor for Message class. Args: message_definition: Message class to provide descriptor for. Returns: Initialized MessageDescriptor instance describing the Message class. """ message_descriptor = MessageDescriptor() message_descriptor.name = message_definition.definition_name().split( '.')[-1] fields = sorted(message_definition.all_fields(), key=lambda v: v.number) if fields: message_descriptor.fields = [describe_field(field) for field in fields] try: nested_messages = message_definition.__messages__ except AttributeError: pass else: message_descriptors = [] for name in nested_messages: value = getattr(message_definition, name) message_descriptors.append(describe_message(value)) message_descriptor.message_types = message_descriptors try: nested_enums = message_definition.__enums__ except AttributeError: pass else: enum_descriptors = [] for name in nested_enums: value = getattr(message_definition, name) enum_descriptors.append(describe_enum(value)) message_descriptor.enum_types = enum_descriptors return message_descriptor def describe_file(module): """Build a file from a specified Python module. Args: module: Python module to describe. Returns: Initialized FileDescriptor instance describing the module. """ descriptor = FileDescriptor() descriptor.package = util.get_package_for_module(module) if not descriptor.package: descriptor.package = None message_descriptors = [] enum_descriptors = [] # Need to iterate over all top level attributes of the module looking for # message and enum definitions. Each definition must be itself described. for name in sorted(dir(module)): value = getattr(module, name) if isinstance(value, type): if issubclass(value, messages.Message): message_descriptors.append(describe_message(value)) elif issubclass(value, messages.Enum): enum_descriptors.append(describe_enum(value)) if message_descriptors: descriptor.message_types = message_descriptors if enum_descriptors: descriptor.enum_types = enum_descriptors return descriptor def describe_file_set(modules): """Build a file set from a specified Python modules. Args: modules: Iterable of Python module to describe. Returns: Initialized FileSet instance describing the modules. """ descriptor = FileSet() file_descriptors = [] for module in modules: file_descriptors.append(describe_file(module)) if file_descriptors: descriptor.files = file_descriptors return descriptor def describe(value): """Describe any value as a descriptor. Helper function for describing any object with an appropriate descriptor object. Args: value: Value to describe as a descriptor. Returns: Descriptor message class if object is describable as a descriptor, else None. """ if isinstance(value, types.ModuleType): return describe_file(value) elif isinstance(value, messages.Field): return describe_field(value) elif isinstance(value, messages.Enum): return describe_enum_value(value) elif isinstance(value, type): if issubclass(value, messages.Message): return describe_message(value) elif issubclass(value, messages.Enum): return describe_enum(value) return None @util.positional(1) def import_descriptor_loader(definition_name, importer=__import__): """Find objects by importing modules as needed. A definition loader is a function that resolves a definition name to a descriptor. The import finder resolves definitions to their names by importing modules when necessary. Args: definition_name: Name of definition to find. importer: Import function used for importing new modules. Returns: Appropriate descriptor for any describable type located by name. Raises: DefinitionNotFoundError when a name does not refer to either a definition or a module. """ # Attempt to import descriptor as a module. if definition_name.startswith('.'): definition_name = definition_name[1:] if not definition_name.startswith('.'): leaf = definition_name.split('.')[-1] if definition_name: try: module = importer(definition_name, '', '', [leaf]) except ImportError: pass else: return describe(module) try: # Attempt to use messages.find_definition to find item. return describe(messages.find_definition(definition_name, importer=__import__)) except messages.DefinitionNotFoundError as err: # There are things that find_definition will not find, but if # the parent is loaded, its children can be searched for a # match. split_name = definition_name.rsplit('.', 1) if len(split_name) > 1: parent, child = split_name try: parent_definition = import_descriptor_loader( parent, importer=importer) except messages.DefinitionNotFoundError: # Fall through to original error. pass else: # Check the parent definition for a matching descriptor. if isinstance(parent_definition, EnumDescriptor): search_list = parent_definition.values or [] elif isinstance(parent_definition, MessageDescriptor): search_list = parent_definition.fields or [] else: search_list = [] for definition in search_list: if definition.name == child: return definition # Still didn't find. Reraise original exception. raise err class DescriptorLibrary(object): """A descriptor library is an object that contains known definitions. A descriptor library contains a cache of descriptor objects mapped by definition name. It contains all types of descriptors except for file sets. When a definition name is requested that the library does not know about it can be provided with a descriptor loader which attempt to resolve the missing descriptor. """ @util.positional(1) def __init__(self, descriptors=None, descriptor_loader=import_descriptor_loader): """Constructor. Args: descriptors: A dictionary or dictionary-like object that can be used to store and cache descriptors by definition name. definition_loader: A function used for resolving missing descriptors. The function takes a definition name as its parameter and returns an appropriate descriptor. It may raise DefinitionNotFoundError. """ self.__descriptor_loader = descriptor_loader self.__descriptors = descriptors or {} def lookup_descriptor(self, definition_name): """Lookup descriptor by name. Get descriptor from library by name. If descriptor is not found will attempt to find via descriptor loader if provided. Args: definition_name: Definition name to find. Returns: Descriptor that describes definition name. Raises: DefinitionNotFoundError if not descriptor exists for definition name. """ try: return self.__descriptors[definition_name] except KeyError: pass if self.__descriptor_loader: definition = self.__descriptor_loader(definition_name) self.__descriptors[definition_name] = definition return definition else: raise messages.DefinitionNotFoundError( 'Could not find definition for %s' % definition_name) def lookup_package(self, definition_name): """Determines the package name for any definition. Determine the package that any definition name belongs to. May check parent for package name and will resolve missing descriptors if provided descriptor loader. Args: definition_name: Definition name to find package for. """ while True: descriptor = self.lookup_descriptor(definition_name) if isinstance(descriptor, FileDescriptor): return descriptor.package else: index = definition_name.rfind('.') if index < 0: return None definition_name = definition_name[:index] protorpclite/message_types.py 0000644 00000010066 15025317163 0012522 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Simple protocol message types. Includes new message and field types that are outside what is defined by the protocol buffers standard. """ import datetime from apitools.base.protorpclite import messages from apitools.base.protorpclite import util __all__ = [ 'DateTimeField', 'DateTimeMessage', 'VoidMessage', ] class VoidMessage(messages.Message): """Empty message.""" class DateTimeMessage(messages.Message): """Message to store/transmit a DateTime. Fields: milliseconds: Milliseconds since Jan 1st 1970 local time. time_zone_offset: Optional time zone offset, in minutes from UTC. """ milliseconds = messages.IntegerField(1, required=True) time_zone_offset = messages.IntegerField(2) class DateTimeField(messages.MessageField): """Field definition for datetime values. Stores a python datetime object as a field. If time zone information is included in the datetime object, it will be included in the encoded data when this is encoded/decoded. """ type = datetime.datetime message_type = DateTimeMessage @util.positional(3) def __init__(self, number, **kwargs): super(DateTimeField, self).__init__(self.message_type, number, **kwargs) def value_from_message(self, message): """Convert DateTimeMessage to a datetime. Args: A DateTimeMessage instance. Returns: A datetime instance. """ message = super(DateTimeField, self).value_from_message(message) if message.time_zone_offset is None: return datetime.datetime.fromtimestamp( message.milliseconds / 1000.0, tz=datetime.timezone.utc).replace(tzinfo=None) # Need to subtract the time zone offset, because when we call # datetime.fromtimestamp, it will add the time zone offset to the # value we pass. milliseconds = (message.milliseconds - 60000 * message.time_zone_offset) timezone = util.TimeZoneOffset(message.time_zone_offset) return datetime.datetime.fromtimestamp(milliseconds / 1000.0, tz=timezone) def value_to_message(self, value): value = super(DateTimeField, self).value_to_message(value) # First, determine the delta from the epoch, so we can fill in # DateTimeMessage's milliseconds field. if value.tzinfo is None: time_zone_offset = 0 local_epoch = datetime.datetime.fromtimestamp(0, tz=datetime.timezone.utc).replace(tzinfo=None) else: time_zone_offset = util.total_seconds( value.tzinfo.utcoffset(value)) # Determine Jan 1, 1970 local time. local_epoch = datetime.datetime.fromtimestamp(-time_zone_offset, tz=value.tzinfo) delta = value - local_epoch # Create and fill in the DateTimeMessage, including time zone if # one was specified. message = DateTimeMessage() message.milliseconds = int(util.total_seconds(delta) * 1000) if value.tzinfo is not None: utc_offset = value.tzinfo.utcoffset(value) if utc_offset is not None: message.time_zone_offset = int( util.total_seconds(value.tzinfo.utcoffset(value)) / 60) return message protorpclite/__init__.py 0000644 00000001265 15025317163 0011412 0 ustar 00 # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Shared __init__.py for apitools.""" from pkgutil import extend_path __path__ = extend_path(__path__, __name__) protorpclite/descriptor_test.py 0000644 00000041317 15025317163 0013072 0 ustar 00 #!/usr/bin/env python # # Copyright 2010 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # """Tests for apitools.base.protorpclite.descriptor.""" import platform import types import unittest import six from apitools.base.protorpclite import descriptor from apitools.base.protorpclite import message_types from apitools.base.protorpclite import messages from apitools.base.protorpclite import test_util RUSSIA = u'\u0420\u043e\u0441\u0441\u0438\u044f' class ModuleInterfaceTest(test_util.ModuleInterfaceTest, test_util.TestCase): MODULE = descriptor class DescribeEnumValueTest(test_util.TestCase): def testDescribe(self): class MyEnum(messages.Enum): MY_NAME = 10 expected = descriptor.EnumValueDescriptor() expected.name = 'MY_NAME' expected.number = 10 described = descriptor.describe_enum_value(MyEnum.MY_NAME) described.check_initialized() self.assertEqual(expected, described) class DescribeEnumTest(test_util.TestCase): def testEmptyEnum(self): class EmptyEnum(messages.Enum): pass expected = descriptor.EnumDescriptor() expected.name = 'EmptyEnum' described = descriptor.describe_enum(EmptyEnum) described.check_initialized() self.assertEqual(expected, described) def testNestedEnum(self): class MyScope(messages.Message): class NestedEnum(messages.Enum): pass expected = descriptor.EnumDescriptor() expected.name = 'NestedEnum' described = descriptor.describe_enum(MyScope.NestedEnum) described.check_initialized() self.assertEqual(expected, described) @unittest.skipIf('PyPy' in platform.python_implementation(), 'todo: reenable this') def testEnumWithItems(self): class EnumWithItems(messages.Enum): A = 3 B = 1 C = 2 expected = descriptor.EnumDescriptor() expected.name = 'EnumWithItems' a = descriptor.EnumValueDescriptor() a.name = 'A' a.number = 3 b = descriptor.EnumValueDescriptor() b.name = 'B' b.number = 1 c = descriptor.EnumValueDescriptor() c.name = 'C' c.number = 2 expected.values = [b, c, a] described = descriptor.describe_enum(EnumWithItems) described.check_initialized() self.assertEqual(expected, described) class DescribeFieldTest(test_util.TestCase): def testLabel(self): for repeated, required, expected_label in ( (True, False, descriptor.FieldDescriptor.Label.REPEATED), (False, True, descriptor.FieldDescriptor.Label.REQUIRED), (False, False, descriptor.FieldDescriptor.Label.OPTIONAL)): field = messages.IntegerField( 10, required=required, repeated=repeated) field.name = 'a_field' expected = descriptor.FieldDescriptor() expected.name = 'a_field' expected.number = 10 expected.label = expected_label expected.variant = descriptor.FieldDescriptor.Variant.INT64 described = descriptor.describe_field(field) described.check_initialized() self.assertEqual(expected, described) def testDefault(self): test_cases = ( (messages.IntegerField, 200, '200'), (messages.FloatField, 1.5, '1.5'), (messages.FloatField, 1e6, '1000000.0'), (messages.BooleanField, True, 'true'), (messages.BooleanField, False, 'false'), (messages.BytesField, b''.join([six.int2byte(x) for x in (31, 32, 33)]), b'\\x1f !'), (messages.StringField, RUSSIA, RUSSIA), ) for field_class, default, expected_default in test_cases: field = field_class(10, default=default) field.name = u'a_field' expected = descriptor.FieldDescriptor() expected.name = u'a_field' expected.number = 10 expected.label = descriptor.FieldDescriptor.Label.OPTIONAL expected.variant = field_class.DEFAULT_VARIANT expected.default_value = expected_default described = descriptor.describe_field(field) described.check_initialized() self.assertEqual(expected, described) def testDefault_EnumField(self): class MyEnum(messages.Enum): VAL = 1 module_name = test_util.get_module_name(MyEnum) field = messages.EnumField(MyEnum, 10, default=MyEnum.VAL) field.name = 'a_field' expected = descriptor.FieldDescriptor() expected.name = 'a_field' expected.number = 10 expected.label = descriptor.FieldDescriptor.Label.OPTIONAL expected.variant = messages.EnumField.DEFAULT_VARIANT expected.type_name = '%s.MyEnum' % module_name expected.default_value = '1' described = descriptor.describe_field(field) self.assertEqual(expected, described) def testMessageField(self): field = messages.MessageField(descriptor.FieldDescriptor, 10) field.name = 'a_field' expected = descriptor.FieldDescriptor() expected.name = 'a_field' expected.number = 10 expected.label = descriptor.FieldDescriptor.Label.OPTIONAL expected.variant = messages.MessageField.DEFAULT_VARIANT expected.type_name = ( 'apitools.base.protorpclite.descriptor.FieldDescriptor') described = descriptor.describe_field(field) described.check_initialized() self.assertEqual(expected, described) def testDateTimeField(self): field = message_types.DateTimeField(20) field.name = 'a_timestamp' expected = descriptor.FieldDescriptor() expected.name = 'a_timestamp' expected.number = 20 expected.label = descriptor.FieldDescriptor.Label.OPTIONAL expected.variant = messages.MessageField.DEFAULT_VARIANT expected.type_name = ( 'apitools.base.protorpclite.message_types.DateTimeMessage') described = descriptor.describe_field(field) described.check_initialized() self.assertEqual(expected, described) class DescribeMessageTest(test_util.TestCase): def testEmptyDefinition(self): class MyMessage(messages.Message): pass expected = descriptor.MessageDescriptor() expected.name = 'MyMessage' described = descriptor.describe_message(MyMessage) described.check_initialized() self.assertEqual(expected, described) def testDefinitionWithFields(self): class MessageWithFields(messages.Message): field1 = messages.IntegerField(10) field2 = messages.StringField(30) field3 = messages.IntegerField(20) expected = descriptor.MessageDescriptor() expected.name = 'MessageWithFields' expected.fields = [ descriptor.describe_field( MessageWithFields.field_by_name('field1')), descriptor.describe_field( MessageWithFields.field_by_name('field3')), descriptor.describe_field( MessageWithFields.field_by_name('field2')), ] described = descriptor.describe_message(MessageWithFields) described.check_initialized() self.assertEqual(expected, described) def testNestedEnum(self): class MessageWithEnum(messages.Message): class Mood(messages.Enum): GOOD = 1 BAD = 2 UGLY = 3 class Music(messages.Enum): CLASSIC = 1 JAZZ = 2 BLUES = 3 expected = descriptor.MessageDescriptor() expected.name = 'MessageWithEnum' expected.enum_types = [descriptor.describe_enum(MessageWithEnum.Mood), descriptor.describe_enum(MessageWithEnum.Music)] described = descriptor.describe_message(MessageWithEnum) described.check_initialized() self.assertEqual(expected, described) def testNestedMessage(self): class MessageWithMessage(messages.Message): class Nesty(messages.Message): pass expected = descriptor.MessageDescriptor() expected.name = 'MessageWithMessage' expected.message_types = [ descriptor.describe_message(MessageWithMessage.Nesty)] described = descriptor.describe_message(MessageWithMessage) described.check_initialized() self.assertEqual(expected, described) class DescribeFileTest(test_util.TestCase): """Test describing modules.""" def LoadModule(self, module_name, source): result = { '__name__': module_name, 'messages': messages, } exec(source, result) module = types.ModuleType(module_name) for name, value in result.items(): setattr(module, name, value) return module def testEmptyModule(self): """Test describing an empty file.""" module = types.ModuleType('my.package.name') expected = descriptor.FileDescriptor() expected.package = 'my.package.name' described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) def testNoPackageName(self): """Test describing a module with no module name.""" module = types.ModuleType('') expected = descriptor.FileDescriptor() described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) def testPackageName(self): """Test using the 'package' module attribute.""" module = types.ModuleType('my.module.name') module.package = 'my.package.name' expected = descriptor.FileDescriptor() expected.package = 'my.package.name' described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) def testMain(self): """Test using the 'package' module attribute.""" module = types.ModuleType('__main__') module.__file__ = '/blim/blam/bloom/my_package.py' expected = descriptor.FileDescriptor() expected.package = 'my_package' described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) def testMessages(self): """Test that messages are described.""" module = self.LoadModule('my.package', 'class Message1(messages.Message): pass\n' 'class Message2(messages.Message): pass\n') message1 = descriptor.MessageDescriptor() message1.name = 'Message1' message2 = descriptor.MessageDescriptor() message2.name = 'Message2' expected = descriptor.FileDescriptor() expected.package = 'my.package' expected.message_types = [message1, message2] described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) def testEnums(self): """Test that enums are described.""" module = self.LoadModule('my.package', 'class Enum1(messages.Enum): pass\n' 'class Enum2(messages.Enum): pass\n') enum1 = descriptor.EnumDescriptor() enum1.name = 'Enum1' enum2 = descriptor.EnumDescriptor() enum2.name = 'Enum2' expected = descriptor.FileDescriptor() expected.package = 'my.package' expected.enum_types = [enum1, enum2] described = descriptor.describe_file(module) described.check_initialized() self.assertEqual(expected, described) class DescribeFileSetTest(test_util.TestCase): """Test describing multiple modules.""" def testNoModules(self): """Test what happens when no modules provided.""" described = descriptor.describe_file_set([]) described.check_initialized() # The described FileSet.files will be None. self.assertEqual(descriptor.FileSet(), described) def testWithModules(self): """Test what happens when no modules provided.""" modules = [types.ModuleType('package1'), types.ModuleType('package1')] file1 = descriptor.FileDescriptor() file1.package = 'package1' file2 = descriptor.FileDescriptor() file2.package = 'package2' expected = descriptor.FileSet() expected.files = [file1, file1] described = descriptor.describe_file_set(modules) described.check_initialized() self.assertEqual(expected, described) class DescribeTest(test_util.TestCase): def testModule(self): self.assertEqual(descriptor.describe_file(test_util), descriptor.describe(test_util)) def testField(self): self.assertEqual( descriptor.describe_field(test_util.NestedMessage.a_value), descriptor.describe(test_util.NestedMessage.a_value)) def testEnumValue(self): self.assertEqual( descriptor.describe_enum_value( test_util.OptionalMessage.SimpleEnum.VAL1), descriptor.describe(test_util.OptionalMessage.SimpleEnum.VAL1)) def testMessage(self): self.assertEqual(descriptor.describe_message(test_util.NestedMessage), descriptor.describe(test_util.NestedMessage)) def testEnum(self): self.assertEqual( descriptor.describe_enum(test_util.OptionalMessage.SimpleEnum), descriptor.describe(test_util.OptionalMessage.SimpleEnum)) def testUndescribable(self): class NonService(object): def fn(self): pass for value in (NonService, NonService.fn, 1, 'string', 1.2, None): self.assertEqual(None, descriptor.describe(value)) class ModuleFinderTest(test_util.TestCase): def testFindMessage(self): self.assertEqual( descriptor.describe_message(descriptor.FileSet), descriptor.import_descriptor_loader( 'apitools.base.protorpclite.descriptor.FileSet')) def testFindField(self): self.assertEqual( descriptor.describe_field(descriptor.FileSet.files), descriptor.import_descriptor_loader( 'apitools.base.protorpclite.descriptor.FileSet.files')) def testFindEnumValue(self): self.assertEqual( descriptor.describe_enum_value( test_util.OptionalMessage.SimpleEnum.VAL1), descriptor.import_descriptor_loader( 'apitools.base.protorpclite.test_util.' 'OptionalMessage.SimpleEnum.VAL1')) class DescriptorLibraryTest(test_util.TestCase): def setUp(self): self.packageless = descriptor.MessageDescriptor() self.packageless.name = 'Packageless' self.library = descriptor.DescriptorLibrary( descriptors={ 'not.real.Packageless': self.packageless, 'Packageless': self.packageless, }) def testLookupPackage(self): self.assertEqual('csv', self.library.lookup_package('csv')) self.assertEqual( 'apitools.base.protorpclite', self.library.lookup_package('apitools.base.protorpclite')) def testLookupNonPackages(self): lib = 'apitools.base.protorpclite.descriptor.DescriptorLibrary' for name in ('', 'a', lib): self.assertRaisesWithRegexpMatch( messages.DefinitionNotFoundError, 'Could not find definition for %s' % name, self.library.lookup_package, name) def testNoPackage(self): self.assertRaisesWithRegexpMatch( messages.DefinitionNotFoundError, 'Could not find definition for not.real', self.library.lookup_package, 'not.real.Packageless') self.assertEqual(None, self.library.lookup_package('Packageless')) if __name__ == '__main__': unittest.main() __init__.py 0000644 00000001313 15025317163 0006656 0 ustar 00 #!/usr/bin/env python # # Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Shared __init__.py for apitools.""" from pkgutil import extend_path __path__ = extend_path(__path__, __name__)
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.03 |
proxy
|
phpinfo
|
Settings