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

Collection docstrings #261

Merged
merged 6 commits into from
Nov 10, 2015
Merged

Collection docstrings #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
73eb8c6
Abstract collection documentation methods
kyleknap Sep 15, 2015
edf19eb
Add docstring for collection batch action
kyleknap Sep 15, 2015
761d811
Add docstrings to collection methods
kyleknap Sep 15, 2015
d901fb1
Add docstring for collection attr
kyleknap Sep 15, 2015
3e84a64
Update some tests for docstrings
kyleknap Sep 15, 2015
de0eb74
Integration tests pass
kyleknap Sep 17, 2015
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
285 changes: 181 additions & 104 deletions boto3/docs/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,120 +38,197 @@ def document_collections(self, section):
self._document_collection(collection_section, collection)

def _document_collection(self, section, collection):
section.style.start_sphinx_py_attr(collection.name)
methods = get_instance_public_methods(
getattr(self._resource, collection.name))
document_collection_object(section, collection)
batch_actions = {}
for batch_action in collection.batch_actions:
batch_actions[batch_action.name] = batch_action

for method in sorted(methods):
method_section = section.add_new_section(method)
if method in batch_actions:
self._document_batch_action(
method_section, batch_actions[method], collection)
document_batch_action(
section=method_section,
resource_name=self._resource_name,
event_emitter=self._resource.meta.client.meta.events,
batch_action_model=batch_actions[method],
collection_model=collection,
service_model=self._resource.meta.client.meta.service_model
)
else:
self._document_custom_action(
method_section, method, collection)

def _document_batch_action(self, section, action, collection):
operation_model = self._service_model.operation_model(
action.request.operation)
ignore_params = get_resource_ignore_params(action.request.params)

example_return_value = 'response'
if action.resource:
example_return_value = xform_name(action.resource.type)
resource_name = xform_name(self._resource_name)
if self.represents_service_resource:
resource_name = self._resource_name
example_prefix = '%s = %s.%s.%s' % (
example_return_value, resource_name,
collection.name, action.name
)
document_collection_method(
section=method_section,
resource_name=self._resource_name,
action_name=method,
event_emitter=self._resource.meta.client.meta.events,
collection_model=collection,
service_model=self._resource.meta.client.meta.service_model
)


def document_collection_object(section, collection_model,
include_signature=True):
"""Documents a collection resource object

:param section: The section to write to

:param collection_model: The model of the collection

:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
"""
if include_signature:
section.style.start_sphinx_py_attr(collection_model.name)
section.include_doc_string(
'A collection of %s resources' % collection_model.resource.type)


def document_batch_action(section, resource_name, event_emitter,
batch_action_model, service_model, collection_model,
include_signature=True):
"""Documents a collection's batch action

:param section: The section to write to

:param resource_name: The name of the resource

:param action_name: The name of collection action. Currently only
can be all, filter, limit, or page_size

:param event_emitter: The event emitter to use to emit events

:param batch_action_model: The model of the batch action

:param collection_model: The model of the collection

:param service_model: The model of the service

:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
"""
operation_model = service_model.operation_model(
batch_action_model.request.operation)
ignore_params = get_resource_ignore_params(
batch_action_model.request.params)

example_return_value = 'response'
if batch_action_model.resource:
example_return_value = xform_name(batch_action_model.resource.type)

example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name
example_prefix = '%s = %s.%s.%s' % (
example_return_value, example_resource_name,
collection_model.name, batch_action_model.name
)
document_model_driven_resource_method(
section=section, method_name=batch_action_model.name,
operation_model=operation_model,
event_emitter=event_emitter,
method_description=operation_model.documentation,
example_prefix=example_prefix,
exclude_input=ignore_params,
resource_action_model=batch_action_model,
include_signature=include_signature
)


def document_collection_method(section, resource_name, action_name,
event_emitter, collection_model, service_model,
include_signature=True):
"""Documents a collection method

:param section: The section to write to

:param resource_name: The name of the resource

:param action_name: The name of collection action. Currently only
can be all, filter, limit, or page_size

:param event_emitter: The event emitter to use to emit events

:param collection_model: The model of the collection

:param service_model: The model of the service

:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
"""
operation_model = service_model.operation_model(
collection_model.request.operation)

underlying_operation_members = []
if operation_model.input_shape:
underlying_operation_members = operation_model.input_shape.members

example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name

