Documentação da API

>> Skell module

Skell structure.

Skell

Class for skell.

Source code in incolume/py/model_2023_07_05/skell.py

class Skell:
    """Class for skell."""

    def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
        """Esqueleto de função.

        args:
            args: Argumentos.
            kwargs: Argumentos chaveados.

        returns:
            Um dicionário com os argumentos de entrada.

        Examples:
            >>> skell = Skell(1, 2, 3)
            >>> skell.__dict__
            {'args': (1, 2, 3)}

            >>> skell = Skell(a=1, b=2, c=3)
            >>> skell.__dict__
            {'args': (), 'a': 1, 'b': 2, 'c': 3}

            >>> skell = Skell(1, 2, 3, a=1, b=2, c=3)
            >>> skell.__dict__
            {'args': (1, 2, 3), 'a': 1, 'b': 2, 'c': 3}
        """
        self.__dict__.update({'args': args})
        self.__dict__.update(kwargs)

__init__(*args, **kwargs)

Esqueleto de função.

Parameters:

Name	Type	Description	Default
args	typing.Any	Argumentos.	()
kwargs	typing.Any	Argumentos chaveados.	{}

Returns:

Type	Description
None	Um dicionário com os argumentos de entrada.

Examples:

>>> skell = Skell(1, 2, 3)
>>> skell.__dict__
{'args': (1, 2, 3)}

>>> skell = Skell(a=1, b=2, c=3)
>>> skell.__dict__
{'args': (), 'a': 1, 'b': 2, 'c': 3}

>>> skell = Skell(1, 2, 3, a=1, b=2, c=3)
>>> skell.__dict__
{'args': (1, 2, 3), 'a': 1, 'b': 2, 'c': 3}

Source code in incolume/py/model_2023_07_05/skell.py

def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
    """Esqueleto de função.

    args:
        args: Argumentos.
        kwargs: Argumentos chaveados.

    returns:
        Um dicionário com os argumentos de entrada.

    Examples:
        >>> skell = Skell(1, 2, 3)
        >>> skell.__dict__
        {'args': (1, 2, 3)}

        >>> skell = Skell(a=1, b=2, c=3)
        >>> skell.__dict__
        {'args': (), 'a': 1, 'b': 2, 'c': 3}

        >>> skell = Skell(1, 2, 3, a=1, b=2, c=3)
        >>> skell.__dict__
        {'args': (1, 2, 3), 'a': 1, 'b': 2, 'c': 3}
    """
    self.__dict__.update({'args': args})
    self.__dict__.update(kwargs)

run()

Run this.

Source code in incolume/py/model_2023_07_05/skell.py

def run():
    """Run this."""
    skell(1, 2, 3, a=7)

skell(*args, **kwargs)

Esqueleto de função.

Parameters:

Name	Type	Description	Default
args	typing.Any	Argumentos.	()
kwargs	typing.Any	Argumentos chaveados.	{}

Returns:

Type	Description
typing.Dict[str, typing.Any]	Um dicionário com os argumentos de entrada.

Examples:

>>> skell(1, 2, 3)
{'args': (1, 2, 3)}

>>> skell(a=1, b=2, c=3)
{'args': (), 'a': 1, 'b': 2, 'c': 3}

Source code in incolume/py/model_2023_07_05/skell.py

def skell(
    *args: typing.Any, **kwargs: typing.Any
) -> typing.Dict[str, typing.Any]:
    """Esqueleto de função.

    args:
        args: Argumentos.
        kwargs: Argumentos chaveados.

    returns:
        Um dicionário com os argumentos de entrada.

    Examples:
        >>> skell(1, 2, 3)
        {'args': (1, 2, 3)}

        >>> skell(a=1, b=2, c=3)
        {'args': (), 'a': 1, 'b': 2, 'c': 3}
    """
    result = {'args': args, **kwargs}
    logging.debug(result)
    logging.info('Args: {%s}, kwargs: {%s}', bool(args), bool(kwargs))
    return result

>> Other module

Other module.

other_print(s)

Other print.

Source code in incolume/py/model_2023_07_05/other.py

def other_print(s: Any) -> None:
    """Other print."""
    print(s)

>> Another module

Another module.

Another dataclass

Dataclass from another package.

Source code in incolume/py/model_2023_07_05/another.py

@dataclasses.dataclass
class Another:
    """Dataclass from another package."""

    name: str