~radix/storm/database-trace-hook

« back to all changes in this revision

Viewing changes to storm/expr.py

Merge no-underscore-parse-methods [r=niemeyer,jkakar] [f=128060]

Now it's easy to tell what you can touch in Storm: If it begins with
an underscore, you definitely can't touch it in any way. If it doesn't
begin with an underscore, read the documentation to see how it's meant
to be used. If it doesn't have a docstring, file a bug. :-)

This branch renames _parse_get, _parse_set, _from_database, _to_database,
_build_raw_cursor, _raw_execute, _result_factory, _param_mark, _compile,
and _connection_factory so that they no longer have preceding underscores,
because they were all meant to be overridden in subclasses. Documentation
was added on their intended usage.

It also adds a LOT of documentation to store.py, variables.py, and
database.py, and fixes a few existing docstrings to be valid epytext.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1236
1236
    auto-incrementing sequence.  There's no standard way to compile a
1237
1237
    sequence, since it's very database-dependent.
1238
1238
 
1239
 
    This may be used as follows:
 
1239
    This may be used as follows::
1240
1240
 
1241
1241
      class Class(object):
1242
1242
          (...)