custom_action_info_dict = {
'all': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection.' % collection_model.resource.type),
'example_prefix': '%s_iterator = %s.%s.all' % (
xform_name(collection_model.resource.type),
example_resource_name, collection_model.name),
'exclude_input': underlying_operation_members
},
'filter': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection filtered by kwargs passed to '
'method.' % collection_model.resource.type),
'example_prefix': '%s_iterator = %s.%s.filter' % (
xform_name(collection_model.resource.type),
example_resource_name, collection_model.name),
'exclude_input': get_resource_ignore_params(
collection_model.request.params)
},
'limit': {
'method_description': (
'Creates an iterable up to a specified amount of '
'%s resources in the collection.' %
collection_model.resource.type),
'example_prefix': '%s_iterator = %s.%s.limit' % (
xform_name(collection_model.resource.type),
example_resource_name, collection_model.name),
'include_input': [
DocumentedShape(
name='count', type_name='integer',
documentation=(
'The limit to the number of resources '
'in the iterable.'))],
'exclude_input': underlying_operation_members
},
'page_size': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection, but limits the number of '
'items returned by each service call by the specified '
'amount.' % collection_model.resource.type),
'example_prefix': '%s_iterator = %s.%s.page_size' % (
xform_name(collection_model.resource.type),
example_resource_name, collection_model.name),
'include_input': [
DocumentedShape(
name='count', type_name='integer',
documentation=(
'The number of items returned by each '
'service call'))],
'exclude_input': underlying_operation_members
}
}
if action_name in custom_action_info_dict:
action_info = custom_action_info_dict[action_name]
document_model_driven_resource_method(
section=section, method_name=action.name,
section=section, method_name=action_name,
operation_model=operation_model,
event_emitter=self._resource.meta.client.meta.events,
method_description=operation_model.documentation,
example_prefix=example_prefix,
exclude_input=ignore_params,
resource_action_model=action
event_emitter=event_emitter,
resource_action_model=collection_model,
include_signature=include_signature,
**action_info
)

def _document_custom_action(self, section, action_name, collection):
operation_model = self._service_model.operation_model(
collection.request.operation)

underlying_operation_members = []
if operation_model.input_shape:
underlying_operation_members = operation_model.input_shape.members

resource_name = xform_name(self._resource_name)
if self.represents_service_resource:
resource_name = self._resource_name

custom_action_info_dict = {
'all': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection.' % collection.resource.type),
'example_prefix': '%s_iterator = %s.%s.all' % (
xform_name(collection.resource.type),
resource_name, collection.name),
'exclude_input': underlying_operation_members
},
'filter': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection filtered by kwargs passed to '
'method.' % collection.resource.type),
'example_prefix': '%s_iterator = %s.%s.filter' % (
xform_name(collection.resource.type),
resource_name, collection.name),
'exclude_input': get_resource_ignore_params(
collection.request.params)
},
'limit': {
'method_description': (
'Creates an iterable up to a specified amount of '
'%s resources in the collection.' %
collection.resource.type),
'example_prefix': '%s_iterator = %s.%s.limit' % (
xform_name(collection.resource.type),
resource_name, collection.name),
'include_input': [
DocumentedShape(
name='count', type_name='integer',
documentation=(
'The limit to the number of resources '
'in the iterable.'))],
'exclude_input': underlying_operation_members
},
'page_size': {
'method_description': (
'Creates an iterable of all %s resources '
'in the collection, but limits the number of '
'items returned by each service call by the specified '
'amount.' % collection.resource.type),
'example_prefix': '%s_iterator = %s.%s.page_size' % (
xform_name(collection.resource.type),
resource_name, collection.name),
'include_input': [
DocumentedShape(
name='count', type_name='integer',
documentation=(
'The number of items returned by each '
'service call'))],
'exclude_input': underlying_operation_members
}
}
if action_name in custom_action_info_dict:
action_info = custom_action_info_dict[action_name]
document_model_driven_resource_method(
section=section, method_name=action_name,
operation_model=operation_model,
event_emitter=self._resource.meta.client.meta.events,
resource_action_model=collection,
**action_info
)
18 changes: 18 additions & 0 deletions boto3/docs/docstring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
from boto3.docs.attr import document_attribute
from boto3.docs.attr import document_identifier
from boto3.docs.attr import document_reference
from boto3.docs.collection import document_collection_object
from boto3.docs.collection import document_collection_method
from boto3.docs.collection import document_batch_action


class ActionDocstring(LazyLoadedDocstring):
Expand Down Expand Up @@ -48,3 +51,18 @@ def _write_docstring(self, *args, **kwargs):
class ReferenceDocstring(LazyLoadedDocstring):
def _write_docstring(self, *args, **kwargs):
document_reference(*args, **kwargs)


class CollectionDocstring(LazyLoadedDocstring):
def _write_docstring(self, *args, **kwargs):
document_collection_object(*args, **kwargs)


class CollectionMethodDocstring(LazyLoadedDocstring):
def _write_docstring(self, *args, **kwargs):
document_collection_method(*args, **kwargs)


class BatchActionDocstring(LazyLoadedDocstring):
def _write_docstring(self, *args, **kwargs):
document_batch_action(*args, **kwargs)
Loading