Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
potiuk merged 8 commits into from
Apr 16, 2024
Merged

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

potiuk merged 8 commits into from
Apr 16, 2024

Conversation

@rawwar
Copy link
Contributor

@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 requested review from XD-DENG, ashb and kaxil as code owners April 7, 2024 13:38
@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
romsharon98
romsharon98 approved these changes Apr 7, 2024
View reviewed changes
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
Contributor Author

rawwar commented Apr 8, 2024 •
edited
Loading 

        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

romsharon98 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?

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
@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
@rawwar
[docs] update DagBag class docstring to include all params (apache#…
a06349e 
…38814)

* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <kalyan.ben10@live.com>

---------

Signed-off-by: kalyanr <kalyan.ben10@live.com>
jedcunningham pushed a commit that referenced this pull request Apr 26, 2024
@rawwar @jedcunningham
[docs] update DagBag class docstring to include all params (#38814)
672d47e 
* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <kalyan.ben10@live.com>

---------

Signed-off-by: kalyanr <kalyan.ben10@live.com>
(cherry picked from commit b002741)
Taragolis pushed a commit that referenced this pull request May 6, 2024
@grrolland @hussein-awala
@ephraimbuddy @potiuk @eladkal @rawwar @lzdanski @jedcunningham @vincbeck @humit0 @bbovenzi
Fix SFTPSensor.newer_than not working with jinja logical ds/ts expres…
8965f2e 
…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 <kalyan.ben10@live.com>

---------

Signed-off-by: kalyanr <kalyan.ben10@live.com>

* 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 <kalyan.ben10@live.com>
Co-authored-by: Grégoire Rolland <gregoire.rolland@mymoneybank.com>
Co-authored-by: Hussein Awala <hussein@awala.fr>
Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
Co-authored-by: Elad Kalif <45845474+eladkal@users.noreply.github.com>
Co-authored-by: Kalyan <kalyan.ben10@live.com>
Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
Co-authored-by: Vincent <97131062+vincbeck@users.noreply.github.com>
Co-authored-by: humit <jhjang1005@naver.com>
Co-authored-by: Brent Bovenzi <brent@astronomer.io>
pateash pushed a commit to pateash/airflow that referenced this pull request May 13, 2024
@grrolland @hussein-awala
@ephraimbuddy @potiuk @eladkal @rawwar @lzdanski @jedcunningham @vincbeck @humit0 @bbovenzi @pateash
Fix SFTPSensor.newer_than not working with jinja logical ds/ts expres…
105979e 
…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 <kalyan.ben10@live.com>

---------

Signed-off-by: kalyanr <kalyan.ben10@live.com>

* 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 <kalyan.ben10@live.com>
Co-authored-by: Grégoire Rolland <gregoire.rolland@mymoneybank.com>
Co-authored-by: Hussein Awala <hussein@awala.fr>
Co-authored-by: Ephraim Anierobi <splendidzigy24@gmail.com>
Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
Co-authored-by: Elad Kalif <45845474+eladkal@users.noreply.github.com>
Co-authored-by: Kalyan <kalyan.ben10@live.com>
Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
Co-authored-by: Vincent <97131062+vincbeck@users.noreply.github.com>
Co-authored-by: humit <jhjang1005@naver.com>
Co-authored-by: Brent Bovenzi <brent@astronomer.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@potiuk potiuk potiuk approved these changes

@romsharon98 romsharon98 romsharon98 approved these changes

@kaxil kaxil Awaiting requested review from kaxil

@XD-DENG XD-DENG Awaiting requested review from XD-DENG

@ashb ashb Awaiting requested review from ashb

Assignees

No one assigned

Labels

type:doc-only Changelog: Doc Only

Projects

None yet

Milestone

Airflow 2.9.1

Development

Successfully merging this pull request may close these issues.

4 participants

@rawwar @romsharon98 @potiuk @eladkal