a !f@K@sXdZddlmZddlmZddlmZddlmZGddde Z Gdd d e Z d S) zDefine API Subscriptions.)NotFound)topic_name_from_path)Policy)Messagec@seZdZdZdZd*ddZed+ddZedd Z ed d Z ed d Z d,ddZ ddZ d-ddZd.ddZd/ddZd0ddZd1ddZd2ddZd3d d!Zd4d"d#Zd5d$d%Zd6d&d'Zd7d(d)ZdS)8 SubscriptionaSubscriptions receive messages published to their topics. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions :type name: string :param name: the name of the subscription :type topic: :class:`gcloud.pubsub.topic.Topic` or ``NoneType`` :param topic: the topic to which the subscription belongs; if ``None``, the subscription's topic has been deleted. :type ack_deadline: int :param ack_deadline: the deadline (in seconds) by which messages pulled from the back-end must be acknowledged. :type push_endpoint: string :param push_endpoint: URL to which messages will be pushed by the back-end. If not set, the application must pull messages. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the topic. z_deleted-topic_NcCsb|dur|durtd|dur0|dur0td||_||_|pD|j|_|jj|_||_||_dS)Nz%Pass only one of 'topic' or 'client'.) TypeErrornametopic_clientprojectZ_project ack_deadline push_endpoint)selfrr r r clientr[/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/pubsub/subscription.py__init__8s  zSubscription.__init__c Cs|dur i}|d}||jkr$d}n0||}|durTt||j}||}||<|dd\}}}}|d} |di} | d} |dur||| | |dS|||| | S) aFactory: construct a topic given its API representation :type resource: dict :param resource: topic resource representation returned from the API :type client: :class:`gcloud.pubsub.client.Client` :param client: Client which holds credentials and project configuration for a topic. :type topics: dict or None :param topics: A mapping of topic names -> topics. If not passed, the subscription will have a newly-created topic. :rtype: :class:`gcloud.pubsub.subscription.Subscription` :returns: Subscription parsed from ``resource``. Nr r/ackDeadlineSeconds pushConfig pushEndpoint)r r r)_DELETED_TOPIC_PATHgetrr r split) clsresourcerZtopicsZ topic_pathr Z topic_name_rr push_configr rrr from_api_reprHs$      zSubscription.from_api_reprcCs|jjS)z"Project bound to the subscription.)r r rrrrr oszSubscription.projectcCsd|j|jfS)z.Fully-qualified name used in subscription APIszprojects/%s/subscriptions/%s)r rrrrr full_nametszSubscription.full_namecCs d|jfS)z$URL path for the subscription's APIsz/%s)r rrrrpathyszSubscription.pathFcCst||||S)aB:class:`AutoAck` factory :type return_immediately: boolean :param return_immediately: passed through to :meth:`Subscription.pull` :type max_messages: int :param max_messages: passed through to :meth:`Subscription.pull` :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: passed through to :meth:`Subscription.pull` and :meth:`Subscription.acknowledge`. :rtype: :class:`AutoAck` :returns: the instance created for the given ``ack_id`` and ``message`` )AutoAck)rreturn_immediately max_messagesrrrrauto_ack~szSubscription.auto_ackcCs|dur|j}|S)aCheck client or verify over-ride. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the topic of the current subscription. :rtype: :class:`gcloud.pubsub.client.Client` :returns: The client passed in or the currently bound client. N)r )rrrrr_require_clients zSubscription._require_clientcCs.||}|j}||j|jj|j|jdS)a2API call: create the subscription via a PUT request See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/create Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_create] :end-before: [END subscription_create] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. N)r'subscriber_apiZsubscription_creater r r r rrapirrrcreates  zSubscription.createcCs>||}|j}z||jWnty4YdS0dSdS)aAPI call: test existence of the subscription via a GET request See https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_exists] :end-before: [END subscription_exists] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. :rtype: bool :returns: Boolean indicating existence of the subscription. FTN)r'r(subscription_getr rr)rrrexistss  zSubscription.existscCsD||}|j}||j}|d|_|di}|d|_dS)a<API call: sync local subscription configuration via a GET request See https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_reload] :end-before: [END subscription_reload] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. rrrN)r'r(r,r rr r )rrr*datarrrrreloads     zSubscription.reloadcCs ||}|j}||jdS)a6API call: delete the subscription via a DELETE request. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/delete Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_delete] :end-before: [END subscription_delete] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. N)r'r(Zsubscription_deleter r)rrrdeletes zSubscription.deletecCs(||}|j}||j|||_dS)aAPI call: update the push endpoint for the subscription. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_push_pull] :end-before: [END subscription_push_pull] .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_pull_push] :end-before: [END subscription_pull_push] :type push_endpoint: string :param push_endpoint: URL to which messages will be pushed by the back-end. If None, the application must pull messages. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. N)r'r(Zsubscription_modify_push_configr r )rr rr*rrrmodify_push_configurations z&Subscription.modify_push_configurationcCs.||}|j}||j||}dd|DS)aAPI call: retrieve messages for the subscription. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/pull Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_pull] :end-before: [END subscription_pull] :type return_immediately: boolean :param return_immediately: if True, the back-end returns even if no messages are available; if False, the API call blocks until one or more messages are available. :type max_messages: int :param max_messages: the maximum number of messages to return. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. :rtype: list of (ack_id, message) tuples :returns: sequence of tuples: ``ack_id`` is the ID to be used in a subsequent call to :meth:`acknowledge`, and ``message`` is an instance of :class:`gcloud.pubsub.message.Message`. cSs"g|]}|dt|dfqS)ZackIdmessage)rr).0inforrr <sz%Subscription.pull..)r'r(Zsubscription_pullr )rr$r%rr*responserrrpulls zSubscription.pullcCs"||}|j}||j|dS)aAPI call: acknowledge retrieved messages for the subscription. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/acknowledge Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_acknowledge] :end-before: [END subscription_acknowledge] :type ack_ids: list of string :param ack_ids: ack IDs of messages being acknowledged :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. N)r'r(Zsubscription_acknowledger )rack_idsrr*rrr acknowledge?s zSubscription.acknowledgecCs$||}|j}||j||dS)akAPI call: update acknowledgement deadline for a retrieved message. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyAckDeadline :type ack_ids: list of string :param ack_ids: ack IDs of messages being updated :type ack_deadline: int :param ack_deadline: new deadline for the message, in seconds :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. N)r'r(Z subscription_modify_ack_deadliner )rr8r rr*rrrmodify_ack_deadlineVs  z Subscription.modify_ack_deadlinecCs&||}|j}||j}t|S)aFetch the IAM policy for the subscription. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/getIamPolicy Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_get_iam_policy] :end-before: [END subscription_get_iam_policy] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. :rtype: :class:`gcloud.pubsub.iam.Policy` :returns: policy created from the resource returned by the ``getIamPolicy`` API request. )r'iam_policy_apiget_iam_policyr rr)rrr*resprrrr<ks  zSubscription.get_iam_policycCs0||}|j}|}||j|}t|S)aUpdate the IAM policy for the subscription. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/setIamPolicy Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_set_iam_policy] :end-before: [END subscription_set_iam_policy] :type policy: :class:`gcloud.pubsub.iam.Policy` :param policy: the new policy, typically fetched via :meth:`get_iam_policy` and updated in place. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. :rtype: :class:`gcloud.pubsub.iam.Policy` :returns: updated policy created from the resource returned by the ``setIamPolicy`` API request. )r'r;Z to_api_reprset_iam_policyr rr)rpolicyrr*rr=rrrr>s  zSubscription.set_iam_policycCs"||}|j}||jt|S)a/Verify permissions allowed for the current user. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/testIamPermissions Example: .. literalinclude:: pubsub_snippets.py :start-after: [START subscription_check_iam_permissions] :end-before: [END subscription_check_iam_permissions] :type permissions: list of string :param permissions: list of permissions to be tested :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current subscription's topic. :rtype: sequence of string :returns: subset of ``permissions`` allowed by current IAM policy. )r'r;Ztest_iam_permissionsr list)rZ permissionsrr*rrrcheck_iam_permissionss   z"Subscription.check_iam_permissions)NNNN)N)Fr"N)N)N)N)N)N)Fr"N)N)N)N)N)N)__name__ __module__ __qualname____doc__rr classmethodrpropertyr r r!r&r'r+r-r/r0r1r7r9r:r<r>rArrrrrs4  &          %    rcs2eZdZdZd fdd ZddZd d ZZS) r#a|Wrapper for :meth:`Subscription.pull` results. Mapping, tracks messages still-to-be-acknowledged. When used as a context manager, acknowledges all messages still in the mapping on `__exit__`. When processing the pulled messsages, application code MUST delete messages from the :class:`AutoAck` mapping which are not successfully processed, e.g.: .. code-block: python with AutoAck(subscription) as ack: # calls ``subscription.pull`` for ack_id, message in ack.items(): try: do_something_with(message): except: del ack[ack_id] :type subscription: :class:`Subscription` :param subscription: subcription to be pulled. :type return_immediately: boolean :param return_immediately: passed through to :meth:`Subscription.pull` :type max_messages: int :param max_messages: passed through to :meth:`Subscription.pull` :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: passed through to :meth:`Subscription.pull` and :meth:`Subscription.acknowledge`. Fr"Ncs*tt|||_||_||_||_dSN)superr#r _subscription_return_immediately _max_messagesr )rZ subscriptionr$r%r __class__rrrs zAutoAck.__init__cCs$|j|j|j|j}|||SrH)rJr7rKrLr update)ritemsrrr __enter__s   zAutoAck.__enter__cCs|jt||jdSrH)rJr9r@r )rexc_typeexc_valexc_tbrrr__exit__szAutoAck.__exit__)Fr"N)rBrCrDrErrQrU __classcell__rrrMrr#s  r#N) rEZgcloud.exceptionsrZgcloud.pubsub._helpersrZgcloud.pubsub.iamrZgcloud.pubsub.messagerobjectrdictr#rrrrs    *