diff options
author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2017-01-03 17:27:01 +0100 |
---|---|---|
committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2017-01-03 17:27:01 +0100 |
commit | 71a168797cc7e6398222490e6de02080de842e1d (patch) | |
tree | 9e8e4dc97f556ca9faecdace127704a0a275322b /lib/sql.py | |
parent | a76e665567879f39bf20dc04f85ff001ab034213 (diff) | |
download | psycopg2-71a168797cc7e6398222490e6de02080de842e1d.tar.gz |
Several improvements to the sql objects
Comparable, iterable, content accessible
Diffstat (limited to 'lib/sql.py')
-rw-r--r-- | lib/sql.py | 171 |
1 files changed, 95 insertions, 76 deletions
@@ -37,23 +37,28 @@ class Composable(object): Abstract base class for objects that can be used to compose an SQL string. `!Composable` objects can be passed directly to `~cursor.execute()` and - `~cursor.executemany()`. + `~cursor.executemany()` 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. - - .. automethod:: as_string """ - def as_string(self, conn_or_curs): + def __init__(self, wrapped): + self._wrapped = wrapped + + def __repr__(self): + return "%s(%r)" % (self.__class__.__name__, self._wrapped) + + def as_string(self, context): """ Return the string value of the object. - The object is evaluated in the context of the *conn_or_curs* argument. + :param context: the context to evaluate the string into. + :type context: `connection` or `cursor` - The function is automatically invoked by `~cursor.execute()` and + The method is automatically invoked by `~cursor.execute()` and `~cursor.executemany()` if a `!Composable` is passed instead of the query string. """ @@ -70,14 +75,20 @@ class Composable(object): def __mul__(self, n): return Composed([self] * n) + def __eq__(self, other): + return type(self) is type(other) and self._wrapped == other._wrapped + + def __ne__(self, other): + return not self.__eq__(other) + class Composed(Composable): """ - A `Composable` object obtained concatenating a sequence of `Composable`. + A `Composable` object made of a sequence of `Composable`. - The object is usually created using `Composable` operators. However it is - possible to create a `!Composed` directly specifying a sequence of - `Composable` as arguments. + 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:: @@ -86,30 +97,38 @@ class Composed(Composable): >>> print(comp.as_string(conn)) insert into "table" - .. automethod:: join + `!Composed` objects are iterable (so they can be used in `SQL.join` for + instance). """ def __init__(self, seq): - self._seq = [] + wrapped = [] for i in seq: if not isinstance(i, Composable): raise TypeError( "Composed elements must be Composable, got %r instead" % i) - self._seq.append(i) + wrapped.append(i) - def __repr__(self): - return "sql.Composed(%r)" % (self._seq,) + super(Composed, self).__init__(wrapped) + + @property + def seq(self): + """The list of the content of the `!Composed`.""" + return list(self._wrapped) - def as_string(self, conn_or_curs): + def as_string(self, context): rv = [] - for i in self._seq: - rv.append(i.as_string(conn_or_curs)) + for i in self._wrapped: + rv.append(i.as_string(context)) return ''.join(rv) + def __iter__(self): + return iter(self._wrapped) + def __add__(self, other): if isinstance(other, Composed): - return Composed(self._seq + other._seq) + return Composed(self._wrapped + other._wrapped) if isinstance(other, Composable): - return Composed(self._seq + [other]) + return Composed(self._wrapped + [other]) else: return NotImplemented @@ -133,16 +152,7 @@ class Composed(Composable): raise TypeError( "Composed.join() argument must be a string or an SQL") - if len(self._seq) <= 1: - return self - - it = iter(self._seq) - rv = [it.next()] - for i in it: - rv.append(joiner) - rv.append(i) - - return Composed(rv) + return joiner.join(self) class SQL(Composable): @@ -153,6 +163,12 @@ class SQL(Composable): 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 {} from {}").format( @@ -160,20 +176,18 @@ class SQL(Composable): ... sql.Identifier('table')) >>> print(query.as_string(conn)) select "foo", "bar" from "table" - - .. automethod:: format - - .. automethod:: join """ def __init__(self, string): if not isinstance(string, basestring): raise TypeError("SQL values must be strings") - self._wrapped = string + super(SQL, self).__init__(string) - def __repr__(self): - return "sql.SQL(%r)" % (self._wrapped,) + @property + def string(self): + """The string wrapped by the `!SQL` object.""" + return self._wrapped - def as_string(self, conn_or_curs): + def as_string(self, context): return self._wrapped def format(self, *args, **kwargs): @@ -191,9 +205,9 @@ class SQL(Composable): 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. + the named ones. However placeholder modifiers (``{0!r}``, ``{0:<10}``) + are not supported. Only `!Composable` objects can be passed to the + template. Example:: @@ -242,9 +256,14 @@ class SQL(Composable): def join(self, seq): """ - Join a sequence of `Composable` or a `Composed` and return a `!Composed`. + Join a sequence of `Composable`. + + :param seq: the elements to join. + :type seq: iterable of `!Composable` - Use the object *string* to separate the *seq* elements. + 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:: @@ -253,9 +272,6 @@ class SQL(Composable): >>> print(snip.as_string(conn)) "foo", "bar", "baz" """ - if isinstance(seq, Composed): - seq = seq._seq - rv = [] it = iter(seq) try: @@ -294,13 +310,15 @@ class Identifier(Composable): if not isinstance(string, basestring): raise TypeError("SQL identifiers must be strings") - self._wrapped = string + super(Identifier, self).__init__(string) - def __repr__(self): - return "sql.Identifier(%r)" % (self._wrapped,) + @property + def string(self): + """The string wrapped by the `Identifier`.""" + return self._wrapped - def as_string(self, conn_or_curs): - return ext.quote_ident(self._wrapped, conn_or_curs) + def as_string(self, context): + return ext.quote_ident(self._wrapped, context) class Literal(Composable): @@ -323,20 +341,19 @@ class Literal(Composable): 'foo', 'ba''r', 42 """ - def __init__(self, wrapped): - self._wrapped = wrapped - - def __repr__(self): - return "sql.Literal(%r)" % (self._wrapped,) + @property + def wrapped(self): + """The object wrapped by the `!Literal`.""" + return self._wrapped - def as_string(self, conn_or_curs): + def as_string(self, context): # is it a connection or cursor? - if isinstance(conn_or_curs, ext.connection): - conn = conn_or_curs - elif isinstance(conn_or_curs, ext.cursor): - conn = conn_or_curs.connection + if isinstance(context, ext.connection): + conn = context + elif isinstance(context, ext.cursor): + conn = context.connection else: - raise TypeError("conn_or_curs must be a connection or a cursor") + raise TypeError("context must be a connection or a cursor") a = ext.adapt(self._wrapped) if hasattr(a, 'prepare'): @@ -362,15 +379,15 @@ class Placeholder(Composable): >>> names = ['foo', 'bar', 'baz'] - >>> q1 = sql.SQL("insert into table (%s) values (%s)") % [ + >>> q1 = sql.SQL("insert into table ({}) values ({})").format( ... sql.SQL(', ').join(map(sql.Identifier, names)), - ... sql.SQL(', ').join(sql.Placeholder() * 3)] + ... 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 (%s) values (%s)") % [ - ... sql.SQL(', ').join(map(sql.Identifier, names)), - ... sql.SQL(', ').join(map(sql.Placeholder, names))] + >>> 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) @@ -384,22 +401,24 @@ class Placeholder(Composable): elif name is not None: raise TypeError("expected string or None as name, got %r" % name) - self._name = name + super(Placeholder, self).__init__(name) + + @property + def name(self): + """The name of the `!Placeholder`.""" + return self._wrapped def __repr__(self): - return "sql.Placeholder(%r)" % ( - self._name if self._name is not None else '',) + return "Placeholder(%r)" % ( + self._wrapped if self._wrapped is not None else '',) - def as_string(self, conn_or_curs): - if self._name is not None: - return "%%(%s)s" % self._name + def as_string(self, context): + if self._wrapped is not None: + return "%%(%s)s" % self._wrapped else: return "%s" -# Alias -PH = Placeholder - # Literals NULL = SQL("NULL") DEFAULT = SQL("DEFAULT") |