development.md

Polycog cognition

__init__ files

__init__ files are a combination of automatic generation, and manual tuning...

1. pip install mkinit
2. mkinit --relative src/cognition[/submodule] (optional: -w for overwrite)
3. Iterative loop of running checks (below) and applying black/ruff fixes
   • Note: Since mkinit ignores type definitions, this is a purely manual process (with the most extreme being functypes)
     • Identification: grep -rnE '^\s*type\s+[A-Za-z_][A-Za-z0-9_]*(\s*\[[^]]*\])?\s*=' --include='*.py' src

Preparation for Commit

Run below (stopping on errors) via source checks.sh (given installs via dev-requirements.txt).

Testing

1. export PYTHONPATH="${PYTHONPATH}:src"
2. python -m unittest discover

Coverage

(After #1 above)

1. coverage run --source=cognition -m unittest discover
2. Options...
   • coverage report -m
   • coverage html

Pre-Commit Checks

1. mypy tests src
2. pylint tests src
3. ruff check tests src
4. black --check tests src
5. validate-pyproject pyproject.toml