o "4g@@sdZddlmZddlZddlZddlmZmZddlm Z m Z m Z m Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZd#d$ddZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZed!Zed"Z dS)%z SQL composition utility module ) annotationsN)ABCabstractmethod)AnyIteratorIterableSequence)Escaping) AdaptContext)PyFormat) LiteralString) conn_encoding) TransformerobjrcontextAdaptContext | NonereturnstrcCst||S)a Adapt a Python object to a quoted SQL string. Use this function only if you absolutely want to convert a Python string to an SQL quoted literal to use e.g. to generate batch SQL and you won't have a connection available when you will need to use it. This function is relatively inefficient, because it doesn't cache the adaptation rules. If you pass a `!context` you can adapt the adaptation rules used, otherwise only global rules are used. )Literal as_string)rrrT/var/www/html/authentication-server/venv/lib/python3.10/site-packages/psycopg/sql.pyquotes rc@sheZdZdZdddZd dd Zed!d"ddZd!d#ddZd$ddZ d%ddZ d&ddZ d&ddZ d S)' ComposableaP Abstract base class for objects that can be used to compose an SQL string. `!Composable` objects can be joined using the ``+`` operator: the result will be a `Composed` instance containing the objects joined. The operator ``*`` is also supported with an integer argument: the result is a `!Composed` instance containing the left argument repeated as many times as requested. `!SQL` and `!Composed` objects can be passed directly to `~psycopg.Cursor.execute()`, `~psycopg.Cursor.executemany()`, `~psycopg.Cursor.copy()` in place of the query string. rrcCs ||_dSN_objselfrrrr__init__5 zComposable.__init__rrcCs|jjd|jdS)N()) __class____name__rrrrr__repr__8szComposable.__repr__NrrbytescCst)a~ Return the value of the object as bytes. :param context: the context to evaluate the object into. :type context: `connection` or `cursor` The method is automatically invoked by `~psycopg.Cursor.execute()`, `~psycopg.Cursor.executemany()`, `~psycopg.Cursor.copy()` if a `!Composable` is passed instead of the query string. )NotImplementedErrorrrrrras_bytes;s zComposable.as_bytescCsH|r|jnd}t|}||}t|tr||St||dS)z Return the value of the object as string. :param context: the context to evaluate the string into. :type context: `connection` or `cursor` Nr) connectionrr+ isinstancer(decodecodecslookup)rrconnencbrrrrJs    zComposable.as_stringotherComposedcCs:t|tr t|g|St|trt|gt|gStSr)r-r5rNotImplementedrr4rrr__add__[s  zComposable.__add__nintcCst|g|Sr)r5)rr9rrr__mul__cszComposable.__mul__boolcCst|t|uo |j|jkSr)typerr7rrr__eq__fszComposable.__eq__cCs || Sr)r>r7rrr__ne__is zComposable.__ne__)rrrrrrrrr(rrrrr4rrr5)r9r:rr5)r4rrr<) r% __module__ __qualname____doc__r r'rr+rr8r;r>r?rrrrr&s      rcsVeZdZUdZded<dfdd Zddd dZdddZdddZdddZ Z S) r5a. A `Composable` object made of a sequence of `!Composable`. The object is usually created using `!Composable` operators and methods (such as the `SQL.format()` method). `!Composed` objects can be passed directly to `~psycopg.Cursor.execute()`, `~psycopg.Cursor.executemany()`, `~psycopg.Cursor.copy()` in place of the query string. It is also possible to create a `!Composed` directly specifying a sequence of objects as arguments: if they are not `!Composable` they will be wrapped in a `Literal`. Example:: >>> comp = sql.Composed( ... [sql.SQL("INSERT INTO "), sql.Identifier("table")]) >>> print(comp.as_string(conn)) INSERT INTO "table" `!Composed` objects are iterable (so they can be used in `SQL.join` for instance). zlist[Composable]rseq Sequence[Any]csdd|D}t|dS)NcSs"g|] }t|tr |nt|qSr)r-rr.0rrrr s"z%Composed.__init__..)superr )rrGr$rrr szComposed.__init__Nrrrr(csdfdd|jDS)Nc3s|]}|VqdSr)r+rIrrr sz$Composed.as_bytes..)joinrr*rrOrr+szComposed.as_bytesIterator[Composable]cCs t|jSr)iterrr&rrr__iter__r!zComposed.__iter__r4rcCs8t|tr t|j|jSt|trt|j|gStSr)r-r5rrr6r7rrrr8s  zComposed.__add__joinerSQL | LiteralStringcCs:t|tr t|}n t|tstd|d||jS)a~ Return a new `!Composed` interposing the `!joiner` with the `!Composed` items. The `!joiner` must be a `SQL` or a string which will be interpreted as an `SQL`. Example:: >>> fields = sql.Identifier('foo') + sql.Identifier('bar') # a Composed >>> print(fields.join(', ').as_string(conn)) "foo", "bar" z5Composed.join() argument must be strings or SQL, got  instead)r-rSQL TypeErrorrQr)rrUrrrrQs    z Composed.join)rGrHrrA)rrRrC)rUrVrr5) r%rDrErF__annotations__r r+rTr8rQ __classcell__rrrMrr5ms    r5cs`eZdZUdZded<eZdfdd Zddd d Z ddddZ dddZ d ddZ Z S)!rXa A `Composable` representing a snippet of SQL statement. `!SQL` exposes `join()` and `format()` methods useful to create a template where to merge variable parts of a query (for instance field or table names). The `!obj` string doesn't undergo any form of escaping, so it is not suitable to represent variable identifiers or values: you should only use it to pass constant strings representing templates or snippets of SQL statements; use other objects such as `Identifier` or `Literal` to represent variable parts. `!SQL` objects can be passed directly to `~psycopg.Cursor.execute()`, `~psycopg.Cursor.executemany()`, `~psycopg.Cursor.copy()` in place of the query string. Example:: >>> query = sql.SQL("SELECT {0} FROM {1}").format( ... sql.SQL(', ').join([sql.Identifier('foo'), sql.Identifier('bar')]), ... sql.Identifier('table')) >>> print(query.as_string(conn)) SELECT "foo", "bar" FROM "table" r rrcs*t|t|tstd|ddS)Nz SQL values must be strings, got rW)rLr r-rrYrrMrrr s  z SQL.__init__NrrrrcCs|jSrrr*rrrrsz SQL.as_stringr(cCs"|r|jnd}t|}|j|Sr)r,rrencoderrr1r2rrrr+s z SQL.as_bytesargsrkwargsr5c Osg}d}|j|jD]S\}}}}|rtd|rtd|r&|t||dur+q |rA|r5td||t|d}q |sW|durKtd||||d7}q |||q t|S)a Merge `Composable` objects into a template. :param args: parameters to replace to numbered (``{0}``, ``{1}``) or auto-numbered (``{}``) placeholders :param kwargs: parameters to replace to named (``{name}``) placeholders :return: the union of the `!SQL` string with placeholders replaced :rtype: `Composed` The method is similar to the Python `str.format()` method: the string template supports auto-numbered (``{}``), numbered (``{0}``, ``{1}``...), and named placeholders (``{name}``), with positional arguments replacing the numbered placeholders and keywords replacing the named ones. However placeholder modifiers (``{0!r}``, ``{0:<10}``) are not supported. If a `!Composable` objects is passed to the template it will be merged according to its `as_string()` method. If any other Python object is passed, it will be wrapped in a `Literal` object and so escaped according to SQL rules. Example:: >>> print(sql.SQL("SELECT * FROM {} WHERE {} = %s") ... .format(sql.Identifier('people'), sql.Identifier('id')) ... .as_string(conn)) SELECT * FROM "people" WHERE "id" = %s >>> print(sql.SQL("SELECT * FROM {tbl} WHERE name = {name}") ... .format(tbl=sql.Identifier('people'), name="O'Rourke")) ... .as_string(conn)) SELECT * FROM "people" WHERE name = 'O''Rourke' rz(no format specification supported by SQLz%no format conversion supported by SQLNz6cannot switch from automatic field numbering to manualz6cannot switch from manual field numbering to automaticr ) _formatterparser ValueErrorappendrXisdigitr:r5) rr^r_rvautonumprenamespecconvrrrformats6# z SQL.formatrGIterable[Composable]cCs^g}t|}z |t|Wn tyYt|Sw|D] }||||qt|S)a Join a sequence of `Composable`. :param seq: the elements to join. :type seq: iterable of `!Composable` Use the `!SQL` object's string to separate the elements in `!seq`. Note that `Composed` objects are iterable too, so they can be used as argument for this method. Example:: >>> snip = sql.SQL(', ').join( ... sql.Identifier(n) for n in ['foo', 'bar', 'baz']) >>> print(snip.as_string(conn)) "foo", "bar", "baz" )rSrcnext StopIterationr5)rrGreitirrrrQ%s   zSQL.join)rr rrBrA)r^rr_rrr5)rGrlrr5)r%rDrErFrZstring Formatterr`r rr+rkrQr[rrrMrrXs    HrXcsLeZdZUdZded<dfdd Zdd d ZddddZdddZZ S) Identifiera# A `Composable` representing an SQL identifier or a dot-separated sequence. Identifiers usually represent names of database objects, such as tables or fields. PostgreSQL identifiers follow `different rules`__ than SQL string literals for escaping (e.g. they use double quotes instead of single). .. __: https://www.postgresql.org/docs/current/sql-syntax-lexical.html# SQL-SYNTAX-IDENTIFIERS Example:: >>> t1 = sql.Identifier("foo") >>> t2 = sql.Identifier("ba'r") >>> t3 = sql.Identifier('ba"z') >>> print(sql.SQL(', ').join([t1, t2, t3]).as_string(conn)) "foo", "ba'r", "ba""z" Multiple strings can be passed to the object to represent a qualified name, i.e. a dot-separated sequence of identifiers. Example:: >>> query = sql.SQL("SELECT {} FROM {}").format( ... sql.Identifier("table", "field"), ... sql.Identifier("schema", "table")) >>> print(query.as_string(conn)) SELECT "table"."field" FROM "schema"."table" z Sequence[str]rstringsrcs@t||s td|D]}t|tstd|dqdS)NzIdentifier cannot be emptyz*SQL identifier parts must be strings, got rW)rLr rYr-r)rrtsrMrrr gs   zIdentifier.__init__rcCs"|jjddtt|jdS)Nr", r#)r$r%rQmapreprrr&rrrr'ts"zIdentifier.__repr__Nrrr(csZ|r|jnd}|rt|jt|fddjD}n fddjD}d|S)Ncsg|] }|qSr)escape_identifierr\rJru)r2escrrrK|sz'Identifier.as_bytes..csg|] }|qSr)_escape_identifierr\rzr&rrrK~s.)r,r pgconnrrrQ)rrr1escsr)r2r{rrr+ws  zIdentifier.as_bytesrucCsd|dddS)zK Approximation of PQescapeIdentifier taking no connection. "s"")replace)rrurrrr|szIdentifier._escape_identifier)rtrr@rrA)rur(rr() r%rDrErFrZr r'r+r|r[rrrMrrsEs   rsc@seZdZdZd d ddZdS) ra A `Composable` representing an SQL value to include in a query. Usually you will want to include placeholders in the query and pass values as `~cursor.execute()` arguments. If however you really really need to include a literal value in the query you can use this object. The string returned by `!as_string()` follows the normal :ref:`adaptation rules ` for Python objects. Example:: >>> s1 = sql.Literal("fo'o") >>> s2 = sql.Literal(42) >>> s3 = sql.Literal(date(2000, 1, 1)) >>> print(sql.SQL(', ').join([s1, s2, s3]).as_string(conn)) 'fo''o', 42, '2000-01-01'::date Nrrrr(cCst|}||jSr)r from_context as_literalr)rrtxrrrr+s  zLiteral.as_bytesrrA)r%rDrErFr+rrrrrsrcsLeZdZdZdejfdfdd Zdd d ZddddZddddZ Z S) Placeholdera A `Composable` representing a placeholder for query parameters. If the name is specified, generate a named placeholder (e.g. ``%(name)s``, ``%(name)b``), otherwise generate a positional placeholder (e.g. ``%s``, ``%b``). The object is useful to generate SQL queries with a variable number of arguments. Examples:: >>> names = ['foo', 'bar', 'baz'] >>> q1 = sql.SQL("INSERT INTO my_table ({}) VALUES ({})").format( ... sql.SQL(', ').join(map(sql.Identifier, names)), ... sql.SQL(', ').join(sql.Placeholder() * len(names))) >>> print(q1.as_string(conn)) INSERT INTO my_table ("foo", "bar", "baz") VALUES (%s, %s, %s) >>> q2 = sql.SQL("INSERT INTO my_table ({}) VALUES ({})").format( ... sql.SQL(', ').join(map(sql.Identifier, names)), ... sql.SQL(', ').join(map(sql.Placeholder, names))) >>> print(q2.as_string(conn)) INSERT INTO my_table ("foo", "bar", "baz") VALUES (%(foo)s, %(bar)s, %(baz)s) rhrrkstr | PyFormatcsvt|t|tstd|d|vrtd|t|tur't|}t|ts6tdt|j||_ dS)Nzexpected string as name, got r#zinvalid name: z!expected PyFormat as format, got ) rLr r-rrYrbr=r r%_format)rrhrkrMrrr s     zPlaceholder.__init__rcCsTg}|jr |t|j|jtjur|d|jj|jjdd |dS)Nzformat=r"rvr#) rrcrxrr AUTOrhr$r%rQ)rpartsrrrr's  zPlaceholder.__repr__NrrcCs*|jj}|jrd|jd|Sd|S)Nz%(r#%)rvaluer)rrcoderrrrs"zPlaceholder.as_stringr(cCs&|r|jnd}t|}|||Sr)r,rrr\r]rrrr+szPlaceholder.as_bytes)rhrrkrr@rrBrA) r%rDrErFr rr r'rr+r[rrrMrrs   rNULLDEFAULTr)rrrrrr)!rF __future__rr/rqabcrrtypingrrrrpqr r _enumsr _compatr _encodingsr _transformerrrrr5rXrsrrrrrrrrs,        GECA