U ڲg\@sUdZddlmZddlZddlZddlmZmZmZm Z ddl m Z m Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZmZmZddlmZmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'm(Z(m)Z)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4e r\ddl5m6Z6m7Z7ddl8m9Z9e*dZ:ej;jj?Z?ej>j@Z@ejAjBZBejAjCZCejAjDZDejEjFZFejEjGZGe2HZIeJdZKGdddeZLdeL_MeejNgdfZOdePd <eeLgdfZQdePd!<Gd"d#d#ee!ZRdS)$z psycopg connection objects ) annotationsN)CallableGeneric NamedTuple TYPE_CHECKING)ref ReferenceType)warn)partial)pq)errors)postgres) generators)PQGen PQGenConnQuery) ComposableSQL)Xid)Row) AdaptersMap)IsolationLevel) LiteralStringSelf TypeAliasTypeVar)connection_summary) BasePipeline)PrepareManager) capabilities)ConnectionInfo)PGconnPGresult)BasePool CursorRowZpsycopgc@s*eZdZUdZded<ded<ded<dS)Notifyz8An asynchronous notification received from the database.strZchannelpayloadintpidN)__name__ __module__ __qualname____doc____annotations__r0r0dd?d@Z&dddAdBZ'd ddCdDZ(dEdFdGdHdIZ)dJddKdLdMZ*dJddKdNdOZ+e,dPdQddRdSdTZ-dUddKdVdWZ.dUddKdXdYZ/e,dPdZdd[d\d]Z0ed^dd_d`Z1e1jd^dddad`Z1ed^ddbdcZ2e2jd^dddddcZ2e3ddfdgd dEdhdidjdkZ4e5fdldmdndodpdqZ6drddsdtduZ7dddvdwZ8dddxdyZ9dzdd{d|Z:ddd}d~Z;ddddZd d ddddZ=dddddZ>ddddZ?ddddddZ@ddddZAdS)BaseConnectionz Base class for different types of connections. Share common functionalities such as access to the wrapped PGconn, but allow different interfaces (sync/async). r")pgconncCs||_d|_d|_g|_g|_d|_d|_t|_d|_ t |}t t j ||_t t j||_|d|_|d|_d|_d|_d|_dS)NFr)r5 _autocommit _adapters_notice_handlers_notify_handlers_num_transactions_closedr _prepared_tpcrr r4_notice_handlerZnotice_handler_notify_handlerZnotify_handler _pipeline_isolation_level _read_only _deferrable_begin_statement)selfr5wselfr0r0r1__init__bs&zBaseConnection.__init__None)returncCs<t|dsdS|jrdSt|dr&dStd|dtdS)Nr5_poolz connection zV was deleted while still open. Please use 'with' or '.close()' to close the connection)hasattrclosedr ResourceWarningrFr0r0r1__del__s   zBaseConnection.__del__r'cCs>|jjd|jj}t|j}d|d|dt|ddS)N.< z at 0xx>) __class__r,r-rr5id)rFclsinfor0r0r1__repr__s zBaseConnection.__repr__boolcCs |jjtkS)z$`!True` if the connection is closed.)r5statusBADrOr0r0r1rMszBaseConnection.closedcCs|jjtko|j S)z `!True` if the connection was interrupted. A broken connection is always `closed`, but wasn't closed in a clean way, such as using `close()` or a `!with` block. )r5r\r]r<rOr0r0r1brokenszBaseConnection.brokencCs|jS)z'The autocommit state of the connection.)r7rOr0r0r1 autocommitszBaseConnection.autocommit)valuerJcCs||dSN)_set_autocommitrFr`r0r0r1r_scCstdSraNotImplementedErrorrcr0r0r1rbszBaseConnection._set_autocommitz PQGen[None]ccs|dEdHt||_dS)Nr_)_check_intrans_genr[r7rcr0r0r1_set_autocommit_gensz"BaseConnection._set_autocommit_genzIsolationLevel | NonecCs|jS)zX The isolation level of the new transactions started on the connection. )rBrOr0r0r1isolation_levelszBaseConnection.isolation_levelcCs||dSra)_set_isolation_levelrcr0r0r1rhscCstdSrardrcr0r0r1risz#BaseConnection._set_isolation_levelccs0|dEdH|dk r t|nd|_d|_dS)Nrhr6)rfrrBrErcr0r0r1_set_isolation_level_gensz'BaseConnection._set_isolation_level_genz bool | NonecCs|jS)zX The read-only state of the new transactions started on the connection. )rCrOr0r0r1 read_onlyszBaseConnection.read_onlycCs||dSra)_set_read_onlyrcr0r0r1rkscCstdSrardrcr0r0r1rlszBaseConnection._set_read_onlyccs0|dEdH|dk r t|nd|_d|_dS)Nrkr6)rfr[rCrErcr0r0r1_set_read_only_gensz!BaseConnection._set_read_only_gencCs|jS)zY The deferrable state of the new transactions started on the connection. )rDrOr0r0r1 deferrableszBaseConnection.deferrablecCs||dSra)_set_deferrablercr0r0r1rnscCstdSrardrcr0r0r1roszBaseConnection._set_deferrableccs0|dEdH|dk r t|nd|_d|_dS)Nrnr6)rfr[rDrErcr0r0r1_set_deferrable_gensz"BaseConnection._set_deferrable_gen) attributerJccsr|jj}|tkr.|jr.|jEdH|jj}|tkrn|jrPtd|dntd|dt |j dS)Nz can't change z2 now: connection.transaction() context in progressz' now: connection in transaction status ) r5transaction_statusIDLErA _sync_genr;eProgrammingErrorr TransactionStatusname)rFrqr\r0r0r1rfs z!BaseConnection._check_intrans_genr!cCs t|jS)z>A `ConnectionInfo` attribute to inspect connection properties.)r!r5rOr0r0r1rYszBaseConnection.inforcCs|jsttj|_|jSra)r8rradaptersrOr0r0r1ry s zBaseConnection.adapterszBaseConnection[Row]cCs|Srar0rOr0r0r1 connectionszBaseConnection.connectionr)cCs|jjS)zReturn the file descriptor of the connection. This function allows to use the connection as file-like object in functions waiting for readiness, such as the ones defined in the `selectors` module. )r5socketrOr0r0r1filenoszBaseConnection.filenocCs|r|j}|dS)z/Cancel the current operation on the connection.N)_should_cancelr5Z get_cancelcancel)rFcr0r0r1r~"s zBaseConnection.cancelcCs(|jr dS|jr$|jdr$tddS)zhCheck whether the current command should actually be cancelled when invoking cancel*(). Fr z=cancel() cannot be used with a prepared two-phase transactionT)rMr>rurvrOr0r0r1r}(szBaseConnection._should_cancelfloatzPQGenConn[None])timeoutrJccs*|j}|tj||dEdHdS)Nr)r5 cancel_connstartrr~)rFrrr0r0r1 _cancel_gen7s zBaseConnection._cancel_genr2)callbackrJcCs|j|dS)z Register a callable to be invoked when a notice message is received. :param callback: the callback to call upon message received. :type callback: Callable[[~psycopg.errors.Diagnostic], None] N)r9appendrFrr0r0r1add_notice_handler<sz!BaseConnection.add_notice_handlercCs|j|dS)z Unregister a notice message callable previously registered. :param callback: the callback to remove. :type callback: Callable[[~psycopg.errors.Diagnostic], None] N)r9removerr0r0r1remove_notice_handlerEsz$BaseConnection.remove_notice_handlerz"ReferenceType[BaseConnection[Row]]r#)rGresrJc Csr|}|r|jsdSt||jj}|jD]B}z ||Wq*tk rj}ztd||W5d}~XYq*Xq*dS)Nz)error processing notice callback '%s': %s)r9ru Diagnosticr5 _encoding Exceptionlogger exception)rGrrFZdiagcbexr0r0r1r?Ns   zBaseConnection._notice_handlerr3cCs|j|dS)z Register a callable to be invoked whenever a notification is received. :param callback: the callback to call upon notification received. :type callback: Callable[[~psycopg.Notify], None] N)r:rrr0r0r1add_notify_handler]sz!BaseConnection.add_notify_handlercCs|j|dS)z Unregister a notification callable previously registered. :param callback: the callback to remove. :type callback: Callable[[~psycopg.Notify], None] N)r:rrr0r0r1remove_notify_handlerfsz$BaseConnection.remove_notify_handlerz pq.PGnotify)rGpgnrJcCsR|}|r|jsdS|jj}t|j||j||j}|jD] }||q@dSra)r:r5rr&ZrelnamedecodeextraZbe_pid)rGrrFencnrr0r0r1r@os  zBaseConnection._notify_handlerz int | NonecCs|jjS)a& Number of times a query is executed before it is prepared. - If it is set to 0, every query is prepared the first time it is executed. - If it is set to `!None`, prepared statements are disabled on the connection. Default value: 5 r=prepare_thresholdrOr0r0r1r|s z BaseConnection.prepare_thresholdcCs ||j_dSrarrcr0r0r1rscCs|jj}|tjkr|SdS)z Maximum number of prepared statements on the connection. `!None` means no max number of prepared statements. The default value is 100. N)r= prepared_maxsysmaxsize)rFrvr0r0r1rszBaseConnection.prepared_maxcCs|dkrtj}||j_dSra)rrr=rrcr0r0r1rsgrzPQGenConn[Self])conninforrJccs tj||dEdH}||}|S)z?Generator to connect to the database and create a new instance.rN)rconnect)rXrrr5connr0r0r1 _connect_genszBaseConnection._connect_genrz pq.FormatzPQGen[PGresult | None])command result_formatrJccs |t|tr"||jj}nt|tr6||}|jrpt |jj |d|d}|jj ||jj ddS|tkr|j|n|jj |d|dt|jEdHd}|jtkr|jtkr|jtkrtj||jjdn$tdt|jjd||S)z Generator to send a command and receive the result to the backend. Only used to implement internal commands such as "commit", with eventual arguments bound client-side. The cursor can do more complex stuff. N)rencodingunexpected result z from command )_check_connection_ok isinstancer'encoder5rras_bytesrAr Zsend_query_params command_queuer result_queueTEXTZ send_queryrexecuter\ COMMAND_OK TUPLES_OK FATAL_ERRORruerror_from_resultInterfaceErrorr ExecStatusrxr)rFrrcmdresultr0r0r1 _exec_commands4     zBaseConnection._exec_commandz bytes | None)rxrJccs|dks ts4|dk rd|nd}||EdHdS||jrpt|jj|}|jj||jj ddS|j|t |jEdHd}|j t kr|j tkrtj||jjdntdt|j jddS)ae Deallocate one, or all, prepared statement in the session. ``name == None`` stands for DEALLOCATE ALL. If possible, use protocol-level commands; otherwise use SQL statements. Note that PgBouncer doesn't support DEALLOCATE name, but it supports protocol-level Close from 1.21 and DEALLOCATE ALL from 1.22. Ns DEALLOCATE sDEALLOCATE ALLrrrz0 from sending closing prepared statement message)_HAS_SEND_CLOSErrrAr r5Zsend_close_preparedrrrrrr\rrrurrrr rrx)rFrxZstmtrrr0r0r1 _deallocates*    zBaseConnection._deallocatecCs>|jjtkrdS|jjtkr&tdtd|jjdS)Nzthe connection is closedz7cannot execute operations: the connection is in status )r5r\OKr]ruOperationalErrorrrOr0r0r1rs    z#BaseConnection._check_connection_okccsH|jr dS|jjtkrdS||EdH|jrD|jEdHdS)z.Generator to start a transaction if necessary.N)r7r5rrrsr_get_tx_start_commandrArtrOr0r0r1 _start_querys zBaseConnection._start_querybytescCs|jr |jSdg}|jdk rHt|j}|d||jdd|jdk rf||jr`dnd|jdk r||jr~dndd ||_|jS) NsBEGINsISOLATION LEVEL_rSs READ ONLYs READ WRITEs DEFERRABLEsNOT DEFERRABLE ) rErhrrrxreplacerrkrnjoin)rFpartsvalr0r0r1rs      z$BaseConnection._get_tx_start_commandccsZ|jrtd|jr td|jjtkr0dS|dEdH|jrV|j EdHdS)z-Generator implementing `Connection.commit()`.zExplicit commit() forbidden within a Transaction context. (Transaction will be automatically committed on successful exit from context.)z6commit() cannot be used during a two-phase transactionNsCOMMIT) r;rurvr>r5rrrsrrArtrOr0r0r1 _commit_gen2s zBaseConnection._commit_genccs|jrtd|jr td|jr6|jEdH|jjtkrFdS| dEdH|j |j |EdH|jr|jEdHdS)z/Generator implementing `Connection.rollback()`.zExplicit rollback() forbidden within a Transaction context. (Either raise Rollback() or allow an exception to propagate out of the context.)z8rollback() cannot be used during a two-phase transactionNsROLLBACK) r;rurvr>rArtr5rrrsrr=clearZ maintain_genrOr0r0r1 _rollback_genFs"  zBaseConnection._rollback_genr) format_idgtridbqualrJcCs|t|||S)aL Returns a `Xid` to pass to the `!tpc_*()` methods of this connection. The argument types and constraints are explained in :ref:`two-phase-commit`. The values passed to the method will be available on the returned object as the members `~Xid.format_id`, `~Xid.gtrid`, `~Xid.bqual`. ) _check_tpcrZ from_parts)rFrrrr0r0r1xidas zBaseConnection.xidz Xid | str)rrJccsv|t|tst|}|jjtkrDtdt |jjj |j rTtd|df|_ ||EdHdS)Nz8can't start two-phase transaction: connection in status z3can't use two-phase transactions in autocommit modeF)rrr from_stringr5rrrsrurvr rwrxr7r>rrrFrr0r0r1_tpc_begin_genns    zBaseConnection._tpc_begin_genccsp|jstd|jdr$td|jd}|df|_|tdt|EdH|jrl|jEdHdS)Nz='tpc_prepare()' must be called inside a two-phase transactionr zF'tpc_prepare()' cannot be used during a prepared two-phase transactionrTzPREPARE TRANSACTION {}) r>rurvrrformatr'rArtrr0r0r1_tpc_prepare_gens   zBaseConnection._tpc_prepare_genrzXid | str | None)actionrrJccsd|d}|dkr:|js.t|d|jd}n*|jrPt|dt|tsdt|}|jr|jdst|d|d}d|_|EdHn*|t d  t |t |EdHd|_dS) NZtpc_z()z? without xid must must be called inside a two-phase transactionrz= with xid must must be called outside a two-phase transactionr r_genz{} PREPARED {}) lowerr>rurvrrrgetattrrrrr')rFrrfnamemethr0r0r1_tpc_finish_gens*    zBaseConnection._tpc_finish_gencCsdS)z0Raise NotSupportedError if TPC is not supported.Nr0rOr0r0r1rszBaseConnection._check_tpcN)r)Br+r,r-r.ruWarningErrorrZ DatabaseErrorZ DataErrorrZIntegrityErrorZ InternalErrorrvZNotSupportedErrorrHrPrZpropertyrMr^r_setterrbrgrhrirjrkrlrmrnrorprfrYryrzr|r~r}rrr staticmethodr?rrr@rr classmethodrrrrrrrrrrrrrrr0r0r0r1r4Ns#          .'   r4)Sr. __future__rrloggingtypingrrrrweakrefrrwarningsr functoolsr rr r rurrabcrrrZsqlrrr>rZrowsrZadaptrZ_enumsr_compatrrrrZpq.miscrrArZ _preparingrZ _capabilitiesr Z_connection_infor!Zpq.abcr"r#Zpsycopg_pool.baser$r%ZFormatrZBINARYZ ConnStatusrr]rrrrrwrsZINTRANSZhas_send_close_preparedr getLoggerrr&r,rr2r/r3r4r0r0r0r1sV