def parse_fake_service_package(
session: Session, service_name: ServiceName,
package_data: type[BasePackageData]) -> ServicePackage:
"""
Create fake boto3 service module structure.
Used by stubs and master package.
Arguments:
session -- boto3 session.
service_name -- Target service name.
package_data -- Package data.
Returns:
ServiceModule structure.
"""
shape_parser = ShapeParser(session, service_name)
boto3_client = get_boto3_client(session, service_name)
boto3_resource = get_boto3_resource(session, service_name)
result = ServicePackage(
data=package_data,
service_name=service_name,
client=Client(
name=Client.get_class_name(service_name),
service_name=service_name,
boto3_client=boto3_client,
),
)
if boto3_resource is not None:
result.service_resource = ServiceResource(
name=ServiceResource.get_class_name(service_name),
service_name=service_name,
boto3_service_resource=boto3_resource,
)
waiter_names: list[str] = boto3_client.waiter_names
for waiter_name in waiter_names:
real_class_name = get_class_prefix(waiter_name)
waiter_class_name = f"{real_class_name}Waiter"
result.waiters.append(
Waiter(
waiter_class_name,
waiter_name=waiter_name,
service_name=service_name,
))
for paginator_name in shape_parser.get_paginator_names():
operation_name = xform_name(paginator_name)
result.paginators.append(
Paginator(
f"{paginator_name}Paginator",
operation_name=operation_name,
service_name=service_name,
paginator_name=paginator_name,
))
return result
def parse_fake_service_package(session: Session,
service_name: ServiceName) -> ServicePackage:
"""
Create fake boto3 service module structure.
Used by stubs and master package.
Arguments:
session -- boto3 session.
service_name -- Target service name.
Returns:
ServiceModule structure.
"""
shape_parser = ShapeParser(session, service_name)
result = ServicePackage(
name=service_name.module_name,
pypi_name=service_name.pypi_name,
service_name=service_name,
client=Client(),
)
boto3_client = get_boto3_client(session, service_name)
boto3_resource = get_boto3_resource(session, service_name)
if boto3_resource is not None:
result.service_resource = ServiceResource()
for waiter_name in boto3_client.waiter_names:
real_class_name = get_class_prefix(waiter_name)
waiter_class_name = f"{real_class_name}Waiter"
result.waiters.append(
Waiter(waiter_class_name, waiter_name=waiter_name))
for paginator_name in shape_parser.get_paginator_names():
operation_name = xform_name(paginator_name)
result.paginators.append(
Paginator(f"{paginator_name}Paginator",
operation_name=operation_name))
return result
def main() -> None:
"""
Main entrypoint for builder.
"""
args = parse_args(sys.argv[1:])
logger = get_logger(level=args.log_level)
session = Session(region_name=DUMMY_REGION)
botocore_session = session._session
botocore_session.set_credentials("access_key", "secret_key", "token")
args.output_path.mkdir(exist_ok=True, parents=True)
available_service_names = get_available_service_names(session)
logger.info(
f"{len(available_service_names)} supported boto3 services discovered")
if args.list_services:
for service_name in available_service_names:
print(
f"- {service_name.name} : {service_name.class_name} {service_name.boto3_doc_link}"
)
return
service_names = get_selected_service_names(args.service_names,
available_service_names)
for service_name in available_service_names:
service_name.has_service_resource = bool(
get_boto3_resource(session, service_name))
for service_name in service_names:
service_name.has_service_resource = bool(
get_boto3_resource(session, service_name))
JinjaManager.update_globals(
builder_version=args.builder_version,
get_anchor_link=get_anchor_link,
render_docstrings=True,
hasattr=hasattr,
len=len,
)
boto3_generator = Boto3Generator(
service_names=service_names,
available_service_names=available_service_names,
master_service_names=service_names
if args.partial_overload else available_service_names,
session=session,
output_path=args.output_path,
generate_setup=not args.installed,
skip_published=args.skip_published,
disable_smart_version=args.disable_smart_version,
version=args.build_version,
)
aiobotocore_generator = AioBotocoreGenerator(
service_names=service_names,
available_service_names=available_service_names,
master_service_names=service_names
if args.partial_overload else available_service_names,
session=session,
output_path=args.output_path,
generate_setup=not args.installed,
skip_published=args.skip_published,
disable_smart_version=args.disable_smart_version,
version=args.build_version,
)
generators_map = {
Product.boto3: boto3_generator.generate_stubs,
Product.boto3_services: boto3_generator.generate_service_stubs,
Product.boto3_docs: boto3_generator.generate_docs,
Product.aiobotocore: aiobotocore_generator.generate_stubs,
Product.aiobotocore_services:
aiobotocore_generator.generate_service_stubs,
Product.aiobotocore_docs: aiobotocore_generator.generate_docs,
}
generators = [generators_map[p] for p in args.products]
for generator in generators:
generator()
logger.info("Completed")
def parse_service_resource(
session: Session, service_name: ServiceName,
shape_parser: ShapeParser) -> Optional[ServiceResource]:
"""
Parse boto3 ServiceResource data.
Arguments:
session -- boto3 session.
service_name -- Target service name.
Returns:
ServiceResource structure or None if service does not have a resource.
"""
service_resource = get_boto3_resource(session, service_name)
if service_resource is None:
return None
logger = get_logger()
logger.debug("Parsing ServiceResource")
result = ServiceResource(
name=f"{service_name.class_name}ServiceResource",
service_name=service_name,
boto3_service_resource=service_resource,
docstring=(f"[{service_name.class_name}.ServiceResource documentation]"
f"({service_name.doc_link}.ServiceResource)"),
)
public_methods = get_public_methods(service_resource)
shape_method_map = shape_parser.get_service_resource_method_map()
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("ServiceResource", method_name,
public_method, service_name)
method.docstring = (
f"[ServiceResource.{method_name} documentation]"
f"({service_name.doc_link}.ServiceResource.{method_name})")
result.methods.append(method)
logger.debug("Parsing ServiceResource attributes")
result.attributes.extend(
parse_attributes(service_name, "ServiceResource", service_resource))
result.attributes.extend(parse_identifiers(service_resource))
result.attributes.extend(parse_references(service_resource))
logger.debug("Parsing ServiceResource collections")
collections = parse_collections("ServiceResource", service_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,
),
))
for sub_resource in get_sub_resources(session, service_name,
service_resource):
sub_resource_name = sub_resource.__class__.__name__.split(".", 1)[-1]
logger.debug(f"Parsing {sub_resource_name} sub resource")
result.sub_resources.append(
parse_resource(sub_resource_name, sub_resource, service_name,
shape_parser))
return result