rules

sample module that performs sample operations.

Contains

• SampleClass

SampleClass

Documentation of the SampleClass.

Source code in my_module/libs/rules/rules.py

class SampleClass:
    """Documentation of the SampleClass."""

    def __init__(self) -> None:
        """Initializes samples class."""
        return

    @staticmethod
    def true() -> bool:
        """Return True my friend."""
        return True

    @classmethod
    def false(cls) -> bool:
        """
        Doc strings should not start with Returns...
        Nonetheless, returns False
        """
        return False

__init__() -> None

Initializes samples class.

Source code in my_module/libs/rules/rules.py

def __init__(self) -> None:
    """Initializes samples class."""
    return

false() -> bool classmethod

Doc strings should not start with Returns... Nonetheless, returns False

Source code in my_module/libs/rules/rules.py

@classmethod
def false(cls) -> bool:
    """
    Doc strings should not start with Returns...
    Nonetheless, returns False
    """
    return False

true() -> bool staticmethod

Return True my friend.

Source code in my_module/libs/rules/rules.py

@staticmethod
def true() -> bool:
    """Return True my friend."""
    return True

create_rules(some_parameter: str | None = None) -> bool

compute and parse rules for validation

Parameters:

Name	Type	Description	Default
some_parameter	str | None	parameter for function. Defaults to None.	None

Returns:

Name	Type	Description
bool	bool	parsed rules.

Source code in my_module/libs/rules/rules.py

def create_rules(some_parameter: str | None = None) -> bool:  # noqa: D103
    """compute and parse rules for validation

    Args:
        some_parameter (str | None, optional): parameter for function. Defaults to None.

    Returns:
        bool: parsed rules.
    """
    return True