Class Map

Constructs a 'Map' object with a given 'ark'. The 'ark' can be of the following types of objects:

• dict The 'Map' object will be constructed consistent with the dict object.
• Map The 'ark' will be deep-copied.
• str The string will be parsed and the 'Map' object will be constructed for the parsed string.
• list The elements of the list object must be of the above types. A new 'Map' object will be constructed using the first elements, and then the 'Map' object will be updated with the remaining objects in the list.

If 'ark' is not provided, an empty 'Map' will be constructed. User can optionally specify the 'parent' parameter, which will set the parent of this 'Map' object to the given value of the 'parent' parameter.

Parameters:

• parent - This paremeter provides the parent of this 'Sea' object. It can be None.

Overrides: object.__init__

Sets an attribute called 'key' with 'value'.
- 'key' can be a str object or a 'Key' object.
- 'value' can be a 'Sea' object or other types of object (including None).
- If 'key' already exists in this 'Map' object and its value is a 'Sea' object, then 'value' must be either None or a
- 'Sea' object. In other words, you cannot change a 'Sea' value to a non-'Sea' value except for None.
- The parent of the 'value', if it is a 'Sea' object, will reset to this 'Map' object after this function.

Overrides: object.__setattr__

Converts this 'Map' object into a string representation.
- 'ind' specifies the indentation of the converted string.
- 'tag' specifies the tags. And only the keys with the specified tags will be converted.
  'tag' can be a string (representing a single tag) or a 'list' or 'set' of strings (representing multiple tags).
- 'pre' specifies the prefix.

Overrides: object.__str__

Compares this 'Map' object with another 'Map' object 'rhs', returns True if the keys and values in both are equal, or False if otherwise. Note if '__CHECK_SEA_DEBUG' is set to True, difference in detail will be printed to the stdout.

Overrides: Sea.__eq__

This is the support for the 'in' operation, and it returns True if 'key' is already in this 'Map' object, False if
otherwise.
- 'key' can be either a string or a 'Key' object.

This is the iterator fr the support for the 'for ... in ...' syntax. The element yielded is the key of this 'Map' object.

Returns the value associated with the 'key'.
- 'key' should be string or 'Key' object.
- If 'key' does not exist in this 'Map' object, the 'KeyError' exception will be raised.

Associates the given 'value' with the given 'key'.
- 'key' should be string or 'Key' object.
- If 'key' does not exist in this 'Map' object before, the 'key' will be put into the 'Map' object.
- 'value' will be processed first by the '_val_filter' function (see above), the 'Sea' object returned by the
  '_val_filter' function will be the actual object associated with the key. So any object acceptable by the
  '_val_filter' function can be used here.

Overrides: Sea.__deepcopy__

Returns references of all keys in a list. Note each element in the returned list will be of the 'Key' type.

Returns references of all values in a list. Note each element in the returned list will be of the 'Sea' type.

Returns the key and associated value in a list. Note each element in the returned list will be a 2-tuple object. The first element of the tuple is a reference of the key, and the second element is a reference of the value. User can optionally set the 'should_sort' parameter to True, which will let the function return a sorted list. The sorting will be based on the alphanumeric order of 'key'.

Recursively applies the operation as given by 'op' to all 'Sea' subobjects of this 'Sea' object.

Overrides: Sea.apply

Updates this 'Map' object with the given 'ark' or with the given 'file'.

Parameters:

• file - If 'file' is not None, it must be the name of a file in the ark file format. If 'file' is given, the 'ark' parameter will be ignored.
• ark - ark can be a string or a dict or a 'Map' object. Or ark can be list of the previous objects.

Returns True if this 'Map' object has the 'key'. Returns False if otherwise.

Returns the value of the given 'key'.

Parameters:

• key - The 'key' can be a composite key (i.e., the pathway notation), such as, e.g., "key[1][2].key2.key3[2]".

Associates the given value with the given key. The difference between this function and the __setitem__ operator is that the former allows us to reset the tag of the value.

Parameters:

• key - The 'key' can be a composite key (i.e., the pathway notation), e.g., "key[1].key2[0].key3".
• tag - If the "tag" parameter is specified, the value of 'tag' will be used to tag the 'value'.

INDEX_PATTERN

Value:

re.compile(r'([^\[]*)\[ *([\+-]*[1234567890]*) *\]')

raw_val

Readwrite. When read, this returns the current raw value (references and macros kept as is).

Get Method:

__get_raw_val(self) - This function returns the value of the 'raw_val' property (see below).

Set Method:

__set_val(self, val) - This function sets the value of the 'val' property (see below).

bval

Readonly. Returns a new `Map' object, which has all macros expanded and references dereferenced.

Get Method:

__get_bval(self) - Returns a new 'Sea' object, which has all macros expanded and references dereferenced.

dval

Readonly. Returns a new `Map' object with dereferenced values.

Get Method:

__get_dval(self) - Returns a new `Sea' object, which has all references dereferenced but macros kept as is.

val

Readwrite. When read, this returns the current value (macros will be expanded, and references will be dereferenced.

Get Method:

__get_val(self) - Returns the value of this 'Map' object.

Set Method:

__set_val(self, val) - This function sets the value of the 'val' property (see below).