Viewpoints panel

Rename

Batch rename saved viewpoints with find and replace, numbering, prefixes and case cleanup, with a live preview.

On the ribbonStacked button, Viewpoints panel

NeedsSaved viewpoints in the document

What it does#

The tool for a viewpoint tree that arrived from three people with three naming conventions. Tick the views, choose an operation, watch the preview, apply.

How to use it#

Click Rename and tick the viewpoints to change.
Choose an operation: find and replace, plain or regular expression; a prefix and a suffix; sequential numbering with a start and a padding; or a case cleanup.
Read the preview. Collisions, two views ending up with the same name, are flagged as you type, and nothing applies while one remains.
Click Apply. The toast counts what was renamed.

Limitations#

Folders are renamed like viewpoints, but their contents are not renumbered as a unit; tick the children for that.

Other uses#

Number a folder of views in walk order before exporting a report, so the pages come out in sequence.
Strip a date suffix off fifty views in one go.

Source#

The tool's own files, word for word as shipped in Viewpoints.panel/Manage.stack/Renamer.pushbutton. Every pyNavis tool is an ordinary bundle: copy these into your own extension and change what you like.

script.py Runs on a click. View on GitHub

"""Batch renames saved viewpoints: find/replace (plain or regex), prefix and
suffix, sequential numbering, or case cleanup, with a live preview."""
import clr

clr.AddReference('PyNavis.Runtime')
from System import Func
from System.Collections.Generic import List
from PyNavis.Runtime.Forms import ViewpointRenamerDialog, ViewpointRow

from pynavis import forms, output, toast, viewpoints

RenameRequest = ViewpointRenamerDialog.RenameRequest
RenamePreview = ViewpointRenamerDialog.RenamePreview
RenameItem = ViewpointRenamerDialog.RenameItem


def to_rows(snapshot):
    rows = List[ViewpointRow]()
    for row in snapshot:
        r = ViewpointRow()
        r.Guid = row['guid']
        r.Key = row['key']
        r.ParentKey = row['parent_key']
        r.Folder = row['folder']
        r.Name = row['name']
        r.Kind = row['kind']
        r.Depth = row['depth']
        r.IsFolder = row['is_folder']
        r.Comments = row['comments']
        rows.Add(r)
    return rows


def op_dict(op):
    return {
        'type': op.Type,
        'find': op.Find, 'replace': op.Replace, 'regex': op.Regex,
        'prefix': op.Prefix, 'suffix': op.Suffix,
        'pattern': op.Pattern, 'start': op.Start, 'pad': op.Pad,
        'mode': op.CaseMode,
    }


def run():
    snapshot = viewpoints.snapshot()
    if not snapshot:
        forms.alert('This document has no saved viewpoints.')
        return

    by_guid = dict((row['guid'], row) for row in snapshot)

    def plan_for(request):
        keys = [by_guid[g]['key'] for g in request.CheckedGuids if g in by_guid]
        return viewpoints.plan_renames(snapshot, keys, op_dict(request.Op))

    def preview(request):
        plan = plan_for(request)
        data = RenamePreview()
        for entry in plan['renames']:
            item = RenameItem()
            item.Guid = entry['guid']
            item.OldName = entry['old']
            item.NewName = entry['new']
            item.Collision = bool(entry.get('collision'))
            data.Items.Add(item)
        for problem in plan['problems']:
            data.Problems.Add(problem)
        return data

    request = ViewpointRenamerDialog.Show(
        to_rows(snapshot), Func[RenameRequest, RenamePreview](preview))
    if request is None:
        return

    plan = plan_for(request)
    if plan['collisions'] or plan['problems'] or not plan['renames']:
        toast.info('Nothing to rename.')
        return

    total = len(plan['renames'])

    def tick(done, count):
        output.progress(float(done) / count, 'Renaming %d of %d' % (done, count))

    applied, errors = viewpoints.apply_renames(
        plan['renames'], progress=tick if total > 500 else None)
    output.progress(1.0)
    if errors:
        toast.warning('Renamed %d item(s), %d failed.' % (applied, len(errors)),
                      errors[0])
    else:
        toast.success('Renamed %d item(s).' % applied)


run()

bundle.yaml The bundle contract: the keys pyNavis reads for this tool. View on GitHub

title: Rename
tooltip: Batch rename saved viewpoints with find/replace, numbering, and case cleanup

PreviousTrue Distance NextDelete