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

chore(deps): update dependency typer to >0.6,<0.16 #1173

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(deps): update dependency typer to >0.6,<0.16 #1173

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 28, 2024 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typer (changelog) >0.6,<0.14 -> >0.6,<0.16 age adoption passing confidence

Release Notes

fastapi/typer (typer)

v0.15.0

Compare Source

Features
Internal

v0.14.0

Compare Source

Breaking Changes
  • 🔥 Remove auto naming of groups added via add_typer based on the group's callback function name. PR #​1052 by @​patrick91.

Before, it was supported to infer the name of a command group from the callback function name in the sub-app, so, in this code:

import typer

app = typer.Typer()
users_app = typer.Typer()

app.add_typer(users_app)

@&#8203;users_app.callback()
def users():  # <-- This was the inferred command group name
    """
    Manage users in the app.
    """

@&#8203;users_app.command()
def create(name: str):
    print(f"Creating user: {name}")

...the command group would be named users, based on the name of the function def users().

Now you need to set it explicitly:

import typer

app = typer.Typer()
users_app = typer.Typer()

app.add_typer(users_app, name="users")  # <-- Explicitly set the command group name

@&#8203;users_app.callback()
def users():
    """
    Manage users in the app.
    """

@&#8203;users_app.command()
def create(name: str):
    print(f"Creating user: {name}")

Updated docs SubCommand Name and Help.

Note: this change will enable important features in the next release. 🤩

Internal

v0.13.1

Compare Source

Features
Refactors
Docs
Internal

v0.13.0

Compare Source

Features
Fixes
Refactors
Internal

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title chore(deps): update dependency typer to >0.6,<0.15 chore(deps): update dependency typer to >0.6,<0.16 Dec 3, 2024
@renovate renovate bot force-pushed the renovate/typer-0.x branch 2 times, most recently from fbe0be8 to b30f4e0 Compare December 9, 2024 17:46
@renovate renovate bot force-pushed the renovate/typer-0.x branch from b30f4e0 to 82a064b Compare December 9, 2024 17:58
@johnthagen
Copy link
Collaborator

johnthagen commented Dec 11, 2024 •
edited
Loading

It would be nice to support Typer >=0.15 for users who lock openapi-python-client as a development dependency. We hit an issue where we depend on typer-slim 0.15.1 and it caused an error in openapi-python-client, I assume because typer-slim is shadowing the site-packages path for typer.

openapi_python_client/cli.py", line 66, in <module>
    @app.callback(name="openapi-python-client")
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: Typer.callback() got an unexpected keyword argument 'name'

@dbanty
Copy link
Collaborator

dbanty commented Dec 11, 2024

@johnthagen any chance you have time to investigate the type checker issue and solve it? Hopefully while retaining support for older Typer versions.

@johnthagen
Copy link
Collaborator

@dbanty So looking into it, this is the failing line:

openapi-python-client/openapi_python_client/cli.py

Line 66 in 9220217

@app.callback(name="openapi-python-client")

It looks like according to Typer docs

Looks like they want users to use app.add_typer(users_app, name="users") style to name groups.

The upstream PR

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.
2 participants
@johnthagen @dbanty