def _get_region_or_default()

in codeguru_profiler_agent/codeguru_client_builder.py [0:0]

• 18 lines of code
• 10 McCabe index (conditional complexity)

    def _get_region_or_default(self):
        """
        Creating a AWS client can fail with NoRegionError if there was no way for the sdk to detect the region
        If the region is not specified in the client constructor through providing boto3.Session, the sdk would
        search in ~/.aws/config or AWS_DEFAULT_REGION
        Any user running in an EC2, lambda, fargate... etc would have this set somehow but to prevent the agent from
        crashing for customers running on a different environment we will set region to IAD with a warning if there is
        not one defined.
        """
        region_from_session = self._get_session_or_default().region_name
        if self._region_name is not None:
            if region_from_session is not None and self._region_name != region_from_session:
                logger.info("Different region settings were detected - session: {region_from_session}, "
                            "parameter: {region_from_param}. By default, client will be created with region "
                            "specified in parameter: {region_from_param}"
                            .format(region_from_session=region_from_session, region_from_param=self._region_name))
            return self._region_name

        # let the SDK search for the region...
        if region_from_session is not None:
            return region_from_session

        # No region has been set, creating an AWS client will fail in this case, set region to IAD by default.
        # Debatable if we want to do this best effort here. We could simply let the boto3 client raise an exception
        # when it finds that there is no way to chose the region. I decided to do this for our agent not to block the
        # process for users running it in local environment, even if it will probably not work unless their profiling
        # group happens to be in IAD. This also saves us from having to set a region everywhere in unit tests.
        logger.info(
            "AWS SDK was not able to detect the region either from config file or environment variable, "
            + "default region will be set to us-east-1. Make sure you set the region_name parameter in the "
            + "Profiler constructor to the region in which you created your profiling group. "
            + "See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html for other ways."
        )
        return "us-east-1"