Module omnipy.compute.mixins.name

Overview

View Source

from typing import cast

from inflection import underscore

from slugify import slugify

from omnipy.modules.prefect import generate_slug

from omnipy.util.mixin import DynamicMixinAcceptor

class NameJobBaseMixin:

    def __init__(self, *, name: str | None = None):

        self._name: str | None = name

        if self._name is not None:

            self._check_not_empty_string('name', self._name)

        else:

            if hasattr(self, '_job_func'):

                self._name = self._job_func.__name__

        # TODO: When job state machine is implemented, check using that to see if in job state

        self._unique_name = self._generate_unique_name() if hasattr(self, 'create_job') else None

    @staticmethod

    def _check_not_empty_string(param_name: str, param: str) -> None:

        if len(param) == 0:

            raise ValueError('Empty strings not allowed for parameter "{}"'.format(param_name))

    @property

    def name(self) -> str | None:

        return self._name

    @property

    def unique_name(self) -> str | None:

        return self._unique_name

    def _generate_unique_name(self) -> str | None:

        if self._name is None:

            return None

        class_name = self.__class__.__name__

        if class_name.endswith(DynamicMixinAcceptor.WITH_MIXINS_CLS_PREFIX):

            class_name = class_name[:-len(DynamicMixinAcceptor.WITH_MIXINS_CLS_PREFIX)]

        class_name_snake_case = underscore(class_name)

        return slugify(f'{class_name_snake_case}-{self._name}-{generate_slug(2)}')

    def _regenerate_unique_name(self) -> None:

        self._unique_name = self._generate_unique_name()

class NameJobMixin:

    def regenerate_unique_name(self) -> None:

        self_as_name_job_base_mixin = cast(NameJobBaseMixin, self)

        self_as_name_job_base_mixin._regenerate_unique_name()

Classes

NameJobBaseMixin

class NameJobBaseMixin(
    *,
    name: str | None = None
)

View Source

class NameJobBaseMixin:

    def __init__(self, *, name: str | None = None):

        self._name: str | None = name

        if self._name is not None:

            self._check_not_empty_string('name', self._name)

        else:

            if hasattr(self, '_job_func'):

                self._name = self._job_func.__name__

        # TODO: When job state machine is implemented, check using that to see if in job state

        self._unique_name = self._generate_unique_name() if hasattr(self, 'create_job') else None

    @staticmethod

    def _check_not_empty_string(param_name: str, param: str) -> None:

        if len(param) == 0:

            raise ValueError('Empty strings not allowed for parameter "{}"'.format(param_name))

    @property

    def name(self) -> str | None:

        return self._name

    @property

    def unique_name(self) -> str | None:

        return self._unique_name

    def _generate_unique_name(self) -> str | None:

        if self._name is None:

            return None

        class_name = self.__class__.__name__

        if class_name.endswith(DynamicMixinAcceptor.WITH_MIXINS_CLS_PREFIX):

            class_name = class_name[:-len(DynamicMixinAcceptor.WITH_MIXINS_CLS_PREFIX)]

        class_name_snake_case = underscore(class_name)

        return slugify(f'{class_name_snake_case}-{self._name}-{generate_slug(2)}')

    def _regenerate_unique_name(self) -> None:

        self._unique_name = self._generate_unique_name()

---

Instance variables

name

unique_name

NameJobMixin

class NameJobMixin(
    /,
    *args,
    **kwargs
)

View Source

class NameJobMixin:

    def regenerate_unique_name(self) -> None:

        self_as_name_job_base_mixin = cast(NameJobBaseMixin, self)

        self_as_name_job_base_mixin._regenerate_unique_name()

---

Methods

regenerate_unique_name

def regenerate_unique_name(
    self
) -> None

Returns:

Type	Description
NoneType

View Source

    def regenerate_unique_name(self) -> None:

        self_as_name_job_base_mixin = cast(NameJobBaseMixin, self)

        self_as_name_job_base_mixin._regenerate_unique_name()