Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

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

Type checking focused around element.py and shell testing - #2167

Open
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking
Open

Type checking focused around element.py and shell testing#2167
nathanwilliams-ct wants to merge 4 commits into
apache:masterfrom
nathanwilliams-ct:nathan/type-checking

Conversation

@nathanwilliams-ct

Copy link
Copy Markdown
Contributor

Note: This adds a number of assertions where nullable values were assumed to be populated.

There should not be any functional changes.

@richardmaw-codethinkrichardmaw-codethink 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.

I was curious and had some comments while reading through, hope you don't mind.

Comment threadsrc/buildstream/_frontend/app.py Outdated
Comment threadsrc/buildstream/_frontend/app.py Outdated

# A list of all loaded loaders for this project
self._collect = []
self._collect: list["Loader"] = []

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.

https://docs.python.org/3/library/__future__.html#future__.annotations is the typical solution recommended for circular definitions

but honestly it's due to become the default in the next release and the import deprecated to eventually become a syntax error so switching to it is going to cause more work down the line

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I went with the Manual String annotations as that is what is used elsewhere in the codebase at the moment.

Rabbit hole of documentation:

Which summarises to:

  • For 3.14 annotations will be lazily evaluated.
  • from __future__ import annotations sticks around until 3.13 reaches end of life.
  • from __future__ import annotations has been around since 3.7

Buildstream currently supports the following python versions: 310,311,312,313,314

Using from __future__ import annotations would mean a simple find and replace could remove it in future. Using manual quotes like this would be a lot of manual re-work..

I think I will switch to from __future__ import annotations for this PR to reduce future work...?

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.

We don't want to rely on from __future__ import annotations since it's going away, but if the code can be made to work with it for python < 3.14, and with the native lazy annotations support in python 3.14, then it should be fine. We can import it conditionally.

But let's please try to keep changes to a minimum. If you want to do this, please do it separately.

Comment threadsrc/buildstream/_loader/loader.py Outdated

element = Element._new_from_load_element(load_element)

from ..plugins.elements.junction import JunctionElement

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.

Is this deferred import intentional? It's not going to have the problem of deferring finding import problems since Element._new_from_load_element will have needed to import it, but it does seem out of place.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's a cyclic import as JunctionElement imports Element already.

I am not a big fan of the cast here, but I am not sure on better way to do it with python's type checking. The cast is mainly to keep the type checker happy, and I am unsure if it's 'free' at runtime and makes the import unnecessary. I did debate wrapping it behind a if TYPE_CHECKING gate.

An assert isinstance(element,JunctionElement) also didn't play nice, as Element is it's base class.

I was trying to work out how I might get _new_from_load_element to just return a JunctionElement.

Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Comment threadsrc/buildstream/element.py Outdated
Note: This adds a number of assertions where nullable values were assumed to be populated.
@nathanwilliams-ct
nathanwilliams-ctforce-pushed the nathan/type-checking branch 2 times, most recently from 2372be3 to 2dd5296CompareAugust 12, 2026 12:25
This removes the ambiguity around the type of the dependencies argument the function used
Comment threadsrc/buildstream/element.py
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@nathanwilliams-ct@abderrahim@richardmaw-codethink