o T_7:@sdZddlZddlmZddlmZmZeZ Gddde Z Gddde Z Gd d d e Z Gd d d e ZGd dde ZGddde Ze dZe dZdS)zSQL composition utility module N) extensions)PY3 string_typesc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS) Composablea6 Abstract base class for objects that can be used to compose an SQL string. `!Composable` objects can be passed directly to `~cursor.execute()`, `~cursor.executemany()`, `~cursor.copy_expert()` 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. cCs ||_dSN_wrapped)selfwrappedr B/var/www/chikooza/env/lib/python3.10/site-packages/psycopg2/sql.py__init__2 zComposable.__init__cCsd|jj|jfS)Nz%s(%r)) __class____name__rr r r r __repr__5szComposable.__repr__cCst)aj Return the string value of the object. :param context: the context to evaluate the string into. :type context: `connection` or `cursor` The method is automatically invoked by `~cursor.execute()`, `~cursor.executemany()`, `~cursor.copy_expert()` if a `!Composable` is passed instead of the query string. )NotImplementedErrorr contextr r r as_string8s zComposable.as_stringcCs:t|tr t|g|St|trt|gt|gStSr) isinstanceComposedrNotImplementedr otherr r r __add__Es  zComposable.__add__cCst|g|Sr)r)r nr r r __mul__MszComposable.__mul__cCst|t|uo |j|jkSr)typerrr r r __eq__PszComposable.__eq__cCs || Sr)r rr r r __ne__Ss zComposable.__ne__N) r __module__ __qualname____doc__r rrrrr r!r r r r r$s   rcsLeZdZdZfddZeddZddZdd Zd d Z d d Z Z S)ra 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 `!Composable` as arguments. 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). csBg}|D]}t|tstd|||qtt||dS)Nz4Composed elements must be Composable, got %r instead)rr TypeErrorappendsuperrr )r seqr irr r r is  zComposed.__init__cC t|jS)z+The list of the content of the `!Composed`.)listrrr r r r(ss z Composed.seqcCs*g}|jD] }|||qd|S)N)rr&rjoin)r rrvr)r r r rxs  zComposed.as_stringcCr+r)iterrrr r r __iter__~rzComposed.__iter__cCs8t|tr t|j|jSt|trt|j|gStSr)rrrrrrr r r rs  zComposed.__add__cCs0t|tr t|}n t|tstd||S)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" z3Composed.join() argument must be a string or an SQL)rrSQLr%r.)r joinerr r r r.s    z Composed.join) rr"r#r$r propertyr(rr1rr. __classcell__r r r*r rWs  rcsDeZdZdZfddZeddZddZdd Zd d Z Z S) r2aA 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 *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" cs&t|ts tdtt||dS)NzSQL values must be strings)rrr%r'r2r )r stringr*r r r s z SQL.__init__cC|jS)z(The string wrapped by the `!SQL` object.rrr r r r6z SQL.stringcCr7rrrr r r rsz SQL.as_stringc Osg}d}t|jD]S\}}}}|rtd|rtd|r%|t||dur*q |r@|r4td||t|d}q |sV|durJtd||||d7}q |||q t|S)a^ Merge `Composable` objects into a template. :param `Composable` args: parameters to replace to numbered (``{0}``, ``{1}``) or auto-numbered (``{}``) placeholders :param `Composable` 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. Only `!Composable` objects can be passed to the template. 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 {pkey} = %s") ... .format(tbl=sql.Identifier('people'), pkey=sql.Identifier('id')) ... .as_string(conn)) select * from "people" where "id" = %s 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 automatic) _formatterparser ValueErrorr&r2isdigitintr) r argskwargsr/autonumprenamespecconvr r r formats6  z SQL.formatcCs^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" )r0r&next StopIterationr)r r(r/itr)r r r r.s   zSQL.join) rr"r#r$r r4r6rrFr.r5r r r*r r2s  @r2csHeZdZdZfddZeddZeddZdd Zd d Z Z 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/static/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" cs<|std|D] }t|tstdqtt||dS)NzIdentifier cannot be emptyz$SQL identifier parts must be strings)r%rrr'rJr )r stringssr*r r r Bs zIdentifier.__init__cCr7)z5A tuple with the strings wrapped by the `Identifier`.rrr r r rKLr8zIdentifier.stringscCs t|jdkr |jdStd)z0The string wrapped by the `Identifier`. r9rz2the Identifier wraps more than one than one string)lenrAttributeErrorrr r r r6Qs  zIdentifier.stringcCsd|jjdtt|jfS)Nz%s(%s)z, )rrr.mapreprrrr r r r[szIdentifier.__repr__csdfdd|jDS)N.c3s|] }t|VqdSr)ext quote_ident).0rLrr r asz'Identifier.as_string..)r.rrr rUr r`szIdentifier.as_string) rr"r#r$r r4rKr6rrr5r r r*r rJ#s    rJc@s$eZdZdZeddZddZdS)Literala 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("foo") >>> s2 = sql.Literal("ba'r") >>> s3 = sql.Literal(42) >>> print(sql.SQL(', ').join([s1, s2, s3]).as_string(conn)) 'foo', 'ba''r', 42 cCr7)z%The object wrapped by the `!Literal`.rrr r r r xr8zLiteral.wrappedcCszt|tjr |}nt|tjr|j}ntdt|j}t|dr'||| }t r;t|t r;| tj |j}|S)Nz(context must be a connection or a cursorprepare)rrR connectioncursorr%adaptrhasattrrX getquotedrbytesdecode encodingsencoding)r rconnar/r r r r}s     zLiteral.as_stringN)rr"r#r$r4r rr r r r rWds   rWcs>eZdZdZd fdd ZeddZddZd d ZZ S) PlaceholderaA `Composable` representing a placeholder for query parameters. If the name is specified, generate a named placeholder (e.g. ``%(name)s``), otherwise generate a positional placeholder (e.g. ``%s``). The object is useful to generate SQL queries with a variable number of arguments. Examples:: >>> names = ['foo', 'bar', 'baz'] >>> q1 = sql.SQL("insert into table ({}) values ({})").format( ... sql.SQL(', ').join(map(sql.Identifier, names)), ... sql.SQL(', ').join(sql.Placeholder() * len(names))) >>> print(q1.as_string(conn)) insert into table ("foo", "bar", "baz") values (%s, %s, %s) >>> q2 = sql.SQL("insert into table ({}) values ({})").format( ... sql.SQL(', ').join(map(sql.Identifier, names)), ... sql.SQL(', ').join(map(sql.Placeholder, names))) >>> print(q2.as_string(conn)) insert into table ("foo", "bar", "baz") values (%(foo)s, %(bar)s, %(baz)s) NcsHt|trd|vrtd|n |durtd|tt||dS)N)zinvalid name: %rz'expected string or None as name, got %r)rrr<r%r'rdr )r rCr*r r r s   zPlaceholder.__init__cCr7)zThe name of the `!Placeholder`.rrr r r rCr8zPlaceholder.namecCsd|jdur |jfSdfS)NzPlaceholder(%r)r-rrr r r rs zPlaceholder.__repr__cCs|jdur d|jSdS)Nz%%(%s)sz%srrr r r rs  zPlaceholder.as_stringr) rr"r#r$r r4rCrrr5r r r*r rds rdNULLDEFAULT)r$r6psycopg2rrRpsycopg2.compatrr Formatterr:objectrrr2rJrWrdrfrgr r r r s 3IA-6