oncall-engine/engine/pyproject.toml
Joey Orlando 9dde1805aa
add mypy static type checker to backend codebase (#2151)
# What this PR does

- Adds [`mypy` static type checking](https://mypy-lang.org/) to our CI
pipeline. Currently there is still a **ton** of errors being returned by
the tool, as we'll need to fix pre-existing errors. I think we can
slowly chip away at these errors in small PRs, doing them all in one
large PR is likely very risky.
- Also, this PR starts chipping away at one of the main type errors that
we have which is accessing the `datetime` class (from the `datetime`
library) or `timedelta` function on the `django.utils.timezone` module.
Basically we should be instead accessing these two objects from the
native `datetime` module. This makes sense because the [`__all__`
attribute](https://github.com/django/django/blob/main/django/utils/timezone.py#L14-L30)
in `django.utils.timezone` does not re-export `datetime` or `timedelta`.
- splits `engine` dependencies out into `requirements.txt` and
`requirements-dev.txt`

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated (N/A)
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required) (N/A)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required) (N/A)
2023-06-12 12:50:33 -04:00

62 lines
1.5 KiB
TOML

[tool.isort]
profile = "black"
line_length=120
# TODO: upgrade this to python 3.11
py_version=39
extend_skip_glob = "**/migrations/**"
[tool.black]
line-length = 120
# TODO: upgrade this to python 3.11
target-version = ["py39"]
force-exclude = "migrations"
[tool.mypy]
implicit_reexport = true
plugins = [
"mypy_django_plugin.main",
"mypy_drf_plugin.main",
]
exclude = [
# TOML's double-quoted strings require escaping backslashes
"tests/test_.*\\.py$", # test files
"migrations/\\d*.*\\.py", # migration files
]
# mypy per-module options
[[tool.mypy.overrides]]
module = [
# the following setting should eventually be removed, one module at a time.
# It's only being added to temporarily surpress the:
# "module is installed, but missing library stubs or py.typed marker" errors
# we can slowly either start to add library stubs ourselves, or try and upgrade these libraries to see if
# a newer version includes type stubs
"anymail.*",
"debug_toolbar.*",
"django_deprecate_fields.*",
"django_sns_view.*",
"factory.*",
"fcm_django.*",
"firebase_admin.*",
"humanize.*",
"icalendar.*",
"markdown2.*",
"mirage.*",
"ordered_model.*",
"phonenumbers.*",
"polymorphic.*",
"pyroscope.*",
"ratelimit.*",
"recurring_ical_events.*",
"rest_polymorphic.*",
"slackclient.*",
"social_core.*",
"social_django.*",
"twilio.*",
"uwsgidecorators.*",
"whitenoise.*",
]
ignore_missing_imports = true
[tool.django-stubs]
django_settings_module = "settings.dev"