introspector 0.2.1a0

Introduce strict typing in your functions.

Introspector

[WIP] A Python library to write strongly typed code.

Table of contents

• Introspector
  • Table of contents
  • Introduction
  • Requirements
  • Basic usage
  • Python 3.10 supported typing syntax
  • Instrospector.strict available options
    • :arrow_right: ignore

Introduction

Introduce strict typing in your functions.
This project is under development.

Requirements

• Python >= 3.10

Basic usage

import introspector

@introspector.strict
def foo(a: int, b: list[dict[str, Any]]) -> list[int]:
    # Some funny code...

    return [1, 2, 3, 4]

foo(
    42, 
    [
        {
            'x': ['hello', 'world'],
            'y': 3.14,
        },
    ],
)

When the code is executed, the instrospector.strict decorator will inspect the signature of the foo function and compare it with the values passed in its parameters.
If the typing of the values does not match the signature of the function, introspector will throw a TypeError exception.

Python 3.10 supported typing syntax

This paclage support the following typing syntaxes:

Name	Description	Example
| operator	The Union type shortcut syntax	int | float

Instrospector.strict available options

:arrow_right: ignore

A list of parameter names that will be excluded from the typing control.
Notice that the ignore option will always contains self and cls.

Example:

@instrospector.strict(ignore=['b'])
def foo(a: int, b: float) -> None:
    ...

The argument b will be ignored by the typing control.