Skip to content

Module Template

Vinicius Reif Biavatti edited this page Jul 25, 2022 · 1 revision
  • You can use this template as base to create modules in the correct format and order.
"""
Module summary.
"""
from typing import (
    Any,
    Final,
    TYPE_CHECKING,
)
if TYPE_CHECKING:
    pass  # Type hint imports


###############################################################################
# Module Constants
###############################################################################


PUBLIC_CONST: Final[int] = 1
__PRIVATE_CONST: Final[int] = 2


###############################################################################
# Module Variables
###############################################################################


public_var: int = 1
__private_var: int = 2


###############################################################################
# Public/Private Classes
###############################################################################


class PublicClass:
    """
    Public Class.
    """


class __PrivateClass:
    """
    Private Class.
    """


###############################################################################
# Public/Private Functions
###############################################################################


def public_function(param1: Any) -> None:
    """
    Public function.
    """


def __private_function(param1: Any) -> None:
    """
    Private function.
    """


###############################################################################
# Main
###############################################################################


def main() -> None:
    """
    Main function.
    """


# Initialization
if __name__ == '__main__':
    main()
Clone this wiki locally