azure/aria/aria-extension-cloudify/src/aria/aria/parser/presentation/__init__.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 Presentation package.
  18
  19 .. autosummary::
  20    :nosignatures:
  21
  22    aria.parser.presentation.PresentationContext
  23    aria.parser.presentation.PresenterException
  24    aria.parser.presentation.PresenterNotFoundError
  25    aria.parser.presentation.Field
  26    aria.parser.presentation.NULL
  27    aria.parser.presentation.none_to_null
  28    aria.parser.presentation.null_to_none
  29    aria.parser.presentation.Value
  30    aria.parser.presentation.Presenter
  31    aria.parser.presentation.PresenterSource
  32    aria.parser.presentation.DefaultPresenterSource
  33
  34 Presentations
  35 -------------
  36
  37 .. autosummary::
  38    :nosignatures:
  39
  40    aria.parser.presentation.PresentationBase
  41    aria.parser.presentation.Presentation
  42    aria.parser.presentation.AsIsPresentation
  43
  44 Field decorators
  45 ----------------
  46
  47 .. autosummary::
  48    :nosignatures:
  49
  50    aria.parser.presentation.has_fields
  51    aria.parser.presentation.short_form_field
  52    aria.parser.presentation.allow_unknown_fields
  53    aria.parser.presentation.primitive_field
  54    aria.parser.presentation.primitive_list_field
  55    aria.parser.presentation.primitive_dict_field
  56    aria.parser.presentation.primitive_dict_unknown_fields
  57    aria.parser.presentation.object_field
  58    aria.parser.presentation.object_list_field
  59    aria.parser.presentation.object_dict_field
  60    aria.parser.presentation.object_sequenced_list_field
  61    aria.parser.presentation.object_dict_unknown_fields
  62    aria.parser.presentation.field_getter
  63    aria.parser.presentation.field_setter
  64    aria.parser.presentation.field_validator
  65
  66 Field validators
  67 ----------------
  68
  69 .. autosummary::
  70    :nosignatures:
  71
  72    aria.parser.presentation.type_validator
  73    aria.parser.presentation.list_type_validator
  74    aria.parser.presentation.list_length_validator
  75    aria.parser.presentation.derived_from_validator
  76
  77 Utilities
  78 ---------
  79
  80 .. autosummary::
  81    :nosignatures:
  82
  83    aria.parser.presentation.get_locator
  84    aria.parser.presentation.parse_types_dict_names
  85    aria.parser.presentation.validate_primitive
  86    aria.parser.presentation.validate_no_short_form
  87    aria.parser.presentation.validate_no_unknown_fields
  88    aria.parser.presentation.validate_known_fields
  89    aria.parser.presentation.get_parent_presentation
  90    aria.parser.presentation.report_issue_for_unknown_type
  91    aria.parser.presentation.report_issue_for_parent_is_self
  92    aria.parser.presentation.report_issue_for_unknown_parent_type
  93    aria.parser.presentation.report_issue_for_circular_type_hierarchy
  94 """
  95
  96 from .exceptions import PresenterException, PresenterNotFoundError
  97 from .context import PresentationContext
  98 from .presenter import Presenter
  99 from .presentation import Value, PresentationBase, Presentation, AsIsPresentation
 100 from .source import PresenterSource, DefaultPresenterSource
 101 from .null import NULL, none_to_null, null_to_none
 102 from .fields import (Field, has_fields, short_form_field, allow_unknown_fields, primitive_field,
 103                      primitive_list_field, primitive_dict_field, primitive_dict_unknown_fields,
 104                      object_field, object_list_field, object_dict_field,
 105                      object_sequenced_list_field, object_dict_unknown_fields, field_getter,
 106                      field_setter, field_validator)
 107 from .field_validators import (type_validator, list_type_validator, list_length_validator,
 108                                derived_from_validator)
 109 from .utils import (get_locator, parse_types_dict_names, validate_primitive, validate_no_short_form,
 110                     validate_no_unknown_fields, validate_known_fields, get_parent_presentation,
 111                     report_issue_for_unknown_type, report_issue_for_unknown_parent_type,
 112                     report_issue_for_parent_is_self, report_issue_for_circular_type_hierarchy)
 113
 114 __all__ = (
 115     'PresenterException',
 116     'PresenterNotFoundError',
 117     'PresentationContext',
 118     'Presenter',
 119     'Value',
 120     'PresentationBase',
 121     'Presentation',
 122     'AsIsPresentation',
 123     'PresenterSource',
 124     'DefaultPresenterSource',
 125     'NULL',
 126     'none_to_null',
 127     'null_to_none',
 128     'Field',
 129     'has_fields',
 130     'short_form_field',
 131     'allow_unknown_fields',
 132     'primitive_field',
 133     'primitive_list_field',
 134     'primitive_dict_field',
 135     'primitive_dict_unknown_fields',
 136     'object_field',
 137     'object_list_field',
 138     'object_dict_field',
 139     'object_sequenced_list_field',
 140     'object_dict_unknown_fields',
 141     'field_getter',
 142     'field_setter',
 143     'field_validator',
 144     'type_validator',
 145     'list_type_validator',
 146     'list_length_validator',
 147     'derived_from_validator',
 148     'get_locator',
 149     'parse_types_dict_names',
 150     'validate_primitive',
 151     'validate_no_short_form',
 152     'validate_no_unknown_fields',
 153     'validate_known_fields',
 154     'get_parent_presentation',
 155     'report_issue_for_unknown_type',
 156     'report_issue_for_unknown_parent_type',
 157     'report_issue_for_parent_is_self',
 158     'report_issue_for_circular_type_hierarchy')