Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); docs(deferring): add type annotation to code examples by Lee-W · Pull Request #32422 · apache/airflow · GitHub
Skip to content

docs(deferring): add type annotation to code examples - #32422

Merged
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example
Jul 9, 2023
Merged

docs(deferring): add type annotation to code examples#32422
potiuk merged 3 commits into
apache:mainfrom
astronomer:add-type-annotation-to-deferrable-example

Conversation

@Lee-W

@Lee-WLee-W commented Jul 7, 2023

Copy link
Copy Markdown
Member

As discussed in #32355 (comment), I'm thinking of adding some type annotations to the documentation.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W
Lee-W marked this pull request as ready for review July 7, 2023 09:09
@Lee-W
Lee-W requested a review from potiuk as a code ownerJuly 7, 2023 09:09
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated

@pankajastropankajastro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

we should add the same for exampleDateTimeTrigger too we have 2 serialize and run methods there wdyt?

Sorry, I kinda don't get it. Could you point out where is it?

@pankajastro

Copy link
Copy Markdown
Member

Sorry, I kinda don't get it. Could you point out where is it?

sure, type annotation for trigger examples also code block https://github.com/apache/airflow/blob/main/docs/apache-airflow/authoring-and-scheduling/deferring.rst?plain=1#L111-L124

@Lee-W

Lee-W commented Jul 7, 2023

Copy link
Copy Markdown
MemberAuthor

ah yes, I've changed all the code block into that

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-type-annotation-to-deferrable-example branch from 4c34d66 to 0ceeac9CompareJuly 7, 2023 16:04
* Any Operator can defer; no special marking on its class is needed, and it's not limited to Sensors.
* In order for any changes to a Trigger to be reflected, the *triggerer* needs to be restarted whenever the Trigger is modified.
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.::
* If you want add an operator or sensor that supports both deferrable and non-deferrable modes. It's suggested to add ``deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False)`` to the ``__init__`` method of the operator and use it to decide whether to run the operator in deferrable mode. You'll be able to configure the default value of ``deferrable`` of all the operators and sensors that supports switch between deferrable and non-deferrable mode through ``default_deferrable`` in the ``operator`` section. Here's an example of a sensor that supports both modes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here we are talking about both operators and sensors, but giving an example of deferrable: bool = conf.getboolean("operators", "default_deferrable", fallback=False) only for operators.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

As the sensor is a kind of operator as well https://github.com/apache/airflow/blob/main/airflow/sensors/base.py#L82, it seems to me this should be fine. But I'm good with making this change as well. We probably should add default_deferrablehere. Maybe that should be another PR?

Comment threaddocs/apache-airflow/authoring-and-scheduling/deferring.rst Outdated
Co-authored-by: Syed Hussain <103602455+syedahsn@users.noreply.github.com>

@syedahsnsyedahsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@potiuk
potiuk merged commit 5d8c54e into apache:mainJul 9, 2023
@eladkaleladkal added this to the Airflow 2.6.4 milestone Jul 9, 2023
@eladkaleladkal added the type:doc-only Changelog: Doc Only label Jul 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@Lee-W@pankajastro@potiuk@uranusjr@pankajkoti@phanikumv@syedahsn@eladkal