Merge pull request #4723 from jsenecal/4615_interface_label

Closes: #4615 Physical labels

netbox/utilities/forms.py

@@ -530,6 +530,8 @@ class ExpandableNameField(forms.CharField):
                 """
 
     def to_python(self, value):
+        if value is None:
+            return list()
         if re.search(ALPHANUMERIC_EXPANSION_PATTERN, value):
             return list(expand_alphanumeric_pattern(value))
         return [value]
@@ -802,6 +804,31 @@ class ImportForm(BootstrapMixin, forms.Form):
                 })
 
 
+class LabeledComponentForm(BootstrapMixin, forms.Form):
+    """
+    Base form for adding label pattern validation to `Create` forms
+    """
+    name_pattern = ExpandableNameField(
+        label='Name'
+    )
+    label_pattern = ExpandableNameField(
+        label='Label',
+        required=False
+    )
+
+    def clean(self):
+
+        # Validate that the number of components being created from both the name_pattern and label_pattern are equal
+        name_pattern_count = len(self.cleaned_data['name_pattern'])
+        label_pattern_count = len(self.cleaned_data['label_pattern'])
+        if label_pattern_count and name_pattern_count != label_pattern_count:
+            raise forms.ValidationError({
+                'label_pattern': 'The provided name pattern will create {} components, however {} labels will '
+                'be generated. These counts must match.'.format(
+                    name_pattern_count, label_pattern_count)
+            }, code='label_pattern_mismatch')
+
+
 class TableConfigForm(BootstrapMixin, forms.Form):
     """
     Form for configuring user's table preferences.

netbox/utilities/views.py

@@ -1088,10 +1088,13 @@ class ComponentCreateView(GetReturnURLMixin, ObjectPermissionRequiredMixin, View
             new_components = []
             data = deepcopy(request.POST)
 
-            for i, name in enumerate(form.cleaned_data['name_pattern']):
-
+            names = form.cleaned_data['name_pattern']
+            labels = form.cleaned_data.get('label_pattern')
+            for i, name in enumerate(names):
+                label = labels[i] if labels else None
                 # Initialize the individual component form
                 data['name'] = name
+                data['label'] = label
                 if hasattr(form, 'get_iterative_data'):
                     data.update(form.get_iterative_data(i))
                 component_form = self.model_form(data)
@@ -1100,9 +1103,11 @@ class ComponentCreateView(GetReturnURLMixin, ObjectPermissionRequiredMixin, View
                     new_components.append(component_form)
                 else:
                     for field, errors in component_form.errors.as_data().items():
-                        # Assign errors on the child form's name field to name_pattern on the parent form
+                        # Assign errors on the child form's name/label field to name_pattern/label_pattern on the parent form
                         if field == 'name':
                             field = 'name_pattern'
+                        elif field == 'label':
+                            field = 'label_pattern'
                         for e in errors:
                             form.add_error(field, '{}: {}'.format(name, ', '.join(e)))
 
@@ -1187,10 +1192,14 @@ class BulkComponentCreateView(GetReturnURLMixin, ObjectPermissionRequiredMixin,
                         for obj in data['pk']:
 
                             names = data['name_pattern']
-                            for name in names:
+                            labels = data['label_pattern']
+                            for i, name in enumerate(names):
+                                label = labels[i] if labels else None
+
                                 component_data = {
                                     self.parent_field: obj.pk,
                                     'name': name,
+                                    'label': label
                                 }
                                 component_data.update(data)
                                 component_form = self.model_form(component_data)