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.

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

[docs] update DagBag class docstring to include all params #38814

Merged
merged 8 commits into from
Apr 16, 2024

Conversation

rawwar
Copy link
Collaborator

@rawwar rawwar commented Apr 7, 2024

Updates docstring to include following missing params:

  1. safe_mode
  2. store_serialized_dags
  3. collect_dags

@rawwar rawwar changed the title [docs] update docstring for DagBag class to include all params [docs] update DagBag class docstring to include all params Apr 7, 2024
Copy link
Contributor

@romsharon98 romsharon98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

        When ``True`` uses heuristics (files containing ``DAG`` and ``airflow`` strings) to filter

@rawwar
Copy link
Collaborator Author

rawwar commented Apr 8, 2024

        When ``True`` uses heuristics (files containing ``DAG`` and ``airflow`` strings) to filter

@romsharon98, Sorry, I did not understand what you are trying to point out here. can you please elaborate?

@romsharon98
Copy link
Contributor

    When ``True`` uses heuristics (files containing ``DAG`` and ``airflow`` strings) to filter

@romsharon98, Sorry, I did not understand what you are trying to point out here. can you please elaborate?

Just a needy comment, you need to add one space and remove one space and it should be like this line at the end.

@potiuk potiuk merged commit b002741 into apache:main Apr 16, 2024
42 checks passed
@eladkal eladkal added this to the Airflow 2.9.1 milestone Apr 16, 2024
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Apr 16, 2024
@rawwar rawwar deleted the kalyan/docs/update_dagbag_docstring branch April 16, 2024 15:01
grrolland pushed a commit to grrolland/airflow that referenced this pull request Apr 19, 2024
…38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>
utkarsharma2 pushed a commit to astronomer/airflow that referenced this pull request Apr 22, 2024
…38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>
jedcunningham pushed a commit that referenced this pull request Apr 26, 2024
* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>
(cherry picked from commit b002741)
Taragolis pushed a commit that referenced this pull request May 6, 2024
…sion (#39056)

* Fixes #36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* Fix formatting

* Fix formatting

* Fixes #36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* update simple-salesforce type hints to support 1.12.6 (#39047)

* Fix formatting

* Add changelog for airflow python client 2.9.0 (#39060)

* Upgrade to latest hatchling as build dependency (#39044)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (#38995) (#39054)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (#38995)

* update databricks

* [docs] update `DagBag` class docstring to include all params (#38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>

* Data aware scheduling docs edits (#38687)

* Moves airflow import in deprecated pod_generator to local (#39062)

The import might be invoked when K8S executor starts with sentry on
and it might lead to circular imports

Related: #31442

* KPO xcom sidecar PodDefault usage (#38951)

We should use the same, non deprecated, version of PodDefaults for the
xcom sidecar when creating and reading xcom.

* Fix formatting

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Add examples in AWS auth manager documentation (#39040)

* update document (#39068)

* Update hatchling to version 1.24.0 (#39072)

* Check that the dataset<>task exists before trying to render graph (#39069)

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Fix utc timezone in unit tests

* Fix utc timezone in unit tests

---------

Signed-off-by: kalyanr <[email protected]>
Co-authored-by: Grégoire Rolland <[email protected]>
Co-authored-by: Hussein Awala <[email protected]>
Co-authored-by: Ephraim Anierobi <[email protected]>
Co-authored-by: Jarek Potiuk <[email protected]>
Co-authored-by: Elad Kalif <[email protected]>
Co-authored-by: Kalyan <[email protected]>
Co-authored-by: Laura Zdanski <[email protected]>
Co-authored-by: Jed Cunningham <[email protected]>
Co-authored-by: Vincent <[email protected]>
Co-authored-by: humit <[email protected]>
Co-authored-by: Brent Bovenzi <[email protected]>
RodrigoGanancia pushed a commit to RodrigoGanancia/airflow that referenced this pull request May 10, 2024
…38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>
RodrigoGanancia pushed a commit to RodrigoGanancia/airflow that referenced this pull request May 10, 2024
…sion (apache#39056)

* Fixes apache#36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* Fix formatting

* Fix formatting

* Fixes apache#36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* update simple-salesforce type hints to support 1.12.6 (apache#39047)

* Fix formatting

* Add changelog for airflow python client 2.9.0 (apache#39060)

* Upgrade to latest hatchling as build dependency (apache#39044)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (apache#38995) (apache#39054)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (apache#38995)

* update databricks

* [docs] update `DagBag` class docstring to include all params (apache#38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>

* Data aware scheduling docs edits (apache#38687)

* Moves airflow import in deprecated pod_generator to local (apache#39062)

The import might be invoked when K8S executor starts with sentry on
and it might lead to circular imports

Related: apache#31442

* KPO xcom sidecar PodDefault usage (apache#38951)

We should use the same, non deprecated, version of PodDefaults for the
xcom sidecar when creating and reading xcom.

* Fix formatting

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Add examples in AWS auth manager documentation (apache#39040)

* update document (apache#39068)

* Update hatchling to version 1.24.0 (apache#39072)

* Check that the dataset<>task exists before trying to render graph (apache#39069)

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Fix utc timezone in unit tests

* Fix utc timezone in unit tests

---------

Signed-off-by: kalyanr <[email protected]>
Co-authored-by: Grégoire Rolland <[email protected]>
Co-authored-by: Hussein Awala <[email protected]>
Co-authored-by: Ephraim Anierobi <[email protected]>
Co-authored-by: Jarek Potiuk <[email protected]>
Co-authored-by: Elad Kalif <[email protected]>
Co-authored-by: Kalyan <[email protected]>
Co-authored-by: Laura Zdanski <[email protected]>
Co-authored-by: Jed Cunningham <[email protected]>
Co-authored-by: Vincent <[email protected]>
Co-authored-by: humit <[email protected]>
Co-authored-by: Brent Bovenzi <[email protected]>
pateash pushed a commit to pateash/airflow that referenced this pull request May 13, 2024
…sion (apache#39056)

* Fixes apache#36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* Fix formatting

* Fix formatting

* Fixes apache#36629

* Fixes PR failed test

* Remove an parametrize duplicate tests

* update simple-salesforce type hints to support 1.12.6 (apache#39047)

* Fix formatting

* Add changelog for airflow python client 2.9.0 (apache#39060)

* Upgrade to latest hatchling as build dependency (apache#39044)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (apache#38995) (apache#39054)

* Prepare docs 1st wave (RC3) + ad hoc April 2024 (apache#38995)

* update databricks

* [docs] update `DagBag` class docstring to include all params (apache#38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>

* Data aware scheduling docs edits (apache#38687)

* Moves airflow import in deprecated pod_generator to local (apache#39062)

The import might be invoked when K8S executor starts with sentry on
and it might lead to circular imports

Related: apache#31442

* KPO xcom sidecar PodDefault usage (apache#38951)

We should use the same, non deprecated, version of PodDefaults for the
xcom sidecar when creating and reading xcom.

* Fix formatting

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Add examples in AWS auth manager documentation (apache#39040)

* update document (apache#39068)

* Update hatchling to version 1.24.0 (apache#39072)

* Check that the dataset<>task exists before trying to render graph (apache#39069)

* Change date/time parsing method for newer_than parameter un SFTPSensor

* Fix utc timezone in unit tests

* Fix utc timezone in unit tests

---------

Signed-off-by: kalyanr <[email protected]>
Co-authored-by: Grégoire Rolland <[email protected]>
Co-authored-by: Hussein Awala <[email protected]>
Co-authored-by: Ephraim Anierobi <[email protected]>
Co-authored-by: Jarek Potiuk <[email protected]>
Co-authored-by: Elad Kalif <[email protected]>
Co-authored-by: Kalyan <[email protected]>
Co-authored-by: Laura Zdanski <[email protected]>
Co-authored-by: Jed Cunningham <[email protected]>
Co-authored-by: Vincent <[email protected]>
Co-authored-by: humit <[email protected]>
Co-authored-by: Brent Bovenzi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants