stable-baselines3/Makefile
Antonin RAFFIN b413f4c285
Fix VecEnv type hints (#1736)
* Fix VecNormalize type hints

* Fix VecEnv utils type annotations

* Apply suggestions from code review

Co-authored-by: M. Ernestus <maximilian@ernestus.de>

* Remove PyType

---------

Co-authored-by: M. Ernestus <maximilian@ernestus.de>
2023-11-08 09:46:40 +01:00

68 lines
1.4 KiB
Makefile

SHELL=/bin/bash
LINT_PATHS=stable_baselines3/ tests/ docs/conf.py setup.py
pytest:
./scripts/run_tests.sh
mypy:
mypy ${LINT_PATHS}
missing-annotations:
mypy --disallow-untyped-calls --disallow-untyped-defs --ignore-missing-imports stable_baselines3
# missing docstrings
# pylint -d R,C,W,E -e C0116 stable_baselines3 -j 4
type: mypy
lint:
# stop the build if there are Python syntax errors or undefined names
# see https://www.flake8rules.com/
ruff ${LINT_PATHS} --select=E9,F63,F7,F82 --show-source
# exit-zero treats all errors as warnings.
ruff ${LINT_PATHS} --exit-zero
format:
# Sort imports
ruff --select I ${LINT_PATHS} --fix
# Reformat using black
black ${LINT_PATHS}
check-codestyle:
# Sort imports
ruff --select I ${LINT_PATHS}
# Reformat using black
black --check ${LINT_PATHS}
commit-checks: format type lint
doc:
cd docs && make html
spelling:
cd docs && make spelling
clean:
cd docs && make clean
# Build docker images
# If you do export RELEASE=True, it will also push them
docker: docker-cpu docker-gpu
docker-cpu:
./scripts/build_docker.sh
docker-gpu:
USE_GPU=True ./scripts/build_docker.sh
# PyPi package release
release:
python -m build
twine upload dist/*
# Test PyPi package release
test-release:
python -m build
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
.PHONY: clean spelling doc lint format check-codestyle commit-checks