diff options
author | Benjamin Schubert <ben.c.schubert@gmail.com> | 2019-07-09 17:54:48 +0100 |
---|---|---|
committer | Benjamin Schubert <ben.c.schubert@gmail.com> | 2019-07-09 17:54:48 +0100 |
commit | 924bc4e7e7b7c74210aefc900db2a8fb51fa3ef3 (patch) | |
tree | 9ea26a54c4b2db7e80914e7de6dea80bf651633e | |
parent | bb0bb4263cd4cbcfab940acf7694dec4b675610d (diff) | |
download | buildstream-bschubert/reorganize-yaml.tar.gz |
_yaml: Reorder methods in Node classes to match their scopebschubert/reorganize-yaml
-rw-r--r-- | src/buildstream/_yaml.pxd | 28 | ||||
-rw-r--r-- | src/buildstream/_yaml.pyx | 399 |
2 files changed, 244 insertions, 183 deletions
diff --git a/src/buildstream/_yaml.pxd b/src/buildstream/_yaml.pxd index 7aac91569..093ba80b2 100644 --- a/src/buildstream/_yaml.pxd +++ b/src/buildstream/_yaml.pxd @@ -26,11 +26,15 @@ cdef class Node: cdef int line cdef int column + # Public Methods cpdef Node copy(self) cpdef ProvenanceInformation get_provenance(self) cpdef object strip_node_info(self) + # Private Methods used in BuildStream cpdef void _assert_fully_composited(self) except * + + # Module Local Methods cdef void _compose_on(self, str key, MappingNode target, list path) except * cdef bint _is_composite_list(self) except * cdef bint _shares_position_with(self, Node target) @@ -40,15 +44,13 @@ cdef class Node: cdef class MappingNode(Node): cdef dict value - cpdef void _composite(self, MappingNode target) except * - cpdef void _composite_under(self, MappingNode target) except * - cdef Node _get(self, str key, default, default_constructor) + # Public Methods + cpdef bint get_bool(self, str key, default=*) except * + cpdef int get_int(self, str key, default=*) except * cpdef MappingNode get_mapping(self, str key, default=*) cpdef Node get_node(self, str key, list allowed_types=*, bint allow_none=*) cpdef ScalarNode get_scalar(self, str key, default=*) cpdef SequenceNode get_sequence(self, str key, object default=*) - cpdef bint get_bool(self, str key, default=*) except * - cpdef int get_int(self, str key, default=*) except * cpdef str get_str(self, str key, object default=*) cpdef object items(self) cpdef list keys(self) @@ -56,15 +58,24 @@ cdef class MappingNode(Node): cpdef void validate_keys(self, list valid_keys) except * cpdef object values(self) - cdef void __composite(self, MappingNode target, list path=*) except * + # Private Methods used in BuildStream + cpdef void _composite(self, MappingNode target) except * + cpdef void _composite_under(self, MappingNode target) except * + cpdef list _find(self, Node target) + + # Module Local Methods cdef void _compose_on_composite_dict(self, MappingNode target) cdef void _compose_on_list(self, SequenceNode target) - cpdef list _find(self, Node target) + cdef Node _get(self, str key, default, default_constructor) + + # Private Methods + cdef void __composite(self, MappingNode target, list path=*) except * cdef class ScalarNode(Node): cdef str value + # Public Methods cpdef bint as_bool(self) except * cpdef int as_int(self) except * cpdef str as_str(self) @@ -74,12 +85,13 @@ cdef class ScalarNode(Node): cdef class SequenceNode(Node): cdef list value + # Public Methods cpdef void append(self, object value) + cpdef list as_str_list(self) cpdef MappingNode mapping_at(self, int index) cpdef Node node_at(self, int index, list allowed_types=*) cpdef ScalarNode scalar_at(self, int index) cpdef SequenceNode sequence_at(self, int index) - cpdef list as_str_list(self) cdef class ProvenanceInformation: diff --git a/src/buildstream/_yaml.pyx b/src/buildstream/_yaml.pyx index 100d5a811..80c7a59ce 100644 --- a/src/buildstream/_yaml.pyx +++ b/src/buildstream/_yaml.pyx @@ -70,6 +70,13 @@ cdef class Node: self.line = line self.column = column + def __json__(self): + raise ValueError("Nodes should not be allowed when jsonify-ing data", self) + + ############################################################# + # Public Methods # + ############################################################# + @classmethod def from_dict(cls, dict value): if value: @@ -79,12 +86,6 @@ cdef class Node: # We got an empty dict, we can shortcut return MappingNode.__new__(MappingNode, _SYNTHETIC_FILE_INDEX, 0, next_synthetic_counter(), {}) - cdef bint _walk_find(self, Node target, list path) except *: - raise NotImplementedError() - - cdef bint _shares_position_with(self, Node target): - return self.file_index == target.file_index and self.line == target.line and self.column == target.column - cpdef Node copy(self): raise NotImplementedError() @@ -94,6 +95,10 @@ cdef class Node: cpdef object strip_node_info(self): raise NotImplementedError() + ############################################################# + # Private Methods used in BuildStream # + ############################################################# + # _assert_fully_composited() # # This must be called on a fully loaded and composited node, @@ -108,6 +113,13 @@ cdef class Node: cpdef void _assert_fully_composited(self) except *: raise NotImplementedError() + ############################################################# + # Module Local Methods # + ############################################################# + + cdef void _compose_on(self, str key, MappingNode target, list path) except *: + raise NotImplementedError() + # _is_composite_list # # Checks if the node is a Mapping with array composition @@ -124,11 +136,11 @@ cdef class Node: cdef bint _is_composite_list(self) except *: raise NotImplementedError() - cdef void _compose_on(self, str key, MappingNode target, list path) except *: - raise NotImplementedError() + cdef bint _shares_position_with(self, Node target): + return self.file_index == target.file_index and self.line == target.line and self.column == target.column - def __json__(self): - raise ValueError("Nodes should not be allowed when jsonify-ing data", self) + cdef bint _walk_find(self, Node target, list path) except *: + raise NotImplementedError() cdef class ScalarNode(Node): @@ -152,12 +164,13 @@ cdef class ScalarNode(Node): self.value = value + ############################################################# + # Public Methods # + ############################################################# + cpdef ScalarNode copy(self): return self - cpdef bint is_none(self): - return self.value is None - cpdef bint as_bool(self) except *: if type(self.value) is bool: return self.value @@ -190,12 +203,23 @@ cdef class ScalarNode(Node): return None return str(self.value) + cpdef bint is_none(self): + return self.value is None + cpdef object strip_node_info(self): return self.value + ############################################################# + # Private Methods used in BuildStream # + ############################################################# + cpdef void _assert_fully_composited(self) except *: pass + ############################################################# + # Module Local Methods # + ############################################################# + cdef void _compose_on(self, str key, MappingNode target, list path) except *: cdef Node target_value = target.value.get(key) @@ -222,87 +246,62 @@ cdef class MappingNode(Node): def __contains__(self, what): return what in self.value - cpdef MappingNode copy(self): - cdef dict copy = {} - cdef str key - cdef Node value + def __delitem__(self, str key): + del self.value[key] - for key, value in self.value.items(): - copy[key] = value.copy() + def __setitem__(self, str key, object value): + cdef Node old_value - return MappingNode.__new__(MappingNode, self.file_index, self.line, self.column, copy) + if type(value) in [MappingNode, ScalarNode, SequenceNode]: + self.value[key] = value + else: + node = _create_node_recursive(value, self) - # find() - # - # Searches the given node tree for the given target node. - # - # This is typically used when trying to walk a path to a given node - # for the purpose of then modifying a similar tree of objects elsewhere - # - # Args: - # target (Node): The node you are looking for in that tree - # - # Returns: - # (list): A path from `node` to `target` or None if `target` is not in the subtree - cpdef list _find(self, Node target): - cdef list path = [] - if self._walk_find(target, path): - return path - return None + # FIXME: Do we really want to override provenance? + # + # Related to https://gitlab.com/BuildStream/buildstream/issues/1058 + # + # There are only two cases were nodes are set in the code (hence without provenance): + # - When automatic variables are set by the core (e-g: max-jobs) + # - when plugins call Element.set_public_data + # + # The first case should never throw errors, so it is of limited interests. + # + # The second is more important. What should probably be done here is to have 'set_public_data' + # able of creating a fake provenance with the name of the plugin, the project and probably the + # element name. + # + # We would therefore have much better error messages, and would be able to get rid of most synthetic + # nodes. + old_value = self.value.get(key) + if old_value: + node.file_index = old_value.file_index + node.line = old_value.line + node.column = old_value.column - # composite() - # - # Compose one mapping node onto another - # - # Args: - # target (Node): The target to compose into - # - # Raises: LoadError - # - cpdef void _composite(self, MappingNode target) except *: - try: - self.__composite(target, []) - except CompositeError as e: - source_provenance = self.get_provenance() - error_prefix = "" - if source_provenance: - error_prefix = "{}: ".format(source_provenance) - raise LoadError(LoadErrorReason.ILLEGAL_COMPOSITE, - "{}Failure composing {}: {}" - .format(error_prefix, - e.path, - e.message)) from e + self.value[key] = node - # Like composite(target, source), but where target overrides source instead. - # - cpdef void _composite_under(self, MappingNode target) except *: - target._composite(self) + ############################################################# + # Public Methods # + ############################################################# + cpdef MappingNode copy(self): + cdef dict copy = {} cdef str key cdef Node value - cdef list to_delete = [key for key in target.value.keys() if key not in self.value] for key, value in self.value.items(): - target.value[key] = value - for key in to_delete: - del target.value[key] - - cdef Node _get(self, str key, object default, object default_constructor): - value = self.value.get(key, _sentinel) + copy[key] = value.copy() - if value is _sentinel: - if default is _sentinel: - provenance = self.get_provenance() - raise LoadError(LoadErrorReason.INVALID_DATA, - "{}: Dictionary did not contain expected key '{}'".format(provenance, key)) + return MappingNode.__new__(MappingNode, self.file_index, self.line, self.column, copy) - if default is None: - value = None - else: - value = default_constructor.__new__( - default_constructor, _SYNTHETIC_FILE_INDEX, 0, next_synthetic_counter(), default) + cpdef int get_int(self, str key, object default=_sentinel) except *: + cdef ScalarNode scalar = self.get_scalar(key, default) + return scalar.as_int() - return value + cpdef bint get_bool(self, str key, object default=_sentinel) except *: + cdef ScalarNode scalar = self.get_scalar(key, default) + return scalar.as_bool() cpdef MappingNode get_mapping(self, str key, object default=_sentinel): value = self._get(key, default, MappingNode) @@ -359,14 +358,6 @@ cdef class MappingNode(Node): return value - cpdef bint get_bool(self, str key, object default=_sentinel) except *: - cdef ScalarNode scalar = self.get_scalar(key, default) - return scalar.as_bool() - - cpdef int get_int(self, str key, object default=_sentinel) except *: - cdef ScalarNode scalar = self.get_scalar(key, default) - return scalar.as_int() - cpdef str get_str(self, str key, object default=_sentinel): cdef ScalarNode scalar = self.get_scalar(key, default) return scalar.as_str() @@ -383,6 +374,12 @@ cdef class MappingNode(Node): except KeyError: pass + cpdef object strip_node_info(self): + cdef str key + cdef Node value + + return {key: value.strip_node_info() for key, value in self.value.items()} + # validate_keys() # # Validate the node so as to ensure the user has not specified @@ -410,20 +407,84 @@ cdef class MappingNode(Node): cpdef object values(self): return self.value.values() - cpdef object strip_node_info(self): + ############################################################# + # Private Methods used in BuildStream # + ############################################################# + + cpdef void _assert_fully_composited(self) except *: cdef str key cdef Node value - return {key: value.strip_node_info() for key, value in self.value.items()} + for key, value in self.value.items(): + # Assert that list composition directives dont remain, this + # indicates that the user intended to override a list which + # never existed in the underlying data + # + if key in ('(>)', '(<)', '(=)'): + provenance = value.get_provenance() + raise LoadError(LoadErrorReason.TRAILING_LIST_DIRECTIVE, + "{}: Attempt to override non-existing list".format(provenance)) + + value._assert_fully_composited() + + # _composite() + # + # Compose one mapping node onto another + # + # Args: + # target (Node): The target to compose into + # + # Raises: LoadError + # + cpdef void _composite(self, MappingNode target) except *: + try: + self.__composite(target, []) + except CompositeError as e: + source_provenance = self.get_provenance() + error_prefix = "" + if source_provenance: + error_prefix = "{}: ".format(source_provenance) + raise LoadError(LoadErrorReason.ILLEGAL_COMPOSITE, + "{}Failure composing {}: {}" + .format(error_prefix, + e.path, + e.message)) from e + + # Like _composite(target, source), but where target overrides source instead. + # + cpdef void _composite_under(self, MappingNode target) except *: + target._composite(self) - cdef void __composite(self, MappingNode target, list path=None) except *: cdef str key cdef Node value + cdef list to_delete = [key for key in target.value.keys() if key not in self.value] for key, value in self.value.items(): - path.append(key) - value._compose_on(key, target, path) - path.pop() + target.value[key] = value + for key in to_delete: + del target.value[key] + + # _find() + # + # Searches the given node tree for the given target node. + # + # This is typically used when trying to walk a path to a given node + # for the purpose of then modifying a similar tree of objects elsewhere + # + # Args: + # target (Node): The node you are looking for in that tree + # + # Returns: + # (list): A path from `node` to `target` or None if `target` is not in the subtree + cpdef list _find(self, Node target): + cdef list path = [] + if self._walk_find(target, path): + return path + return None + + ############################################################# + # Module Local Methods # + ############################################################# cdef void _compose_on(self, str key, MappingNode target, list path) except *: cdef Node target_value @@ -502,6 +563,23 @@ cdef class MappingNode(Node): else: target.value["(>)"] = suffix + cdef Node _get(self, str key, object default, object default_constructor): + value = self.value.get(key, _sentinel) + + if value is _sentinel: + if default is _sentinel: + provenance = self.get_provenance() + raise LoadError(LoadErrorReason.INVALID_DATA, + "{}: Dictionary did not contain expected key '{}'".format(provenance, key)) + + if default is None: + value = None + else: + value = default_constructor.__new__( + default_constructor, _SYNTHETIC_FILE_INDEX, 0, next_synthetic_counter(), default) + + return value + cdef bint _is_composite_list(self) except *: cdef bint has_directives = False cdef bint has_keys = False @@ -521,57 +599,6 @@ cdef class MappingNode(Node): return has_directives - def __delitem__(self, str key): - del self.value[key] - - def __setitem__(self, str key, object value): - cdef Node old_value - - if type(value) in [MappingNode, ScalarNode, SequenceNode]: - self.value[key] = value - else: - node = _create_node_recursive(value, self) - - # FIXME: Do we really want to override provenance? - # - # Related to https://gitlab.com/BuildStream/buildstream/issues/1058 - # - # There are only two cases were nodes are set in the code (hence without provenance): - # - When automatic variables are set by the core (e-g: max-jobs) - # - when plugins call Element.set_public_data - # - # The first case should never throw errors, so it is of limited interests. - # - # The second is more important. What should probably be done here is to have 'set_public_data' - # able of creating a fake provenance with the name of the plugin, the project and probably the - # element name. - # - # We would therefore have much better error messages, and would be able to get rid of most synthetic - # nodes. - old_value = self.value.get(key) - if old_value: - node.file_index = old_value.file_index - node.line = old_value.line - node.column = old_value.column - - self.value[key] = node - - cpdef void _assert_fully_composited(self) except *: - cdef str key - cdef Node value - - for key, value in self.value.items(): - # Assert that list composition directives dont remain, this - # indicates that the user intended to override a list which - # never existed in the underlying data - # - if key in ('(>)', '(<)', '(=)'): - provenance = value.get_provenance() - raise LoadError(LoadErrorReason.TRAILING_LIST_DIRECTIVE, - "{}: Attempt to override non-existing list".format(provenance)) - - value._assert_fully_composited() - cdef bint _walk_find(self, Node target, list path) except *: cdef str k cdef Node v @@ -587,12 +614,56 @@ cdef class MappingNode(Node): return False + ############################################################# + # Private Methods # + ############################################################# + + cdef void __composite(self, MappingNode target, list path=None) except *: + cdef str key + cdef Node value + + for key, value in self.value.items(): + path.append(key) + value._compose_on(key, target, path) + path.pop() cdef class SequenceNode(Node): + def __cinit__(self, int file_index, int line, int column, list value): self.value = value + def __iter__(self): + return iter(self.value) + + def __len__(self): + return len(self.value) + + def __reversed__(self): + return reversed(self.value) + + def __setitem__(self, int key, object value): + cdef Node old_value + + if type(value) in [MappingNode, ScalarNode, SequenceNode]: + self.value[key] = value + else: + node = _create_node_recursive(value, self) + + # FIXME: Do we really want to override provenance? + # See __setitem__ on 'MappingNode' for more context + old_value = self.value[key] + if old_value: + node.file_index = old_value.file_index + node.line = old_value.line + node.column = old_value.column + + self.value[key] = node + + ############################################################# + # Public Methods # + ############################################################# + cpdef void append(self, object value): if type(value) in [MappingNode, ScalarNode, SequenceNode]: self.value.append(value) @@ -600,6 +671,9 @@ cdef class SequenceNode(Node): node = _create_node_recursive(value, self) self.value.append(node) + cpdef list as_str_list(self): + return [node.as_str() for node in self.value] + cpdef SequenceNode copy(self): cdef list copy = [] cdef Node entry @@ -654,13 +728,14 @@ cdef class SequenceNode(Node): return value - cpdef list as_str_list(self): - return [node.as_str() for node in self.value] - cpdef object strip_node_info(self): cdef Node value return [value.strip_node_info() for value in self.value] + ############################################################# + # Private Methods used in BuildStream # + ############################################################# + cpdef void _assert_fully_composited(self) except *: cdef Node value for value in self.value: @@ -699,32 +774,6 @@ cdef class SequenceNode(Node): return False - def __iter__(self): - return iter(self.value) - - def __len__(self): - return len(self.value) - - def __reversed__(self): - return reversed(self.value) - - def __setitem__(self, int key, object value): - cdef Node old_value - - if type(value) in [MappingNode, ScalarNode, SequenceNode]: - self.value[key] = value - else: - node = _create_node_recursive(value, self) - - # FIXME: Do we really want to override provenance? - # See __setitem__ on 'MappingNode' for more context - old_value = self.value[key] - if old_value: - node.file_index = old_value.file_index - node.line = old_value.line - node.column = old_value.column - - self.value[key] = node # Metadata container for a yaml toplevel node. # |