Skip to content
This repository was archived by the owner on Aug 25, 2026. It is now read-only.
This repository was archived by the owner on Aug 25, 2026. It is now read-only.

Dictionary support not reflected in type annotations #1380

Description

@PicardParis

Issue

  • This is a follow-up to #986 (closed). Retesting the recent google-cloud-documentai==1.5.0 version, the issue is still present.
  • This code is valid:
    import google.cloud.documentai_v1 as documentai
    
    client_options = dict(api_endpoint="eu-documentai.googleapis.com")
    client = documentai.DocumentProcessorServiceClient(client_options=client_options)
    
  • But it triggers the following type checker warning:
    Argument of type "dict[str, str]" cannot be assigned to parameter "client_options" of type "ClientOptions | None" in function "__init__"
    Type "dict[str, str]" cannot be assigned to type "ClientOptions | None"
    "dict[str, str]" is incompatible with "ClientOptions"
    
  • If you check the source, client_options can be a dict, yet its declaration says otherwise:
    def __init__(
        ...
        client_options: Optional[client_options_lib.ClientOptions] = None,
        ...
    ) -> None:
        ...
        if isinstance(client_options, dict):
            client_options = client_options_lib.from_dict(client_options)

Expected

def __init__(
    ...
    client_options: Union[client_options_lib.ClientOptions, dict, None] = None,
    ...
) -> None:
    ...

Activity

  1. atulep commented on Aug 15, 2022

    @atulep
    Contributor

    @PicardParis

    Yup, your code looks good. Feel free to open a PR. Otherwise, my team will triage this issue and resolve it, but may take longer.

  2. PicardParis commented on Aug 16, 2022

    @PicardParis
    ContributorAuthor

    Hi, I thought the library was auto-generated from protobufs. Please confirm that it's not and I'll make a PR.

  3. vam-google commented on Aug 26, 2022

    @vam-google
    Contributor

    @PicardParis The library is generated, so the change should be done not in the lib, but in gapic-generator-python (i.e. this repository) instead. The changes are most likely to happen in one of the template files (*.py.j2 files). I would look into changing somethign here: https://github.com/googleapis/gapic-generator-python/blob/main/gapic/templates/%25namespace/%25name_%25version/%25sub/services/%25service/client.py.j2#L279

  4. added
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    priority: p3Desirable enhancement or fix. May not be included in next release.
    on Aug 26, 2022
  5. PicardParis commented on Sep 6, 2022

    @PicardParis
    ContributorAuthor

    @atulep @vam-google

    • Thanks for the explanation & pointer
    • I made the tentative PR#1431
  6. added a commit that references this issue on Oct 17, 2022
    de62f12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions