Skip to content

Welcome to PyTypes

λ poetry run python main.py --help
Usage: main.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  confgen   Generate pytypes.toml
  evaluate  Evaluate given original and traced repository
  fetch     Download repositories and apply tracing decorators
  typegen   Generate type hinted files using trace data

Dependencies, Tests & Documentation

The dependencies can be installed by simply running 

λ poetry install

The tests can be executed by running 

λ poetry run pytest

And finally, documentation can be generated installing the mkdocs package from the extras group, and rendered using 

λ poetry run mkdocs serve

Workflow

λ poetry run python main.py --help
Usage: main.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  confgen   Generate pytypes.toml
  evaluate  Evaluate given original and traced repository
  fetch     Download repositories and apply tracing decorators
  typegen   Generate type hinted files using trace data
  1. Fetching: poetry run python main.py fetch --help
  2. Tracing
  3. Typegen: poetry run python main.py typegen --help
  4. Evaluating: poetry run python main.py evaluate --help

Miscellaneous

Project layout

├── common
│   ├── data_file_collector.py
│   ├── ptconfig.py
│   ├── resolver.py
│   └── trace_data_category.py
├── confgen
│   └── __init__.py
├── constants.py
├── docs
├── evaluation
│   ├── file_type_hints_collector.py
│   ├── ipynb_evaluation_template.py
│   ├── metric_data_calculator.py
│   ├── normalize_types.py
│   └── performance_data_file_collector.py
├── fetching
│   ├── detector.py
│   ├── projio.py
│   ├── repo.py
│   └── strat.py
├── LICENSE
├── main.py
├── mkdocs.yml
├── mypy.ini
├── poetry.lock
├── pyproject.toml
├── pytest.ini
├── pytypes.toml
├── README.md
├── test.log
├── tox.ini
├── tracing
│   ├── decorators.py
│   ├── optimisation
│   │   ├── base.py
│   │   ├── enums.py
│   │   ├── looping.py
│   │   └── utils.py
│   ├── tracer.py
│   └── trace_update.py
└── typegen
    ├── strats
    │   ├── eval_inline.py
    │   ├── gen.py
    │   ├── imports.py
    │   ├── inline.py
    │   └── stub.py
    ├── trace_data_file_collector.py
    └── unification
        ├── drop_dupes.py
        ├── drop_min_threshold.py
        ├── drop_test_func.py
        ├── drop_vars.py
        ├── filter_base.py
        ├── keep_only_first.py
        ├── subtyping.py
        └── union.py