U ڲg@sUdZddlmZddlZddlmZmZmZmZddlm Z m Z m Z ddl m Z ddlmZdd lmZdd lmZmZdd lmZe rdd lmZdd lmZddlmZddlmZejj Z ejj!Z!ejj"Z"ejj#Z#edddZ$eddddZ%Gddde e%Z&Gddde e%Z'Gddde e%Z(Gddde e%Z)dZ*de+d<d Z,de+d!<d"d#d$d%d&Z-d"d'd$d(d)Z.d"d*d$d+d,Z/e0d-d.d/d0d1d2d3Z1d4d5d6d7d8Z2d9d5d:d;d<Z3d9d5d:d=d>Z4d"d?d$d@dAZ5dBdCdDdEdFZ6d"dGd$dHdIZ7dJdKdLdMdNZ8dS)Oz psycopg row factories ) annotationsN)AnyCallable NamedTupleNoReturn) TYPE_CHECKINGProtocolSequence) namedtuple)pq)errors) TypeAliasTypeVar)_as_python_identifier)Cursor) BaseCursor) AsyncCursor)PGresultTT) covariantRowTupleRow)rdefaultc@s eZdZdZdddddZdS)RowMakera Callable protocol taking a sequence of value and returning an object. The sequence of value is what is returned from a database query, already adapted to the right Python types. The return value is the object that your program would like to receive: by default (`tuple_row()`) it is a simple tuple, but it may be any type of object. Typically, `!RowMaker` functions are returned by `RowFactory`. Sequence[Any]r)_RowMaker__valuesreturncCsdSN)selfrrr0/tmp/pip-unpacked-wheel-b_ea6rx_/psycopg/rows.py__call__1zRowMaker.__call__N__name__ __module__ __qualname____doc__r"rrrr!r%s rc@s eZdZdZdddddZdS) RowFactorya Callable protocol taking a `~psycopg.Cursor` and returning a `RowMaker`. A `!RowFactory` is typically called when a `!Cursor` receives a result. This way it can inspect the cursor state (for instance the `~psycopg.Cursor.description` attribute) and help a `!RowMaker` to create a complete object. For instance the `dict_row()` `!RowFactory` uses the names of the column to define the dictionary key and returns a `!RowMaker` function which would use the values to create a dictionary for each record. z Cursor[Any] RowMaker[Row])_RowFactory__cursorrcCsdSrr)r r+rrr!r"Br#zRowFactory.__call__Nr$rrrr!r)4s r)c@s eZdZdZdddddZdS)AsyncRowFactoryz@ Like `RowFactory`, taking an async cursor as argument. zAsyncCursor[Any]r*)_AsyncRowFactory__cursorrcCsdSrr)r r-rrr!r"Jr#zAsyncRowFactory.__call__Nr$rrrr!r,Esr,c@s eZdZdZdddddZdS)BaseRowFactoryzF Like `RowFactory`, taking either type of cursor as argument. BaseCursor[Any, Any]r*)_BaseRowFactory__cursorrcCsdSrr)r r0rrr!r"Rr#zBaseRowFactory.__call__Nr$rrrr!r.Msr.ztuple[Any, ...]rdict[str, Any]DictRowr/zRowMaker[TupleRow]cursorrcCstS)zRow factory to represent rows as simple tuples. This is the default factory, used when `~psycopg.Connection.connect()` or `~psycopg.Connection.cursor()` are called without a `!row_factory` parameter. )tuple)r4rrr! tuple_rowds r6zRowMaker[DictRow]cs,t|dkrtSdddfdd }|S)zRow factory to represent rows as dictionaries. The dictionary keys are taken from the column names of the returned columns. Nrr1valuesrcstt|Srdictzipr8namesrr! dict_row_zszdict_row..dict_row_ _get_names no_result)r4r?rr=r!dict_rowqs rCzRowMaker[NamedTuple]csJ|jstSt}|dkr"tSt|jffddt|D}|jS)zRow factory to represent rows as `~collections.namedtuple`. The field names are taken from the column names of the returned columns, with some mangling to deal with invalid names. Nc3s|]}|VqdSr)fname.0iresrr! sz!namedtuple_row..)pgresultrB _get_nfields_make_nt _encodingrange_make)r4nfieldsntrrHr!namedtuple_rows"rSistrbytesztype[NamedTuple])encr>rcs tfdd|D}td|S)Nc3s|]}t|VqdSr)rdecode)rFnrVrr!rJsz_make_nt..r)r5r )rVr>ZsnamesrrYr!rMsrMztype[T]zBaseRowFactory[T])clsrcsdddfdd }|S)aQGenerate a row factory to represent rows as instances of the class `!cls`. The class must support every output column name as a keyword parameter. :param cls: The class to return for each row. It must support the fields returned by the query as keyword arguments. :rtype: `!Callable[[Cursor],` `RowMaker`\[~T]] r/ RowMaker[T]r3cs.t|dkrtSdddfdd }|S)Nrrr7csftt|Srr9r<)rZr>rr! class_row__sz2class_row..class_row_..class_row__r@)r4r\rZr=r! class_row_s zclass_row..class_row_r)rZr^rr]r! class_rows  r_zCallable[..., T])funcrcsdddfdd }|S)zGenerate a row factory calling `!func` with positional parameters for every row. :param func: The function to call for each row. It must support the fields returned by the query as positional arguments. BaseCursor[Any, T]r[)currcsdddfdd }|S)Nrrr7cs|Srrr<r`rr! args_row__sz/args_row..args_row_..args_row__r)rbrdrcrr! args_row_szargs_row..args_row_r)r`rerrcr!args_rowsrfcsdddfdd }|S)zGenerate a row factory calling `!func` with keyword parameters for every row. :param func: The function to call for each row. It must support the fields returned by the query as keyword arguments. rar[r3cs.t|dkrtSdddfdd }|S)Nrrr7csftt|Srr9r<)r`r>rr! kwargs_row__sz5kwargs_row..kwargs_row_..kwargs_row__r@)r4rgrcr=r! kwargs_row_s zkwargs_row..kwargs_row_r)r`rhrrcr! kwargs_rows riz RowMaker[Any]cCsH|j}|stSt|}|dkr"tS|dkr4tdddddd}|S) zR Generate a row factory returning the first column as a scalar value. Nr zat least one column expectedrrr7cSs|dS)Nrrr<rrr! scalar_row_szscalar_row..scalar_row_)rKrBrLeZProgrammingError)r4rIrQrjrrr! scalar_rows rlrrr7cCstddS)zA `RowMaker` that always fail. It can be used as return value for a `RowFactory` called with no result. Note that the `!RowFactory` *will* be called with no result, but the resulting `!RowMaker` never should. z the cursor doesn't have a resultN)rkZInterfaceErrorr<rrr!rBsrBzlist[str] | Nonecs@|jsdSt}|dkr"dS|jfddt|DS)Ncsg|]}|qSr)rDrWrErVrIrr! sz_get_names..)rKrLrNrO)r4rQrrmr!rAs rArz int | None)rIrcCs>|j}|jtks2|jtks2|jtks2|jtkr6|r6|SdSdS)z Return the number of columns in a result, if it returns tuples else None Take into account the special case of results with zero columns. N)rQstatus TUPLES_OK SINGLE_TUPLE TUPLES_CHUNK COMMAND_OK)rIrQrrr!rLsrL)9r( __future__r functoolstypingrrrrrrr collectionsr r r rk_compatrrZ _encodingsrr4rZ _cursor_baserZ cursor_asyncrZpsycopg.pq.abcrZ ExecStatusrsrprqrrrrrr)r,r.r__annotations__r2r6rCrS lru_cacherMr_rfrirlrBrArLrrrr!sL