-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Open
Labels
type: bugSomething isn't workingSomething isn't working
Description
What's the issue?
Codedoc typing does not match with actual expected param types in AssetRecordsFilter.
class AssetRecordsFilter(
NamedTuple(
"_AssetRecordsFilter",
[
("asset_key", PublicAttr[AssetKey]),
("asset_partitions", PublicAttr[Optional[Sequence[str]]]),
("after_timestamp", PublicAttr[Optional[float]]),
("before_timestamp", PublicAttr[Optional[float]]),
("after_storage_id", PublicAttr[Optional[int]]), # int
("before_storage_id", PublicAttr[Optional[int]]), # int
("storage_ids", PublicAttr[Optional[Sequence[int]]]),
],
)
):
"""Defines a set of filter fields for fetching a set of asset event records.
Args:
asset_key (Optional[AssetKey]): Asset key for which to get asset event entries / records.
asset_partitions (Optional[List[str]]): Filter parameter such that only asset
events with a partition value matching one of the provided values are returned. Only
valid when the `asset_key` parameter is provided.
after_timestamp (Optional[float]): Filter parameter such that only event records for
events with timestamp greater than the provided value are returned.
before_timestamp (Optional[float]): Filter parameter such that only event records for
events with timestamp less than the provided value are returned.
after_storage_id (Optional[float]): Filter parameter such that only event records for # SHOULD BE INT
events with storage_id greater than the provided value are returned.
before_storage_id (Optional[float]): Filter parameter such that only event records for # SHOULD BE INT
events with storage_id less than the provided value are returned.
storage_ids (Optional[Sequence[int]]): Filter parameter such that only event records for
the given storage ids are returned.
tags (Optional[Mapping[str, Union[str, Sequence[str]]]]): Filter parameter such that only
events with the given event tags are returned
"""
What did you expect to happen?
documentation should match implementation
How to reproduce?
Investigate lines 252-286 in ...\dagster\_core\event_api.py
or try creating an AssetRecordsFilter
object based off of type hinting docs.
Dagster version
dagster, version 1.11.13
Deployment type
Local
Deployment details
N/A
Additional information
dagster/python_modules/dagster/dagster/_core/event_api.py
Lines 261 to 262 in 1d356a2
("after_storage_id", PublicAttr[Optional[int]]), | |
("before_storage_id", PublicAttr[Optional[int]]), |
dagster/python_modules/dagster/dagster/_core/event_api.py
Lines 278 to 281 in 1d356a2
after_storage_id (Optional[float]): Filter parameter such that only event records for | |
events with storage_id greater than the provided value are returned. | |
before_storage_id (Optional[float]): Filter parameter such that only event records for | |
events with storage_id less than the provided value are returned. |
Message from the maintainers
Impacted by this issue? Give it a 👍! We factor engagement into prioritization.
Metadata
Metadata
Assignees
Labels
type: bugSomething isn't workingSomething isn't working