10BC0 Typing of timeout · Issue #1545 · googleapis/python-bigquery · GitHub
[go: up one dir, main page]
Skip to content

Typing of timeout #1545

New issue
New issue
Closed
#1554
Closed
Typing of timeout#1545
#1554
Assignees
tswast
Labels
api: bigqueryIssues related to the googleapis/python-bigquery API.priority: p2Moderately-important priority. Fix may not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
@boennecd

Description

@boennecd
boennecd
opened on Apr 5, 2023

Environment details

  • OS type and version: MacOs
  • Python version: 3.9.6

Steps to reproduce

This is fairly tiny and relates to a typing issue. timeout is documented as Optional[float] but only typed as float. E.g.

python-bigquery/google/cloud/bigquery/job/query.py

Line 1395 in 0bf9546

timeout: float = None,

python-bigquery/google/cloud/bigquery/job/query.py

Lines 1415 to 1419 in 0bf9546

timeout (Optional[float]):
The number of seconds to wait for the underlying HTTP transport
before using ``retry``.
If multiple requests are made under the hood, ``timeout``
applies to each individual request.

and also at

python-bigquery/google/cloud/bigquery/job/base.py

Line 884 in a2520ca

self, retry: "retries.Retry" = DEFAULT_RETRY, timeout: float = None

python-bigquery/google/cloud/bigquery/job/base.py

Lines 892 to 896 in a2520ca

timeout (Optional[float]):
The number of seconds to wait for the underlying HTTP transport
before using ``retry``.
If multiple requests are made under the hood, ``timeout``
applies to each individual request.

The type check is ignored in both cases which may explain this?

python-bigquery/google/cloud/bigquery/job/query.py

Line 1390 in 0bf9546

def result( # type: ignore # (complaints about the overloaded signature)

python-bigquery/google/cloud/bigquery/job/base.py

Line 883 in a2520ca

def result( # type: ignore # (signature complaint)

This makes the functions slightly annoying to use if one passes an Optional[float] on.

Metadata

Metadata

Assignees

Labels

api: bigqueryIssues related to the googleapis/python-bigquery API.priority: p2Moderately-important priority. 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
    0