U ڲg:?@sdZddlmZddlZddlZddlmZmZddlm Z m Z m Z m Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZd!d dddddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZedZed Z dS)"z SQL composition utility module ) annotationsN)ABCabstractmethod)AnyIteratorIterableSequence)Escaping) AdaptContext)PyFormat) LiteralString) conn_encoding) TransformerrAdaptContext | Nonestr)objcontextreturncCst||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)rrr//tmp/pip-unpacked-wheel-b_ea6rx_/psycopg/sql.pyquotes rc@seZdZdZddddZdddd Zedd d d ddZd d dd ddZdddddZ dddddZ dddddZ dddddZ d S)! 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. rrcCs ||_dSN_objselfrrrr__init__5szComposable.__init__rrcCs|jjd|jdS)N()) __class____name__rr rrr__repr__8szComposable.__repr__NrbytesrrcCstdS)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. N)NotImplementedErrorr rrrras_bytes;s zComposable.as_bytescCsL|r |jnd}t|}||}t|tr4||St||dSdS)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)r rconnencbrrrrJs    zComposable.as_stringComposedotherrcCs>t|trt|g|St|tr6t|gt|gStSdSr)r/r6rNotImplementedr r8rrr__add__[s   zComposable.__add__int)nrcCst|g|Sr)r6)r r=rrr__mul__cszComposable.__mul__boolcCst|t|ko|j|jkSr)typerr:rrr__eq__fszComposable.__eq__cCs || Sr)rAr:rrr__ne__iszComposable.__ne__)N)N) r& __module__ __qualname____doc__r!r(rr-rr;r>rArBrrrrr&srcspeZdZUdZded<ddfdd Zdd d d d d ZddddZdddddZdddddZ Z S)r6a] 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). zlist[Composable]rz Sequence[Any])seqcsdd|D}t|dS)NcSs"g|]}t|tr|nt|qSr)r/rr.0rrrr sz%Composed.__init__..)superr!)r rFr%rrr!szComposed.__init__Nrr)r*csdfdd|jDS)Nc3s|]}|VqdSr)r-rGrrr sz$Composed.as_bytes..)joinrr,rrMrr-szComposed.as_byteszIterator[Composable]r"cCs t|jSr)iterrr'rrr__iter__szComposed.__iter__rr7cCs<t|trt|j|jSt|tr4t|j|gStSdSr)r/r6rrr9r:rrrr;s   zComposed.__add__zSQL | LiteralString)joinerrcCs:t|trt|}nt|ts.td|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 TypeErrorrOr)r rRrrrrOs    z Composed.join)N) r&rCrDrE__annotations__r!r-rQr;rO __classcell__rrrKrr6ms r6cs~eZdZUdZded<eZddfdd Zddd d d d Z ddd d ddZ ddddddZ dddddZ Z S)rTaF 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 rrcs*t|t|ts&td|ddS)Nz SQL values must be strings, got rS)rJr!r/rrUrrKrrr!s  z SQL.__init__Nrrr*cCs|jSrrr,rrrrsz SQL.as_stringr)cCs"|r |jnd}t|}|j|Sr)r.rrencoder rr3r4rrrr-sz SQL.as_bytesrr6)argskwargsrc Osg}d}|j|jD]\}}}}|r.td|r:td|rL|t||dkrVq|r|rjtd||t|d}q|s|dkrtd||||d7}q|||qt|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 ValueErrorappendrTisdigitr<r6) r rZr[rvZautonumprenamespecconvrrrformats6# z SQL.formatzIterable[Composable])rFrcCsZg}t|}z|t|Wntk r2Yn X|D]}||||q8t|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" )rPr_next StopIterationr6)r rFraitirrrrOs  zSQL.join)N)N)r&rCrDrErVstring Formatterr\r!rr-rfrOrWrrrKrrTs HrTcs`eZdZUdZded<ddfdd Zddd d Zdd d dddZd d dddZZ 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]rr)stringscs@t||std|D]}t|tstd|dqdS)NzIdentifier cannot be emptyz*SQL identifier parts must be strings, got rS)rJr!rUr/r)r rnsrKrrr!_s   zIdentifier.__init__r"cCs"|jjddtt|jdS)Nr#, r$)r%r&rOmapreprrr'rrrr(lszIdentifier.__repr__Nrr)r*csZ|r |jnd}|r.csg|]}|qSr)_escape_identifierrXrsr'rrrIvs.)r.r ZpgconnrrrO)r rr3Zescsr)r4rtr rr-os zIdentifier.as_bytes)rorcCsd|dddS)zK Approximation of PQescapeIdentifier taking no connection. "s"")replace)r rorrrruyszIdentifier._escape_identifier)N) r&rCrDrErVr!r(r-rurWrrrKrrm=s   rmc@s"eZdZdZddddddZdS) 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 Nrr)r*cCst|}||jSr)rZ from_contextZ as_literalr)r rZtxrrrr-s zLiteral.as_bytes)N)r&rCrDrEr-rrrrrsrcsbeZdZdZdejfdddfdd Zddd d Zdd dd ddZdd dd ddZ 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) rzstr | PyFormat)rcrfcsvt|t|ts$td|d|kr:td|t|tkrNt|}t|tsltdt|j||_ dS)Nzexpected string as name, got r$zinvalid name: z!expected PyFormat as format, got ) rJr!r/rrUr^r@r r&_format)r rcrfrKrrr!s    zPlaceholder.__init__r"cCsTg}|jr|t|j|jtjk r:|d|jj|jjdd |dS)Nzformat=r#rpr$) rr_rrr{r AUTOrcr%r&rO)r partsrrrr(s  zPlaceholder.__repr__Nrr*cCs*|jj}|jr d|jd|Sd|S)Nz%(r$%)r{valuer)r rcoderrrrszPlaceholder.as_stringr)cCs&|r |jnd}t|}|||Sr)r.rrrXrYrrrr-szPlaceholder.as_bytes)N)N) r&rCrDrEr r|r!r(rr-rWrrrKrrys  ryNULLDEFAULT)N)!rE __future__rr1rkabcrrtypingrrrrZpqr r Z_enumsr _compatr Z _encodingsrZ _transformerrrrr6rTrmrryrrrrrrs*       GACA