blob: 59694439530e60f6f263e24ceda1a2f4802b679c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
#!/usr/bin/python
#
# Copyright 2012 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Module that holds all global-level filter classes of Definate."""
__author__ = 'msu@google.com (Martin Suess)'
import yaml_validator
class Error(Exception):
"""Base error class."""
class Container(object):
"""Container class to hold all information to be passed between filters."""
def __init__(self, absolute_paths=None, relative_paths=None):
"""Initializer.
Args:
absolute_paths: Optional list of strings to specify the full path of the
generated files
(e.g. ['//depot/def/AUTOGEN1.net', '/tmp/AUTOGEN2.net']).
relative_paths: Optional list of strings to specify the paths of the
generated files relative to the location of the definition directory
(e.g. ['AUTOGEN1.net']).
"""
self.absolute_paths = absolute_paths if absolute_paths else []
self.relative_paths = relative_paths if relative_paths else []
self.changelist = ''
class GlobalFilter(object):
"""Abstract class defining the interface for the filter chain objects."""
def __init__(self):
"""Initializer."""
self._yaml_validator = yaml_validator.YamlValidator()
def Filter(self, container, args):
"""Interface to filter or modify data passed into it.
Args:
container: Container object which holds all global information.
See Container class for details.
args: Dictionary of arguments depending on the actual filter in use.
Raises:
NotImplementedError: In any case since this is not implemented an needs
to be defined by subclasses.
"""
raise NotImplementedError(
'This is an interface only. Implemented by subclasses.')
|
