Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "Add client exceptions to boto3 docs" #4354

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Revert "Add client exceptions to boto3 docs" #4354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions boto3/docs/service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ def __init__(self, service_name, session, root_docs_path):
self.sections = [
'title',
'client',
'client-exceptions',
'paginators',
'waiters',
'resources',
Expand All @@ -66,7 +65,6 @@ def document_service(self):
self.title(doc_structure.get_section('title'))

self.client_api(doc_structure.get_section('client'))
self.client_exceptions(doc_structure.get_section('client-exceptions'))
self.paginator_api(doc_structure.get_section('paginators'))
self.waiter_api(doc_structure.get_section('waiters'))
if self._service_resource:
Expand Down
6 changes: 0 additions & 6 deletions tests/unit/docs/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,12 +344,6 @@ def add_shape_to_params(
required_list.append(param_name)
params_shape['required'] = required_list

def add_shape_to_errors(self, shape_name):
operation = self.json_model['operations']['SampleOperation']
errors = operation.get('errors', [])
errors.append({'shape': shape_name})
operation['errors'] = errors

def assert_contains_lines_in_order(self, lines, contents=None):
if contents is None:
contents = self.doc_structure.flush_structure().decode('utf-8')
Expand Down
86 changes: 0 additions & 86 deletions tests/unit/docs/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,13 @@
# 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.docs.client import ClientExceptionsDocumenter

from boto3.docs.client import Boto3ClientDocumenter
from tests.unit.docs import BaseDocsTest


class TestBoto3ClientDocumenter(BaseDocsTest):
def setUp(self):
super().setUp()
exception_shape = {
'SomeException': {
'exception': True,
'type': 'structure',
'members': {'Message': {'shape': 'String'}},
}
}
self.add_shape(exception_shape)
self.add_shape_to_errors('SomeException')
self.setup_client_and_resource()
self.client_documenter = Boto3ClientDocumenter(
self.client, self.root_services_path
)
Expand Down Expand Up @@ -108,82 +96,8 @@ def test_document_client(self):
' - *(dict) --*',
' - **Foo** *(string) --*',
' - **Bar** *(string) --*',
'**Exceptions**',
'* :py:class:`MyService.Client.exceptions.SomeException`',
],
self.get_nested_service_contents(
'myservice', 'client', 'sample_operation'
),
)


class TestClientExceptionsDocumenter(BaseDocsTest):
def setup_documenter(self):
self.setup_client_and_resource()
self.exceptions_documenter = ClientExceptionsDocumenter(
self.client, self.root_services_path
)

def test_no_modeled_exceptions(self):
self.setup_documenter()
self.exceptions_documenter.document_exceptions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'=================',
'Client Exceptions',
'=================',
'Client exceptions are available',
'This client has no modeled exception classes.',
]
)

def test_modeled_exceptions(self):
exception_shape = {
'SomeException': {
'exception': True,
'type': 'structure',
'members': {'Message': {'shape': 'String'}},
}
}
self.add_shape(exception_shape)
self.setup_documenter()
self.exceptions_documenter.document_exceptions(self.doc_structure)
self.assert_contains_lines_in_order(
[
'=================',
'Client Exceptions',
'=================',
'Client exceptions are available',
'The available client exceptions are:',
'.. toctree::',
':maxdepth: 1',
':titlesonly:',
' myservice/client/exceptions/SomeException',
]
)
self.assert_contains_lines_in_order(
[
'.. py:class:: MyService.Client.exceptions.SomeException',
'**Example**',
'::',
'except client.exceptions.SomeException as e:',
'.. py:attribute:: response',
'**Syntax**',
'{',
"'Message': 'string',",
"'Error': {",
"'Code': 'string',",
"'Message': 'string'",
'}',
'}',
'**Structure**',
'- *(dict) --*',
'- **Message** *(string) --* ',
'- **Error** *(dict) --* ',
'- **Code** *(string) --* ',
'- **Message** *(string) --* ',
],
self.get_nested_service_contents(
'myservice', 'client/exceptions', 'SomeException'
),
)
8 changes: 0 additions & 8 deletions tests/unit/docs/test_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,6 @@ def test_document_service(self):
'.. py:class:: MyService.Client',
'These are the available methods:',
' myservice/client/sample_operation',
'=================',
'Client Exceptions',
'=================',
'Client exceptions are available on a client instance ',
'via the ``exceptions`` property. For more detailed instructions ',
'and examples on the exact usage of client exceptions, see the ',
'error handling ',
'This client has no modeled exception classes.',
'==========',
'Paginators',
'==========',
Expand Down
Loading