Skip to main content

Monkey-patching and extensions for django-stubs

Project description

Extensions and monkey-patching for django-stubs

Build Status Checked with mypy Gitter

This package contains extensions and monkey-patching functions for the django-stubs package. Certain features of django-stubs (i.e. generic django classes that don't define the __class_getitem__ method) require runtime monkey-patching, which can't be done with type stubs. These extensions were split into a separate package so library consumers don't need mypy as a runtime dependency (#526).

Installation

pip install django-stubs-ext

Usage

In your Django application, use the following code:

import django_stubs_ext

django_stubs_ext.monkeypath()

This only needs to be called once, so the call to monkeypatch should be placed in your top-level urlconf.

Version compatibility

Since django-stubs supports multiple Django versions, this package takes care to only monkey-patch the features needed by your django version, and decides which features to patch at runtime. This is completely safe, as (currently) we only add a __class_getitem__ method that does nothing:

@classmethod
def __class_getitem__(cls, *args, **kwargs):
    return cls

To get help

For help with django-stubs, please view the main repository at https://github.com/typeddjango/django-stubs

We have a Gitter chat here: https://gitter.im/mypy-django/Lobby If you think you have a more generic typing issue, please refer to https://github.com/python/mypy and their Gitter.

Contributing

The django-stubs-ext package is part of the django-stubs monorepo. If you would like to contribute, please view the django-stubs contribution guide.

You can always also reach out in gitter to discuss your contributions!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-stubs-ext-0.1.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

django_stubs_ext-0.1.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file django-stubs-ext-0.1.0.tar.gz.

File metadata

  • Download URL: django-stubs-ext-0.1.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for django-stubs-ext-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2cf0f9615c0f7c399d23e4be4d9ab4b354e550480a950f659cdf1aa3ba19bd38
MD5 e8c5e9164fc659ed14fea25fe3fe926b
BLAKE2b-256 cf20b3f6c4e211dac108bc597c014ac4e1df15de674b1bc306eb85a8ff0b61e1

See more details on using hashes here.

File details

Details for the file django_stubs_ext-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: django_stubs_ext-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for django_stubs_ext-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 663469e7452ead59ae9235eb62b35ef09a15ae94f2193fedf1b84aea471fc011
MD5 f6e0ccbe9022a59a705773226e141ea2
BLAKE2b-256 d49634088dc2442cf75d6bc4473348d0f41958bd53c2f573f6214d253251a8b1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page