Skip to content

base

A package that contains base classes for CSV sources.

DemandSource dataclass

Base class for the demand sources. This class in an abstract class that defines the interface for the demand CSV source.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@dataclass
class DemandSource:
    """
    Base class for the demand sources.
    This class in an abstract class that defines the interface for the demand CSV
    source.
    """

    @abc.abstractmethod
    def __aiter__(self: "DemandSource") -> AsyncIterator[demand_pb2.Demand]:
        """DemandSource implements Asynchronous Iterator.
        This allows you to use any implementation of DemandSource as
        ```python title="example.py" linenums="1"
        source = DemandSourceImplementation()
        for _ in source:
            # do something with Demand
        ```
        """
        ...

    @abc.abstractmethod
    async def __anext__(
        self: "DemandSource",
    ) -> demand_pb2.Demand:
        """You can fetch the next element in the asynchronous iterator."""
        ...

__aiter__() abstractmethod

DemandSource implements Asynchronous Iterator. This allows you to use any implementation of DemandSource as

example.py
1
2
3
source = DemandSourceImplementation()
for _ in source:
    # do something with Demand

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
82
83
84
85
86
87
88
89
90
91
92
@abc.abstractmethod
def __aiter__(self: "DemandSource") -> AsyncIterator[demand_pb2.Demand]:
    """DemandSource implements Asynchronous Iterator.
    This allows you to use any implementation of DemandSource as
    ```python title="example.py" linenums="1"
    source = DemandSourceImplementation()
    for _ in source:
        # do something with Demand
    ```
    """
    ...

__anext__() abstractmethod async

You can fetch the next element in the asynchronous iterator.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
94
95
96
97
98
99
@abc.abstractmethod
async def __anext__(
    self: "DemandSource",
) -> demand_pb2.Demand:
    """You can fetch the next element in the asynchronous iterator."""
    ...

MaterialsSource

Base class for material sources.

This class in an abstract class that defines the interface for materials CSV source.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
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
43
class MaterialsSource:
    """
    Base class for material sources.

    This class in an abstract class that defines the interface for materials CSV
    source.
    """

    @abc.abstractmethod
    def __aiter__(self: "MaterialsSource") -> AsyncIterator[material_pb2.Material]:
        """MaterialSource implements Asynchronous Iterator.

        This allows you to use any implementation of MaterialSource as

        ```python title="example.py" linenums="1"
        source = MaterialSourceImplementation()
        for _ in source:
            # do something with Material
        ```
        """
        ...

    @abc.abstractmethod
    async def __anext__(
        self: "MaterialsSource",
    ) -> material_pb2.Material:
        """You can fetch the next element in the asynchronous iterator."""
        ...

__aiter__() abstractmethod

MaterialSource implements Asynchronous Iterator.

This allows you to use any implementation of MaterialSource as

example.py
1
2
3
source = MaterialSourceImplementation()
for _ in source:
    # do something with Material
Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
@abc.abstractmethod
def __aiter__(self: "MaterialsSource") -> AsyncIterator[material_pb2.Material]:
    """MaterialSource implements Asynchronous Iterator.

    This allows you to use any implementation of MaterialSource as

    ```python title="example.py" linenums="1"
    source = MaterialSourceImplementation()
    for _ in source:
        # do something with Material
    ```
    """
    ...

__anext__() abstractmethod async

You can fetch the next element in the asynchronous iterator.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
38
39
40
41
42
43
@abc.abstractmethod
async def __anext__(
    self: "MaterialsSource",
) -> material_pb2.Material:
    """You can fetch the next element in the asynchronous iterator."""
    ...

ProductsSource dataclass

Base class for the product sources. This class in an abstract class that defines the interface for the products CSV source.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
@dataclass
class ProductsSource:
    """
    Base class for the product sources.
    This class in an abstract class that defines the interface for the products CSV
    source.
    """

    @abc.abstractmethod
    def __aiter__(self: "ProductsSource") -> AsyncIterator[product_pb2.Product]:
        """ProductSource implements Asynchronous Iterator.
        This allows you to use any implementation of ProductsSource as
        ```python title="example.py" linenums="1"
        source = ProductSourceImplementation()
        for _ in source:
            # do something with Product
        ```
        """
        ...

    @abc.abstractmethod
    async def __anext__(
        self: "ProductsSource",
    ) -> product_pb2.Product:
        """You can fetch the next element in the asynchronous iterator."""
        ...

__aiter__() abstractmethod

ProductSource implements Asynchronous Iterator. This allows you to use any implementation of ProductsSource as

example.py
1
2
3
source = ProductSourceImplementation()
for _ in source:
    # do something with Product

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
54
55
56
57
58
59
60
61
62
63
64
@abc.abstractmethod
def __aiter__(self: "ProductsSource") -> AsyncIterator[product_pb2.Product]:
    """ProductSource implements Asynchronous Iterator.
    This allows you to use any implementation of ProductsSource as
    ```python title="example.py" linenums="1"
    source = ProductSourceImplementation()
    for _ in source:
        # do something with Product
    ```
    """
    ...

__anext__() abstractmethod async

You can fetch the next element in the asynchronous iterator.

Source code in src/volur/sdk/v1alpha2/sources/csv/base.py 
66
67
68
69
70
71
@abc.abstractmethod
async def __anext__(
    self: "ProductsSource",
) -> product_pb2.Product:
    """You can fetch the next element in the asynchronous iterator."""
    ...