New loader C# bugfixes and improvements by romangolev · Pull Request #3032 · pyrevitlabs/pyRevit

romangolev · 2026-01-25T06:31:48Z

New loader C# bugfixes and improvements

Description

Address #2995 Task and pursue the effort of bug elimination.

This PR fixes:
#3024
#3023

Also adds support for Help URL:
https://pyrevitlabs.notion.site/Anatomy-of-IronPython-Scripts-f11d0099667f46a28d29b028dd99ccaf#fee25dbae69b419489e2fd168fbb2876

Checklist

Before submitting your pull request, ensure the following requirements are met:

Code follows the PEP 8 style guide.
Code has been formatted with Black using the command:
```
pipenv run black {source_file_or_directory}
```
Changes are tested and verified to work as expected.

Related Issues

If applicable, link the issues resolved by this pull request:

Resolves #[issue number]

Additional Notes

Include any additional context, screenshots, or considerations for reviewers.

Thank you for contributing to pyRevit! 🎉

devloai · 2026-01-25T06:31:52Z

Unable to trigger custom agent "Code Reviewer"You have run out of credits 😔
Please upgrade your plan or buy additional credits from the subscription page.

Copilot

Pull request overview

Addresses loader/parser issues in the new C# loader by improving Python constant parsing, fixing extension root discovery from config, and adding first-class “Help URL” (F1 contextual help) support for commands.

Changes:

Extend Python script constant parsing to correctly ignore trailing comments and support __helpurl__ dictionaries.
Add helpurl / helpurls support to bundle parsing and propagate it through parsed component models; apply F1 contextual help during ribbon item post-processing.
Update extension root discovery to use pyRevit_config.ini parsing (UserExtensionsList) instead of manual line scanning.

Reviewed changes

Copilot reviewed 7 out of 23 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
dev/pyRevitLoader/pyRevitExtensionParserTester/PanelButtonBundleTests.cs	Adds a regression test ensuring trailing comments don’t pollute parsed script metadata (e.g., `__title__`).
dev/pyRevitLoader/pyRevitExtensionParser/ParsedComponent.cs	Adds `HelpUrl` + localized help URL support to parsed UI components.
dev/pyRevitLoader/pyRevitExtensionParser/ParsedBundle.cs	Adds `HelpUrl` and `HelpUrls` (localized) to the bundle model.
dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs	Updates extension root discovery and wires help URL parsing/merging from scripts + bundle.yaml; improves string constant extraction to ignore trailing comments.
dev/pyRevitLoader/pyRevitExtensionParser/BundleParser.cs	Adds `helpurl` / `helpurls` parsing support in bundle.yaml.
dev/pyRevitLoader/pyRevitAssemblyBuilder/UIManager/Buttons/PanelButtonBuilder.cs	Documents contextual-help behavior for dialog launcher conversion.
dev/pyRevitLoader/pyRevitAssemblyBuilder/UIManager/Buttons/ButtonPostProcessor.cs	Applies contextual help (F1 URL) to created ribbon items.
bin/netfx/engines/IPY342/pyRevitExtensionParser.dll	Updates the shipped parser assembly for the IPY342 engine build.

Comments suppressed due to low confidence (1)

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs:751

Template substitution is applied to scriptHelpUrl but not to bundleInComponent.HelpUrl nor to finalLocalizedHelpUrls. This means helpurl/helpurls values containing {{...}} templates won’t resolve (and may later fail URL validation). Apply SubstituteTemplates to the bundle HelpUrl and run SubstituteTemplatesInDict on finalLocalizedHelpUrls the same way titles/tooltips are handled.

                // Apply template substitution to string values
                title = SubstituteTemplates(title, mergedTemplates);
                doc = SubstituteTemplates(doc, mergedTemplates);
                author = SubstituteTemplates(author, mergedTemplates);
                var hyperlink = SubstituteTemplates(bundleInComponent?.Hyperlink, mergedTemplates);
                scriptHelpUrl = SubstituteTemplates(scriptHelpUrl, mergedTemplates);
                
                // Apply template substitution to localized values
                finalLocalizedTitles = SubstituteTemplatesInDict(finalLocalizedTitles, mergedTemplates);
                finalLocalizedTooltips = SubstituteTemplatesInDict(finalLocalizedTooltips, mergedTemplates);

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs

dev/pyRevitLoader/pyRevitExtensionParser/BundleParser.cs

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs

jmcouffin · 2026-01-25T13:51:17Z

@romangolev can you review the 3 comments from ghcopilot, please?

jmcouffin · 2026-01-25T14:12:33Z

Test 1

This works: 🚀  🟢 
__title__ = " _ variable title _ "
__context__ = "zero-doc"
__authors__ = ["jmc", "John Doe"]
__helpurl__ = {"en_us": "https://www.nytimes.com", "fr_fr": "https://www.lemonde.fr"}
__doc__ = {"en_us": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "fr_fr": "Lorem tooltip en francais"}
print("Complex Push Button jm")

