ob-metaflow-stubs 6.0.3.127__py2.py3-none-any.whl → 6.0.3.128__py2.py3-none-any.whl

metaflow-stubs/cards.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.916400                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.004313                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.930394                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.017658                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.929141                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.016490                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/cli_components/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.951933                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.041799                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.919646                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.007201                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/client/core.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.923994                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.011423                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
     import datetime
-    import metaflow.client.core
     import typing
-    import tarfile
+    import metaflow.client.core
     import metaflow.events
+    import tarfile
 
 from ..metaflow_current import current as current
 from ..events import Trigger as Trigger

metaflow-stubs/client/filecache.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.950083                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.036870                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.content_addressed_store
     import metaflow.exception
+    import metaflow.datastore.content_addressed_store
 
 from ..exception import MetaflowException as MetaflowException
 

metaflow-stubs/events.pyi

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.916997                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.004081                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.events
     import metaflow
+    import metaflow.events
 
 
 TYPE_CHECKING: bool

metaflow-stubs/exception.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.908634                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:33.996282                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/flowspec.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.913258                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.000902                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
-    import metaflow.exception
-    import metaflow.unbounded_foreach
     import metaflow.datastore.inputs
-    import typing
     import metaflow.flowspec
+    import typing
+    import metaflow.unbounded_foreach
+    import metaflow.exception
 
 from . import parameters as parameters
 from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.39.1+obcheckpoint(0.1.4);ob(v1) 2024-12-17T21:56:50.905462
+2.12.39.1+obcheckpoint(0.1.6);ob(v1) 2024-12-18T07:29:33.993102

metaflow-stubs/includefile.pyi

@@ -1,17 +1,17 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.919346                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.006898                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
-    import metaflow._vendor.click.types
-    import typing
     import metaflow.parameters
+    import typing
+    import metaflow._vendor.click.types
 
 from ._vendor import click as click
 from .exception import MetaflowException as MetaflowException

metaflow-stubs/info_file.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.907836                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:33.995436                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.912122                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:33.999812                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/heartbeat.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.934178                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.021259                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/metadata.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.933672                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.020763                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metadata_provider/util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.933911                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.020996                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_config.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.909666                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:33.997364                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/metaflow_current.pyi

@@ -1,21 +1,21 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:51.046031                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.133820                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core
+    import typing
+    import metaflow.plugins.cards.component_serializer
     import metaflow
-    import metaflow.metaflow_current
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator
-    import metaflow.plugins.cards.component_serializer
-    import typing
-    import metaflow.events
     import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.checkpoints.decorator
+    import metaflow.events
 
 
 TYPE_CHECKING: bool
@@ -228,21 +228,93 @@ class Current(object, metaclass=type):
     def graph(self):
         ...
     @property
-    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+    def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
         """
-        (only in the presence of the @card decorator)
+        (only in the presence of the @model decorator)
         
-        The `@card` decorator makes the cards available through the `current.card`
-        object. If multiple `@card` decorators are present, you can add an `ID` to
-        distinguish between them using `@card(id=ID)` as the decorator. You will then
-        be able to access that specific card using `current.card[ID].
+        The object used for loading / saving models.
+        `current.model` exposes a `save` method to save models and a `load` method to load models.
+        `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
+        or models loaded via `current.model.load`.
+        
+        Usage (Saving a model):
+        -------
+        
+        ```
+        @model
+        @step
+        def train(self):
+            # current.model.save returns a dictionary reference to the model saved
+            self.my_model = current.model.save(
+                path_to_my_model,
+                label="my_model",
+                metadata={
+                    "epochs": 10,
+                    "batch-size": 32,
+                    "learning-rate": 0.001,
+                }
+            )
+            self.next(self.test)
+        
+        @model(load="my_model")
+        @step
+        def test(self):
+            # `current.model.loaded` returns a dictionary of the loaded models
+            # where the key is the name of the artifact and the value is the path to the model
+            print(os.listdir(current.model.loaded["my_model"]))
+            self.next(self.end)
+        ```
+        
+        Usage (Loading models):
+        -------
+        
+        ```
+        @step
+        def train(self):
+            # current.model.load returns the path to the model loaded
+            checkpoint_path = current.model.load(
+                self.checkpoint_key,
+            )
+            model_path = current.model.load(
+                self.model,
+            )
+            self.next(self.test)
+        ```
         
-        Methods available are `append` and `extend`
         
         Returns
         -------
-        CardComponentCollector
-            The or one of the cards attached to this step.
+        ModelSerializer
+            The object used for loading / saving models.
+        """
+        ...
+    @property
+    def parallel(self) -> "metaflow.metaflow_current.Parallel":
+        """
+        (only in the presence of the @parallel decorator)
+        
+        Returns a namedtuple with relevant information about the parallel task.
+        
+        Returns
+        -------
+        Parallel
+            `namedtuple` with the following fields:
+                - main_ip (`str`)
+                    The IP address of the control task.
+                - num_nodes (`int`)
+                    The total number of tasks created by @parallel
+                - node_index (`int`)
+                    The index of the current task in all the @parallel tasks.
+                - control_task_id (`Optional[str]`)
+                    The task ID of the control task. Available to all tasks.
+        """
+        ...
+    @property
+    def is_parallel(self) -> bool:
+        """
+        (only in the presence of the @parallel decorator)
+        
+        True if the current step is a @parallel step.
         """
         ...
     @property
