*Jf5>dZddlZddlZddlmZmZddlmZmZm Z m Z m Z m Z m Z ddlmZddlmZddlmZmZdd lmZdd lmZdd ed e ed efdZGddeZGddeZGddeZGddeZGddeZGddeZedZ edZ!dS)z SQL composition utility module N)ABCabstractmethod)AnyIteratorIterableListOptionalSequenceUnion)Escaping) AdaptContext) TransformerPyFormat) LiteralString) conn_encodingobjcontextreturncFt||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)rrs N/home/alex/cs2snipeproduction/venv/lib/python3.11/site-packages/psycopg/sql.pyquoters 3<< ! !' * **ceZdZdZdefdZdefdZede e de fdZ de e defdZ dd Zd edd fd Zd edefdZd edefdZdS) ComposableaG Abstract base class for objects that can be used to compose an SQL string. `!Composable` objects can be passed directly to `~psycopg.Cursor.execute()`, `~psycopg.Cursor.executemany()`, `~psycopg.Cursor.copy()` in place of the query 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. rc||_dSN_obj)selfrs r__init__zComposable.__init__2s  rrc0|jjd|jdS)N()) __class____name__r!r"s r__repr__zComposable.__repr__5s .)::DI::::rrct)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. )NotImplementedErrorr"rs ras_byteszComposable.as_bytes8s "!rc|r|jnd}t|}||}t|tr||St j||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. isinstancebytesdecodecodecslookup)r"rconnencbs rrzComposable.as_stringGs{&-6w!!$D!! MM' " " a   388C== =%%,,Q//2 2rotherComposedct|trt|g|zSt|tr!t|gt|gzStSr)r1r:rNotImplementedr"r9s r__add__zComposable.__add__Xs` eX & & ,TF##e+ + eZ ( ( "TF##hw&7&77 7! !rnc(t|g|zSr)r:)r"r?s r__mul__zComposable.__mul__`s ###rc^t|t|uo|j|jkSr)typer!r=s r__eq__zComposable.__eq__cs'DzzT%[[(DTY%*-DDrc.|| Sr)rDr=s r__ne__zComposable.__ne__fs;;u%%%%rN)r9rrr:)r( __module__ __qualname____doc__rr#strr*rr rr2r.rr>intrAboolrDrFrrrr#s.  C;#;;;; " 6 "5 " " "^ "3,!73C3333"""""$$$$$$ECEDEEEE&C&D&&&&&&rrceZdZUdZeeed<deeffd Z de e de fdZ deefdZd eddfd Zd ed efddfd ZxZS)r:a] A `Composable` object made of a sequence of `!Composable`. The object is usually created using `!Composable` operators and methods. However it is 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). r!seqcbd|D}t|dS)NcZg|](}t|tr|nt|)SrM)r1rr).0rs r z%Composed.__init__..s1SSSjj11Cssws||SSSr)superr#)r"rOr's rr#zComposed.__init__s4SSsSSS rrrcPdfd|jDS)Nrc3BK|]}|VdSr)r.)rRrrs r z$Composed.as_bytes..s/CC# W--CCCCCCr)joinr!r-s `rr.zComposed.as_bytess,xxCCCCCCCCCCrc*t|jSr)iterr!r)s r__iter__zComposed.__iter__sDIrr9ct|trt|j|jzSt|trt|j|gzStSr)r1r:r!rr<r=s rr>zComposed.__add__sZ eX & & 4DI 233 3 eZ ( ( "DI/00 0! !rjoinerSQLct|trt|}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)r1rJr^ TypeErrorrXr!)r"r]s rrXz Composed.joinst fc " " [[FFFC(( ++++  {{49%%%r)r(rGrHrIrr__annotations__r rr#r rr2r.rr[r>r rrX __classcell__r's@rr:r:js& z HSMD 6D5DDDD(:."Z"J""""&5 !56&:&&&&&&&&rr:ceZdZUdZeed<ejZdeffd Z de e de fdZ de e defdZd ed edefd Zd eedefd ZxZS)r^aF 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. 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!rct|t|tst d|ddS)Nz SQL values must be strings, got r`)rTr#r1rJra)r"rr's rr#z SQL.__init__sT #s## PNsNNNOO O P Prrrc|jSrr r-s rrz SQL.as_strings yrcfd}|rt|j}|j|S)Nzutf-8)rr0r!encode)r"rr7s rr.z SQL.as_bytess5  4 233Cy$$$rargskwargscFg}d}|j|jD]\}}}}|rtd|rtd|r"|t ||P|r<|rtd||t|d}|s2|td||||dz }|||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! ValueErrorappendr^isdigitrKr:) r"rjrkrvautonumprenamespecconvs rformatz SQL.formatsQF "!"&*_%:%:49%E%E ( ( !CtT M !KLLL J !HIII $ #c((###|||~~ ($P $s4yy/*** (?$P $w-(((1  &,''''||rrOcg}t|} |t||D],}||||-n#t$rYnwxYwt |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" )rZrpnext StopIterationr:)r"rOrritis rrXzSQL.joins$ #YY  IId2hh      $ !      D ||s"A%% A21A2)r(rGrHrIrrbstring Formatterrmr#r rrJrr2r.rr:rxrrrXrcrds@rr^r^s, !!##JPMPPPPPP ,!7C% 6%5%%%% FCF3F8FFFFP,rr^cheZdZUdZeeed<deffd ZdefdZde e de fdZ xZ 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" r!stringsct||std|D]*}t|tstd|d+dS)NzIdentifier cannot be emptyz*SQL identifier parts must be strings, got r`)rTr#rar1rJ)r"rsr's rr#zIdentifier.__init__]s !!! :899 9  Aa%% NNNN   rrc||jjddtt|jdS)Nr%, r&)r'r(rXmapreprr!r)s rr*zIdentifier.__repr__js6.)NNDIIc$ 6J6J,K,KNNNNrrc|r|jnd}|stdt|jt |fd|jD}d|S)Nz(a connection is necessary for Identifierc`g|]*}|+SrM)escape_identifierri)rRrr7escs rrSz'Identifier.as_bytes..ss1HHH%%ahhsmm44HHHr.)r0ror pgconnrr!rX)r"rr6escsr7rs @@rr.zIdentifier.as_bytesmsx%,6w!!$ IGHH Ht{##D!!HHHHHdiHHHyyr)r(rGrHrIr rJrbr#r*r rr2r.rcrds@rrr;s> 3-       O#OOOO 65rrc.eZdZdZdeedefdZdS)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 rrc^tj|}||jSr)r from_context as_literalr!)r"rtxs rr.zLiteral.as_bytess&  %g . .}}TY'''rN)r(rGrHrIr rr2r.rMrrrrwsE(( 6(5((((((rrceZdZdZdejfdedeeefffd ZdefdZ de e defd Z de e de fd ZxZS) 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) rurxct|t|tst d|d|vrt d|t |turt|}t|ts$t dt |j||_ dS)Nzexpected string as name, got r&zinvalid name: z!expected PyFormat as format, got ) rTr#r1rJrarorCrr(_format)r"rurxr's rr#zPlaceholder.__init__s $$$ FDDDDEE E $;;6d6677 7 <<3  f%%F&(++ MDLL4IMM "( rrcg}|jr'|t|j|jtjur"|d|jj|jjdd |dS)Nzformat=r%rr&) r!rprrrAUTOrur'r(rX)r"partss rr*zPlaceholder.__repr__s 9 * LLdi ) ) ) rs5  ########KKKKKKKKKKKKKKKKKK((((((((""""""%%%%%% + +s +Xl3 +s + + + + D&D&D&D&D&D&D&D&N>&>&>&>&>&z>&>&>&BMMMMM*MMM`99999999x(((((j(((4=3=3=3=3=3*=3=3=3B s6{{ #i..r