Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add stubs for django-import-export #11709

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Add stubs for django-import-export #11709

wants to merge 12 commits into from
+766 −0

Conversation

Viicos
Copy link
Contributor

@Viicos Viicos commented Apr 3, 2024 •
edited

Was discussed in django-import-export/django-import-export#1783

Checklist:

  • formats
  • templatetags
  • __init__.pyi
  • admin.pyi
  • exceptions.pyi
  • fields.pyi
  • forms.pyi
  • instance_loaders.pyi
  • mixins.pyi
  • resources.pyi
  • results.pyi
  • signals.pyi
  • tmp_storages.pyi
  • utils.pyi
  • widgets.pyi

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@Viicos
More work: widgets
d8c47e3 
`render` and `clean` should be redefined on each subclass
as the return value can change. However, this is usually
not an API users will have to deal with, so not worth
the trouble
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@Viicos
Copy link
Contributor Author

Viicos commented Apr 14, 2024

I know there's a lot being added here, so I'd understand if this can't get merged.

I'm also wondering how to fix the issue when Django is being imported? 🤔

@Viicos Viicos marked this pull request as ready for review April 14, 2024 10:49
@Viicos Viicos changed the title Add base stubs for django-import-export Add stubs for django-import-export Apr 14, 2024
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@srittau
Copy link
Collaborator

srittau commented Apr 14, 2024 •
edited

The pyright tests are failing, since tablib has no stubs or type annotations yet. So instead of trying to import it, in typeshed we usually just type alias any imported items, like this:

from _typeshed import Incomplete

Dataset: TypeAlias = Incomplete  # tablib.Dataset

The easiest way to work around the stubtest problem for now is to set skip = true in the [tool.stubtest] table of METADATA.toml. Please add a comment why this is a necessary.

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions
Copy link
Contributor

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

@Viicos
Copy link
Contributor Author

Viicos commented Apr 15, 2024

Interesting pytype error..

@srittau
Copy link
Collaborator

srittau commented Apr 15, 2024

Interesting pytype error..

Considering that Library.simple_tag doesn't seem to change the signature, it's probably easiest to just leave it off.

We also need to add django-stubs to the stub uploader allowlist.

srittau added a commit to typeshed-internal/stub_uploader that referenced this pull request Apr 15, 2024
@srittau
Add django-stubs to allowlist
bf9e2bf 
Cf. python/typeshed#11709
@srittau srittau mentioned this pull request Apr 15, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Viicos @srittau