azure/aria/aria-extension-cloudify/src/aria/aria/utils/specification.py

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 """
  17 Utilities for cross-referencing code with specification documents.
  18 """
  19
  20 from .collections import OrderedDict
  21
  22
  23 DSL_SPECIFICATIONS = {}
  24
  25
  26 def implements_specification(section, spec):
  27     """
  28     Decorator for specification implementations.
  29
  30     Used for documentation and standards compliance.
  31     """
  32
  33     from .type import full_type_name
  34
  35     def decorator(obj):
  36         specification = DSL_SPECIFICATIONS.get(spec)
  37
  38         if specification is None:
  39             specification = {}
  40             DSL_SPECIFICATIONS[spec] = specification
  41
  42         if section in specification:
  43             raise Exception('you cannot specify the same @implements_specification twice, consider'
  44                             ' adding \'-1\', \'-2\', etc.: {0}, {1}'.format(spec, section))
  45
  46         specification[section] = OrderedDict((
  47             ('code', full_type_name(obj)),
  48             ('doc', obj.__doc__)))
  49
  50         try:
  51             setattr(obj, '_dsl_specifications', {section: section, spec: spec})
  52         except BaseException:
  53             pass
  54
  55         return obj
  56
  57     return decorator