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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# Copyright 2015 Amazon.com, Inc. or its affiliates. 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. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from botocore.hooks import HierarchicalEmitter
from boto3.docs.attr import document_attribute
from tests.unit.docs import BaseDocsTest
class TestDocumentAttribute(BaseDocsTest):
def setUp(self):
super().setUp()
self.add_shape(
{
'NestedStruct': {
'type': 'structure',
'members': {
'NestedStrAttr': {
'shape': 'String',
'documentation': 'Documents a nested string attribute',
}
},
}
}
)
self.add_shape(
{
'ResourceShape': {
'type': 'structure',
'members': {
'StringAttr': {
'shape': 'String',
'documentation': 'Documents a string attribute',
},
'NestedAttr': {
'shape': 'NestedStruct',
'documentation': 'Documents a nested attribute',
},
},
}
}
)
self.setup_client_and_resource()
self.event_emitter = HierarchicalEmitter()
self.service_name = 'myservice'
self.resource_name = 'myresource'
self.service_model = self.client.meta.service_model
def test_document_attr_scalar(self):
shape_model = self.service_model.shape_for('ResourceShape')
attr_name = 'StringAttr'
document_attribute(
self.doc_structure,
self.service_name,
self.resource_name,
attr_name,
self.event_emitter,
shape_model.members[attr_name],
)
self.assert_contains_lines_in_order(
[
'.. py:attribute:: StringAttr',
' - *(string) --* Documents a string attribute',
]
)
def test_document_attr_structure(self):
shape_model = self.service_model.shape_for('ResourceShape')
attr_name = 'NestedAttr'
document_attribute(
self.doc_structure,
self.service_name,
self.resource_name,
attr_name,
self.event_emitter,
shape_model.members[attr_name],
)
self.assert_contains_lines_in_order(
[
'.. py:attribute:: NestedAttr',
' - *(dict) --* Documents a nested attribute',
(
' - **NestedStrAttr** *(string) --* Documents a nested '
'string attribute'
),
]
)
|
