pydal.helpers package

Submodules

pydal.helpers.classes module

class pydal.helpers.classes.BasicStorage(*args, **kwargs)

Bases: object

clear(*args, **kwargs)

copy(*args, **kwargs)

get(key, default=None)

has_key(key)

items()

iteritems()

iterkeys()

itervalues()

keys()

pop(*args, **kwargs)

update(*args, **kwargs)

values()

class pydal.helpers.classes.DatabaseStoredFile(db, filename, mode)

close()

close_connection()

escape(obj)

static exists(db, filename)

static is_operational_error(db, error)

static is_programming_error(db, error)

read(bytes=None)

readline()

static try_create_web2py_filesystem(db)

web2py_filesystems = set([])

write(data)

class pydal.helpers.classes.ExecutionHandler(adapter)

Bases: object

after_execute(command)

before_execute(command)

class pydal.helpers.classes.FakeCursor

Bases: object

The Python Database API Specification has a cursor() method, which NoSql drivers generally don’t support. If the exception in this function is taken then it likely means that some piece of functionality has not yet been implemented in the driver. And something is using the cursor.

https://www.python.org/dev/peps/pep-0249/

warn_bad_usage(attr)

class pydal.helpers.classes.FakeDriver(*args, **kwargs)

Bases: pydal.helpers.classes.BasicStorage

close()

commit()

cursor()

class pydal.helpers.classes.MethodAdder(table)

Bases: object

register(method_name=None)

class pydal.helpers.classes.NullCursor

Bases: pydal.helpers.classes.FakeCursor

lastrowid = 1

class pydal.helpers.classes.NullDriver(*args, **kwargs)

Bases: pydal.helpers.classes.FakeDriver

class pydal.helpers.classes.RecordDeleter(colset, table, id)

Bases: pydal.helpers.classes.RecordOperator

class pydal.helpers.classes.RecordOperator(colset, table, id)

Bases: object

class pydal.helpers.classes.RecordUpdater(colset, table, id)

Bases: pydal.helpers.classes.RecordOperator

class pydal.helpers.classes.Reference

Bases: long

get(key, default=None)

pydal.helpers.classes.Reference_pickler(data)

pydal.helpers.classes.Reference_unpickler(data)

class pydal.helpers.classes.SQLALL(table)

Bases: object

Helper class providing a comma-separated string having all the field names (prefixed by table name and ‘.’)

normally only called from within gluon.dal

class pydal.helpers.classes.SQLCallableList

Bases: list

class pydal.helpers.classes.SQLCustomType(type='string', native=None, encoder=None, decoder=None, validator=None, _class=None, widget=None, represent=None)

Bases: object

Allows defining of custom SQL types

Parameters:

• type – the web2py type (default = ‘string’)
• native – the backend type
• encoder – how to encode the value to store it in the backend
• decoder – how to decode the value retrieved from the backend
• validator – what validators to use ( default = None, will use the default validator for type)

Example::

Define as:

decimal = SQLCustomType(

type =’double’, native =’integer’, encoder =(lambda x: int(float(x) * 100)), decoder = (lambda x: Decimal(“0.00”) + Decimal(str(float(x)/100)) ) )

db.define_table(

‘example’, Field(‘value’, type=decimal) )

endswith(text=None)

startswith(text=None)

class pydal.helpers.classes.Serializable

Bases: object

as_dict(flat=False, sanitize=True)

as_json(sanitize=True)

as_xml(sanitize=True)

as_yaml(sanitize=True)

class pydal.helpers.classes.TimingHandler(adapter)

Bases: pydal.helpers.classes.ExecutionHandler

MAXSTORAGE = 100

after_execute(command)

before_execute(command)

timings

pydal.helpers.classes.pickle_basicstorage(s)

pydal.helpers.methods module

pydal.helpers.methods.archive_record(qset, fs, archive_table, current_record)

pydal.helpers.methods.auto_represent(field)

pydal.helpers.methods.auto_validators(field)

pydal.helpers.methods.bar_decode_integer(value)

pydal.helpers.methods.bar_decode_string(value)

pydal.helpers.methods.bar_encode(items)

pydal.helpers.methods.bar_escape(item)

pydal.helpers.methods.cleanup(text)

Validates that the given text is clean: only contains [0-9a-zA-Z_]

pydal.helpers.methods.geoLine(*line)

pydal.helpers.methods.geoPoint(x, y)

pydal.helpers.methods.geoPolygon(*line)

pydal.helpers.methods.hide_password(uri)

pydal.helpers.methods.int2uuid(n)

pydal.helpers.methods.list_represent(values, row=None)

pydal.helpers.methods.pluralize(singular, rules=[(<_sre.SRE_Pattern object at 0x7f2e9ee4cac0>, <_sre.SRE_Pattern object at 0x7f2e9ee4cac0>, 'children'), (<_sre.SRE_Pattern object at 0x7f2e9ee7bc90>, <_sre.SRE_Pattern object at 0x7f2e9ee7bc90>, 'eet'), (<_sre.SRE_Pattern object at 0x7f2e9ed80330>, <_sre.SRE_Pattern object at 0x7f2e9ed80330>, 'eeth'), (<_sre.SRE_Pattern object at 0x7f2e9ed803f0>, <_sre.SRE_Pattern object at 0x7f2e9ee4cb90>, 'l\\1aves'), (<_sre.SRE_Pattern object at 0x7f2e9ee7bd40>, <_sre.SRE_Pattern object at 0x7f2e9ee7bd40>, 'ses'), (<_sre.SRE_Pattern object at 0x7f2e9ee7bdf0>, <_sre.SRE_Pattern object at 0x7f2e9ee7bdf0>, 'men'), (<_sre.SRE_Pattern object at 0x7f2e9ee7bea0>, <_sre.SRE_Pattern object at 0x7f2e9ee7bea0>, 'ives'), (<_sre.SRE_Pattern object at 0x7f2e9ee7bf50>, <_sre.SRE_Pattern object at 0x7f2e9ee7bf50>, 'eaux'), (<_sre.SRE_Pattern object at 0x7f2e9ee3c990>, <_sre.SRE_Pattern object at 0x7f2e9ee3c990>, 'lves'), (<_sre.SRE_Pattern object at 0x7f2e9ee4cc60>, <_sre.SRE_Pattern object at 0x7f2e9f48d510>, 'es'), (<_sre.SRE_Pattern object at 0x7f2ea26bac70>, <_sre.SRE_Pattern object at 0x7f2e9f48d510>, 'es'), (<_sre.SRE_Pattern object at 0x7f2e9edd1318>, <_sre.SRE_Pattern object at 0x7f2e9ed6c150>, 'ies'), (<_sre.SRE_Pattern object at 0x7f2e9f48d510>, <_sre.SRE_Pattern object at 0x7f2e9f48d510>, 's')])

pydal.helpers.methods.smart_query(fields, text)

pydal.helpers.methods.use_common_filters(query)

pydal.helpers.methods.uuid2int(uuidv)

pydal.helpers.methods.varquote_aux(name, quotestr='%s')

pydal.helpers.methods.xorify(orderby)

pydal.helpers.regex module

Module contents