sprox.metadata¶
matadata Module
This contains the class which defines the generic interface for metadata. Basically, it provides an interface for how data is extracted from the provider for widget generation.
Copyright (c) 2008 Christopher Perkins Original Version by Christopher Perkins 2007 Released under MIT license.
Classes¶
- class sprox.metadata.Metadata(provider, entity=None)¶
Bases: dict
Base Metadata class
Metadatas are dictionary-like. They map attributes of the entity they wrap, so that attributes of the entity can be examined without being explicitly set. Elements of a metadata can be set if they are not already part of the wrapped entity. This allows for customization of the metadata without modification to the wrapped metadata.
- clear() → None. Remove all items from D.¶
- copy() → a shallow copy of D¶
- static fromkeys(S[, v]) → New dict with keys from S and values equal to v.¶
v defaults to None.
- get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶
- has_key(k) → True if D has a key k, else False¶
- items() → list of D's (key, value) pairs, as 2-tuples¶
- iteritems() → an iterator over the (key, value) items of D¶
- iterkeys() → an iterator over the keys of D¶
- itervalues() → an iterator over the values of D¶
- keys()¶
- pop(k[, d]) → v, remove specified key and return the corresponding value.¶
If key is not found, d is returned if given, otherwise KeyError is raised
- popitem() → (k, v), remove and return some (key, value) pair as a¶
2-tuple; but raise KeyError if D is empty.
- setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
- update(E, **F) → None. Update D from dict/iterable E and F.¶
If E has a .keys() method, does: for k in E: D[k] = E[k] If E lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values() → list of D's values¶
- viewitems() → a set-like object providing a view on D's items¶
- viewkeys() → a set-like object providing a view on D's keys¶
- viewvalues() → an object providing a view on D's values¶
- class sprox.metadata.EntitiesMetadata(provider, entity=None)¶
Bases: sprox.metadata.Metadata
A class to extract entities from a database definition.
- clear() → None. Remove all items from D.¶
- copy() → a shallow copy of D¶
- static fromkeys(S[, v]) → New dict with keys from S and values equal to v.¶
v defaults to None.
- get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶
- has_key(k) → True if D has a key k, else False¶
- items() → list of D's (key, value) pairs, as 2-tuples¶
- iteritems() → an iterator over the (key, value) items of D¶
- iterkeys() → an iterator over the keys of D¶
- itervalues() → an iterator over the values of D¶
- keys()¶
- pop(k[, d]) → v, remove specified key and return the corresponding value.¶
If key is not found, d is returned if given, otherwise KeyError is raised
- popitem() → (k, v), remove and return some (key, value) pair as a¶
2-tuple; but raise KeyError if D is empty.
- setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
- update(E, **F) → None. Update D from dict/iterable E and F.¶
If E has a .keys() method, does: for k in E: D[k] = E[k] If E lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values() → list of D's values¶
- viewitems() → a set-like object providing a view on D's items¶
- viewkeys() → a set-like object providing a view on D's keys¶
- viewvalues() → an object providing a view on D's values¶
- class sprox.metadata.FieldMetadata(provider, entity=None)¶
Bases: sprox.metadata.Metadata
In the future, if the Field attributes need to be extracted, this is where it will happen.
- clear() → None. Remove all items from D.¶
- copy() → a shallow copy of D¶
- static fromkeys(S[, v]) → New dict with keys from S and values equal to v.¶
v defaults to None.
- get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶
- has_key(k) → True if D has a key k, else False¶
- items() → list of D's (key, value) pairs, as 2-tuples¶
- iteritems() → an iterator over the (key, value) items of D¶
- iterkeys() → an iterator over the keys of D¶
- itervalues() → an iterator over the values of D¶
- keys()¶
- pop(k[, d]) → v, remove specified key and return the corresponding value.¶
If key is not found, d is returned if given, otherwise KeyError is raised
- popitem() → (k, v), remove and return some (key, value) pair as a¶
2-tuple; but raise KeyError if D is empty.
- setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
- update(E, **F) → None. Update D from dict/iterable E and F.¶
If E has a .keys() method, does: for k in E: D[k] = E[k] If E lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values() → list of D's values¶
- viewitems() → a set-like object providing a view on D's items¶
- viewkeys() → a set-like object providing a view on D's keys¶
- viewvalues() → an object providing a view on D's values¶
- class sprox.metadata.FieldsMetadata(provider, entity)¶
Bases: sprox.metadata.Metadata
A class to extract fields from an entity.
- clear() → None. Remove all items from D.¶
- copy() → a shallow copy of D¶
- static fromkeys(S[, v]) → New dict with keys from S and values equal to v.¶
v defaults to None.
- get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶
- has_key(k) → True if D has a key k, else False¶
- items() → list of D's (key, value) pairs, as 2-tuples¶
- iteritems() → an iterator over the (key, value) items of D¶
- iterkeys() → an iterator over the keys of D¶
- itervalues() → an iterator over the values of D¶
- keys()¶
- pop(k[, d]) → v, remove specified key and return the corresponding value.¶
If key is not found, d is returned if given, otherwise KeyError is raised
- popitem() → (k, v), remove and return some (key, value) pair as a¶
2-tuple; but raise KeyError if D is empty.
- setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
- update(E, **F) → None. Update D from dict/iterable E and F.¶
If E has a .keys() method, does: for k in E: D[k] = E[k] If E lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
- values() → list of D's values¶
- viewitems() → a set-like object providing a view on D's items¶
- viewkeys() → a set-like object providing a view on D's keys¶
- viewvalues() → an object providing a view on D's values¶
