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.

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

Support for bytes in Options and Arguments #536

Open
7 tasks done
AlexanderPodorov opened this issue Jan 18, 2023 · 3 comments
Open
7 tasks done

Support for bytes in Options and Arguments #536

AlexanderPodorov opened this issue Jan 18, 2023 · 3 comments
Labels
feature New feature, enhancement or request

Comments

@AlexanderPodorov
Copy link

First Check

  • I added a very descriptive title to this issue.
  • I used the GitHub search to find a similar issue and didn't find it.
  • I searched the Typer documentation, with the integrated search.
  • I already searched in Google "How to X in Typer" and didn't find any information.
  • I already read and followed all the tutorial in the docs and didn't find an answer.
  • I already checked if it is not related to Typer but to Click.

Commit to Help

  • I commit to help with one of those options 👆

Example Code

import typer


def main(name: bytes):
    typer.echo(name)


if  __name__ == '__main__':
    typer.run(main)

Description

It would be nice if we could add support for bytes in order to use it in contexts where bytes are expected (e.g. base64 encode/decode, password hashing, etc.)

Wanted Solution

Support for bytes type. Currently typer says:
RuntimeError: Type not yet supported: <class 'bytes'>

Wanted Code

import typer


def main(name: bytes):
    typer.echo(name)


if  __name__ == '__main__':
    typer.run(main)

Alternatives

Always use encode/decode methods.

Operating System

macOS

Operating System Details

No response

Typer Version

0.7.0

Python Version

3.11.1

Additional Context

No response

@AlexanderPodorov AlexanderPodorov added the feature New feature, enhancement or request label Jan 18, 2023
@marcosschroh
Copy link

Hi,

is there any news on this issue?

@ESPR3SS0
Copy link

Hello, I could look into adding this!

However just so you know, custom types can be made easily. A type for bytes could be made like:

import typer
from typing_extensions import Annotated
app = typer.Typer()
class Bytes(self, value):
    def __init__(self, value):
        self.value = value.encode()
def parse_bytes(val):
    return Bytes(val).value

def func(input: Annotated[Bytes, typer.Argument(parser=parse_bytes)]):
    ....
    ....
    return

The greatest hassle with this solution is remembering to add `parser=parse_bytes' to all the Bytes arguments. So, could be worth natively supporting it.

@JPHutchins
Copy link

This would also be useful for my use cases (firmware / transport protocols). Though, instead of supporting "bytes" directly, wouldn't we need to support "encodings"?

For example, a type specified as:

  • utf-8 would take a string end encode it to utf-8 bytes
  • base64 would encode base64 bytes
  • hex would use bytes from_hex (or whatever that method is called
  • etc

It seems to me that the only arg that would make sense for simply "bytes" would be python byte literals, with all their downsides.

Would be good to scope this to common encodings since there are thousands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature, enhancement or request
Projects
None yet
Development

No branches or pull requests

4 participants