-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
Convert most of the commands from autocommand to typer. #21
Conversation
I haven't yet been able to convert
|
@bswck Do you have any opinion on the implementation? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the ping. Here are a few suggestions from me.
value, | ||
project: Annotated[ | ||
github.Repo, typer.Option(parser=github.Repo) | ||
] = github.Repo.detect(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting. I've used '.'
as a default with github.Repo.detect
being the parser for that thus far (as here), which as I see now is completely wrong, because github.Repo.detect()
doesn't take a path as a non-default parameter (shouldn't that change? :P). Ideally IMO, the github.Repo
class should be constructible from path (maybe not on the constructor-level, because that would introduce a side effect to instantiating the class, which often feels clunky and unpredictable), from which the project name would be inferred the same way as in github.Repo.detect()
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because github.Repo
is a subclass of str
, it can be constructed from a simple string, but that string needs to be the name of the project in GitHub. I should probably document that.
I think what you're suggesting is that github.Repo.detect(...)
should accept a path
parameter that defaults to .
instead of assuming the repo is in the cwd
. I'd be okay with that, I think.
Regardless, this change is about something different - migrating from autocommand to typer, so I'm aiming for feature parity. We can address other concerns in another issue/PR.
@autocommand.autocommand(__name__) | ||
def main(path='.', field='Requires-Dist'): | ||
@main | ||
def run(path='.', field='Requires-Dist'): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's annotate these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good. I'd do that here as a suggestion, but I don't know the syntax (where to put the spaces to satisfy the linter), so I'm going to do it outside of this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On second thought, does it make sense to annotate a variable that's assigned a static string? That feels like over-specifying to me. It's so much easier to read without the annotations and even mypy knows it's a string, right? Let's go without it for now. If there's a benefit to adding the type annotations, I'm open to hear it, but I'm more inclined to keep it simple if the typing system supports that.
I wonder how typer would handle number = 0
; would it need the type annotation to know to construct an integer (or float?) from the input? If not, that's maybe a good justification for indicating the str
- for symmetry and consistency with other types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did end up adding the type annotation, which also gave mypy permission to start nitpicking about the | None
of email.Message.get_all
. Fixed in 405317a.
args: typer.Context = typer.Option(None), | ||
): | ||
cmd = cast(List[str], args.args) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That doesn't look correct. typer.Context
is always injected when there's an annotation that inherits from click.Context
(see inference implementation).
args: typer.Context = typer.Option(None), | |
): | |
cmd = cast(List[str], args.args) | |
args: typer.Context, | |
): | |
cmd = cast(List[str], args.args) |
Additionally, I'd name the context parameter context
or ctx
. args.args
reads weird. But that's just an opinion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call. Not sure how I missed this in the review. I went through the whole thing in the files dialog and didn't see it. I'll get it after the fact.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried removing = typer.Option(None)
, but you can't do that because tag
and keyword
have default values. Maybe it would work if cmd were keyword-only.
args: typer.Context = typer.Option(None), | |
): | |
cmd = cast(List[str], args.args) | |
*, | |
args: typer.Context, | |
): | |
cmd = cast(List[str], args.args) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that works; done in 3a80b14.
See also jaraco/jaraco.ui@208a1c2#r145432894. |
|
||
from . import github, repo | ||
|
||
|
||
@autocommand.autocommand(__name__) | ||
@main | ||
def run(project: github.Repo = github.Repo.detect()): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Bartosz Sławecki <bswck.dev@gmail.com>
Closes #20