Resolve locales warning for providers that end with the locale name (#…

…702)

* Resolve warning conflict

rdt/transformers/pii/anonymizer.py

@@ -80,7 +80,11 @@ def _check_locales(self):
         locales = self.locales if isinstance(self.locales, list) else [self.locales]
         missed_locales = []
         for locale in locales:
-            spec = importlib.util.find_spec(f'faker.providers.{self.provider_name}.{locale}')
+            provider_name = self.provider_name
+            if self.provider_name.endswith(f'.{locale}'):
+                provider_name = self.provider_name.replace(f'.{locale}', '')
+
+            spec = importlib.util.find_spec(f'faker.providers.{provider_name}.{locale}')
             if spec is None:
                 missed_locales.append(locale)
 

tests/unit/transformers/pii/test_anonymizer.py

@@ -186,6 +186,59 @@ def test__check_locales(self, mock_warnings, mock_importlib):
         )
         mock_warnings.warn.assert_called_once_with(expected_message)
 
+    @patch('rdt.transformers.pii.anonymizer.importlib')
+    @patch('rdt.transformers.pii.anonymizer.warnings')
+    def test__check_locales_provider_ending_with_locale(self, mock_warnings, mock_importlib):
+        """Test that check locales does not warn the user if the provider ends with the locale.
+
+        Mock:
+            - Mock importlib with side effects to return `None`.
+            - Mock the warnings.
+        """
+        # Setup
+        instance = Mock()
+        instance.provider_name = 'address.en_US'
+        instance.function_name = 'postcode'
+        instance.locales = ['en_US']
+        mock_importlib.util.find_spec.side_effect = ['en_US']
+
+        # Run
+        AnonymizedFaker._check_locales(instance)
+
+        # Assert
+        mock_warnings.warn.assert_not_called()
+
+    @patch('rdt.transformers.pii.anonymizer.importlib')
+    @patch('rdt.transformers.pii.anonymizer.warnings')
+    def test__check_locales_provider_ending_with_wrong_locale(self, mock_warnings, mock_importlib):
+        """Test that check locales warns the user.
+
+        If the provider ends with the given locale but is not separated by a dot this will warn
+        that the default 'en_US' will be used instead'.
+
+        Mock:
+            - Mock importlib with side effects to return `None`.
+            - Mock the warnings.
+        """
+        # Setup
+        instance = Mock()
+        instance.provider_name = 'addressit'
+        instance.function_name = 'postcode'
+        instance.locales = ['it']
+        mock_importlib.util.find_spec.side_effect = [None]
+
+        # Run
+        AnonymizedFaker._check_locales(instance)
+
+        # Assert
+        expected_message = (
+            "Locales ['it'] do not support provider 'addressit' and function 'postcode'.\n"
+            "In place of these locales, 'en_US' will be used instead. "
+            'Please refer to the localized provider docs for more information: '
+            'https://faker.readthedocs.io/en/master/locales.html'
+        )
+        mock_warnings.warn.assert_called_once_with(expected_message)
+
     @patch('rdt.transformers.pii.anonymizer.faker')
     @patch('rdt.transformers.pii.anonymizer.AnonymizedFaker.check_provider_function')
     def test___init__default(self, mock_check_provider_function, mock_faker):