Skip to content

Add stubs for flask-migrate - #8967

Merged
AlexWaygood merged 6 commits into
python:mainfrom
kasium:flask-migrate
Nov 22, 2022
Merged

Add stubs for flask-migrate#8967
AlexWaygood merged 6 commits into
python:mainfrom
kasium:flask-migrate

Conversation

@kasium

@kasiumkasium commented Oct 22, 2022

Copy link
Copy Markdown
Contributor

As discussed in miguelgrinberg/Flask-Migrate#492 types should be added to typeshed.

@kasium

kasium commented Oct 22, 2022

Copy link
Copy Markdown
ContributorAuthor

So stubstest fails since the cli functions are not functions but click.Command or click.Group. click has inline types so we cannot use it here as a dependency right now. Any clue how to solve this?

error: flask_migrate.cli.branches is not a function
Stub: at line [35](https://github.com/python/typeshed/actions/runs/3302880777/jobs/5450175814#step:5:36) in file /home/runner/work/typeshed/typeshed/stubs/Flask-Migrate/flask_migrate/cli.pyi
def (directory: Union[builtins.str, None], verbose: builtins.bool)
Runtime:
<Command branches>

@github-actions

This comment has been minimized.

Sign in to view
@kasium

kasium commented Nov 17, 2022

Copy link
Copy Markdown
ContributorAuthor

Anybody any idea?

@JelleZijlstra

JelleZijlstra commented Nov 18, 2022

Copy link
Copy Markdown
Member

Should we even include the cli functions in the stub? I imagine they're not supposed to be called directly.

@AlexWaygood

AlexWaygood commented Nov 21, 2022

Copy link
Copy Markdown
Member

Should we even include the cli functions in the stub? I imagine they're not supposed to be called directly.

I agree; we can probably just omit that file for now. Add an allowlist entry if stubtest complains.

@kasium
Add stubs for flask-migrate
37e771a
As discussed in miguelgrinberg/Flask-Migrate#492 types should be added to typeshed.
@github-actions

This comment has been minimized.

Sign in to view
@kasium

kasium commented Nov 22, 2022

Copy link
Copy Markdown
ContributorAuthor

@JelleZijlstra@AlexWaygood thanks for the support

AlexWaygood
AlexWaygood reviewed Nov 22, 2022
View reviewed changes

@AlexWaygoodAlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good -- a few comments below

Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
AlexWaygood
AlexWaygood reviewed Nov 22, 2022
View reviewed changes
Comment threadstubs/Flask-Migrate/flask_migrate/__init__.pyi Outdated
@github-actions

github-actionsBot commented Nov 22, 2022

Copy link
Copy Markdown
Contributor

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

@AlexWaygood
AlexWaygood merged commit ed52f68 into python:mainNov 22, 2022
@kasium
kasium deleted the flask-migrate branch November 22, 2022 16:53
@AlexWaygoodAlexWaygood mentioned this pull request Dec 8, 2022
Merged
hauntsaninja pushed a commit to python/mypy that referenced this pull request Dec 20, 2022
@AlexWaygood
Updatestubinfo.pyfor recent typeshed changes (#14265)
fcd705d
Removals from `stubinfo.py`:
- `atomicwrites` is archived and deprecated at runtime; stubs were
removed from typeshed in python/typeshed#8925
- `attrs` has had inline types for a very long time now
- `chardet` recently cut a release with inline types; typeshed's stubs
were marked obsolete in python/typeshed#9318
- `cryptography` has had inline types for a very long time now; the only
reason why it's still in typeshed is because other typeshed packages
need `types-cryptography` as a dependency, and our testing
infrastructure therefore can't currently cope with it being removed from
typeshed.
- `emoji` recently cut a release bundling stubs with the runtime
package; typeshed's stubs were marked obsolete in
python/typeshed#9051
- `termcolor` recently cut a release with inline types; typeshed's stubs
were marked obsolete in python/typeshed#8746
- `prettytable` recently cut a release with inline types; typeshed's
stubs were marked obsolete in
python/typeshed#9023
Additions:
- Stubs for `Xlib` were added in
python/typeshed#9279
- Stubs for `consolemenu` were added in
python/typeshed#8820
- Stubs for `dockerfile_parse` were added in
python/typeshed#9305
- Stubs for `flask_migrate` were added in
python/typeshed#8967
- Stubs for `paho.mqtt` were added in
python/typeshed#8853
- Stubs for `pycocotools` were added in
python/typeshed#9086
- Stubs for many `pywin32` modules were added in
python/typeshed#8825, and multiple follow-up PRs
- Stubs for `pyscreeze` were added in
python/typeshed#8823
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kasium@JelleZijlstra@AlexWaygood