mirror of
https://github.com/davidhalter/django-stubs.git
synced 2025-12-10 14:01:56 +08:00
Compare commits
187 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cb1fa08a82 | ||
|
|
e2f6abe579 | ||
|
|
ffb6551eb4 | ||
|
|
40c8bfa510 | ||
|
|
402b7d563f | ||
|
|
92eb068a04 | ||
|
|
9d4d06f8b3 | ||
|
|
d746e3f5e4 | ||
|
|
8729a74f81 | ||
|
|
56361b353e | ||
|
|
b71c9ad282 | ||
|
|
ce370ea79f | ||
|
|
2a732fd257 | ||
|
|
645ee97e78 | ||
|
|
5bc3759ea2 | ||
|
|
534a028ea2 | ||
|
|
87856754ea | ||
|
|
2f7fac2eaf | ||
|
|
5ff99fd047 | ||
|
|
f77ebcd22c | ||
|
|
34b126e3da | ||
|
|
6e5f5f2cdb | ||
|
|
95252cde60 | ||
|
|
6ef2cf0331 | ||
|
|
9f3b95841b | ||
|
|
e764b1cf4c | ||
|
|
8a64d87917 | ||
|
|
60f3f9dd9f | ||
|
|
ca10ee9242 | ||
|
|
f651f27ddf | ||
|
|
3915aa0639 | ||
|
|
97ec2ee43b | ||
|
|
19c73a106d | ||
|
|
92ef5d9d95 | ||
|
|
f16d1b8cb6 | ||
|
|
c3cdc1c2d5 | ||
|
|
3704d0ab98 | ||
|
|
b1d619edb2 | ||
|
|
e680326c72 | ||
|
|
574a87e68c | ||
|
|
82ae1751ed | ||
|
|
69042783b1 | ||
|
|
391bbc59d5 | ||
|
|
28c76df3b2 | ||
|
|
3d2534ea8d | ||
|
|
54f5f63e71 | ||
|
|
4c5723d368 | ||
|
|
7e0e43135d | ||
|
|
e05b84e32d | ||
|
|
71751d3795 | ||
|
|
25f92e8e56 | ||
|
|
28d47c7e93 | ||
|
|
197cb4058e | ||
|
|
dac2b31fb2 | ||
|
|
8d2600136a | ||
|
|
570772f973 | ||
|
|
d5c1bfb12a | ||
|
|
64cbb0f70e | ||
|
|
6f5a39625e | ||
|
|
bf604a0398 | ||
|
|
92c8dfc93f | ||
|
|
c10c55052c | ||
|
|
96914e466b | ||
|
|
90ed7f332d | ||
|
|
a801501151 | ||
|
|
8ea59985df | ||
|
|
2964ed53d7 | ||
|
|
1b9176f994 | ||
|
|
54d0d018c6 | ||
|
|
1af3a12f2c | ||
|
|
7af89ee6a6 | ||
|
|
afa16bfb74 | ||
|
|
f77073157b | ||
|
|
fe3b95c611 | ||
|
|
d0f9730c53 | ||
|
|
0fdd678d65 | ||
|
|
2397065fa6 | ||
|
|
04023a9f31 | ||
|
|
95e6c94319 | ||
|
|
d96aee7a8b | ||
|
|
2489bb9b04 | ||
|
|
3a8f278c88 | ||
|
|
85b65b4578 | ||
|
|
150e8e862a | ||
|
|
5b3088a17a | ||
|
|
f89a0fbbaa | ||
|
|
438f8b5829 | ||
|
|
836d5acd8f | ||
|
|
bfae51e64c | ||
|
|
e3801918e3 | ||
|
|
6f296b0a91 | ||
|
|
7ba578f6b2 | ||
|
|
cb123de105 | ||
|
|
38135f2d1f | ||
|
|
998b659749 | ||
|
|
72f69e1c5e | ||
|
|
d666ecd36f | ||
|
|
c1af26c027 | ||
|
|
3c3dfcbc9f | ||
|
|
1196336e3b | ||
|
|
665f4d8ea1 | ||
|
|
b3ed9e4827 | ||
|
|
fb1593630a | ||
|
|
031d42a75d | ||
|
|
f7e1cfc6c7 | ||
|
|
d0c25e3bce | ||
|
|
1c31e71ffc | ||
|
|
6b3b6be3c1 | ||
|
|
5832605053 | ||
|
|
31e795016f | ||
|
|
0cba3f9fd6 | ||
|
|
f02050911f | ||
|
|
e8e6fca78c | ||
|
|
ade48b6546 | ||
|
|
b8f29027d8 | ||
|
|
eba3f6cb15 | ||
|
|
5a45544e76 | ||
|
|
8c2de7da56 | ||
|
|
d43c6dc7e2 | ||
|
|
f7e2109e06 | ||
|
|
cea62abf5a | ||
|
|
3b69ec6a72 | ||
|
|
7e794534c0 | ||
|
|
f5f33b061d | ||
|
|
58b26fdbd3 | ||
|
|
9ca79c24a2 | ||
|
|
540e28f4c6 | ||
|
|
4ac43c6ed6 | ||
|
|
cadd6c963b | ||
|
|
041754f817 | ||
|
|
c0c5d1e588 | ||
|
|
f824003cc4 | ||
|
|
58f1833cab | ||
|
|
cbb6a7a9ac | ||
|
|
2c4827bbaf | ||
|
|
5a151bf851 | ||
|
|
cbc7159995 | ||
|
|
df4c17a947 | ||
|
|
445abc046c | ||
|
|
557b7a4fa3 | ||
|
|
8343d76895 | ||
|
|
8d986a0f43 | ||
|
|
e9a90ebff0 | ||
|
|
7b74a6944a | ||
|
|
83f11a0fc6 | ||
|
|
2829faf1af | ||
|
|
d061e84cc7 | ||
|
|
3a9263dc62 | ||
|
|
14aea2b4d4 | ||
|
|
287c64d6fb | ||
|
|
6601121db2 | ||
|
|
87d59c7c1a | ||
|
|
8402e7c53e | ||
|
|
dceb075152 | ||
|
|
7e3f4bfa02 | ||
|
|
db9ff6aaf6 | ||
|
|
717be5940f | ||
|
|
b939bc96b7 | ||
|
|
02bdf5be95 | ||
|
|
4d4b0003bd | ||
|
|
e143ba568c | ||
|
|
32c0cbca45 | ||
|
|
acc3ca4205 | ||
|
|
be3fc259d5 | ||
|
|
7725b416b6 | ||
|
|
2c23d8e70f | ||
|
|
5910bd1b25 | ||
|
|
963d50c717 | ||
|
|
7407b93151 | ||
|
|
afcd0d9293 | ||
|
|
a85dbff793 | ||
|
|
68aebe2528 | ||
|
|
d3dca5b408 | ||
|
|
c69090ec5b | ||
|
|
29ac1c3017 | ||
|
|
23ad65033b | ||
|
|
64720f492c | ||
|
|
a8fdd4c673 | ||
|
|
813dd8cc1a | ||
|
|
2b53fa5a1a | ||
|
|
e3ea84143f | ||
|
|
82e3aa5464 | ||
|
|
5b9a467cf0 | ||
|
|
4a4dc53c4d | ||
|
|
77fd46987d | ||
|
|
9291164a6b | ||
|
|
0c3e06e875 |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -9,3 +9,7 @@ build/
|
||||
dist/
|
||||
pip-wheel-metadata/
|
||||
.pytest_cache/
|
||||
/.envrc
|
||||
/.direnv
|
||||
django-sources/
|
||||
.venv/
|
||||
4
.gitmodules
vendored
4
.gitmodules
vendored
@@ -1,4 +0,0 @@
|
||||
[submodule "django-sources"]
|
||||
path = django-sources
|
||||
url = https://github.com/django/django.git
|
||||
branch = stable/2.2.x
|
||||
38
.travis.yml
38
.travis.yml
@@ -4,19 +4,33 @@ dist: xenial
|
||||
sudo: required
|
||||
jobs:
|
||||
include:
|
||||
- name: Run plugin test suite with python 3.8
|
||||
python: 3.8
|
||||
script: 'pytest'
|
||||
|
||||
- name: Run plugin test suite with python 3.7
|
||||
python: 3.7
|
||||
script: 'pytest'
|
||||
|
||||
- name: Typecheck Django 3.0 test suite with python 3.8
|
||||
python: 3.8
|
||||
script: |
|
||||
set -e
|
||||
pytest
|
||||
python ./scripts/typecheck_tests.py --django_version=3.0
|
||||
|
||||
- name: Typecheck Django test suite with python 3.7
|
||||
- name: Typecheck Django 3.0 test suite with python 3.7
|
||||
python: 3.7
|
||||
script: 'python ./scripts/typecheck_tests.py'
|
||||
script: |
|
||||
python ./scripts/typecheck_tests.py --django_version=3.0
|
||||
|
||||
- name: Typecheck Django test suite with python 3.6
|
||||
- name: Typecheck Django 3.0 test suite with python 3.6
|
||||
python: 3.6
|
||||
script: 'python ./scripts/typecheck_tests.py'
|
||||
script: |
|
||||
python ./scripts/typecheck_tests.py --django_version=3.0
|
||||
|
||||
- name: Typecheck Django 2.2 test suite with python 3.7
|
||||
python: 3.7
|
||||
script: |
|
||||
python ./scripts/typecheck_tests.py --django_version=2.2
|
||||
|
||||
- name: Mypy for plugin code
|
||||
python: 3.7
|
||||
@@ -24,18 +38,24 @@ jobs:
|
||||
|
||||
- name: Lint with black
|
||||
python: 3.7
|
||||
script: 'black --check --line-length=120 django-stubs/'
|
||||
script: 'black --check django-stubs/ setup.py'
|
||||
|
||||
- name: Lint plugin code with flake8
|
||||
python: 3.7
|
||||
script: 'flake8'
|
||||
|
||||
- name: Lint stubs with flake8-pyi and check for unused imports
|
||||
python: 3.7
|
||||
script: 'flake8 --config flake8-pyi.ini'
|
||||
|
||||
- name: Lint plugin code with isort
|
||||
python: 3.7
|
||||
script: 'isort --check'
|
||||
script: 'isort --check --diff'
|
||||
|
||||
before_install: |
|
||||
# Upgrade pip, setuptools, and wheel
|
||||
sudo add-apt-repository ppa:ubuntugis/ubuntugis-unstable -y
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y binutils libproj-dev gdal-bin
|
||||
pip install -U pip setuptools wheel
|
||||
install: |
|
||||
pip install -r ./dev-requirements.txt
|
||||
111
CONTRIBUTING.md
Normal file
111
CONTRIBUTING.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# How to contribute
|
||||
|
||||
## Tutorials
|
||||
|
||||
If you want to start working on this project,
|
||||
you will need to get familiar with these projects:
|
||||
|
||||
- [Django docs](https://docs.djangoproject.com/en/dev/)
|
||||
- [Typing in Python](https://inventwithpython.com/blog/2019/11/24/type-hints-for-busy-python-programmers/)
|
||||
- [How to write custom mypy plugins](https://mypy.readthedocs.io/en/stable/extending_mypy.html)
|
||||
- [Typechecking Django and DRF](https://sobolevn.me/2019/08/typechecking-django-and-drf) guide
|
||||
- [Testing mypy stubs, plugins, and types](https://sobolevn.me/2019/08/testing-mypy-types) guide
|
||||
|
||||
It is also recommended to take a look at these resources:
|
||||
|
||||
- [Awesome Python Typing](https://github.com/typeddjango/awesome-python-typing)
|
||||
|
||||
|
||||
## Dev documentation
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
We use `pip` to manage the dependencies.
|
||||
|
||||
To install them you would need to activate your `virtualenv` and run `install` command:
|
||||
|
||||
```bash
|
||||
pip install -r ./dev-requirements.txt
|
||||
```
|
||||
|
||||
|
||||
## Tests and linters
|
||||
|
||||
We use `mypy`, `pytest`, `flake8`, and `black` for quality control.
|
||||
Here's [how we run our CI](https://github.com/typeddjango/django-stubs/blob/master/.travis.yml).
|
||||
|
||||
### Typechecking
|
||||
|
||||
To run typechecking use:
|
||||
|
||||
```bash
|
||||
mypy ./mypy_django_plugin
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
There are unit tests and type-related tests.
|
||||
|
||||
To run unit tests:
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
Type-related tests ensure that different Django versions do work correctly.
|
||||
To run type-related tests:
|
||||
|
||||
```bash
|
||||
python ./scripts/typecheck_tests.py --django_version=2.2
|
||||
python ./scripts/typecheck_tests.py --django_version=3.0
|
||||
```
|
||||
|
||||
Currently we only support two Django versions.
|
||||
|
||||
### Linting
|
||||
|
||||
To run auto-formatting:
|
||||
|
||||
```bash
|
||||
isort -rc .
|
||||
black django-stubs/
|
||||
```
|
||||
|
||||
To run linting:
|
||||
|
||||
```bash
|
||||
flake8
|
||||
flake8 --config flake8-pyi.ini
|
||||
```
|
||||
|
||||
|
||||
## Submitting your code
|
||||
|
||||
We use [trunk based](https://trunkbaseddevelopment.com/)
|
||||
development (we also sometimes call it `wemake-git-flow`).
|
||||
|
||||
What the point of this method?
|
||||
|
||||
1. We use protected `master` branch,
|
||||
so the only way to push your code is via pull request
|
||||
2. We use issue branches: to implement a new feature or to fix a bug
|
||||
create a new branch named `issue-$TASKNUMBER`
|
||||
3. Then create a pull request to `master` branch
|
||||
4. We use `git tag`s to make releases, so we can track what has changed
|
||||
since the latest release
|
||||
|
||||
So, this way we achieve an easy and scalable development process
|
||||
which frees us from merging hell and long-living branches.
|
||||
|
||||
In this method, the latest version of the app is always in the `master` branch.
|
||||
|
||||
|
||||
## Other help
|
||||
|
||||
You can contribute by spreading a word about this library.
|
||||
It would also be a huge contribution to write
|
||||
a short article on how you are using this project.
|
||||
You can also share your best practices with us.
|
||||
133
README.md
133
README.md
@@ -1,71 +1,126 @@
|
||||
<img src="http://mypy-lang.org/static/mypy_light.svg" alt="mypy logo" width="300px"/>
|
||||
|
||||
# pep484 stubs for Django framework
|
||||
# Typesafe Django Framework
|
||||
|
||||
[](https://travis-ci.org/typeddjango/django-stubs)
|
||||
[](https://travis-ci.com/typeddjango/django-stubs)
|
||||
[](http://mypy-lang.org/)
|
||||
[](https://gitter.im/mypy-django/Lobby)
|
||||
|
||||
This package contains type stubs and mypy plugin to provide more precise static types and type inference for Django framework. Django uses some Python "magic" that makes having precise types for some code patterns problematic. This is why we need to accompany the stubs with mypy plugins. The final goal is to be able to get precise types for most common patterns.
|
||||
This package contains [type stubs](https://www.python.org/dev/peps/pep-0561/) and a custom mypy plugin to provide more precise static types and type inference for Django framework. Django uses some Python "magic" that makes having precise types for some code patterns problematic. This is why we need this project. The final goal is to be able to get precise types for most common patterns.
|
||||
|
||||
Supports Python 3.6/3.7, and Django 2.1/2.2.
|
||||
|
||||
Could be run on earlier versions of Django, but expect some missing imports warnings.
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
```bash
|
||||
pip install django-stubs
|
||||
```
|
||||
|
||||
### WARNING: All configuration from pre-1.0.0 versions is dropped, use one below.
|
||||
See [Configuration](#configuration) section to get started.
|
||||
|
||||
### WARNING: 1.0.0 breaks `dmypy`, if you need it, stay on the 0.12.x series.
|
||||
|
||||
To make mypy aware of the plugin, you need to add
|
||||
## Configuration
|
||||
|
||||
```
|
||||
To make `mypy` happy, you will need to add:
|
||||
|
||||
```ini
|
||||
[mypy]
|
||||
plugins =
|
||||
mypy_django_plugin.main
|
||||
```
|
||||
|
||||
in your `mypy.ini` file.
|
||||
|
||||
Plugin requires Django settings module (what you put into `DJANGO_SETTINGS_MODULE` variable) to be specified inside `mypy.ini` file.
|
||||
```
|
||||
[mypy]
|
||||
strict_optional = True
|
||||
|
||||
; this one is new
|
||||
[mypy.plugins.django-stubs]
|
||||
django_settings_module = mysettings
|
||||
```
|
||||
where `mysettings` is a value of `DJANGO_SETTINGS_MODULE` (with or without quotes)
|
||||
|
||||
Do you have trouble with mypy / the django plugin not finding your settings module? Try adding the root path of your project to your PYTHONPATH environment variable. If you use pipenv you can add the following to an `.env` file in your project root which pipenv will run automatically before executing any commands.:
|
||||
```
|
||||
PYTHONPATH=${PYTHONPATH}:${PWD}
|
||||
django_settings_module = "myproject.settings"
|
||||
```
|
||||
|
||||
New implementation uses Django runtime to extract models information, so it will crash, if your installed apps `models.py` is not correct. For this same reason, you cannot use `reveal_type` inside global scope of any Python file that will be executed for `django.setup()`.
|
||||
in your `mypy.ini` or `setup.cfg` [file](https://mypy.readthedocs.io/en/latest/config_file.html).
|
||||
|
||||
Two things happeining here:
|
||||
|
||||
1. We need to explicitly list our plugin to be loaded by `mypy`
|
||||
2. Our plugin also requires `django` settings module (what you put into `DJANGO_SETTINGS_MODULE` variable) to be specified
|
||||
|
||||
This fully working [typed boilerplate](https://github.com/wemake-services/wemake-django-template) can serve you as an example.
|
||||
|
||||
|
||||
## Version compatibility
|
||||
|
||||
We rely on different `django` and `mypy` versions:
|
||||
|
||||
| django-stubs | mypy version | django version | python version
|
||||
| ------------ | ---- | ---- | ---- |
|
||||
| 1.6.0 | 0.780 | 2.2.x \|\| 3.x | ^3.6
|
||||
| 1.5.0 | 0.770 | 2.2.x \|\| 3.x | ^3.6
|
||||
| 1.4.0 | 0.760 | 2.2.x \|\| 3.x | ^3.6
|
||||
| 1.3.0 | 0.750 | 2.2.x \|\| 3.x | ^3.6
|
||||
| 1.2.0 | 0.730 | 2.2.x | ^3.6
|
||||
| 1.1.0 | 0.720 | 2.2.x | ^3.6
|
||||
| 0.12.x | old semantic analyzer (<0.711), dmypy support | 2.1.x | ^3.6
|
||||
|
||||
|
||||
## FAQ
|
||||
|
||||
### Is this an official Django project?
|
||||
|
||||
No, it is not. We are independent from Django at the moment.
|
||||
There's a [proposal](https://github.com/django/deps/pull/65) to merge our project into the Django itself.
|
||||
You show your support by linking the PR.
|
||||
|
||||
### Is it safe to use this in production?
|
||||
|
||||
Yes, it is! This project does not affect your runtime at all.
|
||||
It only affects `mypy` type checking process.
|
||||
|
||||
But, it does not make any sense to use this project without `mypy`.
|
||||
|
||||
### mypy crashes when I run it with this plugin installed
|
||||
|
||||
The current implementation uses Django runtime to extract models information, so it will crash, if your installed apps or `models.py` is not correct. For this same reason, you cannot use `reveal_type` inside global scope of any Python file that will be executed for `django.setup()`.
|
||||
|
||||
In other words, if your `manage.py runserver` crashes, mypy will crash too.
|
||||
You can also run `mypy` with the [`--tb`](https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-show-traceback)
|
||||
option to get extra information about errors.
|
||||
|
||||
## Notes
|
||||
### I cannot use QuerySet or Manager with type annotations
|
||||
|
||||
Implementation monkey-patches Django to add `__class_getitem__` to the `Manager` class. If you'd use Python3.7 and do that too in your code, you can make things like
|
||||
You can get a `TypeError: 'type' object is not subscriptable`
|
||||
when you will try to use `QuerySet[MyModel]` or `Manager[MyModel]`.
|
||||
|
||||
This happens because Django classes do not support [`__class_getitem__`](https://www.python.org/dev/peps/pep-0560/#class-getitem) magic method.
|
||||
|
||||
You can use strings instead: `'QuerySet[MyModel]'` and `'Manager[MyModel]'`, this way it will work as a type for `mypy` and as a regular `str` in runtime.
|
||||
|
||||
Currently we [are working](https://github.com/django/django/pull/12405) on providing `__class_getitem__` to the classes where we need them.
|
||||
|
||||
### How can I create a HttpRequest that's guaranteed to have an authenticated user?
|
||||
|
||||
Django's built in `HttpRequest` has the attribute `user` that resolves to the type
|
||||
```python
|
||||
Union[User, AnonymousUser]
|
||||
```
|
||||
class MyUserManager(models.Manager['MyUser']):
|
||||
pass
|
||||
class MyUser(models.Model):
|
||||
objects = UserManager()
|
||||
```
|
||||
work, which should make a error messages a bit better.
|
||||
where `User` is the user model specified by the `AUTH_USER_MODEL` setting.
|
||||
|
||||
If you want a `HttpRequest` that you can type-annotate with where you know that the user is authenticated you can subclass the normal `HttpRequest` class like so:
|
||||
```python
|
||||
from django.http import HttpRequest
|
||||
from my_user_app.models import MyUser
|
||||
|
||||
class AuthenticatedHttpRequest(HttpRequest):
|
||||
user: MyUser
|
||||
```
|
||||
|
||||
And then use `AuthenticatedHttpRequest` instead of the standard `HttpRequest` for when you know that the user is authenticated. For example in views using the `@login_required` decorator.
|
||||
|
||||
|
||||
## Related projects
|
||||
|
||||
- [`awesome-python-typing`](https://github.com/typeddjango/awesome-python-typing) - Awesome list of all typing-related things in Python.
|
||||
- [`djangorestframework-stubs`](https://github.com/typeddjango/djangorestframework-stubs) - Stubs for Django REST Framework.
|
||||
- [`pytest-mypy-plugins`](https://github.com/typeddjango/pytest-mypy-plugins) - `pytest` plugin that we use for testing `mypy` stubs and plugins.
|
||||
- [`wemake-django-template`](https://github.com/wemake-services/wemake-django-template) - Create new typed Django projects in seconds.
|
||||
|
||||
|
||||
Otherwise, custom type will be created in mypy, named `MyUser__MyUserManager`, which will rewrite base manager as `models.Manager[User]` to make methods like `get_queryset()` and others return properly typed `QuerySet`.
|
||||
|
||||
## To get help
|
||||
|
||||
We have Gitter here https://gitter.im/mypy-django/Lobby.
|
||||
We have Gitter here: <https://gitter.im/mypy-django/Lobby>
|
||||
|
||||
If you think you have more generic typing issue, please refer to https://github.com/python/mypy and their Gitter.
|
||||
If you think you have a more generic typing issue, please refer to <https://github.com/python/mypy> and their Gitter.
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
black
|
||||
pytest-mypy-plugins==1.0.3
|
||||
psycopg2
|
||||
flake8
|
||||
isort==4.3.4
|
||||
pytest-mypy-plugins==1.6.1
|
||||
psycopg2-binary
|
||||
flake8==3.7.9
|
||||
flake8-pyi==19.3.0
|
||||
isort==4.3.21
|
||||
gitpython==3.1.0
|
||||
-e .
|
||||
|
||||
Submodule django-sources deleted from 4d6449e125
@@ -1,5 +1,6 @@
|
||||
from typing import Any, Iterator, Type, Optional, Dict
|
||||
|
||||
from django.apps.registry import Apps
|
||||
from django.db.models.base import Model
|
||||
|
||||
MODELS_MODULE_NAME: str
|
||||
@@ -7,11 +8,11 @@ MODELS_MODULE_NAME: str
|
||||
class AppConfig:
|
||||
name: str = ...
|
||||
module: Optional[Any] = ...
|
||||
apps: None = ...
|
||||
apps: Optional[Apps] = ...
|
||||
label: str = ...
|
||||
verbose_name: str = ...
|
||||
path: str = ...
|
||||
models_module: None = ...
|
||||
models_module: Optional[str] = ...
|
||||
models: Dict[str, Type[Model]] = ...
|
||||
def __init__(self, app_name: str, app_module: Optional[Any]) -> None: ...
|
||||
@classmethod
|
||||
|
||||
@@ -1,24 +1,22 @@
|
||||
import threading
|
||||
from collections import OrderedDict
|
||||
from typing import Any, Callable, List, Optional, Tuple, Type, Union, Iterable, DefaultDict, Dict
|
||||
from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Type, Union
|
||||
|
||||
from django.db.migrations.state import AppConfigStub
|
||||
from django.db.models.base import Model
|
||||
|
||||
from .config import AppConfig
|
||||
|
||||
class Apps:
|
||||
all_models: "Dict[str, OrderedDict[str, Type[Model]]]" = ...
|
||||
app_configs: "OrderedDict[str, AppConfig]" = ...
|
||||
all_models: Dict[str, Dict[str, Type[Model]]] = ...
|
||||
app_configs: Dict[str, AppConfig] = ...
|
||||
stored_app_configs: List[Any] = ...
|
||||
apps_ready: bool = ...
|
||||
ready_event: threading.Event = ...
|
||||
loading: bool = ...
|
||||
_pending_operations: DefaultDict[Tuple[str, str], List]
|
||||
_pending_operations: Dict[Tuple[str, str], List]
|
||||
models_ready: bool = ...
|
||||
ready: bool = ...
|
||||
def __init__(self, installed_apps: Optional[Union[List[AppConfigStub], List[str], Tuple]] = ...) -> None: ...
|
||||
def populate(self, installed_apps: Union[List[AppConfigStub], List[str], Tuple] = ...) -> None: ...
|
||||
def __init__(self, installed_apps: Optional[Iterable[Union[AppConfig, str]]] = ...) -> None: ...
|
||||
def populate(self, installed_apps: Iterable[Union[AppConfig, str]] = ...) -> None: ...
|
||||
def check_apps_ready(self) -> None: ...
|
||||
def check_models_ready(self) -> None: ...
|
||||
def get_app_configs(self) -> Iterable[AppConfig]: ...
|
||||
@@ -31,9 +29,9 @@ class Apps:
|
||||
def get_containing_app_config(self, object_name: str) -> Optional[AppConfig]: ...
|
||||
def get_registered_model(self, app_label: str, model_name: str) -> Type[Model]: ...
|
||||
def get_swappable_settings_name(self, to_string: str) -> Optional[str]: ...
|
||||
def set_available_apps(self, available: List[str]) -> None: ...
|
||||
def set_available_apps(self, available: Iterable[str]) -> None: ...
|
||||
def unset_available_apps(self) -> None: ...
|
||||
def set_installed_apps(self, installed: Union[List[str], Tuple[str]]) -> None: ...
|
||||
def set_installed_apps(self, installed: Iterable[str]) -> None: ...
|
||||
def unset_installed_apps(self) -> None: ...
|
||||
def clear_cache(self) -> None: ...
|
||||
def lazy_model_operation(self, function: Callable, *model_keys: Any) -> None: ...
|
||||
|
||||
@@ -345,7 +345,7 @@ SESSION_COOKIE_PATH = "/"
|
||||
SESSION_COOKIE_HTTPONLY = True
|
||||
# Whether to set the flag restricting cookie leaks on cross-site requests.
|
||||
# This can be 'Lax', 'Strict', or None to disable the flag.
|
||||
SESSION_COOKIE_SAMESITE = "Lax"
|
||||
SESSION_COOKIE_SAMESITE: Optional[str] = ...
|
||||
# Whether to save the session data on every request.
|
||||
SESSION_SAVE_EVERY_REQUEST = False
|
||||
# Whether a user's session cookie expires when the Web browser is closed.
|
||||
@@ -413,7 +413,7 @@ CSRF_COOKIE_DOMAIN = None
|
||||
CSRF_COOKIE_PATH = "/"
|
||||
CSRF_COOKIE_SECURE = False
|
||||
CSRF_COOKIE_HTTPONLY = False
|
||||
CSRF_COOKIE_SAMESITE = "Lax"
|
||||
CSRF_COOKIE_SAMESITE: Optional[str] = ...
|
||||
CSRF_HEADER_NAME = "HTTP_X_CSRFTOKEN"
|
||||
CSRF_TRUSTED_ORIGINS: List[str] = ...
|
||||
CSRF_USE_SESSIONS = False
|
||||
|
||||
@@ -5,10 +5,10 @@ from django.http.response import HttpResponse, HttpResponseBase
|
||||
|
||||
from django.urls import URLResolver, URLPattern
|
||||
|
||||
handler400: Callable[..., HttpResponse] = ...
|
||||
handler403: Callable[..., HttpResponse] = ...
|
||||
handler404: Callable[..., HttpResponse] = ...
|
||||
handler500: Callable[..., HttpResponse] = ...
|
||||
handler400: Union[str, Callable[..., HttpResponse]] = ...
|
||||
handler403: Union[str, Callable[..., HttpResponse]] = ...
|
||||
handler404: Union[str, Callable[..., HttpResponse]] = ...
|
||||
handler500: Union[str, Callable[..., HttpResponse]] = ...
|
||||
|
||||
IncludedURLConf = Tuple[List[URLResolver], Optional[str], Optional[str]]
|
||||
|
||||
|
||||
@@ -1,15 +1,17 @@
|
||||
from typing import Any, List, Union
|
||||
from typing import Any, List, Union, Iterable, Optional
|
||||
|
||||
from django.contrib.admin.options import BaseModelAdmin, InlineModelAdmin, ModelAdmin
|
||||
from django.core.checks.messages import Error
|
||||
from django.contrib.admin.options import BaseModelAdmin
|
||||
from django.core.checks.messages import CheckMessage, Error
|
||||
|
||||
from django.apps.config import AppConfig
|
||||
|
||||
_CheckError = Union[str, Error]
|
||||
|
||||
def check_admin_app(app_configs: None, **kwargs: Any) -> List[_CheckError]: ...
|
||||
def check_admin_app(app_configs: Optional[Iterable[AppConfig]], **kwargs: Any) -> List[_CheckError]: ...
|
||||
def check_dependencies(**kwargs: Any) -> List[_CheckError]: ...
|
||||
|
||||
class BaseModelAdminChecks:
|
||||
def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> List[_CheckError]: ...
|
||||
def check(self, admin_obj: BaseModelAdmin, **kwargs: Any) -> List[CheckMessage]: ...
|
||||
|
||||
class ModelAdminChecks(BaseModelAdminChecks): ...
|
||||
class InlineModelAdminChecks(BaseModelAdminChecks): ...
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
from typing import Any, Callable, Optional
|
||||
from typing import Any, Callable, Optional, Type
|
||||
|
||||
def register(*models: Any, site: Optional[Any] = ...) -> Callable: ...
|
||||
from django.db.models.base import Model
|
||||
|
||||
def register(*models: Type[Model], site: Optional[Any] = ...) -> Callable: ...
|
||||
|
||||
4
django-stubs/contrib/admin/exceptions.pyi
Normal file
4
django-stubs/contrib/admin/exceptions.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
from django.core.exceptions import SuspiciousOperation as SuspiciousOperation
|
||||
|
||||
class DisallowedModelAdminLookup(SuspiciousOperation): ...
|
||||
class DisallowedModelAdminToField(SuspiciousOperation): ...
|
||||
@@ -24,7 +24,7 @@ class SimpleListFilter(ListFilter):
|
||||
parameter_name: Any = ...
|
||||
lookup_choices: Any = ...
|
||||
def value(self) -> Optional[str]: ...
|
||||
def lookups(self, request: Any, model_admin: Any) -> None: ...
|
||||
def lookups(self, request: Any, model_admin: Any) -> List[Tuple[Any, str]]: ...
|
||||
|
||||
class FieldListFilter(ListFilter):
|
||||
field: Field = ...
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union
|
||||
from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union, Iterable
|
||||
|
||||
from django.contrib.auth.forms import AdminPasswordChangeForm
|
||||
from django.forms.boundfield import BoundField
|
||||
from django.forms.forms import BaseForm
|
||||
from django.forms.utils import ErrorDict
|
||||
from django.forms.widgets import Media, Widget
|
||||
from django.utils.safestring import SafeText
|
||||
@@ -23,10 +23,10 @@ class AdminForm:
|
||||
readonly_fields: Any = ...
|
||||
def __init__(
|
||||
self,
|
||||
form: AdminPasswordChangeForm,
|
||||
form: BaseForm,
|
||||
fieldsets: List[Tuple[None, Dict[str, List[str]]]],
|
||||
prepopulated_fields: Dict[Any, Any],
|
||||
readonly_fields: Any = ...,
|
||||
readonly_fields: Optional[Iterable[Any]] = ...,
|
||||
model_admin: Any = ...,
|
||||
) -> None: ...
|
||||
def __iter__(self) -> Iterator[Fieldset]: ...
|
||||
@@ -47,7 +47,7 @@ class Fieldset:
|
||||
self,
|
||||
form: Any,
|
||||
name: Optional[Any] = ...,
|
||||
readonly_fields: Any = ...,
|
||||
readonly_fields: Optional[Iterable[Any]] = ...,
|
||||
fields: Any = ...,
|
||||
classes: Any = ...,
|
||||
description: Optional[Any] = ...,
|
||||
@@ -64,7 +64,7 @@ class Fieldline:
|
||||
model_admin: Any = ...
|
||||
readonly_fields: Any = ...
|
||||
def __init__(
|
||||
self, form: Any, field: Any, readonly_fields: Optional[Any] = ..., model_admin: Optional[Any] = ...
|
||||
self, form: Any, field: Any, readonly_fields: Optional[Iterable[Any]] = ..., model_admin: Optional[Any] = ...
|
||||
) -> None: ...
|
||||
def __iter__(self) -> Iterator[Union[AdminField, AdminReadonlyField]]: ...
|
||||
def errors(self) -> SafeText: ...
|
||||
|
||||
0
django-stubs/contrib/admin/migrations/__init__.pyi
Normal file
0
django-stubs/contrib/admin/migrations/__init__.pyi
Normal file
@@ -1,5 +1,24 @@
|
||||
from collections import OrderedDict
|
||||
from typing import Any, Callable, Dict, Iterator, List, Optional, Sequence, Set, Tuple, Type, Union
|
||||
from typing import (
|
||||
Any,
|
||||
Callable,
|
||||
Dict,
|
||||
Generic,
|
||||
Iterator,
|
||||
List,
|
||||
Optional,
|
||||
Sequence,
|
||||
Set,
|
||||
Tuple,
|
||||
Type,
|
||||
Union,
|
||||
Mapping,
|
||||
TypeVar,
|
||||
)
|
||||
|
||||
from django.forms.forms import BaseForm
|
||||
from django.forms.formsets import BaseFormSet
|
||||
from typing_extensions import Literal, TypedDict
|
||||
|
||||
from django.contrib.admin.filters import ListFilter
|
||||
from django.contrib.admin.models import LogEntry
|
||||
@@ -7,7 +26,7 @@ from django.contrib.admin.sites import AdminSite
|
||||
from django.contrib.admin.views.main import ChangeList
|
||||
from django.contrib.auth.forms import AdminPasswordChangeForm
|
||||
from django.contrib.contenttypes.models import ContentType
|
||||
from django.core.checks.messages import Error
|
||||
from django.core.checks.messages import CheckMessage
|
||||
from django.core.paginator import Paginator
|
||||
from django.db.models.base import Model
|
||||
from django.db.models.fields.related import ForeignKey, ManyToManyField, RelatedField
|
||||
@@ -26,8 +45,10 @@ from django.db.models.fields import Field
|
||||
|
||||
IS_POPUP_VAR: str
|
||||
TO_FIELD_VAR: str
|
||||
HORIZONTAL: Any
|
||||
VERTICAL: Any
|
||||
HORIZONTAL: Literal[1] = ...
|
||||
VERTICAL: Literal[2] = ...
|
||||
|
||||
_Direction = Union[Literal[1], Literal[2]]
|
||||
|
||||
def get_content_type_for_model(obj: Union[Type[Model], Model]) -> ContentType: ...
|
||||
def get_ul_class(radio_style: int) -> str: ...
|
||||
@@ -37,26 +58,43 @@ class IncorrectLookupParameters(Exception): ...
|
||||
FORMFIELD_FOR_DBFIELD_DEFAULTS: Any
|
||||
csrf_protect_m: Any
|
||||
|
||||
class BaseModelAdmin:
|
||||
autocomplete_fields: Any = ...
|
||||
raw_id_fields: Any = ...
|
||||
fields: Any = ...
|
||||
exclude: Any = ...
|
||||
fieldsets: Any = ...
|
||||
form: Any = ...
|
||||
filter_vertical: Any = ...
|
||||
filter_horizontal: Any = ...
|
||||
radio_fields: Any = ...
|
||||
prepopulated_fields: Any = ...
|
||||
formfield_overrides: Any = ...
|
||||
readonly_fields: Any = ...
|
||||
ordering: Any = ...
|
||||
sortable_by: Any = ...
|
||||
class _OptionalFieldOpts(TypedDict, total=False):
|
||||
classes: Sequence[str]
|
||||
description: str
|
||||
|
||||
class _FieldOpts(_OptionalFieldOpts, total=True):
|
||||
fields: Sequence[Union[str, Sequence[str]]]
|
||||
|
||||
# Workaround for mypy issue, a Sequence type should be preferred here.
|
||||
# https://github.com/python/mypy/issues/8921
|
||||
# _FieldsetSpec = Sequence[Tuple[Optional[str], _FieldOpts]]
|
||||
_T = TypeVar("_T")
|
||||
_ListOrTuple = Union[Tuple[_T, ...], List[_T]]
|
||||
_FieldsetSpec = _ListOrTuple[Tuple[Optional[str], _FieldOpts]]
|
||||
|
||||
# Generic type specifically for models, for use in BaseModelAdmin and subclasses
|
||||
# https://github.com/typeddjango/django-stubs/issues/482
|
||||
_ModelT = TypeVar("_ModelT", bound=Model)
|
||||
|
||||
class BaseModelAdmin(Generic[_ModelT]):
|
||||
autocomplete_fields: Sequence[str] = ...
|
||||
raw_id_fields: Sequence[str] = ...
|
||||
fields: Sequence[Union[str, Sequence[str]]] = ...
|
||||
exclude: Sequence[str] = ...
|
||||
fieldsets: _FieldsetSpec = ...
|
||||
form: Type[BaseForm] = ...
|
||||
filter_vertical: Sequence[str] = ...
|
||||
filter_horizontal: Sequence[str] = ...
|
||||
radio_fields: Mapping[str, _Direction] = ...
|
||||
prepopulated_fields: Mapping[str, Sequence[str]] = ...
|
||||
formfield_overrides: Mapping[Type[Field], Mapping[str, Any]] = ...
|
||||
readonly_fields: Sequence[Union[str, Callable[[_ModelT], Any]]] = ...
|
||||
ordering: Sequence[str] = ...
|
||||
sortable_by: Sequence[str] = ...
|
||||
view_on_site: bool = ...
|
||||
show_full_result_count: bool = ...
|
||||
checks_class: Any = ...
|
||||
def check(self, **kwargs: Any) -> List[Union[str, Error]]: ...
|
||||
def __init__(self) -> None: ...
|
||||
def check(self, **kwargs: Any) -> List[CheckMessage]: ...
|
||||
def formfield_for_dbfield(
|
||||
self, db_field: Field, request: Optional[HttpRequest], **kwargs: Any
|
||||
) -> Optional[Field]: ...
|
||||
@@ -73,29 +111,28 @@ class BaseModelAdmin:
|
||||
self, db_field: ManyToManyField, request: Optional[HttpRequest], **kwargs: Any
|
||||
) -> ModelMultipleChoiceField: ...
|
||||
def get_autocomplete_fields(self, request: HttpRequest) -> Tuple: ...
|
||||
def get_view_on_site_url(self, obj: Optional[Model] = ...) -> Optional[str]: ...
|
||||
def get_view_on_site_url(self, obj: Optional[_ModelT] = ...) -> Optional[str]: ...
|
||||
def get_empty_value_display(self) -> SafeText: ...
|
||||
def get_exclude(self, request: HttpRequest, obj: Optional[Model] = ...) -> Any: ...
|
||||
def get_fields(self, request: HttpRequest, obj: Optional[Model] = ...) -> Sequence[Union[Callable, str]]: ...
|
||||
def get_exclude(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Any: ...
|
||||
def get_fields(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Sequence[Union[Callable, str]]: ...
|
||||
def get_fieldsets(
|
||||
self, request: HttpRequest, obj: Optional[Model] = ...
|
||||
self, request: HttpRequest, obj: Optional[_ModelT] = ...
|
||||
) -> List[Tuple[Optional[str], Dict[str, Any]]]: ...
|
||||
def get_ordering(self, request: HttpRequest) -> Union[List[str], Tuple]: ...
|
||||
def get_readonly_fields(self, request: HttpRequest, obj: Optional[Model] = ...) -> Union[List[str], Tuple]: ...
|
||||
def get_prepopulated_fields(self, request: HttpRequest, obj: Optional[Model] = ...) -> Dict[str, Tuple[str]]: ...
|
||||
def get_readonly_fields(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Union[List[str], Tuple]: ...
|
||||
def get_prepopulated_fields(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Dict[str, Tuple[str]]: ...
|
||||
def get_queryset(self, request: HttpRequest) -> QuerySet: ...
|
||||
def get_sortable_by(self, request: HttpRequest) -> Union[List[Callable], List[str], Tuple]: ...
|
||||
def lookup_allowed(self, lookup: str, value: str) -> bool: ...
|
||||
def to_field_allowed(self, request: HttpRequest, to_field: str) -> bool: ...
|
||||
def has_add_permission(self, request: HttpRequest, obj: Optional[Model] = ...) -> bool: ...
|
||||
def has_change_permission(self, request: HttpRequest, obj: Optional[Model] = ...) -> bool: ...
|
||||
def has_delete_permission(self, request: HttpRequest, obj: Optional[Model] = ...) -> bool: ...
|
||||
def has_view_permission(self, request: HttpRequest, obj: Optional[Model] = ...) -> bool: ...
|
||||
def has_add_permission(self, request: HttpRequest) -> bool: ...
|
||||
def has_change_permission(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> bool: ...
|
||||
def has_delete_permission(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> bool: ...
|
||||
def has_view_permission(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> bool: ...
|
||||
def has_module_permission(self, request: HttpRequest) -> bool: ...
|
||||
|
||||
class ModelAdmin(BaseModelAdmin):
|
||||
formfield_overrides: Any
|
||||
list_display: Sequence[Union[str, Callable]] = ...
|
||||
class ModelAdmin(BaseModelAdmin[_ModelT]):
|
||||
list_display: Sequence[Union[str, Callable[[_ModelT], Any]]] = ...
|
||||
list_display_links: Optional[Sequence[Union[str, Callable]]] = ...
|
||||
list_filter: Sequence[Union[str, Type[ListFilter], Tuple[str, Type[ListFilter]]]] = ...
|
||||
list_select_related: Union[bool, Sequence[str]] = ...
|
||||
@@ -103,44 +140,43 @@ class ModelAdmin(BaseModelAdmin):
|
||||
list_max_show_all: int = ...
|
||||
list_editable: Sequence[str] = ...
|
||||
search_fields: Sequence[str] = ...
|
||||
date_hierarchy: Optional[Any] = ...
|
||||
date_hierarchy: Optional[str] = ...
|
||||
save_as: bool = ...
|
||||
save_as_continue: bool = ...
|
||||
save_on_top: bool = ...
|
||||
paginator: Any = ...
|
||||
paginator: Type = ...
|
||||
preserve_filters: bool = ...
|
||||
inlines: Sequence[Type[InlineModelAdmin]] = ...
|
||||
add_form_template: Any = ...
|
||||
change_form_template: Any = ...
|
||||
change_list_template: Any = ...
|
||||
delete_confirmation_template: Any = ...
|
||||
delete_selected_confirmation_template: Any = ...
|
||||
object_history_template: Any = ...
|
||||
popup_response_template: Any = ...
|
||||
actions: Any = ...
|
||||
add_form_template: str = ...
|
||||
change_form_template: str = ...
|
||||
change_list_template: str = ...
|
||||
delete_confirmation_template: str = ...
|
||||
delete_selected_confirmation_template: str = ...
|
||||
object_history_template: str = ...
|
||||
popup_response_template: str = ...
|
||||
actions: Sequence[Union[Callable[[ModelAdmin, HttpRequest, QuerySet], None], str]] = ...
|
||||
action_form: Any = ...
|
||||
actions_on_top: bool = ...
|
||||
actions_on_bottom: bool = ...
|
||||
actions_selection_counter: bool = ...
|
||||
checks_class: Any = ...
|
||||
model: Type[Model] = ...
|
||||
model: Type[_ModelT] = ...
|
||||
opts: Options = ...
|
||||
admin_site: AdminSite = ...
|
||||
def __init__(self, model: Type[Model], admin_site: Optional[AdminSite]) -> None: ...
|
||||
def get_inline_instances(self, request: HttpRequest, obj: Optional[Model] = ...) -> List[InlineModelAdmin]: ...
|
||||
def __init__(self, model: Type[_ModelT], admin_site: Optional[AdminSite]) -> None: ...
|
||||
def get_inline_instances(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> List[InlineModelAdmin]: ...
|
||||
def get_urls(self) -> List[URLPattern]: ...
|
||||
@property
|
||||
def urls(self) -> List[URLPattern]: ...
|
||||
@property
|
||||
def media(self) -> Media: ...
|
||||
def get_model_perms(self, request: HttpRequest) -> Dict[str, bool]: ...
|
||||
def get_form(self, request: Any, obj: Optional[Any] = ..., change: bool = ..., **kwargs: Any): ...
|
||||
def get_form(self, request: Any, obj: Optional[_ModelT] = ..., change: bool = ..., **kwargs: Any): ...
|
||||
def get_changelist(self, request: HttpRequest, **kwargs: Any) -> Type[ChangeList]: ...
|
||||
def get_changelist_instance(self, request: HttpRequest) -> ChangeList: ...
|
||||
def get_object(self, request: HttpRequest, object_id: str, from_field: None = ...) -> Optional[Model]: ...
|
||||
def get_object(self, request: HttpRequest, object_id: str, from_field: None = ...) -> Optional[_ModelT]: ...
|
||||
def get_changelist_form(self, request: Any, **kwargs: Any): ...
|
||||
def get_changelist_formset(self, request: Any, **kwargs: Any): ...
|
||||
def get_formsets_with_inlines(self, request: HttpRequest, obj: Optional[Model] = ...) -> Iterator[Any]: ...
|
||||
def get_formsets_with_inlines(self, request: HttpRequest, obj: Optional[_ModelT] = ...) -> Iterator[Any]: ...
|
||||
def get_paginator(
|
||||
self,
|
||||
request: HttpRequest,
|
||||
@@ -149,10 +185,10 @@ class ModelAdmin(BaseModelAdmin):
|
||||
orphans: int = ...,
|
||||
allow_empty_first_page: bool = ...,
|
||||
) -> Paginator: ...
|
||||
def log_addition(self, request: HttpRequest, object: Model, message: Any) -> LogEntry: ...
|
||||
def log_change(self, request: HttpRequest, object: Model, message: Any) -> LogEntry: ...
|
||||
def log_deletion(self, request: HttpRequest, object: Model, object_repr: str) -> LogEntry: ...
|
||||
def action_checkbox(self, obj: Model) -> SafeText: ...
|
||||
def log_addition(self, request: HttpRequest, object: _ModelT, message: Any) -> LogEntry: ...
|
||||
def log_change(self, request: HttpRequest, object: _ModelT, message: Any) -> LogEntry: ...
|
||||
def log_deletion(self, request: HttpRequest, object: _ModelT, object_repr: str) -> LogEntry: ...
|
||||
def action_checkbox(self, obj: _ModelT) -> SafeText: ...
|
||||
def get_actions(self, request: HttpRequest) -> OrderedDict: ...
|
||||
def get_action_choices(
|
||||
self, request: HttpRequest, default_choices: List[Tuple[str, str]] = ...
|
||||
@@ -181,8 +217,8 @@ class ModelAdmin(BaseModelAdmin):
|
||||
fail_silently: bool = ...,
|
||||
) -> None: ...
|
||||
def save_form(self, request: Any, form: Any, change: Any): ...
|
||||
def save_model(self, request: Any, obj: Any, form: Any, change: Any) -> None: ...
|
||||
def delete_model(self, request: HttpRequest, obj: Model) -> None: ...
|
||||
def save_model(self, request: Any, obj: _ModelT, form: Any, change: Any) -> None: ...
|
||||
def delete_model(self, request: HttpRequest, obj: _ModelT) -> None: ...
|
||||
def delete_queryset(self, request: HttpRequest, queryset: QuerySet) -> None: ...
|
||||
def save_formset(self, request: Any, form: Any, formset: Any, change: Any) -> None: ...
|
||||
def save_related(self, request: Any, form: Any, formsets: Any, change: Any) -> None: ...
|
||||
@@ -193,19 +229,19 @@ class ModelAdmin(BaseModelAdmin):
|
||||
add: bool = ...,
|
||||
change: bool = ...,
|
||||
form_url: str = ...,
|
||||
obj: Optional[Any] = ...,
|
||||
obj: Optional[_ModelT] = ...,
|
||||
): ...
|
||||
def response_add(
|
||||
self, request: HttpRequest, obj: Model, post_url_continue: Optional[str] = ...
|
||||
self, request: HttpRequest, obj: _ModelT, post_url_continue: Optional[str] = ...
|
||||
) -> HttpResponse: ...
|
||||
def response_change(self, request: HttpRequest, obj: Model) -> HttpResponse: ...
|
||||
def response_post_save_add(self, request: HttpRequest, obj: Model) -> HttpResponseRedirect: ...
|
||||
def response_post_save_change(self, request: HttpRequest, obj: Model) -> HttpResponseRedirect: ...
|
||||
def response_change(self, request: HttpRequest, obj: _ModelT) -> HttpResponse: ...
|
||||
def response_post_save_add(self, request: HttpRequest, obj: _ModelT) -> HttpResponseRedirect: ...
|
||||
def response_post_save_change(self, request: HttpRequest, obj: _ModelT) -> HttpResponseRedirect: ...
|
||||
def response_action(self, request: HttpRequest, queryset: QuerySet) -> Optional[HttpResponseBase]: ...
|
||||
def response_delete(self, request: HttpRequest, obj_display: str, obj_id: int) -> HttpResponse: ...
|
||||
def render_delete_form(self, request: Any, context: Any): ...
|
||||
def get_inline_formsets(
|
||||
self, request: HttpRequest, formsets: List[Any], inline_instances: List[Any], obj: Optional[Model] = ...
|
||||
self, request: HttpRequest, formsets: List[Any], inline_instances: List[Any], obj: Optional[_ModelT] = ...
|
||||
) -> List[Any]: ...
|
||||
def get_changeform_initial_data(self, request: HttpRequest) -> Dict[str, str]: ...
|
||||
def changeform_view(
|
||||
@@ -229,10 +265,10 @@ class ModelAdmin(BaseModelAdmin):
|
||||
def delete_view(self, request: HttpRequest, object_id: str, extra_context: None = ...) -> Any: ...
|
||||
def history_view(self, request: HttpRequest, object_id: str, extra_context: None = ...) -> HttpResponse: ...
|
||||
|
||||
class InlineModelAdmin(BaseModelAdmin):
|
||||
model: Any = ...
|
||||
fk_name: Any = ...
|
||||
formset: Any = ...
|
||||
class InlineModelAdmin(BaseModelAdmin[_ModelT]):
|
||||
model: Type[_ModelT] = ...
|
||||
fk_name: str = ...
|
||||
formset: BaseFormSet = ...
|
||||
extra: int = ...
|
||||
min_num: Optional[int] = ...
|
||||
max_num: Optional[int] = ...
|
||||
@@ -241,18 +277,18 @@ class InlineModelAdmin(BaseModelAdmin):
|
||||
verbose_name_plural: Optional[str] = ...
|
||||
can_delete: bool = ...
|
||||
show_change_link: bool = ...
|
||||
classes: Any = ...
|
||||
admin_site: Any = ...
|
||||
classes: Optional[Sequence[str]] = ...
|
||||
admin_site: AdminSite = ...
|
||||
parent_model: Any = ...
|
||||
opts: Any = ...
|
||||
has_registered_model: Any = ...
|
||||
def __init__(self, parent_model: Union[Type[Model], Model], admin_site: AdminSite) -> None: ...
|
||||
def __init__(self, parent_model: Union[Type[_ModelT], _ModelT], admin_site: AdminSite) -> None: ...
|
||||
@property
|
||||
def media(self) -> Media: ...
|
||||
def get_extra(self, request: HttpRequest, obj: Optional[Model] = ..., **kwargs: Any) -> int: ...
|
||||
def get_min_num(self, request: HttpRequest, obj: Optional[Model] = ..., **kwargs: Any) -> Optional[int]: ...
|
||||
def get_max_num(self, request: HttpRequest, obj: Optional[Model] = ..., **kwargs: Any) -> Optional[int]: ...
|
||||
def get_formset(self, request: Any, obj: Optional[Any] = ..., **kwargs: Any): ...
|
||||
def get_extra(self, request: HttpRequest, obj: Optional[_ModelT] = ..., **kwargs: Any) -> int: ...
|
||||
def get_min_num(self, request: HttpRequest, obj: Optional[_ModelT] = ..., **kwargs: Any) -> Optional[int]: ...
|
||||
def get_max_num(self, request: HttpRequest, obj: Optional[_ModelT] = ..., **kwargs: Any) -> Optional[int]: ...
|
||||
def get_formset(self, request: Any, obj: Optional[_ModelT] = ..., **kwargs: Any): ...
|
||||
|
||||
class StackedInline(InlineModelAdmin): ...
|
||||
class TabularInline(InlineModelAdmin): ...
|
||||
class StackedInline(InlineModelAdmin[_ModelT]): ...
|
||||
class TabularInline(InlineModelAdmin[_ModelT]): ...
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
|
||||
from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Type, Union
|
||||
|
||||
from django.contrib.admin.options import ModelAdmin
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
from django.db.models.base import Model
|
||||
from django.http.response import HttpResponse
|
||||
from django.template.response import TemplateResponse
|
||||
from django.urls.resolvers import URLPattern, URLResolver
|
||||
from django.urls.resolvers import URLResolver
|
||||
from django.utils.functional import LazyObject
|
||||
|
||||
from django.apps.config import AppConfig
|
||||
|
||||
all_sites: Any
|
||||
|
||||
class AlreadyRegistered(Exception): ...
|
||||
@@ -28,16 +30,16 @@ class AdminSite:
|
||||
name: str = ...
|
||||
_registry: Dict[Type[Model], ModelAdmin]
|
||||
def __init__(self, name: str = ...) -> None: ...
|
||||
def check(self, app_configs: None) -> List[Any]: ...
|
||||
def check(self, app_configs: Optional[Iterable[AppConfig]]) -> List[Any]: ...
|
||||
def register(
|
||||
self,
|
||||
model_or_iterable: Union[List[Type[Model]], Tuple[Type[Model]], Type[Model]],
|
||||
model_or_iterable: Union[Type[Model], Iterable[Type[Model]]],
|
||||
admin_class: Optional[Type[ModelAdmin]] = ...,
|
||||
**options: Any
|
||||
) -> None: ...
|
||||
def unregister(self, model_or_iterable: Type[Model]) -> None: ...
|
||||
def unregister(self, model_or_iterable: Union[Type[Model], Iterable[Type[Model]]]) -> None: ...
|
||||
def is_registered(self, model: Type[Model]) -> bool: ...
|
||||
def add_action(self, action: Callable, name: None = ...) -> None: ...
|
||||
def add_action(self, action: Callable, name: Optional[str] = ...) -> None: ...
|
||||
def disable_action(self, name: str) -> None: ...
|
||||
def get_action(self, name: str) -> Callable: ...
|
||||
@property
|
||||
@@ -52,14 +54,21 @@ class AdminSite:
|
||||
@property
|
||||
def urls(self) -> Tuple[List[URLResolver], str, str]: ...
|
||||
def each_context(self, request: Any): ...
|
||||
def password_change(self, request: WSGIRequest, extra_context: Dict[str, str] = ...) -> TemplateResponse: ...
|
||||
def password_change_done(self, request: WSGIRequest, extra_context: None = ...) -> TemplateResponse: ...
|
||||
def password_change(
|
||||
self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...
|
||||
) -> TemplateResponse: ...
|
||||
def password_change_done(
|
||||
self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...
|
||||
) -> TemplateResponse: ...
|
||||
def i18n_javascript(self, request: WSGIRequest, extra_context: Optional[Dict[Any, Any]] = ...) -> HttpResponse: ...
|
||||
def logout(self, request: WSGIRequest, extra_context: None = ...) -> TemplateResponse: ...
|
||||
def login(self, request: WSGIRequest, extra_context: None = ...) -> HttpResponse: ...
|
||||
def logout(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> TemplateResponse: ...
|
||||
def login(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> HttpResponse: ...
|
||||
def _build_app_dict(self, request: WSGIRequest, label: Optional[str] = ...) -> Dict[str, Any]: ...
|
||||
def get_app_list(self, request: WSGIRequest) -> List[Any]: ...
|
||||
def index(self, request: WSGIRequest, extra_context: Optional[Dict[str, str]] = ...) -> TemplateResponse: ...
|
||||
def app_index(self, request: WSGIRequest, app_label: str, extra_context: None = ...) -> TemplateResponse: ...
|
||||
def index(self, request: WSGIRequest, extra_context: Optional[Dict[str, Any]] = ...) -> TemplateResponse: ...
|
||||
def app_index(
|
||||
self, request: WSGIRequest, app_label: str, extra_context: Optional[Dict[str, Any]] = ...
|
||||
) -> TemplateResponse: ...
|
||||
|
||||
class DefaultAdminSite(LazyObject): ...
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ class ResultList(list):
|
||||
def results(cl: ChangeList) -> Iterator[ResultList]: ...
|
||||
def result_hidden_fields(cl: ChangeList) -> Iterator[BoundField]: ...
|
||||
def result_list(
|
||||
cl: ChangeList
|
||||
cl: ChangeList,
|
||||
) -> Dict[
|
||||
str, Union[List[Dict[str, Optional[Union[int, str]]]], List[ResultList], List[BoundField], ChangeList, int]
|
||||
]: ...
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
from typing import Any, Optional
|
||||
from typing import Any
|
||||
|
||||
from django.contrib.admin.helpers import InlineAdminForm
|
||||
from django.contrib.admin.templatetags.base import InclusionAdminNode
|
||||
from django.template.base import Parser, Token
|
||||
from django.template.context import Context, RequestContext
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
from typing import Any, Optional
|
||||
from typing import Any
|
||||
|
||||
register: Any
|
||||
|
||||
|
||||
@@ -9,12 +9,10 @@ from django.contrib.auth.forms import AdminPasswordChangeForm
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
from django.db.models.base import Model
|
||||
from django.db.models.deletion import Collector
|
||||
from django.db.models.fields.mixins import FieldCacheMixin
|
||||
from django.db.models.fields.reverse_related import ManyToOneRel
|
||||
from django.db.models.options import Options
|
||||
from django.db.models.query import QuerySet
|
||||
from django.forms.forms import BaseForm
|
||||
from django.utils.safestring import SafeText
|
||||
|
||||
from django.db.models.fields import Field, reverse_related
|
||||
|
||||
@@ -27,7 +25,7 @@ def unquote(s: str) -> str: ...
|
||||
def flatten(fields: Any) -> List[Union[Callable, str]]: ...
|
||||
def flatten_fieldsets(fieldsets: Any) -> List[Union[Callable, str]]: ...
|
||||
def get_deleted_objects(
|
||||
objs: QuerySet, request: WSGIRequest, admin_site: AdminSite
|
||||
objs: Sequence[Optional[Model]], request: WSGIRequest, admin_site: AdminSite
|
||||
) -> Tuple[List[Any], Dict[Any, Any], Set[Any], List[Any]]: ...
|
||||
|
||||
class NestedObjects(Collector):
|
||||
@@ -41,22 +39,14 @@ class NestedObjects(Collector):
|
||||
model_objs: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def add_edge(self, source: Optional[Model], target: Model) -> None: ...
|
||||
def collect(
|
||||
self,
|
||||
objs: Union[Sequence[Optional[Model]], QuerySet],
|
||||
source: Optional[Type[Model]] = ...,
|
||||
source_attr: Optional[str] = ...,
|
||||
**kwargs: Any
|
||||
) -> None: ...
|
||||
def related_objects(self, related: ManyToOneRel, objs: List[Model]) -> QuerySet: ...
|
||||
def nested(self, format_callback: Callable = ...) -> Union[List[SafeText], List[int]]: ...
|
||||
def can_fast_delete(self, *args: Any, **kwargs: Any) -> bool: ...
|
||||
def related_objects(self, related: ManyToOneRel, objs: Sequence[Optional[Model]]) -> QuerySet: ...
|
||||
def nested(self, format_callback: Callable = ...) -> List[Any]: ...
|
||||
|
||||
def model_format_dict(obj: Any): ...
|
||||
def model_ngettext(obj: Union[Options, QuerySet], n: Optional[int] = ...) -> str: ...
|
||||
def lookup_field(
|
||||
name: Union[Callable, str], obj: Model, model_admin: BaseModelAdmin = ...
|
||||
) -> Tuple[Optional[Field], Callable, Callable]: ...
|
||||
) -> Tuple[Optional[Field], Any, Any]: ...
|
||||
def label_for_field(
|
||||
name: Union[Callable, str],
|
||||
model: Type[Model],
|
||||
@@ -65,16 +55,14 @@ def label_for_field(
|
||||
form: Optional[BaseForm] = ...,
|
||||
) -> Union[Tuple[Optional[str], Union[Callable, Type[str]]], str]: ...
|
||||
def help_text_for_field(name: str, model: Type[Model]) -> str: ...
|
||||
def display_for_field(
|
||||
value: Any, field: Union[Field, reverse_related.OneToOneRel], empty_value_display: str
|
||||
) -> str: ...
|
||||
def display_for_field(value: Any, field: Field, empty_value_display: str) -> str: ...
|
||||
def display_for_value(value: Any, empty_value_display: str, boolean: bool = ...) -> str: ...
|
||||
|
||||
class NotRelationField(Exception): ...
|
||||
|
||||
def get_model_from_relation(field: Union[Field, reverse_related.ForeignObjectRel]) -> Type[Model]: ...
|
||||
def reverse_field_path(model: Type[Model], path: str) -> Tuple[Type[Model], str]: ...
|
||||
def get_fields_from_path(model: Type[Model], path: str) -> List[Union[Field, FieldCacheMixin]]: ...
|
||||
def get_fields_from_path(model: Type[Model], path: str) -> List[Field]: ...
|
||||
def construct_change_message(
|
||||
form: AdminPasswordChangeForm, formsets: None, add: bool
|
||||
) -> List[Dict[str, Dict[str, List[str]]]]: ...
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
from typing import Any, Callable, Optional
|
||||
from typing import Callable, Optional, TypeVar, overload
|
||||
|
||||
_C = TypeVar("_C", bound=Callable)
|
||||
@overload
|
||||
def staff_member_required(
|
||||
view_func: Optional[Callable] = ..., redirect_field_name: str = ..., login_url: str = ...
|
||||
view_func: _C = ..., redirect_field_name: Optional[str] = ..., login_url: str = ...
|
||||
) -> _C: ...
|
||||
@overload
|
||||
def staff_member_required(
|
||||
view_func: None = ..., redirect_field_name: Optional[str] = ..., login_url: str = ...
|
||||
) -> Callable: ...
|
||||
|
||||
@@ -2,7 +2,11 @@ from collections import OrderedDict
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
|
||||
|
||||
from django.contrib.admin.filters import ListFilter, SimpleListFilter
|
||||
from django.contrib.admin.options import ModelAdmin, IS_POPUP_VAR as IS_POPUP_VAR, TO_FIELD_VAR as TO_FIELD_VAR
|
||||
from django.contrib.admin.options import ( # noqa: F401
|
||||
ModelAdmin,
|
||||
IS_POPUP_VAR as IS_POPUP_VAR,
|
||||
TO_FIELD_VAR as TO_FIELD_VAR,
|
||||
)
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
from django.db.models.base import Model
|
||||
from django.db.models.expressions import Combinable, CombinedExpression, OrderBy
|
||||
@@ -77,9 +81,7 @@ class ChangeList:
|
||||
paginator: Any = ...
|
||||
def get_results(self, request: WSGIRequest) -> None: ...
|
||||
def get_ordering_field(self, field_name: Union[Callable, str]) -> Optional[Union[CombinedExpression, str]]: ...
|
||||
def get_ordering(
|
||||
self, request: WSGIRequest, queryset: QuerySet
|
||||
) -> Union[List[Union[Combinable, str]], List[Union[OrderBy, str]]]: ...
|
||||
def get_ordering(self, request: WSGIRequest, queryset: QuerySet) -> List[Union[OrderBy, Combinable, str]]: ...
|
||||
def get_ordering_field_columns(self) -> OrderedDict: ...
|
||||
def get_queryset(self, request: WSGIRequest) -> QuerySet: ...
|
||||
def apply_select_related(self, qs: QuerySet) -> QuerySet: ...
|
||||
|
||||
6
django-stubs/contrib/admindocs/apps.pyi
Normal file
6
django-stubs/contrib/admindocs/apps.pyi
Normal file
@@ -0,0 +1,6 @@
|
||||
from django.apps import AppConfig as AppConfig
|
||||
from typing import Any
|
||||
|
||||
class AdminDocsConfig(AppConfig):
|
||||
name: str = ...
|
||||
verbose_name: Any = ...
|
||||
@@ -3,46 +3,17 @@ from typing import Any, Optional, Union
|
||||
from django.db.models.fields import Field
|
||||
from django.views.generic import TemplateView
|
||||
|
||||
from .utils import get_view_name
|
||||
|
||||
MODEL_METHODS_EXCLUDE: Any
|
||||
|
||||
class BaseAdminDocsView(TemplateView):
|
||||
template_name: str = ...
|
||||
def dispatch(self, request: Any, *args: Any, **kwargs: Any): ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class BookmarkletsView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class TemplateTagIndexView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class TemplateFilterIndexView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class ViewIndexView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class ViewDetailView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class ModelIndexView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class ModelDetailView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
|
||||
class TemplateDetailView(BaseAdminDocsView):
|
||||
template_name: str = ...
|
||||
def get_context_data(self, **kwargs: Any): ...
|
||||
class BaseAdminDocsView(TemplateView): ...
|
||||
class BookmarkletsView(BaseAdminDocsView): ...
|
||||
class TemplateTagIndexView(BaseAdminDocsView): ...
|
||||
class TemplateFilterIndexView(BaseAdminDocsView): ...
|
||||
class ViewIndexView(BaseAdminDocsView): ...
|
||||
class ViewDetailView(BaseAdminDocsView): ...
|
||||
class ModelIndexView(BaseAdminDocsView): ...
|
||||
class ModelDetailView(BaseAdminDocsView): ...
|
||||
class TemplateDetailView(BaseAdminDocsView): ...
|
||||
|
||||
def get_return_data_type(func_name: Any): ...
|
||||
def get_readable_field_data_type(field: Union[Field, str]) -> str: ...
|
||||
|
||||
@@ -2,7 +2,7 @@ from typing import Any, List, Optional, Type, Union
|
||||
|
||||
from django.contrib.auth.backends import ModelBackend
|
||||
from django.contrib.auth.base_user import AbstractBaseUser
|
||||
from django.contrib.auth.models import AbstractUser, AnonymousUser
|
||||
from django.contrib.auth.models import AnonymousUser
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
from django.db.models.base import Model
|
||||
from django.db.models.options import Options
|
||||
@@ -23,12 +23,12 @@ def load_backend(path: str) -> ModelBackend: ...
|
||||
def get_backends() -> List[ModelBackend]: ...
|
||||
def authenticate(request: Any = ..., **credentials: Any) -> Optional[AbstractBaseUser]: ...
|
||||
def login(
|
||||
request: HttpRequest, user: AbstractBaseUser, backend: Optional[Union[Type[ModelBackend], str]] = ...
|
||||
request: HttpRequest, user: Optional[AbstractBaseUser], backend: Optional[Union[Type[ModelBackend], str]] = ...
|
||||
) -> None: ...
|
||||
def logout(request: HttpRequest) -> None: ...
|
||||
def get_user_model() -> Type[Model]: ...
|
||||
def get_user(request: HttpRequest) -> Union[AbstractBaseUser, AnonymousUser]: ...
|
||||
def get_permission_codename(action: str, opts: Options) -> str: ...
|
||||
def update_session_auth_hash(request: WSGIRequest, user: AbstractUser) -> None: ...
|
||||
def update_session_auth_hash(request: HttpRequest, user: AbstractBaseUser) -> None: ...
|
||||
|
||||
default_app_config: str
|
||||
|
||||
@@ -1,23 +1,34 @@
|
||||
from typing import Any, Optional, Set, Union
|
||||
|
||||
from django.contrib.auth.base_user import AbstractBaseUser
|
||||
from django.contrib.auth.models import AnonymousUser, User
|
||||
from django.contrib.auth.models import AnonymousUser, User, Permission
|
||||
|
||||
from django.db.models.base import Model
|
||||
|
||||
_AnyUser = Union[Model, AnonymousUser]
|
||||
|
||||
UserModel: Any
|
||||
|
||||
class ModelBackend:
|
||||
class BaseBackend:
|
||||
def authenticate(
|
||||
self, request: Any, username: Optional[Union[int, str]] = ..., password: Optional[str] = ..., **kwargs: Any
|
||||
self, request: Any, username: Optional[str] = ..., password: Optional[str] = ..., **kwargs: Any
|
||||
) -> Optional[AbstractBaseUser]: ...
|
||||
def user_can_authenticate(self, user: Optional[AbstractBaseUser]) -> bool: ...
|
||||
def get_user_permissions(self, user_obj: AbstractBaseUser, obj: None = ...) -> Set[str]: ...
|
||||
def get_group_permissions(self, user_obj: AbstractBaseUser, obj: None = ...) -> Set[str]: ...
|
||||
def get_all_permissions(self, user_obj: AbstractBaseUser, obj: Optional[str] = ...) -> Set[str]: ...
|
||||
def has_perm(
|
||||
self, user_obj: Union[AbstractBaseUser, AnonymousUser], perm: str, obj: Optional[str] = ...
|
||||
) -> bool: ...
|
||||
def has_module_perms(self, user_obj: Union[AbstractBaseUser, AnonymousUser], app_label: str) -> bool: ...
|
||||
def get_user(self, user_id: int) -> AbstractBaseUser: ...
|
||||
def get_user(self, user_id: int) -> Optional[AbstractBaseUser]: ...
|
||||
def get_user_permissions(self, user_obj: _AnyUser, obj: Optional[Model] = ...) -> Set[str]: ...
|
||||
def get_group_permissions(self, user_obj: _AnyUser, obj: Optional[Model] = ...) -> Set[str]: ...
|
||||
def get_all_permissions(self, user_obj: _AnyUser, obj: Optional[Model] = ...) -> Set[str]: ...
|
||||
def has_perm(self, user_obj: _AnyUser, perm: str, obj: Optional[Model] = ...) -> bool: ...
|
||||
|
||||
class ModelBackend(BaseBackend):
|
||||
def has_module_perms(self, user_obj: _AnyUser, app_label: str) -> bool: ...
|
||||
def user_can_authenticate(self, user: Optional[_AnyUser]) -> bool: ...
|
||||
def with_perm(
|
||||
self,
|
||||
perm: Union[str, Permission],
|
||||
is_active: bool = ...,
|
||||
include_superusers: bool = ...,
|
||||
obj: Optional[Model] = ...,
|
||||
): ...
|
||||
|
||||
class AllowAllUsersModelBackend(ModelBackend): ...
|
||||
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
import sys
|
||||
from typing import Any, Optional, Tuple, List, overload, TypeVar
|
||||
|
||||
from django.db.models.base import Model
|
||||
|
||||
from django.db import models
|
||||
|
||||
if sys.version_info < (3, 8):
|
||||
from typing_extensions import Literal
|
||||
else:
|
||||
from typing import Literal
|
||||
|
||||
_T = TypeVar("_T", bound=Model)
|
||||
|
||||
class BaseUserManager(models.Manager[_T]):
|
||||
@@ -13,20 +19,17 @@ class BaseUserManager(models.Manager[_T]):
|
||||
def get_by_natural_key(self, username: Optional[str]) -> _T: ...
|
||||
|
||||
class AbstractBaseUser(models.Model):
|
||||
password: models.CharField = ...
|
||||
last_login: models.DateTimeField = ...
|
||||
is_active: models.BooleanField = ...
|
||||
REQUIRED_FIELDS: List[str] = ...
|
||||
class Meta: ...
|
||||
|
||||
password = models.CharField(max_length=128)
|
||||
last_login = models.DateTimeField(blank=True, null=True)
|
||||
def get_username(self) -> str: ...
|
||||
def clean(self) -> None: ...
|
||||
def save(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def natural_key(self) -> Tuple[str]: ...
|
||||
@property
|
||||
def is_anonymous(self) -> bool: ...
|
||||
def is_anonymous(self) -> Literal[False]: ...
|
||||
@property
|
||||
def is_authenticated(self) -> bool: ...
|
||||
def set_password(self, raw_password: Optional[str]) -> None: ...
|
||||
def is_authenticated(self) -> Literal[True]: ...
|
||||
def set_password(self, raw_password: str) -> None: ...
|
||||
def check_password(self, raw_password: str) -> bool: ...
|
||||
def set_unusable_password(self) -> None: ...
|
||||
def has_usable_password(self) -> bool: ...
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
from typing import Any, List
|
||||
from typing import Any, List, Iterable, Optional
|
||||
|
||||
from django.core.checks.messages import CheckMessage
|
||||
|
||||
def check_user_model(app_configs: None = ..., **kwargs: Any) -> List[CheckMessage]: ...
|
||||
def check_models_permissions(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
|
||||
from django.apps.config import AppConfig
|
||||
|
||||
def check_user_model(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[CheckMessage]: ...
|
||||
def check_models_permissions(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...
|
||||
|
||||
@@ -1,13 +1,21 @@
|
||||
from typing import Any, Callable, List, Optional, Set, Union
|
||||
from typing import Callable, List, Optional, Set, Union, TypeVar, overload
|
||||
|
||||
from django.contrib.auth import REDIRECT_FIELD_NAME as REDIRECT_FIELD_NAME
|
||||
from django.contrib.auth import REDIRECT_FIELD_NAME as REDIRECT_FIELD_NAME # noqa: F401
|
||||
from django.http.response import HttpResponseBase
|
||||
|
||||
from django.contrib.auth.models import AbstractUser
|
||||
|
||||
_VIEW = TypeVar("_VIEW", bound=Callable[..., HttpResponseBase])
|
||||
|
||||
def user_passes_test(
|
||||
test_func: Callable, login_url: Optional[str] = ..., redirect_field_name: str = ...
|
||||
) -> Callable: ...
|
||||
def login_required(
|
||||
function: Optional[Callable] = ..., redirect_field_name: str = ..., login_url: Optional[str] = ...
|
||||
) -> Callable: ...
|
||||
test_func: Callable[[AbstractUser], bool], login_url: Optional[str] = ..., redirect_field_name: str = ...
|
||||
) -> Callable[[_VIEW], _VIEW]: ...
|
||||
|
||||
# There are two ways of calling @login_required: @with(arguments) and @bare
|
||||
@overload
|
||||
def login_required(redirect_field_name: str = ..., login_url: Optional[str] = ...) -> Callable[[_VIEW], _VIEW]: ...
|
||||
@overload
|
||||
def login_required(function: _VIEW, redirect_field_name: str = ..., login_url: Optional[str] = ...) -> _VIEW: ...
|
||||
def permission_required(
|
||||
perm: Union[List[str], Set[str], str], login_url: None = ..., raise_exception: bool = ...
|
||||
) -> Callable: ...
|
||||
) -> Callable[[_VIEW], _VIEW]: ...
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
from typing import Any, Dict, Iterator, Optional
|
||||
|
||||
from django.contrib.auth.base_user import AbstractBaseUser
|
||||
from django.contrib.auth.models import AbstractUser, User
|
||||
from django.contrib.auth.models import User
|
||||
from django.contrib.auth.tokens import PasswordResetTokenGenerator
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
@@ -86,6 +86,6 @@ class AdminPasswordChangeForm(forms.Form):
|
||||
password1: Any = ...
|
||||
password2: Any = ...
|
||||
user: User = ...
|
||||
def __init__(self, user: AbstractUser, *args: Any, **kwargs: Any) -> None: ...
|
||||
def __init__(self, user: AbstractBaseUser, *args: Any, **kwargs: Any) -> None: ...
|
||||
def clean_password2(self) -> str: ...
|
||||
def save(self, commit: bool = ...) -> AbstractUser: ...
|
||||
def save(self, commit: bool = ...) -> AbstractBaseUser: ...
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
from typing import Any, Dict, Optional
|
||||
from typing import Any, Dict
|
||||
|
||||
UserModel: Any
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import getpass as getpass
|
||||
import getpass as getpass # noqa: F401
|
||||
from typing import Any
|
||||
|
||||
from django.core.management.base import BaseCommand
|
||||
|
||||
0
django-stubs/contrib/auth/migrations/__init__.pyi
Normal file
0
django-stubs/contrib/auth/migrations/__init__.pyi
Normal file
@@ -23,6 +23,6 @@ class PermissionRequiredMixin(AccessMixin):
|
||||
def dispatch(self, request: http.HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: ...
|
||||
|
||||
class UserPassesTestMixin(AccessMixin):
|
||||
def test_func(self) -> None: ...
|
||||
def test_func(self) -> Optional[bool]: ...
|
||||
def get_test_func(self) -> Callable: ...
|
||||
def dispatch(self, request: http.HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: ...
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
from typing import Any, Collection, Optional, Set, Tuple, Type, TypeVar
|
||||
import sys
|
||||
from typing import Any, Collection, Optional, Set, Tuple, Type, TypeVar, Union
|
||||
|
||||
from django.contrib.auth.backends import ModelBackend
|
||||
from django.contrib.auth.base_user import AbstractBaseUser as AbstractBaseUser, BaseUserManager as BaseUserManager
|
||||
from django.contrib.auth.validators import UnicodeUsernameValidator
|
||||
from django.contrib.contenttypes.models import ContentType
|
||||
@@ -8,24 +10,35 @@ from django.db.models.manager import EmptyManager
|
||||
|
||||
from django.db import models
|
||||
|
||||
if sys.version_info < (3, 8):
|
||||
from typing_extensions import Literal
|
||||
else:
|
||||
from typing import Literal
|
||||
|
||||
_AnyUser = Union[Model, "AnonymousUser"]
|
||||
|
||||
def update_last_login(sender: Type[AbstractBaseUser], user: AbstractBaseUser, **kwargs: Any) -> None: ...
|
||||
|
||||
class PermissionManager(models.Manager):
|
||||
class PermissionManager(models.Manager["Permission"]):
|
||||
def get_by_natural_key(self, codename: str, app_label: str, model: str) -> Permission: ...
|
||||
|
||||
class Permission(models.Model):
|
||||
content_type_id: int
|
||||
name: models.CharField = ...
|
||||
content_type: models.ForeignKey = models.ForeignKey(ContentType, on_delete=models.CASCADE)
|
||||
codename: models.CharField = ...
|
||||
objects: PermissionManager
|
||||
|
||||
name = models.CharField(max_length=255)
|
||||
content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
|
||||
codename = models.CharField(max_length=100)
|
||||
def natural_key(self) -> Tuple[str, str, str]: ...
|
||||
|
||||
class GroupManager(models.Manager):
|
||||
class GroupManager(models.Manager["Group"]):
|
||||
def get_by_natural_key(self, name: str) -> Group: ...
|
||||
|
||||
class Group(models.Model):
|
||||
name: models.CharField = ...
|
||||
permissions: models.ManyToManyField = models.ManyToManyField(Permission)
|
||||
objects: GroupManager
|
||||
|
||||
name = models.CharField(max_length=150)
|
||||
permissions = models.ManyToManyField(Permission)
|
||||
def natural_key(self): ...
|
||||
|
||||
_T = TypeVar("_T", bound=Model)
|
||||
@@ -37,28 +50,39 @@ class UserManager(BaseUserManager[_T]):
|
||||
def create_superuser(
|
||||
self, username: str, email: Optional[str], password: Optional[str], **extra_fields: Any
|
||||
) -> _T: ...
|
||||
def with_perm(
|
||||
self,
|
||||
perm: Union[str, Permission],
|
||||
is_active: bool = ...,
|
||||
include_superusers: bool = ...,
|
||||
backend: Optional[Union[Type[ModelBackend], str]] = ...,
|
||||
obj: Optional[Model] = ...,
|
||||
): ...
|
||||
|
||||
class PermissionsMixin(models.Model):
|
||||
is_superuser: models.BooleanField = ...
|
||||
groups: models.ManyToManyField = models.ManyToManyField(Group)
|
||||
user_permissions: models.ManyToManyField = models.ManyToManyField(Permission)
|
||||
def get_group_permissions(self, obj: None = ...) -> Set[str]: ...
|
||||
def get_all_permissions(self, obj: Optional[str] = ...) -> Set[str]: ...
|
||||
def has_perm(self, perm: str, obj: Optional[str] = ...) -> bool: ...
|
||||
def has_perms(self, perm_list: Collection[str], obj: None = ...) -> bool: ...
|
||||
is_superuser = models.BooleanField()
|
||||
groups = models.ManyToManyField(Group)
|
||||
user_permissions = models.ManyToManyField(Permission)
|
||||
def get_user_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[str]: ...
|
||||
def get_group_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[str]: ...
|
||||
def get_all_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[str]: ...
|
||||
def has_perm(self, perm: str, obj: Optional[_AnyUser] = ...) -> bool: ...
|
||||
def has_perms(self, perm_list: Collection[str], obj: Optional[_AnyUser] = ...) -> bool: ...
|
||||
def has_module_perms(self, app_label: str) -> bool: ...
|
||||
|
||||
class AbstractUser(AbstractBaseUser, PermissionsMixin): # type: ignore
|
||||
username_validator: UnicodeUsernameValidator = ...
|
||||
username: models.CharField = ...
|
||||
first_name: models.CharField = ...
|
||||
last_name: models.CharField = ...
|
||||
email: models.EmailField = ...
|
||||
is_staff: models.BooleanField = ...
|
||||
date_joined: models.DateTimeField = ...
|
||||
|
||||
username = models.CharField(max_length=150)
|
||||
first_name = models.CharField(max_length=30, blank=True)
|
||||
last_name = models.CharField(max_length=150, blank=True)
|
||||
email = models.EmailField(blank=True)
|
||||
is_staff = models.BooleanField()
|
||||
is_active = models.BooleanField()
|
||||
date_joined = models.DateTimeField()
|
||||
|
||||
EMAIL_FIELD: str = ...
|
||||
USERNAME_FIELD: str = ...
|
||||
def clean(self) -> None: ...
|
||||
def get_full_name(self) -> str: ...
|
||||
def get_short_name(self) -> str: ...
|
||||
def email_user(self, subject: str, message: str, from_email: str = ..., **kwargs: Any) -> None: ...
|
||||
@@ -80,13 +104,14 @@ class AnonymousUser:
|
||||
def groups(self) -> EmptyManager: ...
|
||||
@property
|
||||
def user_permissions(self) -> EmptyManager: ...
|
||||
def get_group_permissions(self, obj: None = ...) -> Set[Any]: ...
|
||||
def get_all_permissions(self, obj: Any = ...) -> Set[str]: ...
|
||||
def has_perm(self, perm: str, obj: None = ...) -> bool: ...
|
||||
def has_perms(self, perm_list: Collection[str], obj: None = ...) -> bool: ...
|
||||
def get_user_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[str]: ...
|
||||
def get_group_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[Any]: ...
|
||||
def get_all_permissions(self, obj: Optional[_AnyUser] = ...) -> Set[str]: ...
|
||||
def has_perm(self, perm: str, obj: Optional[_AnyUser] = ...) -> bool: ...
|
||||
def has_perms(self, perm_list: Collection[str], obj: Optional[_AnyUser] = ...) -> bool: ...
|
||||
def has_module_perms(self, module: str) -> bool: ...
|
||||
@property
|
||||
def is_anonymous(self) -> bool: ...
|
||||
def is_anonymous(self) -> Literal[True]: ...
|
||||
@property
|
||||
def is_authenticated(self) -> bool: ...
|
||||
def is_authenticated(self) -> Literal[False]: ...
|
||||
def get_username(self) -> str: ...
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
from pathlib import Path, PosixPath
|
||||
from typing import Any, List, Mapping, Optional, Protocol, Sequence, Set, Union
|
||||
|
||||
from django.contrib.auth.base_user import AbstractBaseUser
|
||||
from django.db.models.base import Model
|
||||
|
||||
_UserModel = Model
|
||||
|
||||
@@ -55,6 +55,7 @@ class PasswordResetDoneView(PasswordContextMixin, TemplateView):
|
||||
class PasswordResetConfirmView(PasswordContextMixin, FormView):
|
||||
post_reset_login: bool = ...
|
||||
post_reset_login_backend: Any = ...
|
||||
reset_url_token: str = ...
|
||||
title: Any = ...
|
||||
token_generator: Any = ...
|
||||
validlink: bool = ...
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
from typing import Any, List, Optional
|
||||
from typing import Any, List, Iterable, Optional
|
||||
|
||||
def check_generic_foreign_keys(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
|
||||
def check_model_name_lengths(app_configs: None = ..., **kwargs: Any) -> List[Any]: ...
|
||||
from django.apps.config import AppConfig
|
||||
|
||||
def check_generic_foreign_keys(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...
|
||||
def check_model_name_lengths(app_configs: Optional[Iterable[AppConfig]] = ..., **kwargs: Any) -> List[Any]: ...
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union, Generic
|
||||
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
|
||||
|
||||
from django.contrib.contenttypes.models import ContentType
|
||||
from django.core.checks.messages import Error
|
||||
from django.core.checks.messages import CheckMessage
|
||||
from django.db.models.base import Model
|
||||
from django.db.models.expressions import Combinable
|
||||
from django.db.models.fields.mixins import FieldCacheMixin
|
||||
from django.db.models.fields.related import ForeignObject
|
||||
from django.db.models.fields.related_descriptors import ReverseManyToOneDescriptor
|
||||
from django.db.models.fields.reverse_related import ForeignObjectRel
|
||||
|
||||
from django.db.models.expressions import Combinable
|
||||
from django.db.models.fields import Field, PositiveIntegerField
|
||||
from django.db.models.fields.mixins import FieldCacheMixin
|
||||
from django.db.models.query import QuerySet
|
||||
from django.db.models.query_utils import FilteredRelation, PathInfo
|
||||
from django.db.models.sql.where import WhereNode
|
||||
|
||||
from django.db.models.fields import Field, PositiveIntegerField
|
||||
|
||||
class GenericForeignKey(FieldCacheMixin):
|
||||
# django-stubs implementation only fields
|
||||
_pyi_private_set_type: Union[Any, Combinable]
|
||||
@@ -41,7 +41,7 @@ class GenericForeignKey(FieldCacheMixin):
|
||||
def contribute_to_class(self, cls: Type[Model], name: str, **kwargs: Any) -> None: ...
|
||||
def get_filter_kwargs_for_object(self, obj: Model) -> Dict[str, Optional[ContentType]]: ...
|
||||
def get_forward_related_filter(self, obj: Model) -> Dict[str, int]: ...
|
||||
def check(self, **kwargs: Any) -> List[Error]: ...
|
||||
def check(self, **kwargs: Any) -> List[CheckMessage]: ...
|
||||
def get_cache_name(self) -> str: ...
|
||||
def get_content_type(
|
||||
self, obj: Optional[Model] = ..., id: Optional[int] = ..., using: Optional[str] = ...
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
from typing import Any, Optional, Union
|
||||
from typing import Union
|
||||
|
||||
from django.http.request import HttpRequest
|
||||
from django.http.response import HttpResponseRedirect
|
||||
|
||||
9
django-stubs/contrib/flatpages/admin.pyi
Normal file
9
django-stubs/contrib/flatpages/admin.pyi
Normal file
@@ -0,0 +1,9 @@
|
||||
from django.contrib import admin as admin
|
||||
from typing import Any
|
||||
|
||||
class FlatPageAdmin(admin.ModelAdmin):
|
||||
form: Any = ...
|
||||
fieldsets: Any = ...
|
||||
list_display: Any = ...
|
||||
list_filter: Any = ...
|
||||
search_fields: Any = ...
|
||||
6
django-stubs/contrib/flatpages/apps.pyi
Normal file
6
django-stubs/contrib/flatpages/apps.pyi
Normal file
@@ -0,0 +1,6 @@
|
||||
from django.apps import AppConfig as AppConfig
|
||||
from typing import Any
|
||||
|
||||
class FlatPagesConfig(AppConfig):
|
||||
name: str = ...
|
||||
verbose_name: Any = ...
|
||||
@@ -1,5 +1,3 @@
|
||||
from typing import Any, Optional
|
||||
|
||||
from django.contrib.flatpages.models import FlatPage
|
||||
from django.core.handlers.wsgi import WSGIRequest
|
||||
from django.http.response import HttpResponse
|
||||
|
||||
1
django-stubs/contrib/gis/__init__.pyi
Normal file
1
django-stubs/contrib/gis/__init__.pyi
Normal file
@@ -0,0 +1 @@
|
||||
default_app_config: str
|
||||
12
django-stubs/contrib/gis/admin/__init__.pyi
Normal file
12
django-stubs/contrib/gis/admin/__init__.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from django.contrib.admin import (
|
||||
AdminSite as AdminSite,
|
||||
HORIZONTAL as HORIZONTAL,
|
||||
ModelAdmin as ModelAdmin,
|
||||
StackedInline as StackedInline,
|
||||
TabularInline as TabularInline,
|
||||
VERTICAL as VERTICAL,
|
||||
autodiscover as autodiscover,
|
||||
register as register,
|
||||
site as site,
|
||||
)
|
||||
from django.contrib.gis.admin.options import GeoModelAdmin as GeoModelAdmin, OSMGeoAdmin as OSMGeoAdmin
|
||||
45
django-stubs/contrib/gis/admin/options.pyi
Normal file
45
django-stubs/contrib/gis/admin/options.pyi
Normal file
@@ -0,0 +1,45 @@
|
||||
from django.contrib.admin import ModelAdmin as ModelAdmin
|
||||
from typing import Any
|
||||
|
||||
spherical_mercator_srid: int
|
||||
|
||||
class GeoModelAdmin(ModelAdmin):
|
||||
default_lon: int = ...
|
||||
default_lat: int = ...
|
||||
default_zoom: int = ...
|
||||
display_wkt: bool = ...
|
||||
display_srid: bool = ...
|
||||
extra_js: Any = ...
|
||||
num_zoom: int = ...
|
||||
max_zoom: bool = ...
|
||||
min_zoom: bool = ...
|
||||
units: bool = ...
|
||||
max_resolution: bool = ...
|
||||
max_extent: bool = ...
|
||||
modifiable: bool = ...
|
||||
mouse_position: bool = ...
|
||||
scale_text: bool = ...
|
||||
layerswitcher: bool = ...
|
||||
scrollable: bool = ...
|
||||
map_width: int = ...
|
||||
map_height: int = ...
|
||||
map_srid: int = ...
|
||||
map_template: str = ...
|
||||
openlayers_url: str = ...
|
||||
point_zoom: Any = ...
|
||||
wms_url: str = ...
|
||||
wms_layer: str = ...
|
||||
wms_name: str = ...
|
||||
wms_options: Any = ...
|
||||
debug: bool = ...
|
||||
widget: Any = ...
|
||||
@property
|
||||
def media(self): ...
|
||||
def formfield_for_dbfield(self, db_field: Any, request: Any, **kwargs: Any): ...
|
||||
def get_map_widget(self, db_field: Any): ...
|
||||
|
||||
class OSMGeoAdmin(GeoModelAdmin):
|
||||
map_template: str = ...
|
||||
num_zoom: int = ...
|
||||
map_srid: Any = ...
|
||||
point_zoom: Any = ...
|
||||
9
django-stubs/contrib/gis/admin/widgets.pyi
Normal file
9
django-stubs/contrib/gis/admin/widgets.pyi
Normal file
@@ -0,0 +1,9 @@
|
||||
from django.forms.widgets import Textarea as Textarea
|
||||
from typing import Any
|
||||
|
||||
geo_context: Any
|
||||
logger: Any
|
||||
|
||||
class OpenLayersWidget(Textarea):
|
||||
def get_context(self, name: Any, value: Any, attrs: Any): ...
|
||||
def map_options(self): ...
|
||||
7
django-stubs/contrib/gis/apps.pyi
Normal file
7
django-stubs/contrib/gis/apps.pyi
Normal file
@@ -0,0 +1,7 @@
|
||||
from django.apps import AppConfig as AppConfig
|
||||
from typing import Any
|
||||
|
||||
class GISConfig(AppConfig):
|
||||
name: str = ...
|
||||
verbose_name: Any = ...
|
||||
def ready(self) -> None: ...
|
||||
0
django-stubs/contrib/gis/db/__init__.pyi
Normal file
0
django-stubs/contrib/gis/db/__init__.pyi
Normal file
0
django-stubs/contrib/gis/db/backends/__init__.pyi
Normal file
0
django-stubs/contrib/gis/db/backends/__init__.pyi
Normal file
8
django-stubs/contrib/gis/db/backends/base/adapter.pyi
Normal file
8
django-stubs/contrib/gis/db/backends/base/adapter.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from typing import Any
|
||||
|
||||
class WKTAdapter:
|
||||
wkt: Any = ...
|
||||
srid: Any = ...
|
||||
def __init__(self, geom: Any) -> None: ...
|
||||
def __eq__(self, other: Any) -> Any: ...
|
||||
def __hash__(self) -> Any: ...
|
||||
44
django-stubs/contrib/gis/db/backends/base/features.pyi
Normal file
44
django-stubs/contrib/gis/db/backends/base/features.pyi
Normal file
@@ -0,0 +1,44 @@
|
||||
from typing import Any
|
||||
|
||||
class BaseSpatialFeatures:
|
||||
gis_enabled: bool = ...
|
||||
has_spatialrefsys_table: bool = ...
|
||||
supports_add_srs_entry: bool = ...
|
||||
supports_geometry_field_introspection: bool = ...
|
||||
supports_3d_storage: bool = ...
|
||||
supports_3d_functions: bool = ...
|
||||
supports_transform: bool = ...
|
||||
supports_null_geometries: bool = ...
|
||||
supports_empty_geometries: bool = ...
|
||||
supports_distance_geodetic: bool = ...
|
||||
supports_length_geodetic: bool = ...
|
||||
supports_perimeter_geodetic: bool = ...
|
||||
supports_area_geodetic: bool = ...
|
||||
supports_num_points_poly: bool = ...
|
||||
supports_left_right_lookups: bool = ...
|
||||
supports_dwithin_distance_expr: bool = ...
|
||||
supports_raster: bool = ...
|
||||
supports_geometry_field_unique_index: bool = ...
|
||||
@property
|
||||
def supports_bbcontains_lookup(self): ...
|
||||
@property
|
||||
def supports_contained_lookup(self): ...
|
||||
@property
|
||||
def supports_crosses_lookup(self): ...
|
||||
@property
|
||||
def supports_distances_lookups(self): ...
|
||||
@property
|
||||
def supports_dwithin_lookup(self): ...
|
||||
@property
|
||||
def supports_relate_lookup(self): ...
|
||||
@property
|
||||
def supports_isvalid_lookup(self): ...
|
||||
@property
|
||||
def supports_collect_aggr(self): ...
|
||||
@property
|
||||
def supports_extent_aggr(self): ...
|
||||
@property
|
||||
def supports_make_line_aggr(self): ...
|
||||
@property
|
||||
def supports_union_aggr(self): ...
|
||||
def __getattr__(self, name: Any): ...
|
||||
33
django-stubs/contrib/gis/db/backends/base/models.pyi
Normal file
33
django-stubs/contrib/gis/db/backends/base/models.pyi
Normal file
@@ -0,0 +1,33 @@
|
||||
from typing import Any
|
||||
|
||||
class SpatialRefSysMixin:
|
||||
@property
|
||||
def srs(self): ...
|
||||
@property
|
||||
def ellipsoid(self): ...
|
||||
@property
|
||||
def name(self): ...
|
||||
@property
|
||||
def spheroid(self): ...
|
||||
@property
|
||||
def datum(self): ...
|
||||
@property
|
||||
def projected(self): ...
|
||||
@property
|
||||
def local(self): ...
|
||||
@property
|
||||
def geographic(self): ...
|
||||
@property
|
||||
def linear_name(self): ...
|
||||
@property
|
||||
def linear_units(self): ...
|
||||
@property
|
||||
def angular_name(self): ...
|
||||
@property
|
||||
def angular_units(self): ...
|
||||
@property
|
||||
def units(self): ...
|
||||
@classmethod
|
||||
def get_units(cls, wkt: Any): ...
|
||||
@classmethod
|
||||
def get_spheroid(cls, wkt: Any, string: bool = ...): ...
|
||||
33
django-stubs/contrib/gis/db/backends/base/operations.pyi
Normal file
33
django-stubs/contrib/gis/db/backends/base/operations.pyi
Normal file
@@ -0,0 +1,33 @@
|
||||
from typing import Any
|
||||
|
||||
class BaseSpatialOperations:
|
||||
postgis: bool = ...
|
||||
spatialite: bool = ...
|
||||
mysql: bool = ...
|
||||
oracle: bool = ...
|
||||
spatial_version: Any = ...
|
||||
select: str = ...
|
||||
def select_extent(self): ...
|
||||
geography: bool = ...
|
||||
geometry: bool = ...
|
||||
disallowed_aggregates: Any = ...
|
||||
geom_func_prefix: str = ...
|
||||
function_names: Any = ...
|
||||
unsupported_functions: Any = ...
|
||||
from_text: bool = ...
|
||||
def convert_extent(self, box: Any, srid: Any) -> None: ...
|
||||
def convert_extent3d(self, box: Any, srid: Any) -> None: ...
|
||||
def geo_quote_name(self, name: Any): ...
|
||||
def geo_db_type(self, f: Any) -> None: ...
|
||||
def get_distance(self, f: Any, value: Any, lookup_type: Any) -> None: ...
|
||||
def get_geom_placeholder(self, f: Any, value: Any, compiler: Any): ...
|
||||
def check_expression_support(self, expression: Any) -> None: ...
|
||||
def spatial_aggregate_name(self, agg_name: Any) -> None: ...
|
||||
def spatial_function_name(self, func_name: Any): ...
|
||||
def geometry_columns(self) -> None: ...
|
||||
def spatial_ref_sys(self) -> None: ...
|
||||
distance_expr_for_lookup: Any = ...
|
||||
def get_db_converters(self, expression: Any): ...
|
||||
def get_geometry_converter(self, expression: Any) -> None: ...
|
||||
def get_area_att_for_field(self, field: Any): ...
|
||||
def get_distance_att_for_field(self, field: Any): ...
|
||||
8
django-stubs/contrib/gis/db/backends/mysql/base.pyi
Normal file
8
django-stubs/contrib/gis/db/backends/mysql/base.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from django.db.backends.mysql.base import DatabaseWrapper as MySQLDatabaseWrapper
|
||||
from typing import Any
|
||||
|
||||
class DatabaseWrapper(MySQLDatabaseWrapper):
|
||||
SchemaEditorClass: Any = ...
|
||||
features_class: Any = ...
|
||||
introspection_class: Any = ...
|
||||
ops_class: Any = ...
|
||||
14
django-stubs/contrib/gis/db/backends/mysql/features.pyi
Normal file
14
django-stubs/contrib/gis/db/backends/mysql/features.pyi
Normal file
@@ -0,0 +1,14 @@
|
||||
from django.contrib.gis.db.backends.base.features import BaseSpatialFeatures as BaseSpatialFeatures
|
||||
from django.db.backends.mysql.features import DatabaseFeatures as MySQLDatabaseFeatures
|
||||
|
||||
class DatabaseFeatures(BaseSpatialFeatures, MySQLDatabaseFeatures):
|
||||
has_spatialrefsys_table: bool = ...
|
||||
supports_add_srs_entry: bool = ...
|
||||
supports_distance_geodetic: bool = ...
|
||||
supports_length_geodetic: bool = ...
|
||||
supports_area_geodetic: bool = ...
|
||||
supports_transform: bool = ...
|
||||
supports_null_geometries: bool = ...
|
||||
supports_num_points_poly: bool = ...
|
||||
def supports_empty_geometry_collection(self): ...
|
||||
def supports_geometry_field_unique_index(self): ...
|
||||
@@ -0,0 +1,7 @@
|
||||
from django.db.backends.mysql.introspection import DatabaseIntrospection as DatabaseIntrospection
|
||||
from typing import Any
|
||||
|
||||
class MySQLIntrospection(DatabaseIntrospection):
|
||||
data_types_reverse: Any = ...
|
||||
def get_geometry_type(self, table_name: Any, description: Any): ...
|
||||
def supports_spatial_index(self, cursor: Any, table_name: Any): ...
|
||||
17
django-stubs/contrib/gis/db/backends/mysql/operations.pyi
Normal file
17
django-stubs/contrib/gis/db/backends/mysql/operations.pyi
Normal file
@@ -0,0 +1,17 @@
|
||||
from django.contrib.gis.db.backends.base.operations import BaseSpatialOperations as BaseSpatialOperations
|
||||
from django.db.backends.mysql.operations import DatabaseOperations as DatabaseOperations
|
||||
from typing import Any
|
||||
|
||||
class MySQLOperations(BaseSpatialOperations, DatabaseOperations):
|
||||
mysql: bool = ...
|
||||
name: str = ...
|
||||
geom_func_prefix: str = ...
|
||||
Adapter: Any = ...
|
||||
def select(self): ...
|
||||
def from_text(self): ...
|
||||
def gis_operators(self): ...
|
||||
disallowed_aggregates: Any = ...
|
||||
def unsupported_functions(self): ...
|
||||
def geo_db_type(self, f: Any): ...
|
||||
def get_distance(self, f: Any, value: Any, lookup_type: Any): ...
|
||||
def get_geometry_converter(self, expression: Any): ...
|
||||
16
django-stubs/contrib/gis/db/backends/mysql/schema.pyi
Normal file
16
django-stubs/contrib/gis/db/backends/mysql/schema.pyi
Normal file
@@ -0,0 +1,16 @@
|
||||
from django.db.backends.mysql.schema import DatabaseSchemaEditor as DatabaseSchemaEditor
|
||||
from typing import Any
|
||||
|
||||
logger: Any
|
||||
|
||||
class MySQLGISSchemaEditor(DatabaseSchemaEditor):
|
||||
sql_add_spatial_index: str = ...
|
||||
sql_drop_spatial_index: str = ...
|
||||
geometry_sql: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def skip_default(self, field: Any): ...
|
||||
def column_sql(self, model: Any, field: Any, include_default: bool = ...): ...
|
||||
def create_model(self, model: Any) -> None: ...
|
||||
def add_field(self, model: Any, field: Any) -> None: ...
|
||||
def remove_field(self, model: Any, field: Any) -> None: ...
|
||||
def create_spatial_indexes(self) -> None: ...
|
||||
8
django-stubs/contrib/gis/db/backends/oracle/adapter.pyi
Normal file
8
django-stubs/contrib/gis/db/backends/oracle/adapter.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from django.contrib.gis.db.backends.base.adapter import WKTAdapter
|
||||
from typing import Any
|
||||
|
||||
class OracleSpatialAdapter(WKTAdapter):
|
||||
input_size: Any = ...
|
||||
wkt: Any = ...
|
||||
srid: Any = ...
|
||||
def __init__(self, geom: Any) -> None: ...
|
||||
8
django-stubs/contrib/gis/db/backends/oracle/base.pyi
Normal file
8
django-stubs/contrib/gis/db/backends/oracle/base.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from django.db.backends.oracle.base import DatabaseWrapper as OracleDatabaseWrapper
|
||||
from typing import Any
|
||||
|
||||
class DatabaseWrapper(OracleDatabaseWrapper):
|
||||
SchemaEditorClass: Any = ...
|
||||
features_class: Any = ...
|
||||
introspection_class: Any = ...
|
||||
ops_class: Any = ...
|
||||
9
django-stubs/contrib/gis/db/backends/oracle/features.pyi
Normal file
9
django-stubs/contrib/gis/db/backends/oracle/features.pyi
Normal file
@@ -0,0 +1,9 @@
|
||||
from django.contrib.gis.db.backends.base.features import BaseSpatialFeatures as BaseSpatialFeatures
|
||||
from django.db.backends.oracle.features import DatabaseFeatures as OracleDatabaseFeatures
|
||||
|
||||
class DatabaseFeatures(BaseSpatialFeatures, OracleDatabaseFeatures):
|
||||
supports_add_srs_entry: bool = ...
|
||||
supports_geometry_field_introspection: bool = ...
|
||||
supports_geometry_field_unique_index: bool = ...
|
||||
supports_perimeter_geodetic: bool = ...
|
||||
supports_dwithin_distance_expr: bool = ...
|
||||
@@ -0,0 +1,6 @@
|
||||
from django.db.backends.oracle.introspection import DatabaseIntrospection as DatabaseIntrospection
|
||||
from typing import Any
|
||||
|
||||
class OracleIntrospection(DatabaseIntrospection):
|
||||
def data_types_reverse(self): ...
|
||||
def get_geometry_type(self, table_name: Any, description: Any): ...
|
||||
30
django-stubs/contrib/gis/db/backends/oracle/models.pyi
Normal file
30
django-stubs/contrib/gis/db/backends/oracle/models.pyi
Normal file
@@ -0,0 +1,30 @@
|
||||
from django.contrib.gis.db import models as models
|
||||
from django.contrib.gis.db.backends.base.models import SpatialRefSysMixin as SpatialRefSysMixin
|
||||
from typing import Any
|
||||
|
||||
class OracleGeometryColumns(models.Model):
|
||||
table_name: Any = ...
|
||||
column_name: Any = ...
|
||||
srid: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@classmethod
|
||||
def table_name_col(cls): ...
|
||||
@classmethod
|
||||
def geom_col_name(cls): ...
|
||||
|
||||
class OracleSpatialRefSys(models.Model, SpatialRefSysMixin):
|
||||
cs_name: Any = ...
|
||||
srid: Any = ...
|
||||
auth_srid: Any = ...
|
||||
auth_name: Any = ...
|
||||
wktext: Any = ...
|
||||
cs_bounds: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@property
|
||||
def wkt(self): ...
|
||||
42
django-stubs/contrib/gis/db/backends/oracle/operations.pyi
Normal file
42
django-stubs/contrib/gis/db/backends/oracle/operations.pyi
Normal file
@@ -0,0 +1,42 @@
|
||||
from django.contrib.gis.db.backends.base.operations import BaseSpatialOperations as BaseSpatialOperations
|
||||
from django.contrib.gis.db.backends.utils import SpatialOperator as SpatialOperator
|
||||
from django.db.backends.oracle.operations import DatabaseOperations as DatabaseOperations
|
||||
from typing import Any
|
||||
|
||||
DEFAULT_TOLERANCE: str
|
||||
|
||||
class SDOOperator(SpatialOperator):
|
||||
sql_template: str = ...
|
||||
|
||||
class SDODWithin(SpatialOperator):
|
||||
sql_template: str = ...
|
||||
|
||||
class SDODisjoint(SpatialOperator):
|
||||
sql_template: Any = ...
|
||||
|
||||
class SDORelate(SpatialOperator):
|
||||
sql_template: str = ...
|
||||
def check_relate_argument(self, arg: Any) -> None: ...
|
||||
def as_sql(self, connection: Any, lookup: Any, template_params: Any, sql_params: Any): ...
|
||||
|
||||
class OracleOperations(BaseSpatialOperations, DatabaseOperations):
|
||||
name: str = ...
|
||||
oracle: bool = ...
|
||||
disallowed_aggregates: Any = ...
|
||||
Adapter: Any = ...
|
||||
extent: str = ...
|
||||
unionagg: str = ...
|
||||
function_names: Any = ...
|
||||
select: str = ...
|
||||
gis_operators: Any = ...
|
||||
unsupported_functions: Any = ...
|
||||
def geo_quote_name(self, name: Any): ...
|
||||
def geo_db_type(self, f: Any): ...
|
||||
def get_distance(self, f: Any, value: Any, lookup_type: Any): ...
|
||||
def get_geom_placeholder(self, f: Any, value: Any, compiler: Any): ...
|
||||
def spatial_aggregate_name(self, agg_name: Any): ...
|
||||
def geometry_columns(self): ...
|
||||
def spatial_ref_sys(self): ...
|
||||
def modify_insert_params(self, placeholder: Any, params: Any): ...
|
||||
def get_geometry_converter(self, expression: Any): ...
|
||||
def get_area_att_for_field(self, field: Any): ...
|
||||
18
django-stubs/contrib/gis/db/backends/oracle/schema.pyi
Normal file
18
django-stubs/contrib/gis/db/backends/oracle/schema.pyi
Normal file
@@ -0,0 +1,18 @@
|
||||
from django.db.backends.oracle.schema import DatabaseSchemaEditor
|
||||
from typing import Any
|
||||
|
||||
class OracleGISSchemaEditor(DatabaseSchemaEditor):
|
||||
sql_add_geometry_metadata: str = ...
|
||||
sql_add_spatial_index: str = ...
|
||||
sql_drop_spatial_index: str = ...
|
||||
sql_clear_geometry_table_metadata: str = ...
|
||||
sql_clear_geometry_field_metadata: str = ...
|
||||
geometry_sql: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def geo_quote_name(self, name: Any): ...
|
||||
def column_sql(self, model: Any, field: Any, include_default: bool = ...): ...
|
||||
def create_model(self, model: Any) -> None: ...
|
||||
def delete_model(self, model: Any) -> None: ...
|
||||
def add_field(self, model: Any, field: Any) -> None: ...
|
||||
def remove_field(self, model: Any, field: Any) -> None: ...
|
||||
def run_geometry_sql(self) -> None: ...
|
||||
13
django-stubs/contrib/gis/db/backends/postgis/adapter.pyi
Normal file
13
django-stubs/contrib/gis/db/backends/postgis/adapter.pyi
Normal file
@@ -0,0 +1,13 @@
|
||||
from typing import Any
|
||||
|
||||
class PostGISAdapter:
|
||||
is_geometry: Any = ...
|
||||
ewkb: Any = ...
|
||||
srid: Any = ...
|
||||
geography: Any = ...
|
||||
def __init__(self, obj: Any, geography: bool = ...) -> None: ...
|
||||
def __conform__(self, proto: Any): ...
|
||||
def __eq__(self, other: Any) -> Any: ...
|
||||
def __hash__(self) -> Any: ...
|
||||
def prepare(self, conn: Any) -> None: ...
|
||||
def getquoted(self): ...
|
||||
10
django-stubs/contrib/gis/db/backends/postgis/base.pyi
Normal file
10
django-stubs/contrib/gis/db/backends/postgis/base.pyi
Normal file
@@ -0,0 +1,10 @@
|
||||
from django.db.backends.postgresql.base import DatabaseWrapper as Psycopg2DatabaseWrapper
|
||||
from typing import Any
|
||||
|
||||
class DatabaseWrapper(Psycopg2DatabaseWrapper):
|
||||
SchemaEditorClass: Any = ...
|
||||
features: Any = ...
|
||||
ops: Any = ...
|
||||
introspection: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def prepare_database(self) -> None: ...
|
||||
9
django-stubs/contrib/gis/db/backends/postgis/const.pyi
Normal file
9
django-stubs/contrib/gis/db/backends/postgis/const.pyi
Normal file
@@ -0,0 +1,9 @@
|
||||
from typing import Any
|
||||
|
||||
GDAL_TO_POSTGIS: Any
|
||||
POSTGIS_TO_GDAL: Any
|
||||
POSTGIS_HEADER_STRUCTURE: str
|
||||
GDAL_TO_STRUCT: Any
|
||||
STRUCT_SIZE: Any
|
||||
BANDTYPE_PIXTYPE_MASK: int
|
||||
BANDTYPE_FLAG_HASNODATA: Any
|
||||
@@ -0,0 +1,9 @@
|
||||
from django.contrib.gis.db.backends.base.features import BaseSpatialFeatures as BaseSpatialFeatures
|
||||
from django.db.backends.postgresql.features import DatabaseFeatures as Psycopg2DatabaseFeatures
|
||||
|
||||
class DatabaseFeatures(BaseSpatialFeatures, Psycopg2DatabaseFeatures):
|
||||
supports_3d_storage: bool = ...
|
||||
supports_3d_functions: bool = ...
|
||||
supports_left_right_lookups: bool = ...
|
||||
supports_raster: bool = ...
|
||||
supports_empty_geometries: bool = ...
|
||||
@@ -0,0 +1,8 @@
|
||||
from django.db.backends.postgresql.introspection import DatabaseIntrospection as DatabaseIntrospection
|
||||
from typing import Any
|
||||
|
||||
class PostGISIntrospection(DatabaseIntrospection):
|
||||
postgis_oid_lookup: Any = ...
|
||||
ignored_tables: Any = ...
|
||||
def get_field_type(self, data_type: Any, description: Any): ...
|
||||
def get_geometry_type(self, table_name: Any, description: Any): ...
|
||||
33
django-stubs/contrib/gis/db/backends/postgis/models.pyi
Normal file
33
django-stubs/contrib/gis/db/backends/postgis/models.pyi
Normal file
@@ -0,0 +1,33 @@
|
||||
from django.contrib.gis.db.backends.base.models import SpatialRefSysMixin as SpatialRefSysMixin
|
||||
from django.db import models as models
|
||||
from typing import Any
|
||||
|
||||
class PostGISGeometryColumns(models.Model):
|
||||
f_table_catalog: Any = ...
|
||||
f_table_schema: Any = ...
|
||||
f_table_name: Any = ...
|
||||
f_geometry_column: Any = ...
|
||||
coord_dimension: Any = ...
|
||||
srid: Any = ...
|
||||
type: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@classmethod
|
||||
def table_name_col(cls): ...
|
||||
@classmethod
|
||||
def geom_col_name(cls): ...
|
||||
|
||||
class PostGISSpatialRefSys(models.Model, SpatialRefSysMixin):
|
||||
srid: Any = ...
|
||||
auth_name: Any = ...
|
||||
auth_srid: Any = ...
|
||||
srtext: Any = ...
|
||||
proj4text: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@property
|
||||
def wkt(self): ...
|
||||
56
django-stubs/contrib/gis/db/backends/postgis/operations.pyi
Normal file
56
django-stubs/contrib/gis/db/backends/postgis/operations.pyi
Normal file
@@ -0,0 +1,56 @@
|
||||
from django.contrib.gis.db.backends.base.operations import BaseSpatialOperations
|
||||
from django.contrib.gis.db.backends.utils import SpatialOperator
|
||||
from django.db.backends.postgresql.operations import DatabaseOperations
|
||||
from django.db.models import Func
|
||||
from typing import Any
|
||||
|
||||
BILATERAL: str
|
||||
|
||||
class PostGISOperator(SpatialOperator):
|
||||
geography: Any = ...
|
||||
raster: Any = ...
|
||||
def __init__(self, geography: bool = ..., raster: bool = ..., **kwargs: Any) -> None: ...
|
||||
def as_sql(self, connection: Any, lookup: Any, template_params: Any, *args: Any): ...
|
||||
def check_raster(self, lookup: Any, template_params: Any): ...
|
||||
|
||||
class ST_Polygon(Func):
|
||||
function: str = ...
|
||||
def __init__(self, expr: Any) -> None: ...
|
||||
def output_field(self): ...
|
||||
|
||||
class PostGISOperations(BaseSpatialOperations, DatabaseOperations):
|
||||
name: str = ...
|
||||
postgis: bool = ...
|
||||
geography: bool = ...
|
||||
geom_func_prefix: str = ...
|
||||
Adapter: Any = ...
|
||||
collect: Any = ...
|
||||
extent: Any = ...
|
||||
extent3d: Any = ...
|
||||
length3d: Any = ...
|
||||
makeline: Any = ...
|
||||
perimeter3d: Any = ...
|
||||
unionagg: Any = ...
|
||||
gis_operators: Any = ...
|
||||
unsupported_functions: Any = ...
|
||||
select: str = ...
|
||||
select_extent: Any = ...
|
||||
def function_names(self): ...
|
||||
def spatial_version(self): ...
|
||||
def geo_db_type(self, f: Any): ...
|
||||
def get_distance(self, f: Any, dist_val: Any, lookup_type: Any): ...
|
||||
def get_geom_placeholder(self, f: Any, value: Any, compiler: Any): ...
|
||||
def postgis_geos_version(self): ...
|
||||
def postgis_lib_version(self): ...
|
||||
def postgis_proj_version(self): ...
|
||||
def postgis_version(self): ...
|
||||
def postgis_full_version(self): ...
|
||||
def postgis_version_tuple(self): ...
|
||||
def proj_version_tuple(self): ...
|
||||
def spatial_aggregate_name(self, agg_name: Any): ...
|
||||
def geometry_columns(self): ...
|
||||
def spatial_ref_sys(self): ...
|
||||
def parse_raster(self, value: Any): ...
|
||||
def distance_expr_for_lookup(self, lhs: Any, rhs: Any, **kwargs: Any): ...
|
||||
def get_geometry_converter(self, expression: Any): ...
|
||||
def get_area_att_for_field(self, field: Any): ...
|
||||
@@ -0,0 +1,7 @@
|
||||
from typing import Any
|
||||
|
||||
def pack(structure: Any, data: Any): ...
|
||||
def unpack(structure: Any, data: Any): ...
|
||||
def chunk(data: Any, index: Any): ...
|
||||
def from_pgraster(data: Any): ...
|
||||
def to_pgraster(rast: Any): ...
|
||||
10
django-stubs/contrib/gis/db/backends/postgis/schema.pyi
Normal file
10
django-stubs/contrib/gis/db/backends/postgis/schema.pyi
Normal file
@@ -0,0 +1,10 @@
|
||||
from django.db.backends.postgresql.schema import DatabaseSchemaEditor
|
||||
from typing import Any
|
||||
|
||||
class PostGISSchemaEditor(DatabaseSchemaEditor):
|
||||
geom_index_type: str = ...
|
||||
geom_index_ops_nd: str = ...
|
||||
rast_index_wrapper: str = ...
|
||||
sql_alter_column_to_3d: str = ...
|
||||
sql_alter_column_to_2d: str = ...
|
||||
def geo_quote_name(self, name: Any): ...
|
||||
@@ -0,0 +1,5 @@
|
||||
from django.contrib.gis.db.backends.base.adapter import WKTAdapter as WKTAdapter
|
||||
from typing import Any
|
||||
|
||||
class SpatiaLiteAdapter(WKTAdapter):
|
||||
def __conform__(self, protocol: Any): ...
|
||||
13
django-stubs/contrib/gis/db/backends/spatialite/base.pyi
Normal file
13
django-stubs/contrib/gis/db/backends/spatialite/base.pyi
Normal file
@@ -0,0 +1,13 @@
|
||||
from django.db.backends.sqlite3.base import DatabaseWrapper as SQLiteDatabaseWrapper
|
||||
from typing import Any
|
||||
|
||||
class DatabaseWrapper(SQLiteDatabaseWrapper):
|
||||
SchemaEditorClass: Any = ...
|
||||
client_class: Any = ...
|
||||
features_class: Any = ...
|
||||
introspection_class: Any = ...
|
||||
ops_class: Any = ...
|
||||
lib_spatialite_paths: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def get_new_connection(self, conn_params: Any): ...
|
||||
def prepare_database(self) -> None: ...
|
||||
@@ -0,0 +1,4 @@
|
||||
from django.db.backends.sqlite3.client import DatabaseClient as DatabaseClient
|
||||
|
||||
class SpatiaLiteClient(DatabaseClient):
|
||||
executable_name: str = ...
|
||||
@@ -0,0 +1,6 @@
|
||||
from django.contrib.gis.db.backends.base.features import BaseSpatialFeatures as BaseSpatialFeatures
|
||||
from django.db.backends.sqlite3.features import DatabaseFeatures as SQLiteDatabaseFeatures
|
||||
|
||||
class DatabaseFeatures(BaseSpatialFeatures, SQLiteDatabaseFeatures):
|
||||
supports_3d_storage: bool = ...
|
||||
def supports_area_geodetic(self): ...
|
||||
@@ -0,0 +1,13 @@
|
||||
from django.db.backends.sqlite3.introspection import (
|
||||
DatabaseIntrospection as DatabaseIntrospection,
|
||||
FlexibleFieldLookupDict as FlexibleFieldLookupDict,
|
||||
)
|
||||
from typing import Any
|
||||
|
||||
class GeoFlexibleFieldLookupDict(FlexibleFieldLookupDict):
|
||||
base_data_types_reverse: Any = ...
|
||||
|
||||
class SpatiaLiteIntrospection(DatabaseIntrospection):
|
||||
data_types_reverse: Any = ...
|
||||
def get_geometry_type(self, table_name: Any, description: Any): ...
|
||||
def get_constraints(self, cursor: Any, table_name: Any): ...
|
||||
33
django-stubs/contrib/gis/db/backends/spatialite/models.pyi
Normal file
33
django-stubs/contrib/gis/db/backends/spatialite/models.pyi
Normal file
@@ -0,0 +1,33 @@
|
||||
from django.contrib.gis.db.backends.base.models import SpatialRefSysMixin as SpatialRefSysMixin
|
||||
from django.db import models as models
|
||||
from typing import Any
|
||||
|
||||
class SpatialiteGeometryColumns(models.Model):
|
||||
f_table_name: Any = ...
|
||||
f_geometry_column: Any = ...
|
||||
coord_dimension: Any = ...
|
||||
srid: Any = ...
|
||||
spatial_index_enabled: Any = ...
|
||||
type: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@classmethod
|
||||
def table_name_col(cls): ...
|
||||
@classmethod
|
||||
def geom_col_name(cls): ...
|
||||
|
||||
class SpatialiteSpatialRefSys(models.Model, SpatialRefSysMixin):
|
||||
srid: Any = ...
|
||||
auth_name: Any = ...
|
||||
auth_srid: Any = ...
|
||||
ref_sys_name: Any = ...
|
||||
proj4text: Any = ...
|
||||
srtext: Any = ...
|
||||
class Meta:
|
||||
app_label: str = ...
|
||||
db_table: str = ...
|
||||
managed: bool = ...
|
||||
@property
|
||||
def wkt(self): ...
|
||||
@@ -0,0 +1,33 @@
|
||||
from django.contrib.gis.db.backends.base.operations import BaseSpatialOperations
|
||||
from django.contrib.gis.db.backends.utils import SpatialOperator as SpatialOperator
|
||||
from django.db.backends.sqlite3.operations import DatabaseOperations
|
||||
from typing import Any
|
||||
|
||||
class SpatialiteNullCheckOperator(SpatialOperator):
|
||||
def as_sql(self, connection: Any, lookup: Any, template_params: Any, sql_params: Any): ...
|
||||
|
||||
class SpatiaLiteOperations(BaseSpatialOperations, DatabaseOperations):
|
||||
name: str = ...
|
||||
spatialite: bool = ...
|
||||
Adapter: Any = ...
|
||||
collect: str = ...
|
||||
extent: str = ...
|
||||
makeline: str = ...
|
||||
unionagg: str = ...
|
||||
gis_operators: Any = ...
|
||||
disallowed_aggregates: Any = ...
|
||||
select: str = ...
|
||||
function_names: Any = ...
|
||||
def unsupported_functions(self): ...
|
||||
def spatial_version(self): ...
|
||||
def geo_db_type(self, f: Any) -> None: ...
|
||||
def get_distance(self, f: Any, value: Any, lookup_type: Any): ...
|
||||
def geos_version(self): ...
|
||||
def proj4_version(self): ...
|
||||
def lwgeom_version(self): ...
|
||||
def spatialite_version(self): ...
|
||||
def spatialite_version_tuple(self): ...
|
||||
def spatial_aggregate_name(self, agg_name: Any): ...
|
||||
def geometry_columns(self): ...
|
||||
def spatial_ref_sys(self): ...
|
||||
def get_geometry_converter(self, expression: Any): ...
|
||||
24
django-stubs/contrib/gis/db/backends/spatialite/schema.pyi
Normal file
24
django-stubs/contrib/gis/db/backends/spatialite/schema.pyi
Normal file
@@ -0,0 +1,24 @@
|
||||
from django.db.backends.sqlite3.schema import DatabaseSchemaEditor as DatabaseSchemaEditor
|
||||
from typing import Any
|
||||
|
||||
class SpatialiteSchemaEditor(DatabaseSchemaEditor):
|
||||
sql_add_geometry_column: str = ...
|
||||
sql_add_spatial_index: str = ...
|
||||
sql_drop_spatial_index: str = ...
|
||||
sql_recover_geometry_metadata: str = ...
|
||||
sql_remove_geometry_metadata: str = ...
|
||||
sql_discard_geometry_columns: str = ...
|
||||
sql_update_geometry_columns: str = ...
|
||||
geometry_tables: Any = ...
|
||||
geometry_sql: Any = ...
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None: ...
|
||||
def geo_quote_name(self, name: Any): ...
|
||||
def column_sql(self, model: Any, field: Any, include_default: bool = ...): ...
|
||||
def remove_geometry_metadata(self, model: Any, field: Any) -> None: ...
|
||||
def create_model(self, model: Any) -> None: ...
|
||||
def delete_model(self, model: Any, **kwargs: Any) -> None: ...
|
||||
def add_field(self, model: Any, field: Any) -> None: ...
|
||||
def remove_field(self, model: Any, field: Any) -> None: ...
|
||||
def alter_db_table(
|
||||
self, model: Any, old_db_table: Any, new_db_table: Any, disable_constraints: bool = ...
|
||||
) -> None: ...
|
||||
10
django-stubs/contrib/gis/db/backends/utils.pyi
Normal file
10
django-stubs/contrib/gis/db/backends/utils.pyi
Normal file
@@ -0,0 +1,10 @@
|
||||
from typing import Any, Optional
|
||||
|
||||
class SpatialOperator:
|
||||
sql_template: Any = ...
|
||||
op: Any = ...
|
||||
func: Any = ...
|
||||
def __init__(self, op: Optional[Any] = ..., func: Optional[Any] = ...) -> None: ...
|
||||
@property
|
||||
def default_template(self): ...
|
||||
def as_sql(self, connection: Any, lookup: Any, template_params: Any, sql_params: Any): ...
|
||||
14
django-stubs/contrib/gis/db/models/__init__.pyi
Normal file
14
django-stubs/contrib/gis/db/models/__init__.pyi
Normal file
@@ -0,0 +1,14 @@
|
||||
# noqa: F401
|
||||
from django.db.models import *
|
||||
from django.contrib.gis.db.models.aggregates import *
|
||||
from django.contrib.gis.db.models.fields import (
|
||||
GeometryCollectionField as GeometryCollectionField,
|
||||
GeometryField as GeometryField,
|
||||
LineStringField as LineStringField,
|
||||
MultiLineStringField as MultiLineStringField,
|
||||
MultiPointField as MultiPointField,
|
||||
MultiPolygonField as MultiPolygonField,
|
||||
PointField as PointField,
|
||||
PolygonField as PolygonField,
|
||||
RasterField as RasterField,
|
||||
)
|
||||
37
django-stubs/contrib/gis/db/models/aggregates.pyi
Normal file
37
django-stubs/contrib/gis/db/models/aggregates.pyi
Normal file
@@ -0,0 +1,37 @@
|
||||
from django.db.models import Aggregate
|
||||
from typing import Any, Optional
|
||||
|
||||
class GeoAggregate(Aggregate):
|
||||
function: Any = ...
|
||||
is_extent: bool = ...
|
||||
def output_field(self): ...
|
||||
def as_sql(self, compiler: Any, connection: Any, function: Optional[Any] = ..., **extra_context: Any): ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
def resolve_expression(
|
||||
self,
|
||||
query: Optional[Any] = ...,
|
||||
allow_joins: bool = ...,
|
||||
reuse: Optional[Any] = ...,
|
||||
summarize: bool = ...,
|
||||
for_save: bool = ...,
|
||||
): ...
|
||||
|
||||
class Collect(GeoAggregate):
|
||||
name: str = ...
|
||||
output_field_class: Any = ...
|
||||
|
||||
class Extent(GeoAggregate):
|
||||
name: str = ...
|
||||
def __init__(self, expression: Any, **extra: Any) -> None: ...
|
||||
|
||||
class Extent3D(GeoAggregate):
|
||||
name: str = ...
|
||||
def __init__(self, expression: Any, **extra: Any) -> None: ...
|
||||
|
||||
class MakeLine(GeoAggregate):
|
||||
name: str = ...
|
||||
output_field_class: Any = ...
|
||||
|
||||
class Union(GeoAggregate):
|
||||
name: str = ...
|
||||
output_field_class: Any = ...
|
||||
150
django-stubs/contrib/gis/db/models/fields.pyi
Normal file
150
django-stubs/contrib/gis/db/models/fields.pyi
Normal file
@@ -0,0 +1,150 @@
|
||||
from typing import Any, Iterable, NamedTuple, Optional, TypeVar, Union, Tuple
|
||||
from django.db.models.fields import Field, _ErrorMessagesToOverride, _FieldChoices, _ValidatorCallable
|
||||
|
||||
# __set__ value type
|
||||
_ST = TypeVar("_ST")
|
||||
# __get__ return type
|
||||
_GT = TypeVar("_GT")
|
||||
|
||||
class SRIDCacheEntry(NamedTuple):
|
||||
units: Any
|
||||
units_name: str
|
||||
geodetic: bool
|
||||
spheroid: str
|
||||
|
||||
def get_srid_info(srid: int, connection: Any) -> SRIDCacheEntry: ...
|
||||
|
||||
class BaseSpatialField(Field[_ST, _GT]):
|
||||
def __init__(
|
||||
self,
|
||||
verbose_name: Optional[Union[str, bytes]] = ...,
|
||||
srid: int = ...,
|
||||
spatial_index: bool = ...,
|
||||
name: Optional[str] = ...,
|
||||
primary_key: bool = ...,
|
||||
max_length: Optional[int] = ...,
|
||||
unique: bool = ...,
|
||||
blank: bool = ...,
|
||||
null: bool = ...,
|
||||
db_index: bool = ...,
|
||||
default: Any = ...,
|
||||
editable: bool = ...,
|
||||
auto_created: bool = ...,
|
||||
serialize: bool = ...,
|
||||
unique_for_date: Optional[str] = ...,
|
||||
unique_for_month: Optional[str] = ...,
|
||||
unique_for_year: Optional[str] = ...,
|
||||
choices: Optional[_FieldChoices] = ...,
|
||||
help_text: str = ...,
|
||||
db_column: Optional[str] = ...,
|
||||
db_tablespace: Optional[str] = ...,
|
||||
validators: Iterable[_ValidatorCallable] = ...,
|
||||
error_messages: Optional[_ErrorMessagesToOverride] = ...,
|
||||
): ...
|
||||
def deconstruct(self): ...
|
||||
def db_type(self, connection: Any): ...
|
||||
def spheroid(self, connection: Any): ...
|
||||
def units(self, connection: Any): ...
|
||||
def units_name(self, connection: Any): ...
|
||||
def geodetic(self, connection: Any): ...
|
||||
def get_placeholder(self, value: Any, compiler: Any, connection: Any): ...
|
||||
def get_srid(self, obj: Any): ...
|
||||
def get_db_prep_value(self, value: Any, connection: Any, *args: Any, **kwargs: Any): ...
|
||||
def get_raster_prep_value(self, value: Any, is_candidate: Any): ...
|
||||
def get_prep_value(self, value: Any): ...
|
||||
|
||||
class GeometryField(BaseSpatialField):
|
||||
description: Any = ...
|
||||
form_class: Any = ...
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
dim: Any = ...
|
||||
geography: Any = ...
|
||||
def __init__(
|
||||
self,
|
||||
verbose_name: Optional[Union[str, bytes]] = ...,
|
||||
dim: int = ...,
|
||||
geography: bool = ...,
|
||||
extent: Tuple[float, float, float, float] = ...,
|
||||
tolerance: float = ...,
|
||||
srid: int = ...,
|
||||
spatial_index: bool = ...,
|
||||
name: Optional[str] = ...,
|
||||
primary_key: bool = ...,
|
||||
max_length: Optional[int] = ...,
|
||||
unique: bool = ...,
|
||||
blank: bool = ...,
|
||||
null: bool = ...,
|
||||
db_index: bool = ...,
|
||||
default: Any = ...,
|
||||
editable: bool = ...,
|
||||
auto_created: bool = ...,
|
||||
serialize: bool = ...,
|
||||
unique_for_date: Optional[str] = ...,
|
||||
unique_for_month: Optional[str] = ...,
|
||||
unique_for_year: Optional[str] = ...,
|
||||
choices: Optional[_FieldChoices] = ...,
|
||||
help_text: str = ...,
|
||||
db_column: Optional[str] = ...,
|
||||
db_tablespace: Optional[str] = ...,
|
||||
validators: Iterable[_ValidatorCallable] = ...,
|
||||
error_messages: Optional[_ErrorMessagesToOverride] = ...,
|
||||
): ...
|
||||
def deconstruct(self): ...
|
||||
def formfield(self, **kwargs: Any): ...
|
||||
def select_format(self, compiler: Any, sql: Any, params: Any): ...
|
||||
|
||||
class PointField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class LineStringField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class PolygonField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class MultiPointField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class MultiLineStringField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class MultiPolygonField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class GeometryCollectionField(GeometryField):
|
||||
geom_type: str = ...
|
||||
geom_class: Any = ...
|
||||
form_class: Any = ...
|
||||
description: Any = ...
|
||||
|
||||
class ExtentField(Field):
|
||||
description: Any = ...
|
||||
def get_internal_type(self): ...
|
||||
def select_format(self, compiler: Any, sql: Any, params: Any): ...
|
||||
|
||||
class RasterField(BaseSpatialField):
|
||||
description: Any = ...
|
||||
geom_type: str = ...
|
||||
geography: bool = ...
|
||||
def db_type(self, connection: Any): ...
|
||||
def from_db_value(self, value: Any, expression: Any, connection: Any): ...
|
||||
def get_transform(self, name: Any): ...
|
||||
168
django-stubs/contrib/gis/db/models/functions.pyi
Normal file
168
django-stubs/contrib/gis/db/models/functions.pyi
Normal file
@@ -0,0 +1,168 @@
|
||||
from django.db.models import Func, Transform as StandardTransform
|
||||
from typing import Any, Optional
|
||||
|
||||
NUMERIC_TYPES: Any
|
||||
|
||||
class GeoFuncMixin:
|
||||
function: Any = ...
|
||||
geom_param_pos: Any = ...
|
||||
def __init__(self, *expressions: Any, **extra: Any) -> None: ...
|
||||
def geo_field(self): ...
|
||||
def as_sql(self, compiler: Any, connection: Any, function: Optional[Any] = ..., **extra_context: Any): ...
|
||||
def resolve_expression(self, *args: Any, **kwargs: Any): ...
|
||||
|
||||
class GeoFunc(GeoFuncMixin, Func): ...
|
||||
|
||||
class GeomOutputGeoFunc(GeoFunc):
|
||||
def output_field(self): ...
|
||||
|
||||
class SQLiteDecimalToFloatMixin:
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class OracleToleranceMixin:
|
||||
tolerance: float = ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Area(OracleToleranceMixin, GeoFunc):
|
||||
arity: int = ...
|
||||
def output_field(self): ...
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Azimuth(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class AsGeoJSON(GeoFunc):
|
||||
output_field: Any = ...
|
||||
def __init__(
|
||||
self, expression: Any, bbox: bool = ..., crs: bool = ..., precision: int = ..., **extra: Any
|
||||
) -> None: ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class AsGML(GeoFunc):
|
||||
geom_param_pos: Any = ...
|
||||
output_field: Any = ...
|
||||
def __init__(self, expression: Any, version: int = ..., precision: int = ..., **extra: Any) -> None: ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class AsKML(GeoFunc):
|
||||
output_field: Any = ...
|
||||
def __init__(self, expression: Any, precision: int = ..., **extra: Any) -> None: ...
|
||||
|
||||
class AsSVG(GeoFunc):
|
||||
output_field: Any = ...
|
||||
def __init__(self, expression: Any, relative: bool = ..., precision: int = ..., **extra: Any) -> None: ...
|
||||
|
||||
class AsWKB(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
|
||||
class AsWKT(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
|
||||
class BoundingCircle(OracleToleranceMixin, GeoFunc):
|
||||
def __init__(self, expression: Any, num_seg: int = ..., **extra: Any) -> None: ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Centroid(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
|
||||
class Difference(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class DistanceResultMixin:
|
||||
def output_field(self): ...
|
||||
def source_is_geography(self): ...
|
||||
|
||||
class Distance(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
||||
geom_param_pos: Any = ...
|
||||
spheroid: Any = ...
|
||||
def __init__(self, expr1: Any, expr2: Any, spheroid: Optional[Any] = ..., **extra: Any) -> None: ...
|
||||
def as_postgresql(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Envelope(GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
|
||||
class ForcePolygonCW(GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
|
||||
class GeoHash(GeoFunc):
|
||||
output_field: Any = ...
|
||||
def __init__(self, expression: Any, precision: Optional[Any] = ..., **extra: Any) -> None: ...
|
||||
def as_mysql(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class GeometryDistance(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
function: str = ...
|
||||
arg_joiner: str = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class Intersection(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class IsValid(OracleToleranceMixin, GeoFuncMixin, StandardTransform):
|
||||
lookup_name: str = ...
|
||||
output_field: Any = ...
|
||||
def as_oracle(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Length(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
||||
spheroid: Any = ...
|
||||
def __init__(self, expr1: Any, spheroid: bool = ..., **extra: Any) -> None: ...
|
||||
def as_postgresql(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class LineLocatePoint(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class MakeValid(GeomOutputGeoFunc): ...
|
||||
|
||||
class MemSize(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
|
||||
class NumGeometries(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
|
||||
class NumPoints(GeoFunc):
|
||||
output_field: Any = ...
|
||||
arity: int = ...
|
||||
|
||||
class Perimeter(DistanceResultMixin, OracleToleranceMixin, GeoFunc):
|
||||
arity: int = ...
|
||||
def as_postgresql(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class PointOnSurface(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
|
||||
class Reverse(GeoFunc):
|
||||
arity: int = ...
|
||||
|
||||
class Scale(SQLiteDecimalToFloatMixin, GeomOutputGeoFunc):
|
||||
def __init__(self, expression: Any, x: Any, y: Any, z: float = ..., **extra: Any) -> None: ...
|
||||
|
||||
class SnapToGrid(SQLiteDecimalToFloatMixin, GeomOutputGeoFunc):
|
||||
def __init__(self, expression: Any, *args: Any, **extra: Any) -> None: ...
|
||||
|
||||
class SymDifference(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
|
||||
class Transform(GeomOutputGeoFunc):
|
||||
def __init__(self, expression: Any, srid: Any, **extra: Any) -> None: ...
|
||||
|
||||
class Translate(Scale):
|
||||
def as_sqlite(self, compiler: Any, connection: Any, **extra_context: Any): ...
|
||||
|
||||
class Union(OracleToleranceMixin, GeomOutputGeoFunc):
|
||||
arity: int = ...
|
||||
geom_param_pos: Any = ...
|
||||
126
django-stubs/contrib/gis/db/models/lookups.pyi
Normal file
126
django-stubs/contrib/gis/db/models/lookups.pyi
Normal file
@@ -0,0 +1,126 @@
|
||||
from django.db.models import Lookup, Transform
|
||||
from typing import Any
|
||||
|
||||
class RasterBandTransform(Transform): ...
|
||||
|
||||
class GISLookup(Lookup):
|
||||
sql_template: Any = ...
|
||||
transform_func: Any = ...
|
||||
distance: bool = ...
|
||||
band_rhs: Any = ...
|
||||
band_lhs: Any = ...
|
||||
template_params: Any = ...
|
||||
def __init__(self, lhs: Any, rhs: Any) -> None: ...
|
||||
def process_rhs_params(self) -> None: ...
|
||||
def process_band_indices(self, only_lhs: bool = ...) -> None: ...
|
||||
def get_db_prep_lookup(self, value: Any, connection: Any): ...
|
||||
rhs: Any = ...
|
||||
def process_rhs(self, compiler: Any, connection: Any): ...
|
||||
def get_rhs_op(self, connection: Any, rhs: Any): ...
|
||||
def as_sql(self, compiler: Any, connection: Any): ...
|
||||
|
||||
class OverlapsLeftLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class OverlapsRightLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class OverlapsBelowLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class OverlapsAboveLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class LeftLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class RightLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class StrictlyBelowLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class StrictlyAboveLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class SameAsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class BBContainsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class BBOverlapsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class ContainedLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class ContainsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class ContainsProperlyLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class CoveredByLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class CoversLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class CrossesLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class DisjointLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class EqualsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class IntersectsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class OverlapsLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class RelateLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
sql_template: str = ...
|
||||
pattern_regex: Any = ...
|
||||
def process_rhs(self, compiler: Any, connection: Any): ...
|
||||
|
||||
class TouchesLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class WithinLookup(GISLookup):
|
||||
lookup_name: str = ...
|
||||
|
||||
class DistanceLookupBase(GISLookup):
|
||||
distance: bool = ...
|
||||
sql_template: str = ...
|
||||
def process_rhs_params(self) -> None: ...
|
||||
def process_distance(self, compiler: Any, connection: Any): ...
|
||||
|
||||
class DWithinLookup(DistanceLookupBase):
|
||||
lookup_name: str = ...
|
||||
sql_template: str = ...
|
||||
def process_distance(self, compiler: Any, connection: Any): ...
|
||||
def process_rhs(self, compiler: Any, connection: Any): ...
|
||||
|
||||
class DistanceLookupFromFunction(DistanceLookupBase):
|
||||
def as_sql(self, compiler: Any, connection: Any): ...
|
||||
|
||||
class DistanceGTLookup(DistanceLookupFromFunction):
|
||||
lookup_name: str = ...
|
||||
op: str = ...
|
||||
|
||||
class DistanceGTELookup(DistanceLookupFromFunction):
|
||||
lookup_name: str = ...
|
||||
op: str = ...
|
||||
|
||||
class DistanceLTLookup(DistanceLookupFromFunction):
|
||||
lookup_name: str = ...
|
||||
op: str = ...
|
||||
|
||||
class DistanceLTELookup(DistanceLookupFromFunction):
|
||||
lookup_name: str = ...
|
||||
op: str = ...
|
||||
7
django-stubs/contrib/gis/db/models/proxy.pyi
Normal file
7
django-stubs/contrib/gis/db/models/proxy.pyi
Normal file
@@ -0,0 +1,7 @@
|
||||
from django.db.models.query_utils import DeferredAttribute
|
||||
from typing import Any, Optional
|
||||
|
||||
class SpatialProxy(DeferredAttribute):
|
||||
def __init__(self, klass: Any, field: Any, load_func: Optional[Any] = ...) -> None: ...
|
||||
def __get__(self, instance: Any, cls: Optional[Any] = ...): ...
|
||||
def __set__(self, instance: Any, value: Any): ...
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user