rename functions and variables removing listDomain

home/forms/search.py

@@ -1,20 +1,20 @@
 from copy import deepcopy
 from urllib.parse import urlencode
 
-from data_platform_catalogue.search_types import ListDomainOption, ResultType
+from data_platform_catalogue.search_types import DomainOption, ResultType
 from django import forms
 
 from ..models.domain_model import Domain
-from ..service.list_domain_fetcher import ListDomainFetcher
+from ..service.domain_fetcher import DomainFetcher
 from ..service.search_tag_fetcher import SearchTagFetcher
 
 
-def get_list_domain_choices() -> list[Domain]:
-    """Make ListDomains API call to obtain domain choices"""
+def get_domain_choices() -> list[Domain]:
+    """Make Domains API call to obtain domain choices"""
     choices = [
         Domain("", "All domains"),
     ]
-    list_domain_options: list[ListDomainOption] = ListDomainFetcher().fetch()
+    list_domain_options: list[DomainOption] = DomainFetcher().fetch()
     domains: list[Domain] = [Domain(d.urn, d.name) for d in list_domain_options]
     choices.extend(domains)
     return choices
@@ -59,7 +59,7 @@ class SearchForm(forms.Form):
         ),
     )
     domain = forms.ChoiceField(
-        choices=get_list_domain_choices,
+        choices=get_domain_choices,
         required=False,
         widget=forms.Select(
             attrs={

home/models/domain_model.py

@@ -1,7 +1,7 @@
 import logging
 from typing import NamedTuple
 
-from data_platform_catalogue.search_types import ListDomainOption
+from data_platform_catalogue.search_types import DomainOption
 
 logger = logging.getLogger(__name__)
 
@@ -11,8 +11,8 @@ class Domain(NamedTuple):
     label: str
 
 
-class ListDomainModel:
-    def __init__(self, domains: list[ListDomainOption]):
+class DomainModel:
+    def __init__(self, domains: list[DomainOption]):
         self.labels = {}
 
         self.top_level_domains = [Domain(domain.urn, domain.name) for domain in domains]

home/service/list_domain_fetcher.py → home/service/domain_fetcher.py

@@ -1,12 +1,12 @@
-from data_platform_catalogue.search_types import ListDomainOption
+from data_platform_catalogue.search_types import DomainOption
 from django.core.cache import cache
 
 from .base import GenericService
 
 
-class ListDomainFetcher(GenericService):
+class DomainFetcher(GenericService):
     """
-    ListDomainFetcher implementation to fetch domains with the total number of
+    DomainFetcher implementation to fetch domains with the total number of
     associated entities from the backend.
     """
 
@@ -16,7 +16,7 @@ def __init__(self, filter_zero_entities: bool = True):
         self.cache_timeout_seconds = 300
         self.filter_zero_entities = filter_zero_entities
 
-    def fetch(self) -> list[ListDomainOption]:
+    def fetch(self) -> list[DomainOption]:
         """
         Fetch a static list of options that is independent of the search query
         and any applied filters. Values are cached for 5 seconds to avoid

home/service/search.py

@@ -3,7 +3,7 @@
 from typing import Any
 
 from data_platform_catalogue.search_types import (
-    ListDomainOption,
+    DomainOption,
     MultiSelectFilter,
     ResultType,
     SearchResponse,
@@ -14,16 +14,16 @@
 from nltk.stem import PorterStemmer
 
 from home.forms.search import SearchForm
-from home.models.domain_model import ListDomainModel
+from home.models.domain_model import DomainModel
 
 from .base import GenericService
-from .list_domain_fetcher import ListDomainFetcher
+from .domain_fetcher import DomainFetcher
 
 
 class SearchService(GenericService):
     def __init__(self, form: SearchForm, page: str, items_per_page: int = 20):
-        domains: list[ListDomainOption] = ListDomainFetcher().fetch()
-        self.domain_model = ListDomainModel(domains)
+        domains: list[DomainOption] = DomainFetcher().fetch()
+        self.domain_model = DomainModel(domains)
         self.stemmer = PorterStemmer()
         self.form = form
         if self.form.is_bound:

home/views.py

@@ -1,5 +1,5 @@
 from data_platform_catalogue.client.exceptions import EntityDoesNotExist
-from data_platform_catalogue.search_types import ListDomainOption
+from data_platform_catalogue.search_types import DomainOption
 from django.http import Http404, HttpResponseBadRequest
 from django.shortcuts import render
 
@@ -9,8 +9,8 @@
     DatabaseDetailsService,
     DatasetDetailsService,
 )
+from home.service.domain_fetcher import DomainFetcher
 from home.service.glossary import GlossaryService
-from home.service.list_domain_fetcher import ListDomainFetcher
 from home.service.metadata_specification import MetadataSpecificationService
 from home.service.search import SearchService
 
@@ -19,7 +19,7 @@ def home_view(request):
     """
     Displys only domains that have entities tagged for display in the catalog.
     """
-    domains: list[ListDomainOption] = ListDomainFetcher().fetch()
+    domains: list[DomainOption] = DomainFetcher().fetch()
     context = {"domains": domains, "h1_value": "Home"}
     return render(request, "home.html", context)
 

lib/datahub-client/data_platform_catalogue/client/datahub_client.py

@@ -3,30 +3,6 @@
 from importlib.resources import files
 from typing import Sequence
 
-from datahub.configuration.common import ConfigurationError
-from datahub.emitter import mce_builder
-from datahub.emitter.mcp import MetadataChangeProposalWrapper
-from datahub.ingestion.graph.client import DatahubClientConfig, DataHubGraph
-from datahub.ingestion.source.common.subtypes import (
-    DatasetContainerSubTypes,
-    DatasetSubTypes,
-)
-from datahub.metadata import schema_classes
-from datahub.metadata.com.linkedin.pegasus2avro.common import DataPlatformInstance
-from datahub.metadata.schema_classes import (
-    ChangeTypeClass,
-    ContainerClass,
-    ContainerPropertiesClass,
-    DatasetPropertiesClass,
-    DomainPropertiesClass,
-    DomainsClass,
-    OtherSchemaClass,
-    SchemaFieldClass,
-    SchemaFieldDataTypeClass,
-    SchemaMetadataClass,
-    SubTypesClass,
-)
-
 from data_platform_catalogue.client.exceptions import (
     AspectDoesNotExist,
     ConnectivityError,
@@ -57,13 +33,36 @@
     Table,
 )
 from data_platform_catalogue.search_types import (
-    ListDomainOption,
+    DomainOption,
     MultiSelectFilter,
     ResultType,
     SearchFacets,
     SearchResponse,
     SortOption,
 )
+from datahub.configuration.common import ConfigurationError
+from datahub.emitter import mce_builder
+from datahub.emitter.mcp import MetadataChangeProposalWrapper
+from datahub.ingestion.graph.client import DatahubClientConfig, DataHubGraph
+from datahub.ingestion.source.common.subtypes import (
+    DatasetContainerSubTypes,
+    DatasetSubTypes,
+)
+from datahub.metadata import schema_classes
+from datahub.metadata.com.linkedin.pegasus2avro.common import DataPlatformInstance
+from datahub.metadata.schema_classes import (
+    ChangeTypeClass,
+    ContainerClass,
+    ContainerPropertiesClass,
+    DatasetPropertiesClass,
+    DomainPropertiesClass,
+    DomainsClass,
+    OtherSchemaClass,
+    SchemaFieldClass,
+    SchemaFieldDataTypeClass,
+    SchemaMetadataClass,
+    SubTypesClass,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -230,9 +229,9 @@ def list_domains(
             MultiSelectFilter("tags", ["urn:li:tag:dc_display_in_catalogue"])
         ],
         count: int = 1000,
-    ) -> list[ListDomainOption]:
+    ) -> list[DomainOption]:
         """
-        Returns a list of ListDomainOption objects
+        Returns a list of DomainOption objects
         """
         return self.search_client.list_domains(
             query=query, filters=filters, count=count

lib/datahub-client/data_platform_catalogue/client/search.py

@@ -3,9 +3,6 @@
 from importlib.resources import files
 from typing import Any, Sequence
 
-from datahub.configuration.common import GraphError  # pylint: disable=E0611
-from datahub.ingestion.graph.client import DataHubGraph  # pylint: disable=E0611
-
 from data_platform_catalogue.client.exceptions import CatalogueError
 from data_platform_catalogue.client.graphql_helpers import (
     parse_created_and_modified,
@@ -19,15 +16,17 @@
 )
 from data_platform_catalogue.entities import EntityRef
 from data_platform_catalogue.search_types import (
+    DomainOption,
     FacetOption,
-    ListDomainOption,
     MultiSelectFilter,
     ResultType,
     SearchFacets,
     SearchResponse,
     SearchResult,
     SortOption,
 )
+from datahub.configuration.common import GraphError  # pylint: disable=E0611
+from datahub.ingestion.graph.client import DataHubGraph  # pylint: disable=E0611
 
 logger = logging.getLogger(__name__)
 
@@ -193,7 +192,7 @@ def list_domains(
             MultiSelectFilter("tags", ["urn:li:tag:dc_display_in_catalogue"])
         ],
         count: int = 1000,
-    ) -> list[ListDomainOption]:
+    ) -> list[DomainOption]:
         """
         Returns domains that can be used to filter the search results.
         """
@@ -255,8 +254,8 @@ def _map_filters(self, filters: Sequence[MultiSelectFilter]):
 
     def _parse_list_domains(
         self, list_domains_result: list[dict[str, Any]]
-    ) -> list[ListDomainOption]:
-        list_domain_options: list[ListDomainOption] = []
+    ) -> list[DomainOption]:
+        list_domain_options: list[DomainOption] = []
 
         for domain in list_domains_result:
             urn = domain.get("urn", "")
@@ -265,7 +264,7 @@ def _parse_list_domains(
             entities = domain.get("entities", {})
             total = entities.get("total", 0)
 
-            list_domain_options.append(ListDomainOption(urn, name, total))
+            list_domain_options.append(DomainOption(urn, name, total))
         return list_domain_options
 
     def _parse_result(

lib/datahub-client/data_platform_catalogue/search_types.py

@@ -55,7 +55,7 @@ class FacetOption:
 
 
 @dataclass
-class ListDomainOption:
+class DomainOption:
     """
     A representation of a domain and the number of associated entities
     represented by total.

lib/datahub-client/tests/test_integration_with_datahub_server.py

@@ -12,7 +12,6 @@
 from datetime import datetime, timezone
 
 import pytest
-
 from data_platform_catalogue.client.datahub_client import DataHubCatalogueClient
 from data_platform_catalogue.entities import (
     AccessInformation,
@@ -32,7 +31,7 @@
     UsageRestrictions,
 )
 from data_platform_catalogue.search_types import (
-    ListDomainOption,
+    DomainOption,
     MultiSelectFilter,
     ResultType,
 )
@@ -48,7 +47,7 @@ def test_list_domains():
     response = client.list_domains()
     assert len(response) > 0
     domain = response[0]
-    assert isinstance(domain, ListDomainOption)
+    assert isinstance(domain, DomainOption)
     assert "urn:li:domain" in domain.urn
 
 

tests/conftest.py

@@ -26,8 +26,8 @@
     UsageRestrictions,
 )
 from data_platform_catalogue.search_types import (
+    DomainOption,
     FacetOption,
-    ListDomainOption,
     ResultType,
     SearchFacets,
     SearchResponse,
@@ -38,9 +38,9 @@
 from faker import Faker
 
 from home.forms.search import SearchForm
-from home.models.domain_model import ListDomainModel
+from home.models.domain_model import DomainModel
 from home.service.details import DatabaseDetailsService
-from home.service.list_domain_fetcher import ListDomainFetcher
+from home.service.domain_fetcher import DomainFetcher
 from home.service.search import SearchService
 from home.service.search_facet_fetcher import SearchFacetFetcher
 from home.service.search_tag_fetcher import SearchTagFetcher
@@ -294,22 +294,22 @@ def mock_catalogue(request, example_database):
     mock_list_domains_response(
         mock_catalogue,
         domains=[
-            ListDomainOption(
+            DomainOption(
                 urn="urn:li:domain:prisons",
                 name="Prisons",
                 total=fake.random_int(min=1, max=100),
             ),
-            ListDomainOption(
+            DomainOption(
                 urn="urn:li:domain:courts",
                 name="Courts",
                 total=fake.random_int(min=1, max=100),
             ),
-            ListDomainOption(
+            DomainOption(
                 urn="urn:li:domain:finance",
                 name="Finance",
                 total=fake.random_int(min=1, max=100),
             ),
-            ListDomainOption(
+            DomainOption(
                 urn="urn:li:domain:hq",
                 name="HQ",
                 total=0,
@@ -443,7 +443,7 @@ def search_facets():
 
 @pytest.fixture
 def list_domains(filter_zero_entities):
-    return ListDomainFetcher(filter_zero_entities).fetch()
+    return DomainFetcher(filter_zero_entities).fetch()
 
 
 @pytest.fixture
@@ -453,8 +453,8 @@ def search_tags():
 
 @pytest.fixture
 def valid_domain():
-    domains = ListDomainFetcher().fetch()
-    return ListDomainModel(
+    domains = DomainFetcher().fetch()
+    return DomainModel(
         domains,
     ).top_level_domains[0]