Enhancement 1739 - Improve Copy Legend Functionality by MohamedAsli · Pull Request #2745 · pyrevitlabs/pyRevit

MohamedAsli · 2025-08-04T09:34:09Z

Improve Copy Legend Functionality

Description

This PR enhances the functionality for copying legend views between documents in Revit by adding :

Progress Bar
Transaction Group
Clear success/failure messages
Improved error handling and detailed logging of errors and skipped elements

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
Changes are tested and verified to work as expected.

Related Issues

#1739

Additional Notes

For now I just skipped ReferencePlanes, because they get copied in the model space (unwanted) (see #2319)

…errides exception

… class, remove transaction status, and clear success message

…display logs if operation not aborted

devloai · 2025-08-04T09:34:13Z

I've hit an internal error while addressing the comment. Please try again later.

jmcouffin · 2025-08-04T10:25:44Z

@devloai please review this PR

Copilot

Pull Request Overview

This PR enhances the Copy Legends functionality by adding a progress bar, transaction groups, improved error handling, and clearer user feedback messages. The refactoring transforms a simple copy function into a more robust operation with detailed logging and user experience improvements.

Added progress bar for better user feedback during copy operations
Implemented transaction groups and enhanced error handling with detailed logging
Improved user messaging with success/failure notifications and detailed operation summaries

Copilot · 2025-08-04T10:26:06Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+                    logger_messages.log_message_with_doc_and_legend(
+                        dest_doc.Title,
+                        legend_name,
+                        "Legend name already exists. Renaming to: {}".format(new_name))


The log message is logged for every legend regardless of whether it was actually renamed. This should only be logged when counter > 0 (i.e., when a rename actually occurred).

Suggested change

logger_messages.log_message_with_doc_and_legend(

dest_doc.Title,

legend_name,

"Legend name already exists. Renaming to: {}".format(new_name))

if counter > 0:

logger_messages.log_message_with_doc_and_legend(

dest_doc.Title,

legend_name,

"Legend name already exists. Renaming to: {}".format(new_name))

Copilot · 2025-08-04T10:26:06Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+
+                    options = DB.CopyPasteOptions()
+                    options.SetDuplicateTypeNamesHandler(CopyUseDestination())
+                    copied_elements = DB.ElementTransformUtils.CopyElements(


The indentation of this line is inconsistent with the surrounding code block. It should align with the other statements in the transaction.

Copilot · 2025-08-04T10:26:07Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+                    # skip reference plane for now, they are copied in the model space
+                    if isinstance(el, DB.Element) and el.Category and not isinstance(el, DB.ReferencePlane):


[nitpick] The condition logic could be more readable by extracting the ReferencePlane check into a separate variable or adding a comment explaining why ReferencePlanes are excluded.

Suggested change

# skip reference plane for now, they are copied in the model space

if isinstance(el, DB.Element) and el.Category and not isinstance(el, DB.ReferencePlane):

# ReferencePlanes are skipped because they are copied in the model space, not in the legend view.

is_reference_plane = isinstance(el, DB.ReferencePlane)

if isinstance(el, DB.Element) and el.Category and not is_reference_plane:

devloai

PR Summary:

This PR enhances the Copy Legend functionality by adding:
• Progress bar with cancellation support
• TransactionGroup for better transaction management
• Clear success/failure messages with detailed reporting
• Improved error handling and logging
• Reference plane exclusion to avoid model space copying (addresses #2319)

Review Summary:

Overall solid enhancement that addresses the original issue #1739. The code adds meaningful user feedback and better error handling. I identified 3 logic bugs that should be fixed: incorrect boolean condition for logging, misleading log messages, and missing progress bar cancellation handling. The changes follow pyRevit patterns well and the Reference plane exclusion properly addresses a known issue.

Follow-up suggestions:

@devloai fix the identified logic issues

devloai · 2025-08-04T10:30:22Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+    content = "\n".join(details)
+    forms.alert(msg=main_instruction, sub_msg=content)
+
+    if logger_messages:


The condition here is incorrect. logger_messages is an instance of LogMessage class and will always evaluate to True in a boolean context. You need to check if there are actually messages to log.

if logger_messages.get_messages().strip(): logger.warning(logger_messages.get_messages())

actions

Feedback: Rate this comment to help me improve future code reviews:

👍 Good - Helpful and accurate

👎 Poor - Wrong, unclear, or unhelpful

Skip if you don't have any strong opinions either way.

devloai · 2025-08-04T10:30:22Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+                    while new_name in all_legend_names:
+                        counter += 1
+                        new_name = src_name + " (Duplicate %s)" % counter
+                    logger_messages.log_message_with_doc_and_legend(


This logging message is misleading. It logs "Legend name already exists" for every legend, even when no duplication occurs. The message should only be logged when counter > 0.

if counter > 0: logger_messages.log_message_with_doc_and_legend( dest_doc.Title, legend_name, "Legend name already exists. Renaming to: {}".format(new_name))

actions

Feedback: Rate this comment to help me improve future code reviews:

👍 Good - Helpful and accurate

👎 Poor - Wrong, unclear, or unhelpful

Skip if you don't have any strong opinions either way.

devloai · 2025-08-04T10:30:22Z

... Set.panel/views.stack/Legends.pulldown/Copy Legends to Other Documents.pushbutton/script.py

+current_operation = 0
+skipped_docs = []
+
+with forms.ProgressBar(cancellable=True) as pb:


Progress bar should handle cancellation. Currently, if user cancels the operation, the script will continue processing. Check pb.cancelled and break/exit if needed.

with forms.ProgressBar(cancellable=True) as pb: for dest_doc in open_docs: if pb.cancelled: break # ... rest of the loop

actions

Feedback: Rate this comment to help me improve future code reviews:

👍 Good - Helpful and accurate

👎 Poor - Wrong, unclear, or unhelpful

Skip if you don't have any strong opinions either way.

jmcouffin · 2025-08-04T10:40:03Z

It seems fine overall, please review and test the comments from our AI friends,
Nice contribution again @MohamedAsli Keep them coming!

…improve logs readability

MohamedAsli · 2025-08-04T13:11:24Z

@jmcouffin I think we're good now

jmcouffin · 2025-08-04T13:42:18Z

@MohamedAsli at line 61, Using variable 'tg' before assignment

MohamedAsli · 2025-08-04T14:25:27Z

@jmcouffin Good catch!
How did you manage to catch it, since you can't physically hit "cancel" before the script moves forward?
Anyway, I simply removed the first 'if pb.cancelled' check - it won't change the execution time. I'll just catch it after beginning to loop through the legends.

jmcouffin · 2025-08-04T14:28:01Z

How did you manage to catch it, since you can't physically hit "cancel" before the script moves forward?

It was listed in my code editor errors list :)
The code itself could be further improved for sure, but this is a good enhancement already

Thanks for all of the above @MohamedAsli

github-actions · 2025-08-04T14:41:01Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25216+1429-wip

MohamedAsli · 2025-08-04T14:52:30Z

Thanks!
Absolutely agree on the improvements. I've started but cannot squeeze much time into it. I'll invest it in major commands for now :)

It was listed in my code editor errors list

My pycharm didn't, surely missing some settings

github-actions · 2025-08-07T09:20:31Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25219+0909-wip

github-actions · 2025-09-08T08:17:05Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25251+0805-wip

github-actions · 2025-09-08T08:39:08Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25251+0824-wip

github-actions · 2025-09-09T17:11:51Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25252+1659-wip

github-actions · 2025-09-12T06:55:48Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25255+0644-wip

github-actions · 2025-09-12T09:22:39Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25255+0911-wip

github-actions · 2025-09-13T07:38:15Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25256+0727-wip

github-actions · 2025-09-15T15:01:31Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25258+1448-wip

github-actions · 2025-09-22T10:58:25Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25265+1047-wip

github-actions · 2025-09-23T08:16:37Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25266+0803-wip

github-actions · 2025-09-25T18:09:20Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25268+1757-wip

github-actions · 2025-09-26T13:49:51Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25269+1336-wip

github-actions · 2025-09-26T14:45:45Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25269+1431-wip

github-actions · 2025-09-26T14:49:08Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25269+1436-wip

github-actions · 2025-09-26T18:35:30Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25269+1822-wip

github-actions · 2025-09-28T17:31:56Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25271+1719-wip

github-actions · 2025-09-29T20:18:47Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25272+2003-wip

github-actions · 2025-09-29T20:24:01Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25272+2012-wip

github-actions · 2025-09-29T20:29:11Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25272+2017-wip

github-actions · 2025-09-29T22:02:24Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25272+2149-wip

github-actions · 2025-10-01T17:49:29Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25274+1734-wip

github-actions · 2025-10-04T14:38:11Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25277+1425-wip

github-actions · 2025-10-04T14:40:53Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25277+1427-wip

github-actions · 2025-10-06T22:12:27Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25279+2157-wip

github-actions · 2025-10-07T02:31:04Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25280+0218-wip

github-actions · 2025-10-07T11:08:43Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25280+1054-wip

github-actions · 2025-10-07T11:10:48Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25280+1057-wip

github-actions · 2025-10-09T17:11:40Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25282+1656-wip

github-actions · 2025-10-10T01:54:43Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25283+0140-wip

github-actions · 2025-10-13T10:35:36Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25286+1022-wip

github-actions · 2025-10-29T10:03:10Z

📦 New work-in-progress (wip) builds are available for 5.2.0.25302+0949-wip

MohamedAsli added 9 commits August 2, 2025 04:23

Simplify imports

a438900

Add indeterminate progressbar

a7d8331

Collect log messages to display once finished and handle SetElementOv…

6067185

…errides exception

Add progressbar update

af6aa73

skipping docs with no legend but continue processing

a119a8a

add transaction group

bf73eaf

handle non processed docs and display proper success/fail message

f2e1c0b

total refactor, remove indeterminate from progressbar, add LogMessage…

1ca0ce8

… class, remove transaction status, and clear success message

skip reference planes (because they are copied in model space), only …

29b748e

…display logs if operation not aborted

Merge branch 'develop' into dev/1739

7ed2b33

jmcouffin requested a review from Copilot August 4, 2025 10:25

Copilot AI reviewed Aug 4, 2025

View reviewed changes

devloai bot reviewed Aug 4, 2025

View reviewed changes

MohamedAsli added 2 commits August 4, 2025 14:59

remove the use of 'with transaction', handle progressbar cancelling, …

6cb619e

…improve logs readability

Merge remote-tracking branch 'origin/dev/1739' into dev/1739

a01d3a5

remove variable call before assignment

22c1f2a

jmcouffin approved these changes Aug 4, 2025

View reviewed changes

jmcouffin added Enhancement Enhancement request [class->Improved #{number}: {title}] Tools Issues related to pyRevit commands [subsystem] labels Aug 4, 2025

jmcouffin merged commit 3dbf2d3 into pyrevitlabs:develop Aug 4, 2025

		# skip reference plane for now, they are copied in the model space
		if isinstance(el, DB.Element) and el.Category and not isinstance(el, DB.ReferencePlane):

-                    # skip reference plane for now, they are copied in the model space
-                    if isinstance(el, DB.Element) and el.Category and not isinstance(el, DB.ReferencePlane):
+                    # ReferencePlanes are skipped because they are copied in the model space, not in the legend view.
+                    is_reference_plane = isinstance(el, DB.ReferencePlane)
+                    if isinstance(el, DB.Element) and el.Category and not is_reference_plane:

Uh oh!

Conversation

MohamedAsli commented Aug 4, 2025

Improve Copy Legend Functionality

Description

Checklist

Related Issues

Additional Notes

Uh oh!

devloai bot commented Aug 4, 2025

Uh oh!

jmcouffin commented Aug 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

devloai bot left a comment

Choose a reason for hiding this comment

PR Summary:

Review Summary:

Follow-up suggestions:

Uh oh!

devloai bot Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

devloai bot Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

devloai bot Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

jmcouffin commented Aug 4, 2025

Uh oh!

MohamedAsli commented Aug 4, 2025

Uh oh!

jmcouffin commented Aug 4, 2025

Uh oh!

MohamedAsli commented Aug 4, 2025

Uh oh!

jmcouffin commented Aug 4, 2025

Uh oh!

github-actions bot commented Aug 4, 2025

Uh oh!

MohamedAsli commented Aug 4, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

github-actions bot commented Sep 8, 2025

Uh oh!

github-actions bot commented Sep 8, 2025

Uh oh!

github-actions bot commented Sep 9, 2025

Uh oh!

github-actions bot commented Sep 12, 2025

Uh oh!

github-actions bot commented Sep 12, 2025

Uh oh!

github-actions bot commented Sep 13, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 22, 2025

Uh oh!

github-actions bot commented Sep 23, 2025

Uh oh!

github-actions bot commented Sep 25, 2025

Uh oh!

github-actions bot commented Sep 26, 2025

Uh oh!

github-actions bot commented Sep 26, 2025