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

Refactor: use Literal in type hints #1670

Open
JohannesMessner opened this issue Jun 26, 2023 · 8 comments
Open

Refactor: use Literal in type hints #1670

JohannesMessner opened this issue Jun 26, 2023 · 8 comments
Labels
area/typing good-first-issue Suitable as your first contribution to DocArray!

Comments

@JohannesMessner
Copy link
Member

JohannesMessner commented Jun 26, 2023 •
edited
Loading

Right now we don't really use Literal types anywhere, but we should.
For example, see the following signature:

    @classmethod
    def from_bytes(
        cls: Type[T],
        data: bytes,
        protocol: str = 'protobuf',
        compress: Optional[str] = None,
    ) -> T:
        """Build Document object from binary bytes

        :param data: binary bytes
        :param protocol: protocol to use. It can be 'pickle' or 'protobuf'
        :param compress: compress method to use
        :return: a Document object
        """

Here, protocol can only be 'pickle' or 'protobuf', so Literal['pickle', 'protobuf'] would be the most suitable type hint.
Changing that will require multiple other changes in order to keep mypy happy, since other code relies on protocol being str.

This issue is about adjusting the above, and identifying and fixing other similar instances (if they exists).
@JohannesMessner JohannesMessner converted this from a draft issue Jun 26, 2023
@JohannesMessner JohannesMessner added good-first-issue Suitable as your first contribution to DocArray! area/typing labels Jun 26, 2023
@srini047
Copy link
Contributor

Hey, @JohannesMessner I would like to work on this issue.

@JoanFM
Copy link
Member

JoanFM commented Jun 26, 2023

hey @srini047 ,

It would be great if you can take up this issue.

@srini047 srini047 mentioned this issue Jun 28, 2023
Closed
@JoanFM JoanFM moved this from Todo/Bug to In Progress in DocArray backlog Jul 5, 2023
@JoanFM JoanFM moved this from In Progress to In progress by community in DocArray backlog Jul 5, 2023
@bpshaver
Copy link
Contributor

Is protobuf-array also a possible value for protocol in the intended context? (If not... maybe the parameter name protocol should be used to refer to two different things.)

@bpshaver bpshaver mentioned this issue Oct 23, 2023
Merged
@bpshaver
Copy link
Contributor

Opened a PR.

I'm in favor of an enum over a Literal consisting of different strings, but I can see how the latter is easier for end users. I can seek out other instances of this same issue if this PR looks good.

@JohannesMessner
Copy link
Member Author

I can seek out other instances of this same issue if this PR looks good.

The PR looks good, helping us with further instances of this problem would be great!

@JoanFM
Copy link
Member

JoanFM commented Oct 24, 2023

Yes, it would be nice to make sure there are other instances or if we can close this

@bpshaver
Copy link
Contributor

bpshaver commented Oct 24, 2023 •
edited
Loading

I believe these parameters are candidates for similar treatment:

  • audio_codec

  • audio_format

  • video_codec

But there may be more

@JoanFM
Copy link
Member

JoanFM commented Oct 24, 2023

They do seem nice candidates sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/typing good-first-issue Suitable as your first contribution to DocArray!
Projects
DocArray backlog
Status: In progress by community
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactor: use Literals in type hints srini047/docarray
4 participants
@bpshaver @JoanFM @JohannesMessner @srini047