diff options
Diffstat (limited to 'PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py')
-rw-r--r-- | PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py b/PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py new file mode 100644 index 0000000000..3235dbd485 --- /dev/null +++ b/PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py @@ -0,0 +1,42 @@ +# Copyright (c) 2018 Cisco and/or its affiliates. +# 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 holding AbstractGroupMetadata class.""" + +from abc import ABCMeta, abstractmethod + + +class AbstractGroupMetadata(object): + """Abstract classdefining API for metadata. + + At this level, only __str__() and __repr() methods are required.""" + + __metaclass__ = ABCMeta + + @abstractmethod + def __str__(self): + """Return string with human readable description of the group. + + :returns: Readable description. + :rtype: str + """ + pass + + @abstractmethod + def __repr__(self): + """Return string executable as Python constructor call. + + :returns: Executable constructor call. + :rtype: str + """ + pass |