PyPI/jumpavg/jumpavg/AbstractGroupMetadata.py

   1 # Copyright (c) 2018 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Module holding AbstractGroupMetadata class."""
  15
  16 from abc import ABCMeta, abstractmethod
  17
  18
  19 class AbstractGroupMetadata(object):
  20     """Abstract classdefining API for metadata.
  21
  22     At this level, only __str__() and __repr() methods are required."""
  23
  24     __metaclass__ = ABCMeta
  25
  26     @abstractmethod
  27     def __str__(self):
  28         """Return string with human readable description of the group.
  29
  30         :returns: Readable description.
  31         :rtype: str
  32         """
  33         pass
  34
  35     @abstractmethod
  36     def __repr__(self):
  37         """Return string executable as Python constructor call.
  38
  39         :returns: Executable constructor call.
  40         :rtype: str
  41         """
  42         pass