File: //proc/thread-self/root/lib/python3/dist-packages/launchpadlib/__pycache__/launchpad.cpython-38.pyc
U
��^�n � @ s� d Z eZdgZddlZddlZzddlmZ W n ddlmZ Y nX ddl Z zddl
m Z W n& e k
r� ddl
m
Z
e
jZ Y nX ddlmZmZmZmZ ddlmZ dd lmZ dd
lmZmZmZm Z m Z m Z m Z m Z m!Z! dd l"m#Z# dd l$m%Z%m&Z& d
Z'G dd� de�Z(G dd� de�Z)G dd� de�Z*G dd� de*�Z+G dd� de*�Z,G dd� de*�Z-G dd� de�Z.G d d� de�Z/dS ) zRoot Launchpad API class.� Launchpad� N)�urlsplit)�proxy_info_from_environment)� ProxyInfo)� CollectionWithKeyBasedLookup�
HostedFile� ScalarValue� ServiceRoot)�SystemWideConsumer)� RestfulHttp) � AccessToken�AnonymousAccessToken� AuthorizeRequestTokenWithBrowser� AuthorizeRequestTokenWithURL�Consumer� Credentials�MemoryCredentialStore�KeyringCredentialStore� UnencryptedFileCredentialStore)�uris)�STAGING_SERVICE_ROOT�EDGE_SERVICE_ROOTzhttps://api.launchpad.netc @ s e Zd ZdZdd� ZdZdS )� PersonSetz7A custom subclass capable of person lookup by username.c C s t | jj�� �d t |� S )z7Transform a username into the URL to a person resource.�~��strZ_rootZ _root_uriZ ensureSlash��self�key� r �8/usr/lib/python3/dist-packages/launchpadlib/launchpad.py�_get_url_from_idD s zPersonSet._get_url_from_idZteamN��__name__�
__module__� __qualname__�__doc__r! �
collection_ofr r r r r A s r c @ s e Zd ZdZdd� ZdZdS )�BugSetz2A custom subclass capable of bug lookup by bug ID.c C s t | jj�� �d t |� S )z2Transform a bug ID into the URL to a bug resource.zbugs/r r r r r r! Q s zBugSet._get_url_from_idZbugNr" r r r r r( N s r( c @ s e Zd ZdZdd� ZdZdS )� PillarSetzzA custom subclass capable of lookup by pillar name.
Projects, project groups, and distributions are all pillars.
c C s t | jj�� �t |� S )z<Transform a project name into the URL to a project resource.r r r r r r! ^ s zPillarSet._get_url_from_idNr" r r r r r) X s r) c @ s e Zd ZdZdZdS )�
ProjectSetz;A custom subclass for accessing the collection of projects.ZprojectN�r# r$ r% r& r' r r r r r* g s r* c @ s e Zd ZdZdZdS )�ProjectGroupSet�AA custom subclass for accessing the collection of project groups.Z
project_groupNr+ r r r r r, m s r, c @ s e Zd ZdZdZdS )�DistributionSetr- Z distributionNr+ r r r r r. s s r. c s< e Zd ZdZ� fdd�Zdd� Z� fdd�Zdd � Z� ZS )
�LaunchpadOAuthAwareHttpzBDetects expired/invalid OAuth tokens and tries to get a new token.c s || _ || _tt| �j|� d S �N)� launchpad�authorization_engine�superr/ �__init__)r r1 r2 �args�� __class__r r r4 | s z LaunchpadOAuthAwareHttp.__init__c C s( |j dko&|�d�p&|�d�p&|�d�S )z=Helper method to detect an error caused by a bad OAuth token.i� s
Expired tokens
Invalid tokens Unknown access token)Zstatus�
startswith)r �response�contentr r r �_bad_oauth_token� s
��z(LaunchpadOAuthAwareHttp._bad_oauth_tokenc s& t t| �j|� \}}| j||f|�� S r0 )r3 r/ �_request�retry_on_bad_token)r r5 r9 r: r6 r r r< � s ��z LaunchpadOAuthAwareHttp._requestc G sF | � ||�r>| jdk r>d| jj_| �| jj| jj� | j|� S ||fS )zxIf the response indicates a bad token, get a new token and retry.
Otherwise, just return the response.
N)r; r2 r1 � credentials� access_token�credential_storer< )r r9 r: r5 r r r r= � s �
�
z*LaunchpadOAuthAwareHttp.retry_on_bad_token) r# r$ r% r& r4 r; r< r= �
__classcell__r r r6 r r/ y s
r/ c s: e Zd ZdZdZeeeee d�Z
e
� e j
� e
jddeef� fdd� Zdd� Zed d
� �Zed d � �Zed
d� �Zee
jddedddddef
dd��Zee
jddedg dddef
dd��Zedd� �Zee
jddeefdd��Zede
jddeddddedddf
dd��Zedd� �Zed d d ��Z ed!d d ��Z � Z S )"r z�Root Launchpad API class.
:ivar credentials: The credentials instance used to access Launchpad.
:type credentials: `Credentials`
z1.0)ZbugsZ
distributionsZpeopleZproject_groupsZprojectsNc
s\ t �|�}|�|�s"|�|d �r2d| } t| ��|| _|| _tt| ��||||||� dS )ar Root access to the Launchpad API.
:param credentials: The credentials used to access Launchpad.
:type credentials: `Credentials`
:param authorization_engine: The object used to get end-user input
for authorizing OAuth request tokens. Used when an OAuth
access token expires or becomes invalid during a
session, or is discovered to be invalid once launchpadlib
starts up.
:type authorization_engine: `RequestTokenAuthorizationEngine`
:param service_root: The URL to the root of the web service.
:type service_root: string
�/z�It looks like you're using a service root that incorporates the name of the web service version ("%s"). Please use one of the constants from launchpadlib.uris instead, or at least remove the version name from the root URI.N) r �lookup_service_root�endswith�
ValueErrorr@ r2 r3 r r4 )
r r> r2 r@ � service_root�cache�timeout�
proxy_info�version�errorr6 r r r4 � s$
��
�zLaunchpad.__init__c C s t | | j||||�S r0 )r/ r2 )r r> rG rH rI r r r � httpFactory� s �zLaunchpad.httpFactoryc C s t dddg�t tj�� �@ S )NZ SUDO_USERZSUDO_UIDZSUDO_GID)�set�os�environ�keys)�clsr r r �_is_sudo� s �zLaunchpad._is_sudoc G s | � � rt|� S t|� S r0 )rR r r )rQ r5 r r r � authorization_engine_factory� s z&Launchpad.authorization_engine_factoryc C s | � � rt|�S t|dd�S )NT)Zfallback)rR r r )rQ �credential_save_failedr r r �credential_store_factory� s z"Launchpad.credential_store_factoryc C s^ | � d� t||�}t||d�}|dkr6| �||| �}| dkrH| �| �} | ||| |||||
�S )a Convenience method for setting up access credentials.
When all three pieces of credential information (the consumer
name, the access token and the access secret) are available, this
method can be used to quickly log into the service root.
This method is deprecated as of launchpadlib version
1.9.0. You should use Launchpad.login_anonymously() for
anonymous access, and Launchpad.login_with() for all other
purposes.
:param consumer_name: the application name.
:type consumer_name: string
:param token_string: the access token, as appropriate for the
`AccessToken` constructor
:type token_string: string
:param access_secret: the access token's secret, as appropriate for
the `AccessToken` constructor
:type access_secret: string
:param service_root: The URL to the root of the web service.
:type service_root: string
:param authorization_engine: See `Launchpad.__init__`. If you don't
provide an authorization engine, a default engine will be
constructed using your values for `service_root` and
`credential_save_failed`.
:param allow_access_levels: This argument is ignored, and only
present to preserve backwards compatibility.
:param max_failed_attempts: This argument is ignored, and only
present to preserve backwards compatibility.
:return: The web service root
:rtype: `Launchpad`
�login)�
consumer_namer? N)� _warn_of_deprecated_login_methodr r rS rU )rQ rW Z token_stringZ
access_secretrF rG rH rI r2 �allow_access_levels�max_failed_attemptsr@ rT rJ r? r> r r r rV � s. '
� �� �zLaunchpad.loginc C s& | � d� | �|||||||| |
| �
S )a� Get credentials from Launchpad and log into the service root.
This method is deprecated as of launchpadlib version
1.9.0. You should use Launchpad.login_anonymously() for
anonymous access and Launchpad.login_with() for all other
purposes.
:param consumer_name: Either a consumer name, as appropriate for
the `Consumer` constructor, or a premade Consumer object.
:type consumer_name: string
:param service_root: The URL to the root of the web service.
:type service_root: string
:param authorization_engine: See `Launchpad.__init__`. If you don't
provide an authorization engine, a default engine will be
constructed using your values for `service_root` and
`credential_save_failed`.
:param allow_access_levels: This argument is ignored, and only
present to preserve backwards compatibility.
:return: The web service root
:rtype: `Launchpad`
�get_token_and_login)rX �_authorize_token_and_login) rQ rW rF rG rH rI r2 rY rZ r@ rT rJ r r r r[ & s
�z Launchpad.get_token_and_loginc C s� t |t�r|} nt|�} td�} | | _|dkr>| �||d|�}|dkrR| �| �}n| �d| |jd� |� |j
�}
|
dkr�|| |�} n|
} |j | j_ | | |||||||
�S )aE Authorize a request token. Log in with the resulting access token.
This is the private, non-deprecated implementation of the
deprecated method get_token_and_login(). Once
get_token_and_login() is removed, this code can be streamlined
and moved into its other call site, login_with().
NrT r@ ) �
isinstancer r
r �consumerrS rU �"_assert_login_argument_consistencyrT �loadZunique_consumer_id�application_name)rQ rW rF rG rH rI r2 rY r@ rT rJ r^ r> Zcached_credentialsr r r r\ I sJ
�� �� � �z$Launchpad._authorize_token_and_loginc
C s> | � ||�\}}}}t� } t|| d�}
| |
dd|||||d�S )z:Get access to Launchpad without providing any credentials.)r? N)rF rG rH rI rJ )�
_get_pathsr
r ) rQ rW rF �launchpadlib_dirrH rI rJ �
cache_path�service_root_dir�tokenr> r r r �login_anonymously� s
�
�zLaunchpad.login_anonymouslyc C s� | � ||�\}}}}|dkr4| dkr4|dkr4td��| dk rL|
dk rLtd��|
dkrt| dk rht| | �}
q�| �| �}
n| �d| |
jd� |
}
|dkr�| �||| |�}n2| �d||j� | �d| |jj � | �d||j
� | � |j|||||||
| |
�
S ) a� Log in to Launchpad, possibly acquiring and storing credentials.
Use this method to get a `Launchpad` object. If the end-user
has no cached Launchpad credential, their browser will open
and they'll be asked to log in and authorize a desktop
integration. The authorized Launchpad credential will be
stored securely: in the GNOME keyring, the KDE Wallet, or in
an encrypted file on disk.
The next time your program (or any other program run by that
user on the same computer) invokes this method, the end-user
will be prompted to unlock their keyring (or equivalent), and
the credential will be retrieved from local storage and
reused.
You can customize this behavior in three ways:
1. Pass in a filename to `credentials_file`. The end-user's
credential will be written to that file, and on subsequent
runs read from that file.
2. Subclass `CredentialStore` and pass in an instance of the
subclass as `credential_store`. This lets you change how
the end-user's credential is stored and retrieved locally.
3. Subclass `RequestTokenAuthorizationEngine` and pass in an
instance of the subclass as `authorization_engine`. This
lets you change change what happens when the end-user needs
to authorize the Launchpad credential.
:param application_name: The application name. This is *not*
the OAuth consumer name. Unless a consumer_name is also
provided, the OAuth consumer will be a system-wide
consumer representing the end-user's computer as a whole.
:type application_name: string
:param service_root: The URL to the root of the web service.
:type service_root: string. Can either be the full URL to a service
or one of the short service names.
:param launchpadlib_dir: The directory used to store cached
data obtained from Launchpad. The cache is shared by all
consumers, and each Launchpad service root has its own
cache.
:type launchpadlib_dir: string
:param authorization_engine: A strategy for getting the
end-user to authorize an OAuth request token, for
exchanging the request token for an access token, and for
storing the access token locally so that it can be
reused. By default, launchpadlib will open the end-user's
web browser to have them authorize the request token.
:type authorization_engine: `RequestTokenAuthorizationEngine`
:param allow_access_levels: The acceptable access levels for
this application.
This argument is used to construct the default
`authorization_engine`, so if you pass in your own
`authorization_engine` any value for this argument will be
ignored. This argument will also be ignored unless you
also specify `consumer_name`.
:type allow_access_levels: list of strings
:param max_failed_attempts: Ignored; only present for
backwards compatibility.
:param credentials_file: The path to a file in which to store
this user's OAuth access token.
:param version: The version of the Launchpad web service to use.
:param consumer_name: The consumer name, as appropriate for
the `Consumer` constructor. You probably don't want to
provide this, since providing it will prevent you from
taking advantage of desktop-wide integration.
:type consumer_name: string
:param credential_save_failed: a callback that is called upon
a failure to save the credentials locally. This argument is
used to construct the default `credential_store`, so if
you pass in your own `credential_store` any value for
this argument will be ignored.
:type credential_save_failed: A callable
:param credential_store: A strategy for storing an OAuth
access token locally. By default, tokens are stored in the
GNOME keyring (or equivalent). If `credentials_file` is
provided, then tokens are stored unencrypted in that file.
:type credential_store: `CredentialStore`
:return: A web service root authorized as the end-user.
:rtype: `Launchpad`
NzZAt least one of application_name, consumer_name, or authorization_engine must be provided.zFAt most one of credentials_file and credential_store must be provided.rT r@ ra rW rY ) rb rE r rU r_ rT rS ra r^ r rY r\ )rQ ra rF rc rH rI r2 rY rZ Zcredentials_filerJ rW rT r@ rd re r r r �
login_with� s~ i
���� �� � � � � � �zLaunchpad.login_withc C s t �d| t� d S )Nz�The Launchpad.%s() method is deprecated. You should use Launchpad.login_anonymous() for anonymous access and Launchpad.login_with() for all other purposes.)�warnings�warn�DeprecationWarning)rQ �namer r r rX : s ��z*Launchpad._warn_of_deprecated_login_method�authorization enginec C s0 d}|dk r,||kr,t |||||||f ��dS )a� Helper to find conflicting values passed into the login methods.
Many of the arguments to login_with are used to build other
objects--the authorization engine or the credential store. If
these objects are provided directly, many of the arguments
become redundant. We'll allow redundant arguments through, but
if a argument *conflicts* with the corresponding value in the
provided object, we raise an error.
z�Inconsistent values given for %s: (%r passed in, versus %r in %s). You don't need to pass in %s if you pass in %s, so just omit that argument.N)rE )rQ Z
argument_nameZargument_valueZ object_valueZ object_nameZinconsistent_value_messager r r r_ B s � �z,Launchpad._assert_login_argument_consistencyc
C s |dkrt j�dd�}t j�|�}|dd� dkr:td��zt �|d� W n0 tk
rz } z|jtjkrj� W 5 d}~X Y nX t � |d� t
� |�}t |�\}}}}}t j�||�} t j�| d�}
zt �|
d� W n2 tk
�r } z|jtjkr� W 5 d}~X Y nX |||
| fS )a� Locate launchpadlib-related user paths and ensure they exist.
This is a helper function used by login_with() and
login_anonymously().
:param service_root: The service root the user wants to
connect to. This may be an alias (which will be
dereferenced to a URL and returned) or a URL (which will
be returned as is).
:param launchpadlib_dir: The user's base launchpadlib
directory, if known. This may be modified, expanded, or
determined from the environment if missing. A definitive
value will be returned.
:return: A 4-tuple:
(service_root_uri, launchpadlib_dir, cache_dir, service_root_dir)
Nr z
.launchpadlib� zSMust set $HOME or pass 'launchpadlib_dir' to indicate location to store cached datai� rG )
rN �path�join�
expanduserrE �makedirs�OSError�errnoZEEXIST�chmodr rC r ) rQ rF rc �errZschemeZ host_namero ZqueryZfragmentre rd r r r rb Z s*
zLaunchpad._get_paths)rm )N) r# r$ r% r& ZDEFAULT_VERSIONr( r. r r, r* ZRESOURCE_TYPE_CLASSES�updater r r r r4 rL � classmethodrR rS rU rV r[ r\ rg rh rX r_ rb rA r r r6 r r � s� � �%
� 3 � "
< �
� &
� )0r& �typeZ
__metaclass__�__all__rt rN Z urllib.parser Zurlparseri Zhttplib2r � ImportErrorr Zfrom_environmentZlazr.restfulclient.resourcer r r r Z"lazr.restfulclient.authorize.oauthr
Zlazr.restfulclient._browserr Zlaunchpadlib.credentialsr r
r r r r r r r Z launchpadlibr Zlaunchpadlib.urisr r Z OAUTH_REALMr r( r) r* r, r. r/ r r r r r �<module> s< � ,
$