ashb commented on a change in pull request #20011:
URL: https://github.com/apache/airflow/pull/20011#discussion_r763000669
##########
File path: airflow/models/xcom.py
##########
@@ -79,144 +80,247 @@ def init_on_load(self):
def __repr__(self):
return f'<XCom "{self.key}" ({self.task_id} @ {self.execution_date})>'
+ @overload
@classmethod
- @provide_session
- def set(cls, key, value, task_id, dag_id, execution_date=None,
run_id=None, session=None):
+ def set(
+ cls,
+ key: str,
+ value: Any,
+ *,
+ dag_id: str,
+ task_id: str,
+ run_id: str,
+ session: Optional[Session] = None,
+ ) -> None:
+ """Store an XCom value.
+
+ A deprecated form of this function accepts ``execution_date`` instead
of
+ ``run_id``. The two arguments are mutually exclusive.
+
+ :param key: Key to store the XCom.
+ :param value: XCom value to store.
+ :param dag_id: DAG ID.
+ :param task_id: Task ID.
+ :param run_id: DAG run ID for the task.
+ :param session: Database session. If not given, a new session will be
+ created for this function.
+ :type session: sqlalchemy.orm.session.Session
"""
- Store an XCom value.
- :return: None
- """
+ @overload
+ @classmethod
+ def set(
+ cls,
+ key: str,
+ value: Any,
+ task_id: str,
+ dag_id: str,
+ execution_date: datetime.datetime,
+ session: Optional[Session] = None,
+ ) -> None:
+ """:sphinx-autoapi-skip:"""
+
+ @classmethod
+ @provide_session
+ def set(
+ cls,
+ key: str,
+ value: Any,
+ task_id: str,
+ dag_id: str,
+ execution_date: Optional[datetime.datetime] = None,
+ *,
+ run_id: Optional[str] = None,
+ session: Session,
Review comment:
Ditto
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
