pydal.helpers package

Submodules

pydal.helpers.classes module

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

Bases: object

clear(*args, **kwargs)
copy(*args, **kwargs)
get(key, default=None)[source]
has_key(key)
items()[source]
iteritems()[source]
iterkeys()[source]
itervalues()[source]
keys()[source]
pop(*args, **kwargs)
update(*args, **kwargs)[source]
values()[source]
class pydal.helpers.classes.DatabaseStoredFile(db, filename, mode)[source]
close()[source]
close_connection()[source]
escape(obj)[source]
static exists(db, filename)[source]
read(bytes)[source]
readline()[source]
static try_create_web2py_filesystem(db)[source]
web2py_filesystems = set([])
write(data)[source]
class pydal.helpers.classes.FakeCursor[source]

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)[source]
class pydal.helpers.classes.FakeDriver(*args, **kwargs)[source]

Bases: pydal.helpers.classes.BasicStorage

close()[source]
commit()[source]
cursor()[source]
class pydal.helpers.classes.MethodAdder(table)[source]

Bases: object

register(method_name=None)[source]
class pydal.helpers.classes.NullCursor[source]

Bases: pydal.helpers.classes.FakeCursor

lastrowid = 1
class pydal.helpers.classes.NullDriver(*args, **kwargs)[source]

Bases: pydal.helpers.classes.FakeDriver

class pydal.helpers.classes.RecordDeleter(table, id)[source]

Bases: object

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

Bases: object

class pydal.helpers.classes.Reference[source]

Bases: long

get(key, default=None)[source]
pydal.helpers.classes.Reference_pickler(data)[source]
pydal.helpers.classes.Reference_unpickler(data)[source]
class pydal.helpers.classes.SQLALL(table)[source]

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[source]

Bases: list

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

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)[source]
startswith(text=None)[source]
class pydal.helpers.classes.Serializable[source]

Bases: object

as_dict(flat=False, sanitize=True)[source]
as_json(sanitize=True)[source]
as_xml(sanitize=True)[source]
as_yaml(sanitize=True)[source]
class pydal.helpers.classes.UseDatabaseStoredFile[source]
file_close(fileobj)[source]
file_delete(filename)[source]
file_exists(filename)[source]
file_open(filename, mode='rb', lock=True)[source]
pydal.helpers.classes.pickle_basicstorage(s)[source]

pydal.helpers.methods module

pydal.helpers.methods.archive_record(qset, fs, archive_table, current_record)[source]
pydal.helpers.methods.auto_represent(field)[source]
pydal.helpers.methods.auto_validators(field)[source]
pydal.helpers.methods.bar_decode_integer(value)[source]
pydal.helpers.methods.bar_decode_string(value)[source]
pydal.helpers.methods.bar_encode(items)[source]
pydal.helpers.methods.bar_escape(item)[source]
pydal.helpers.methods.cleanup(text)[source]

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

pydal.helpers.methods.geoLine(*line)[source]
pydal.helpers.methods.geoPoint(x, y)[source]
pydal.helpers.methods.geoPolygon(*line)[source]
pydal.helpers.methods.hide_password(uri)[source]
pydal.helpers.methods.int2uuid(n)[source]
pydal.helpers.methods.list_represent(values, row=None)[source]
pydal.helpers.methods.pluralize(singular, rules=[(<_sre.SRE_Pattern object at 0x7fda3c4dcac0>, <_sre.SRE_Pattern object at 0x7fda3c4dcac0>, 'children'), (<_sre.SRE_Pattern object at 0x7fda3c496b30>, <_sre.SRE_Pattern object at 0x7fda3c496b30>, 'eet'), (<_sre.SRE_Pattern object at 0x7fda3c54eb70>, <_sre.SRE_Pattern object at 0x7fda3c54eb70>, 'eeth'), (<_sre.SRE_Pattern object at 0x7fda3c54ec30>, <_sre.SRE_Pattern object at 0x7fda3c4dcb90>, 'l\\1aves'), (<_sre.SRE_Pattern object at 0x7fda3c496be0>, <_sre.SRE_Pattern object at 0x7fda3c496be0>, 'ses'), (<_sre.SRE_Pattern object at 0x7fda3c496c90>, <_sre.SRE_Pattern object at 0x7fda3c496c90>, 'men'), (<_sre.SRE_Pattern object at 0x7fda3c496d40>, <_sre.SRE_Pattern object at 0x7fda3c496d40>, 'ives'), (<_sre.SRE_Pattern object at 0x7fda3c496df0>, <_sre.SRE_Pattern object at 0x7fda3c496df0>, 'eaux'), (<_sre.SRE_Pattern object at 0x7fda3c4a8df0>, <_sre.SRE_Pattern object at 0x7fda3c4a8df0>, 'lves'), (<_sre.SRE_Pattern object at 0x7fda3c4dcc60>, <_sre.SRE_Pattern object at 0x7fda3997e920>, 'es'), (<_sre.SRE_Pattern object at 0x7fda3c4ed8f0>, <_sre.SRE_Pattern object at 0x7fda3997e920>, 'es'), (<_sre.SRE_Pattern object at 0x7fda3c4958e8>, <_sre.SRE_Pattern object at 0x7fda39160c00>, 'ies'), (<_sre.SRE_Pattern object at 0x7fda3997e920>, <_sre.SRE_Pattern object at 0x7fda3997e920>, 's')])[source]
pydal.helpers.methods.smart_query(fields, text)[source]
pydal.helpers.methods.use_common_filters(query)[source]
pydal.helpers.methods.uuid2int(uuidv)[source]
pydal.helpers.methods.varquote_aux(name, quotestr='%s')[source]
pydal.helpers.methods.xorify(orderby)[source]

pydal.helpers.regex module

Module contents