Skip to content

factory

FileRetrievalFactory

Factory for creating file retrieval strategies based on location type.

This factory class is responsible for returning the appropriate strategy implementation for retrieving files based on the specified location type.

Source code in src/cloe_nessy/file_utilities/factory.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class FileRetrievalFactory:
    """Factory for creating file retrieval strategies based on location type.

    This factory class is responsible for returning the appropriate strategy
    implementation for retrieving files based on the specified location type.
    """

    _strategy_map = {
        LocationType.LOCAL: LocalDirectoryStrategy,
        LocationType.VOLUME: LocalDirectoryStrategy,
        LocationType.ABFS: UtilsStrategy,
        LocationType.S3: UtilsStrategy,
        LocationType.ONELAKE: OneLakeStrategy,
    }

    @staticmethod
    def get_strategy(location_type: LocationType) -> LocalDirectoryStrategy | OneLakeStrategy | UtilsStrategy:
        """Returns the appropriate file retrieval strategy for the given location type.

        Depending on the provided location type, this method returns an instance
        of either `LocalDirectoryStrategy` or `UtilsStrategy`. If the
        location type is not recognized, a `ValueError` is raised.

        Args:
            location_type: The location type for which to get the retrieval strategy.

        Returns:
            FileRetrievalStrategy: An instance of the appropriate file retrieval strategy.

        Raises:
            ValueError: If the provided location type is unknown or unsupported.
        """
        strategy_class = FileRetrievalFactory._strategy_map.get(location_type)
        if not strategy_class:
            raise ValueError(f"Unknown location type: {location_type}")
        return strategy_class()  # type: ignore

get_strategy(location_type) staticmethod

Returns the appropriate file retrieval strategy for the given location type.

Depending on the provided location type, this method returns an instance of either LocalDirectoryStrategy or UtilsStrategy. If the location type is not recognized, a ValueError is raised.

Parameters:

Name Type Description Default
location_type LocationType

The location type for which to get the retrieval strategy.

 required

Returns:

Name Type Description
FileRetrievalStrategy LocalDirectoryStrategy | OneLakeStrategy | UtilsStrategy

An instance of the appropriate file retrieval strategy.

Raises:

Type Description
ValueError

If the provided location type is unknown or unsupported.
Source code in src/cloe_nessy/file_utilities/factory.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@staticmethod
def get_strategy(location_type: LocationType) -> LocalDirectoryStrategy | OneLakeStrategy | UtilsStrategy:
    """Returns the appropriate file retrieval strategy for the given location type.

    Depending on the provided location type, this method returns an instance
    of either `LocalDirectoryStrategy` or `UtilsStrategy`. If the
    location type is not recognized, a `ValueError` is raised.

    Args:
        location_type: The location type for which to get the retrieval strategy.

    Returns:
        FileRetrievalStrategy: An instance of the appropriate file retrieval strategy.

    Raises:
        ValueError: If the provided location type is unknown or unsupported.
    """
    strategy_class = FileRetrievalFactory._strategy_map.get(location_type)
    if not strategy_class:
        raise ValueError(f"Unknown location type: {location_type}")
    return strategy_class()  # type: ignore