pycognaize.common.field_collection.FieldCollection

class FieldCollection(*args, **kwargs)

Bases: OrderedDict

Contains fields included in the document by also providing functionality to group fields by group_name and group_key

Methods

clear
copy
fromkeys	Create a new ordered dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
groups_by_field	Returns groups that contain the given field
groups_by_key	Returns groups that contain the given group_key
groups_by_name	Returns fields that are contained in group with the given group name
items
keys
move_to_end	Move an existing element to the end (or beginning if last is false).
pop	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem	Remove and return a (key, value) pair from the dictionary.
setdefault	Insert key with a value of default if key is not in the dictionary.
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then 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

Attributes

groups	Return Groups
key_groups	Return Groups

clear() → None.  Remove all items from od.

copy() → a shallow copy of od

fromkeys(value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

property groups: dict

Return Groups

groups_by_field(field)

Returns groups that contain the given field

Parameters:

field (Field)

Return type:

list

groups_by_key(group_key)

Returns groups that contain the given group_key

Parameters:

group_key (str)

Return type:

dict

groups_by_name(name)

Returns fields that are contained in group with the given group name

Parameters:

name (str)

Return type:

dict

items() → a set-like object providing a view on D's items

property key_groups: dict

Return Groups

keys() → a set-like object providing a view on D's keys

move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

pop(key[, default]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then 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() → an object providing a view on D's values