def test_get_paginator_names(self) -> None:
session_mock = MagicMock()
service_name_mock = MagicMock()
session_mock._loader.load_service_model.return_value = {"pagination": ["c", "a", "b"]}
shape_parser = ShapeParser(session_mock, service_name_mock)
assert shape_parser.get_paginator_names() == ["a", "b", "c"]
session_mock._loader.load_service_model.return_value = {"paginations": ["c", "a", "b"]}
shape_parser = ShapeParser(session_mock, service_name_mock)
assert shape_parser.get_paginator_names() == []
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 parse_service_package(
session: Session, service_name: ServiceName,
package_data: type[BasePackageData]) -> ServicePackage:
"""
Extract all data from boto3 service package.
Arguments:
session -- boto3 session.
service_name -- Target service name.
package_data -- Package data.
Returns:
ServiceModule structure.
"""
logger = get_logger()
logger.debug("Parsing Shapes")
shape_parser = ShapeParser(session, service_name)
logger.debug("Parsing Client")
client = parse_client(session, service_name, shape_parser)
service_resource = parse_service_resource(session, service_name,
shape_parser)
result = ServicePackage(
data=package_data,
service_name=service_name,
client=client,
service_resource=service_resource,
)
waiter_names: list[str] = client.boto3_client.waiter_names
for waiter_name in waiter_names:
logger.debug(f"Parsing Waiter {waiter_name}")
waiter = client.boto3_client.get_waiter(waiter_name)
waiter_record = Waiter(
name=f"{waiter.name}Waiter",
waiter_name=waiter_name,
service_name=service_name,
)
wait_method = shape_parser.get_wait_method(waiter.name)
waiter_record.methods.append(wait_method)
result.waiters.append(waiter_record)
for paginator_name in shape_parser.get_paginator_names():
logger.debug(f"Parsing Paginator {paginator_name}")
operation_name = xform_name(paginator_name)
# boto3_paginator = client.boto3_client.get_paginator(operation_name)
paginator_record = Paginator(
name=f"{paginator_name}Paginator",
paginator_name=paginator_name,
operation_name=operation_name,
service_name=service_name,
)
paginate_method = shape_parser.get_paginate_method(paginator_name)
paginator_record.methods.append(paginate_method)
result.paginators.append(paginator_record)
if result.paginators:
if len(result.paginators) == 1:
method = result.paginators[0].get_client_method()
method.decorators.clear()
result.client.methods.append(method)
else:
for paginator in result.paginators:
method = paginator.get_client_method()
result.client.methods.append(method)
if result.waiters:
if len(result.waiters) == 1:
method = result.waiters[0].get_client_method()
method.decorators.clear()
result.client.methods.append(method)
else:
for package_waiter in result.waiters:
method = package_waiter.get_client_method()
result.client.methods.append(method)
result.typed_dicts = result.extract_typed_dicts()
result.literals = result.extract_literals()
result.validate()
return result
def parse_service_package(session: Session,
service_name: ServiceName) -> ServicePackage:
"""
Extract all data from boto3 service package.
Arguments:
session -- boto3 session.
service_name -- Target service name.
Returns:
ServiceModule structure.
"""
logger = get_logger()
logger.debug("Parsing Shapes")
shape_parser = ShapeParser(session, service_name)
logger.debug("Parsing Client")
client = parse_client(session, service_name, shape_parser)
service_resource = parse_service_resource(session, service_name,
shape_parser)
result = ServicePackage(
name=service_name.module_name,
pypi_name=service_name.pypi_name,
service_name=service_name,
client=client,
service_resource=service_resource,
)
for waiter_name in client.boto3_client.waiter_names:
logger.debug(f"Parsing Waiter {waiter_name}")
waiter = client.boto3_client.get_waiter(waiter_name)
waiter_record = Waiter(
name=f"{waiter.name}Waiter",
docstring=(f"[Waiter.{waiter.name} documentation]"
f"({service_name.doc_link}.Waiter.{waiter.name})"),
waiter_name=waiter_name,
)
wait_method = shape_parser.get_wait_method(waiter.name)
wait_method.docstring = (
f"[{waiter.name}.wait documentation]"
f"({service_name.doc_link}.Waiter.{waiter.name}.wait)")
waiter_record.methods.append(wait_method)
result.waiters.append(waiter_record)
for paginator_name in shape_parser.get_paginator_names():
logger.debug(f"Parsing Paginator {paginator_name}")
operation_name = xform_name(paginator_name)
paginator = client.boto3_client.get_paginator(operation_name)
paginator_record = Paginator(
name=f"{paginator_name}Paginator",
operation_name=operation_name,
docstring=(
f"[Paginator.{paginator_name} documentation]"
f"({service_name.doc_link}.Paginator.{paginator_name})"),
)
paginate_method = shape_parser.get_paginate_method(paginator_name)
paginate_method.docstring = (
f"[{paginator_name}.paginate documentation]"
f"({service_name.doc_link}.Paginator.{paginator_name}.paginate)")
paginator_record.methods.append(paginate_method)
result.paginators.append(paginator_record)
for paginator in result.paginators:
method = paginator.get_client_method()
result.client.methods.append(method)
for waiter in result.waiters:
method = waiter.get_client_method()
result.client.methods.append(method)
result.typed_dicts = result.extract_typed_dicts(result.get_types(), {})
return result