@@ -307,96 +379,6 @@ class Current(object, metaclass=type):
         """
         ...
     @property
-    def parallel(self) -> "metaflow.metaflow_current.Parallel":
-        """
-        (only in the presence of the @parallel decorator)
-        
-        Returns a namedtuple with relevant information about the parallel task.
-        
-        Returns
-        -------
-        Parallel
-            `namedtuple` with the following fields:
-                - main_ip (`str`)
-                    The IP address of the control task.
-                - num_nodes (`int`)
-                    The total number of tasks created by @parallel
-                - node_index (`int`)
-                    The index of the current task in all the @parallel tasks.
-                - control_task_id (`Optional[str]`)
-                    The task ID of the control task. Available to all tasks.
-        """
-        ...
-    @property
-    def is_parallel(self) -> bool:
-        """
-        (only in the presence of the @parallel decorator)
-        
-        True if the current step is a @parallel step.
-        """
-        ...
-    @property
-    def model(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.modeling_utils.core.ModelSerializer":
-        """
-        (only in the presence of the @model decorator)
-        
-        The object used for loading / saving models.
-        `current.model` exposes a `save` method to save models and a `load` method to load models.
-        `current.model.loaded` exposes the paths to the models loaded via the `load` argument in the @model decorator
-        or models loaded via `current.model.load`.
-        
-        Usage (Saving a model):
-        -------
-        
-        ```
-        @model
-        @step
-        def train(self):
-            # current.model.save returns a dictionary reference to the model saved
-            self.my_model = current.model.save(
-                path_to_my_model,
-                label="my_model",
-                metadata={
-                    "epochs": 10,
-                    "batch-size": 32,
-                    "learning-rate": 0.001,
-                }
-            )
-            self.next(self.test)
-        
-        @model(load="my_model")
-        @step
-        def test(self):
-            # `current.model.loaded` returns a dictionary of the loaded models
-            # where the key is the name of the artifact and the value is the path to the model
-            print(os.listdir(current.model.loaded["my_model"]))
-            self.next(self.end)
-        ```
-        
-        Usage (Loading models):
-        -------
-        
-        ```
-        @step
-        def train(self):
-            # current.model.load returns the path to the model loaded
-            checkpoint_path = current.model.load(
-                self.checkpoint_key,
-            )
-            model_path = current.model.load(
-                self.model,
-            )
-            self.next(self.test)
-        ```
-        
-        
-        Returns
-        -------
-        ModelSerializer
-            The object used for loading / saving models.
-        """
-        ...
-    @property
     def huggingface_hub(self) -> "metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.hf_hub.decorator.HuggingfaceRegistry":
         """
         (only in the presence of the @huggingface_hub decorator)
@@ -466,9 +448,27 @@ class Current(object, metaclass=type):
         """
         ...
     @property
+    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+        """
+        (only in the presence of the @card decorator)
+        
+        The `@card` decorator makes the cards available through the `current.card`
+        object. If multiple `@card` decorators are present, you can add an `ID` to
+        distinguish between them using `@card(id=ID)` as the decorator. You will then
+        be able to access that specific card using `current.card[ID].
+        
+        Methods available are `append` and `extend`
+        
+        Returns
+        -------
+        CardComponentCollector
+            The or one of the cards attached to this step.
+        """
+        ...
+    @property
     def trigger(self) -> "metaflow.events.Trigger":
         """
-        (only in the presence of the @trigger_on_finish, or @trigger decorators)
+        (only in the presence of the @trigger, or @trigger_on_finish decorators)
         
         Returns `Trigger` if the current run is triggered by an event
         

metaflow-stubs/mf_extensions/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.918249                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.005648                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.926884                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.014218                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.926948                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.014289                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/__init__.pyi

@@ -1,6 +1,6 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-17T21:56:50.927008                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.014349                                                            #
 ######################################################################################################
 

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/__init__.pyi

@@ -0,0 +1,6 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.065421                                                            #
+######################################################################################################
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/async_cards.pyi

@@ -0,0 +1,58 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.066039                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import threading
+import typing
+if typing.TYPE_CHECKING:
+    import threading
+    import metaflow.mf_extensions.obcheckpoint.plugins.machine_learning_utilities.card_utils.async_cards
+
+from ......metaflow_current import current as current
+
+class InfoCollectorThread(threading.Thread, metaclass=type):
+    def __init__(self, interval = 1, file_name = None):
+        ...
+    def read(self):
+        ...
+    def has_errored(self):
+        ...
+    def get_error(self):
+        ...
+    def run(self):
+        ...
+    def stop(self):
+        ...
+    ...
+
+class CardRefresher(object, metaclass=type):
+    def on_startup(self, current_card):
+        ...
+    def on_error(self, current_card, error_message):
+        ...
+    def on_update(self, current_card, data_object):
+        ...
+    ...
+
+class CardUpdaterThread(threading.Thread, metaclass=type):
+    def __init__(self, card_refresher: CardRefresher, interval = 1, file_name = None, collector_thread: InfoCollectorThread = None):
+        ...
+    def run(self):
+        ...
+    def stop(self):
+        ...
+    ...
+
+class AsyncPeriodicRefresher(object, metaclass=type):
+    def __init__(self, card_referesher: CardRefresher, updater_interval = 1, collector_interval = 1, file_name = None):
+        ...
+    def start(self):
+        ...
+    def stop(self):
+        ...
+    ...
+

metaflow-stubs/mf_extensions/obcheckpoint/plugins/machine_learning_utilities/card_utils/deco_injection_mixin.pyi

@@ -0,0 +1,23 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.6);ob(v1)                                                   #
+# Generated on 2024-12-18T07:29:34.065478                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from ......exception import MetaflowException as MetaflowException
+
+class CardDecoratorInjector(object, metaclass=type):
+    """
+    Mixin Useful for injecting @card decorators from other first class Metaflow decorators.
+    """
+    def attach_card_decorator(self, flow, step_name, card_id, card_type, refresh_interval = 5):
+        """
+        This method is called `step_init` in your StepDecorator code since
+        this class is used as a Mixin
+        """
+        ...
+    ...
+