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
|
# 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 boto3.docs.action import ActionDocumenter
from tests.unit.docs import BaseDocsTest
class TestActionDocumenter(BaseDocsTest):
def test_document_service_resource_actions(self):
action_documenter = ActionDocumenter(self.resource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'.. py:method:: sample_operation(**kwargs)',
' **Request Syntax**',
' ::',
' response = myservice.sample_operation(',
' Foo=\'string\',',
' Bar=\'string\'',
' )',
' :type Foo: string',
' :param Foo: Documents Foo',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns:',
' **Response Syntax**',
' ::',
' {',
' \'Foo\': \'string\',',
' \'Bar\': \'string\'',
' }',
' **Response Structure**',
' - *(dict) --*',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar',
]
)
def test_document_nonservice_resource_actions(self):
subresource = self.resource.Sample('mysample')
action_documenter = ActionDocumenter(subresource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'.. py:method:: load()',
(
' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'
),
' **Request Syntax** ',
' ::',
' sample.load()',
' :returns: None',
'.. py:method:: operate(**kwargs)',
' **Request Syntax** ',
' ::',
' response = sample.operate(',
" Bar='string'",
' )',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns: ',
' ',
' **Response Syntax** ',
' ::',
' {',
" 'Foo': 'string',",
" 'Bar': 'string'",
' }',
' **Response Structure** ',
' - *(dict) --* ',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar',
'.. py:method:: reload()',
(
' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'
),
' **Request Syntax** ',
' ::',
' sample.reload()',
' :returns: None',
]
)
|
