def parse_resource(
name: str,
resource: Boto3ServiceResource,
service_name: ServiceName,
shape_parser: ShapeParser,
) -> Resource:
"""
Parse boto3 sub Resource data.
Arguments:
resource -- Original boto3 resource.
Returns:
Resource structure.
"""
result = Resource(
name=name,
service_name=service_name,
)
shape_method_map = shape_parser.get_resource_method_map(name)
public_methods = get_resource_public_methods(resource.__class__)
for method_name, public_method in public_methods.items():
if method_name in shape_method_map:
method = shape_method_map[method_name]
else:
method = parse_method(name, method_name, public_method,
service_name)
docstring = get_short_docstring(inspect.getdoc(public_method) or "")
method.docstring = "".join((
f"{docstring}\n\n" if docstring else "",
"[Show boto3 documentation]",
f"({service_name.get_boto3_doc_link(name, method_name)})\n",
"[Show boto3-stubs documentation]",
f"({service_name.get_doc_link('service_resource', name, f'{method_name} method')})",
))
result.methods.append(method)
result.attributes.extend(parse_attributes(service_name, name, resource))
result.attributes.extend(parse_identifiers(resource))
result.attributes.extend(parse_references(resource))
collections = parse_collections(name, resource, service_name, shape_parser)
for collection in collections:
result.collections.append(collection)
result.attributes.append(
Attribute(
collection.attribute_name,
InternalImport(collection.name, service_name, stringify=False),
))
return result
def parse_resource(
name: str,
resource: Boto3ServiceResource,
service_name: ServiceName,
shape_parser: ShapeParser,
) -> Resource:
"""
Parse boto3 sub Resource data.
Arguments:
resource -- Original boto3 resource.
Returns:
Resource structure.
"""
result = Resource(
name=name,
service_name=service_name,
)
shape_method_map = shape_parser.get_resource_method_map(name)
public_methods = get_resource_public_methods(resource.__class__)
for method_name, public_method in public_methods.items():
if method_name in shape_method_map:
method = shape_method_map[method_name]
else:
method = parse_method(name, method_name, public_method,
service_name)
docstring = get_short_docstring(inspect.getdoc(public_method) or "")
method.docstring = docstring
result.methods.append(method)
attributes = parse_attributes(service_name, name, resource, shape_parser)
result.attributes.extend(attributes)
identifiers = parse_identifiers(resource)
result.attributes.extend(identifiers)
references = parse_references(resource)
result.attributes.extend(references)
collections = parse_collections(name, resource, service_name, shape_parser)
for collection in collections:
result.collections.append(collection)
result.attributes.append(
Attribute(
collection.attribute_name,
InternalImport(collection.name, service_name, stringify=False),
))
return result
def parse_resource(
name: str,
resource: Boto3ServiceResource,
service_name: ServiceName,
shape_parser: ShapeParser,
) -> Resource:
"""
Parse boto3 sub Resource data.
Arguments:
resource -- Original boto3 resource.
Returns:
Resource structure.
"""
result = Resource(
name=name,
docstring=(
f"[{name} documentation]"
f"({service_name.doc_link}.ServiceResource.{name})"
),
)
shape_methods_map = shape_parser.get_resource_method_map(name)
public_methods = get_resource_public_methods(resource.__class__)
for method_name, public_method in public_methods.items():
if method_name in shape_methods_map:
method = shape_methods_map[method_name]
else:
method = parse_method(name, method_name, public_method, service_name)
method.docstring = (
f"[{name}.{method_name} documentation]"
f"({service_name.doc_link}.{name}.{method_name})"
)
result.methods.append(method)
result.attributes.extend(parse_attributes(service_name, name, resource))
result.attributes.extend(parse_identifiers(resource))
collections = parse_collections(name, resource, service_name, shape_parser)
for collection in collections:
result.collections.append(collection)
result.attributes.append(
Attribute(
collection.attribute_name, InternalImport(collection.name, service_name)
)
)
return result