this doesn't: helpurls = {"en_us": "https://www.nytimes.com", "fr_fr": "https://www.lemonde.fr"}

expected? @romangolev

Test 2 🟢

bundle.yaml with multiple help url per language

works after restart

Test 3 🟢

custom local extension path added to custom extension path

Works as expected

Note

It always requires a restart of Revit, looking at the notes in the code, this is expected
Custom extensions language switch is not working: 🔴 @romangolev

install custom extension (local)
switch language

title is not changed after reload
it is changed after restart

romangolev · 2026-01-25T14:42:29Z

this doesn't: helpurls = {"en_us": "https://www.nytimes.com", "fr_fr": "https://www.lemonde.fr"}

Not sure if helpurls and help_urls from bundle should be supported. Haven't found any evidence of them on notion not here nor there.

I decided to stick to the helpurl and help_url to handle both singular and multilang support

romangolev · 2026-01-25T14:43:52Z

Custom extensions language switch is not working:

I am on this one now @jmcouffin

jmcouffin · 2026-01-25T14:45:34Z

I decided to stick to the helpurl and help_url to handle both singular and multilang support

Sounds good to me!

…ne docstrings

romangolev · 2026-01-25T16:51:43Z

@jmcouffin
Pushed commits addressing the issue of language not being applied to custom extensions on reload.
As a bonus fixed an issue with multiline doc is not being parsed properly.

I am on a hot streak 😀

jmcouffin · 2026-01-25T17:01:14Z

hot streak

Sounds like Duolingo! 🤣😁🤭

Copilot

Pull request overview

Copilot reviewed 10 out of 26 changed files in this pull request and generated 6 comments.

dev/pyRevitLoader/pyRevitExtensionParser/ParsedBundle.cs

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs

dev/pyRevitLoader/pyRevitAssemblyBuilder/UIManager/Buttons/ButtonPostProcessor.cs

dev/pyRevitLoader/pyRevitExtensionParser/BundleParser.cs

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

tay0thman · 2026-01-27T01:14:12Z

got few errors, while testing the PR:

I see the naming of the scripts are fixed and the custom extensions also being fixed, Good Job @romangolev

romangolev · 2026-01-27T21:25:05Z

@tay0thman thanks for review!

got few errors, while testing the PR:

Haven't noticed the same behavior on my end. Could be that the app uses old dlls. Try to wipe out all the files from AppData\Roaming\pyRevit\2025 and give it another shot

__min_revit_ver__, __max_revit_ver__, __beta__, __cleanengine__, __fullframeengine__, __persistentengine__

romangolev · 2026-01-28T00:43:58Z

@jmcouffin I've been scouting through the docs and found that the new loader implementation lacks the inline support for some of the features. Even though most tools are bundle-driven, I had to add them to make app as backwards compatible as possible.

New Script Variables Supported

Variable	Type	Description
min_revit_ver	String	Minimum Revit version (e.g., "2021")
max_revit_ver	String	Maximum Revit version (e.g., "2024")
beta	Boolean	Mark as beta tool
cleanengine	Boolean	Require clean engine scope
fullframeengine	Boolean	Enable full-frame mode
persistentengine	Boolean	Enable persistent engine

A small fix and refactor for the locale module. Nothing fancy as the main locale stays in python.

tay0thman · 2026-01-28T21:29:31Z

. Try to wipe out all the files from AppData\Roaming\pyRevit\2025 and give it another shot

This worked, no issues here. I'll keep testing but this seems to be a solid PR.

tay0thman · 2026-01-29T00:49:06Z

Ok, I had some time to test it out:
1- Building / Editing Bundles is impossible without restarting Revit. I can unload an extension, but I cannot load / update it again without restarting.
2- Editing a script won't update the tool, Reloading pyRevit will result in the error below:

Both of the Items above are key features tied to pyRevit's "RAD" Mission, so these are critical.

romangolev · 2026-01-30T23:39:26Z

@tay0thman you got the point!
Last commits uploaded must remedy the issues mentioned. The new loader should now be well-aligned with the RAD mission 🏃‍♂️‍➡️

tay0thman · 2026-01-31T00:58:14Z

Last commits uploaded must remedy the issues mentioned. The new loader should now be well-aligned with the RAD mission 🏃‍♂️‍➡️

That Works! Awesome! Thank you @romangolev

One more Item I noticed in the Bundle Metadata, the "before: " & "after: " arguments are not supported by the new loader

I don't see any further issues so far.

github-actions · 2026-02-01T17:49:57Z

📦 New work-in-progress (wip) builds are available for 5.3.1.26032+1738-wip

github-actions · 2026-02-01T17:56:01Z

📦 New work-in-progress (wip) builds are available for 5.3.1.26032+1743-wip

github-actions · 2026-02-01T18:44:36Z

📦 New work-in-progress (wip) builds are available for 5.3.1.26032+1829-wip

github-actions · 2026-02-01T19:50:03Z

📦 New work-in-progress (wip) builds are available for 5.3.1.26032+1937-wip

github-actions · 2026-02-01T20:07:47Z

📦 New work-in-progress (wip) builds are available for 6.0.0.26032+1956-wip

github-actions · 2026-02-01T20:16:24Z

📦 New work-in-progress (wip) builds are available for 6.0.0.26032+2005-wip

github-actions · 2026-02-01T20:20:12Z

📦 New work-in-progress (wip) builds are available for 6.0.0.26032+2008-wip

github-actions · 2026-02-01T20:24:17Z

📦 New public release are available for 6.0.0.26032+2040

github-actions · 2026-02-01T20:34:56Z

📦 New public release are available for 6.0.0.26032+2040

romangolev added 5 commits January 25, 2026 03:21

fix: load custom extensions defined in the iniconfig

8dcf808

Merge remote-tracking branch 'upstream/develop' into develop

c9a3ca5

feat: add support for helpurl from the bundle

9137a85

fix: parse strings correctly from script

3f61f83

chore: update dlls

b035520

Copilot AI review requested due to automatic review settings January 25, 2026 06:31

Copilot started reviewing on behalf of romangolev January 25, 2026 06:32 View session

This was referenced Jan 25, 2026

[Bug]: Custom Extensions Location does not work in Build 5.3.1.26017 #3024

Closed

[Bug]: In-Script naming returns unexpected names #3023

Closed

[Task]: New C# Loader Testing #2995

Open

Copilot AI reviewed Jan 25, 2026

View reviewed changes

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs Outdated Show resolved Hide resolved

dev/pyRevitLoader/pyRevitExtensionParser/BundleParser.cs Outdated Show resolved Hide resolved

dev/pyRevitLoader/pyRevitExtensionParser/ExtensionParser.cs Show resolved Hide resolved

fix: make the custom extenstion route parsing more robust

1ca5014

romangolev added 2 commits January 25, 2026 15:33

fix: double-check help url usage with notion and make changes

d4d94f8

chore: update dlls

223dd53

romangolev added 2 commits January 25, 2026 17:44

fix: invalidate cache for language locale and correctly parse multili…

d17d4c7

…ne docstrings

chore: update dlls

067103b

jmcouffin requested a review from Copilot January 26, 2026 20:07

Copilot started reviewing on behalf of jmcouffin January 26, 2026 20:08 View session

Copilot AI reviewed Jan 26, 2026

View reviewed changes

romangolev added 4 commits January 27, 2026 22:54

feat: add support for more monikers wuth inline scripts:

0bd6c4b

__min_revit_ver__, __max_revit_ver__, __beta__, __cleanengine__, __fullframeengine__, __persistentengine__

fix: address copilot comments

3453d83

refactor: use enum to store all suported locales when parsing

0801e25

chore: update dlls

1ded7a4

romangolev added 4 commits January 30, 2026 23:36

fix: make the loader RAD again

693b29b

fix: make sure in-line _context_ is being used properly

7550971

chore: update dlls

41e4fe5

Merge remote-tracking branch 'upstream/develop' into develop

554803c

jmcouffin mentioned this pull request Jan 31, 2026

[Bug]: "from script import main" not working due to cached imports #3042

Closed

5 tasks

romangolev added 2 commits February 1, 2026 18:10

Merge remote-tracking branch 'upstream/develop' into develop

cce16e3

chore: update dlls

742be2d

jmcouffin merged commit 59f39b5 into pyrevitlabs:develop Feb 1, 2026

Uh oh!

Conversation

romangolev commented Jan 25, 2026

New loader C# bugfixes and improvements

Description

Checklist

Related Issues

Additional Notes

Uh oh!

devloai bot commented Jan 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jmcouffin commented Jan 25, 2026

Uh oh!

jmcouffin commented Jan 25, 2026

Test 1

Test 2 🟢

Test 3 🟢

Uh oh!

romangolev commented Jan 25, 2026

Uh oh!

romangolev commented Jan 25, 2026

Uh oh!

jmcouffin commented Jan 25, 2026

Uh oh!

romangolev commented Jan 25, 2026

Uh oh!

jmcouffin commented Jan 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

tay0thman commented Jan 27, 2026

Uh oh!

romangolev commented Jan 27, 2026

Uh oh!

romangolev commented Jan 28, 2026

Uh oh!

tay0thman commented Jan 28, 2026

Uh oh!

tay0thman commented Jan 29, 2026

Uh oh!

romangolev commented Jan 30, 2026

Uh oh!

tay0thman commented Jan 31, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Uh oh!

Reviewers