nautobot.apps.views
¶
Utilities for apps to implement UI views.
nautobot.apps.views.AdminRequiredMixin
¶
Bases: AccessMixin
Allows access only to admin users.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.BulkComponentCreateView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Add one or more components (e.g. interfaces, console ports, etc.) to a set of Devices or VirtualMachines.
Source code in nautobot/core/views/generic.py
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 |
|
nautobot.apps.views.BulkCreateView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Create new objects in bulk.
queryset: Base queryset for the objects being created
form: Form class which provides the pattern
field
model_form: The ModelForm used to create individual objects
pattern_target: Name of the field to be evaluated as a pattern (if any)
template_name: The name of the template
Source code in nautobot/core/views/generic.py
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 |
|
nautobot.apps.views.BulkDeleteView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Delete objects in bulk.
queryset: Custom queryset to use when retrieving objects (e.g. to select related objects) filter: FilterSet to apply when deleting by QuerySet table: The table used to display devices being deleted form: The form class used to delete objects in bulk template_name: The name of the template
Source code in nautobot/core/views/generic.py
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 |
|
get_form()
¶
Provide a standard bulk delete form if none has been specified for the view
Source code in nautobot/core/views/generic.py
nautobot.apps.views.BulkEditView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Edit objects in bulk.
queryset: Custom queryset to use when retrieving objects (e.g. to select related objects) filter: FilterSet to apply when deleting by QuerySet table: The table used to display devices being edited form: The form class used to edit objects in bulk template_name: The name of the template
Source code in nautobot/core/views/generic.py
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 |
|
nautobot.apps.views.BulkImportView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Import objects in bulk (CSV format).
queryset: Base queryset for the model table: The django-tables2 Table used to render the list of imported objects template_name: The name of the template
Source code in nautobot/core/views/generic.py
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
|
nautobot.apps.views.BulkRenameView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
An extendable view for renaming objects in bulk.
Source code in nautobot/core/views/generic.py
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 |
|
get_selected_objects_parents_name(selected_objects)
¶
Return selected_objects parent name.
This method is intended to be overridden by child classes to return the parent name of the selected objects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
selected_objects |
list[BaseModel]
|
The objects being renamed |
required |
Returns:
Type | Description |
---|---|
str
|
The parent name of the selected objects |
Source code in nautobot/core/views/generic.py
nautobot.apps.views.ComponentCreateView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Add one or more components (e.g. interfaces, console ports, etc.) to a Device or VirtualMachine.
Source code in nautobot/core/views/generic.py
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 |
|
nautobot.apps.views.ContentTypePermissionRequiredMixin
¶
Bases: AccessMixin
Similar to Django's built-in PermissionRequiredMixin, but extended to check model-level permission assignments. This is related to ObjectPermissionRequiredMixin, except that is does not enforce object-level permissions, and fits within Nautobot's custom permission enforcement system.
Source code in nautobot/core/views/mixins.py
get_required_permission()
¶
Return the specific permission necessary to perform the requested action on an object.
nautobot.apps.views.GetReturnURLMixin
¶
Provides logic for determining where a user should be redirected after processing a form.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.NautobotHTMLRenderer
¶
Bases: renderers.BrowsableAPIRenderer
Inherited from BrowsableAPIRenderer to do most of the heavy lifting for getting the context needed for templates and template rendering.
Source code in nautobot/core/views/renderers.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
|
construct_table(view, **kwargs)
¶
Helper function to construct and paginate the table for rendering used in the ObjectListView, ObjectBulkUpdateView and ObjectBulkDestroyView.
Source code in nautobot/core/views/renderers.py
construct_user_permissions(request, model)
¶
Helper function to gather the user's permissions to add, change, delete and view the model, and then render the action buttons accordingly allowed in the ObjectListView UI.
Source code in nautobot/core/views/renderers.py
get_context(data, accepted_media_type, renderer_context)
¶
Override get_context() from BrowsableAPIRenderer to obtain the context data we need to render our templates. context variable contains template context needed to render Nautobot generic templates / circuits templates. Override this function to add additional key/value pair to pass it to your templates.
Source code in nautobot/core/views/renderers.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
get_dynamic_filter_form(view, request, *args, filterset_class=None, **kwargs)
¶
Helper function to obtain the filter_form_class, and then initialize and return the filter_form used in the ObjectListView UI.
Source code in nautobot/core/views/renderers.py
render(data, accepted_media_type=None, renderer_context=None)
¶
Overrode render() from BrowsableAPIRenderer to set self.template with NautobotViewSet's get_template_name() before it is rendered.
Source code in nautobot/core/views/renderers.py
validate_action_buttons(view, request)
¶
Verify actions in self.action_buttons are valid view actions.
Source code in nautobot/core/views/renderers.py
nautobot.apps.views.NautobotUIViewSet
¶
Bases: mixins.ObjectDetailViewMixin
, mixins.ObjectListViewMixin
, mixins.ObjectEditViewMixin
, mixins.ObjectDestroyViewMixin
, mixins.ObjectBulkDestroyViewMixin
, mixins.ObjectBulkCreateViewMixin
, mixins.ObjectBulkUpdateViewMixin
, mixins.ObjectChangeLogViewMixin
, mixins.ObjectNotesViewMixin
Nautobot BaseViewSet that is intended for UI use only. It provides default Nautobot functionalities such as
create()
, bulk_create()
, update()
, partial_update()
, bulk_update()
, destroy()
, bulk_destroy()
, retrieve()
notes()
, changelog()
and list()
actions.
Source code in nautobot/core/views/viewsets.py
nautobot.apps.views.NautobotViewSetMixin
¶
Bases: GenericViewSet
, AccessMixin
, GetReturnURLMixin
, FormView
NautobotViewSetMixin is an aggregation of various mixins from DRF, Django and Nautobot to acheive the desired behavior pattern for NautobotUIViewSet
Source code in nautobot/core/views/mixins.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 |
|
check_permissions(request)
¶
Check whether the user has the permissions needed to perform certain actions.
Source code in nautobot/core/views/mixins.py
dispatch(request, *args, **kwargs)
¶
Override the default dispatch() method to check permissions first. Used to determine whether the user has permissions to a view and object-level permissions. Using AccessMixin handle_no_permission() to deal with Object-Level permissions and API-Level permissions in one pass.
Source code in nautobot/core/views/mixins.py
form_invalid(form)
¶
Handle invalid forms.
Source code in nautobot/core/views/mixins.py
form_save(form, **kwargs)
¶
Generic method to save the object from form. Should be overriden by user if customization is needed.
form_valid(form)
¶
Handle valid forms and redirect to success_url.
Source code in nautobot/core/views/mixins.py
get_extra_context(request, instance=None)
¶
Return any additional context data for the template. request: The current request instance: The object being viewed
get_filter_params(request)
¶
Helper function - take request.GET and discard any parameters that are not used for queryset filtering.
Source code in nautobot/core/views/mixins.py
get_form(*args, **kwargs)
¶
Helper function to get form for different views if specified. If not, return instantiated form using form_class.
Source code in nautobot/core/views/mixins.py
get_form_class(**kwargs)
¶
Helper function to get form_class for different views.
Source code in nautobot/core/views/mixins.py
get_object()
¶
Returns the object the view is displaying. You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.
Source code in nautobot/core/views/mixins.py
get_permissions_for_model(model, actions)
¶
Resolve the named permissions for a given model (or instance) and a list of actions (e.g. view or add).
:param model: A model or instance :param actions: A list of actions to perform on the model
Source code in nautobot/core/views/mixins.py
get_queryset()
¶
Get the list of items for this view.
This must be an iterable, and may be a queryset.
Defaults to using self.queryset
.
This method should always be used rather than accessing self.queryset
directly, as self.queryset
gets evaluated only once, and those results
are cached for all subsequent requests.
Override the original get_queryset()
to apply permission specific to the user and action.
Source code in nautobot/core/views/mixins.py
get_required_permission()
¶
Obtain the permissions needed to perform certain actions on a model.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectBulkCreateViewMixin
¶
Bases: NautobotViewSetMixin
UI mixin to bulk create model instances.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectBulkDestroyViewMixin
¶
Bases: NautobotViewSetMixin
, BulkDestroyModelMixin
UI mixin to bulk destroy model instances.
Source code in nautobot/core/views/mixins.py
bulk_destroy(request, *args, **kwargs)
¶
Call perform_bulk_destroy(). The function exist to keep the DRF's get/post pattern of {action}/perform_{action}, we will need it when we transition from using forms to serializers in the UI. User should override this function to handle any actions as needed before bulk destroy.
Source code in nautobot/core/views/mixins.py
perform_bulk_destroy(request, **kwargs)
¶
request.POST "_delete": Function to render the user selection of objects in a table form/BulkDestroyConfirmationForm via Response that is passed to NautobotHTMLRenderer. request.POST "_confirm": Function to validate the table form/BulkDestroyConfirmationForm and to perform the action of bulk destroy. Render the form with errors if exceptions are raised.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectBulkUpdateViewMixin
¶
Bases: NautobotViewSetMixin
, BulkUpdateModelMixin
UI mixin to bulk update model instances.
Source code in nautobot/core/views/mixins.py
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 |
|
bulk_update(request, *args, **kwargs)
¶
Call perform_bulk_update(). The function exist to keep the DRF's get/post pattern of {action}/perform_{action}, we will need it when we transition from using forms to serializers in the UI. User should override this function to handle any actions as needed before bulk update.
Source code in nautobot/core/views/mixins.py
perform_bulk_update(request, **kwargs)
¶
request.POST "_edit": Function to render the user selection of objects in a table form/BulkUpdateForm via Response that is passed to NautobotHTMLRenderer. request.POST "_apply": Function to validate the table form/BulkUpdateForm and to perform the action of bulk update. Render the form with errors if exceptions are raised.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectChangeLogViewMixin
¶
Bases: NautobotViewSetMixin
UI mixin to list a model's changelog queryset
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectDeleteView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Delete a single object.
queryset: The base queryset for the object being deleted template_name: The name of the template
Source code in nautobot/core/views/generic.py
get_object(kwargs)
¶
Retrieve an object based on kwargs
.
Source code in nautobot/core/views/generic.py
nautobot.apps.views.ObjectDestroyViewMixin
¶
Bases: NautobotViewSetMixin
, mixins.DestroyModelMixin
UI mixin to destroy a model instance.
Source code in nautobot/core/views/mixins.py
destroy(request, *args, **kwargs)
¶
request.GET: render the ObjectDeleteConfirmationForm which is passed to NautobotHTMLRenderer as Response. request.POST: call perform_destroy() which validates the form and perform the action of delete. Override to add more variables to Response
Source code in nautobot/core/views/mixins.py
perform_destroy(request, **kwargs)
¶
Function to validate the ObjectDeleteConfirmationForm and to delete the object.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectDetailViewMixin
¶
Bases: NautobotViewSetMixin
, mixins.RetrieveModelMixin
UI mixin to retrieve a model instance.
Source code in nautobot/core/views/mixins.py
retrieve(request, *args, **kwargs)
¶
Retrieve a model instance.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectDynamicGroupsView
¶
Bases: View
Present a list of dynamic groups associated to a particular object.
base_template: The name of the template to extend. If not provided, "
Source code in nautobot/extras/views.py
nautobot.apps.views.ObjectEditView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Create or edit a single object.
queryset: The base queryset for the object being modified model_form: The form used to create or edit the object template_name: The name of the template
Source code in nautobot/core/views/generic.py
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
|
get_extra_context(request, instance)
¶
Return any additional context data for the template.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request |
HttpRequest
|
The current request |
required |
instance |
Model
|
The object being edited |
required |
Returns:
Type | Description |
---|---|
dict
|
Additional context data |
Source code in nautobot/core/views/generic.py
get_object(kwargs)
¶
Retrieve an object based on kwargs
.
Source code in nautobot/core/views/generic.py
successful_post(request, obj, created, logger)
¶
Callback after the form is successfully saved but before redirecting the user.
Source code in nautobot/core/views/generic.py
nautobot.apps.views.ObjectEditViewMixin
¶
Bases: NautobotViewSetMixin
, mixins.CreateModelMixin
, mixins.UpdateModelMixin
UI mixin to create or update a model instance.
Source code in nautobot/core/views/mixins.py
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 |
|
create(request, *args, **kwargs)
¶
request.GET: render the ObjectForm which is passed to NautobotHTMLRenderer as Response. request.POST: call perform_create() which validates the form and perform the action of create. Override to add more variables to Response.
Source code in nautobot/core/views/mixins.py
perform_create(request, *args, **kwargs)
¶
Function to validate the ObjectForm and to create a new object.
Source code in nautobot/core/views/mixins.py
perform_update(request, *args, **kwargs)
¶
Function to validate the ObjectEditForm and to update/partial_update an existing object.
Source code in nautobot/core/views/mixins.py
update(request, *args, **kwargs)
¶
request.GET: render the ObjectEditForm which is passed to NautobotHTMLRenderer as Response. request.POST: call perform_update() which validates the form and perform the action of update/partial_update of an existing object. Override to add more variables to Response.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectImportView
¶
Bases: GetReturnURLMixin
, ObjectPermissionRequiredMixin
, View
Import a single object (YAML or JSON format).
queryset: Base queryset for the objects being created model_form: The ModelForm used to create individual objects related_object_forms: A dictionary mapping of forms to be used for the creation of related (child) objects template_name: The name of the template
Source code in nautobot/core/views/generic.py
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 |
|
nautobot.apps.views.ObjectListView
¶
Bases: ObjectPermissionRequiredMixin
, View
List a series of objects.
The queryset of objects to display. Note: Prefetching related objects is not necessary, as the
table will prefetch objects as needed depending on the columns being displayed.
filter: A django-filter FilterSet that is applied to the queryset filter_form: The form used to render filter options table: The django-tables2 Table used to render the objects list template_name: The name of the template non_filter_params: List of query parameters that are not used for queryset filtering
Source code in nautobot/core/views/generic.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
get_filter_params(request)
¶
Helper function - take request.GET and discard any parameters that are not used for queryset filtering.
Source code in nautobot/core/views/generic.py
queryset_to_yaml()
¶
Export the queryset of objects as concatenated YAML documents.
validate_action_buttons(request)
¶
Verify actions in self.action_buttons are valid view actions.
Source code in nautobot/core/views/generic.py
nautobot.apps.views.ObjectListViewMixin
¶
Bases: NautobotViewSetMixin
, mixins.ListModelMixin
UI mixin to list a model queryset
Source code in nautobot/core/views/mixins.py
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 |
|
filter_queryset(queryset)
¶
Filter a query with request querystrings.
Source code in nautobot/core/views/mixins.py
list(request, *args, **kwargs)
¶
List the model instances.
Source code in nautobot/core/views/mixins.py
queryset_to_yaml()
¶
Export the queryset of objects as concatenated YAML documents.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectNotesView
¶
Bases: View
Present a list of notes associated to a particular object.
base_template: The name of the template to extend. If not provided, "
Source code in nautobot/extras/views.py
nautobot.apps.views.ObjectNotesViewMixin
¶
Bases: NautobotViewSetMixin
UI Mixin for an Object's Notes.
Source code in nautobot/core/views/mixins.py
nautobot.apps.views.ObjectPermissionRequiredMixin
¶
Bases: AccessMixin
Similar to Django's built-in PermissionRequiredMixin, but extended to check for both model-level and object-level permission assignments. If the user has only object-level permissions assigned, the view's queryset is filtered to return only those objects on which the user is permitted to perform the specified action.
Source code in nautobot/core/views/mixins.py
get_required_permission()
¶
Return the specific permission necessary to perform the requested action on an object.
nautobot.apps.views.ObjectView
¶
Bases: ObjectPermissionRequiredMixin
, View
Retrieve a single object for display.
queryset: The base queryset for retrieving the object template_name: Name of the template to use
Source code in nautobot/core/views/generic.py
get(request, *args, **kwargs)
¶
Generic GET handler for accessing an object.
Source code in nautobot/core/views/generic.py
get_extra_context(request, instance)
¶
Return any additional context data for the template.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request |
Request
|
The current request |
required |
instance |
Model
|
The object being viewed |
required |
Returns:
Type | Description |
---|---|
dict
|
Additional context data |
Source code in nautobot/core/views/generic.py
get_template_name()
¶
Return self.template_name if set. Otherwise, resolve the template path by model app_label and name.
Source code in nautobot/core/views/generic.py
nautobot.apps.views.check_and_call_git_repository_function(request, pk, func)
¶
Helper for checking Git permissions and worker availability, then calling provided function if all is well
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request |
HttpRequest
|
request object. |
required |
pk |
UUID
|
GitRepository pk value. |
required |
func |
function
|
Enqueue git repo function. |
required |
Returns:
Type | Description |
---|---|
Union[HttpResponseForbidden, redirect]
|
HttpResponseForbidden if user does not have permission to run the job, otherwise redirect to the job result page. |
Source code in nautobot/extras/views.py
nautobot.apps.views.check_filter_for_display(filters, field_name, values)
¶
Return any additional context data for the template.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filters |
OrderedDict
|
The output of |
required |
field_name |
str
|
The name of the filter to get a label for and lookup values |
required |
values |
list[str]
|
List of strings that may be PKs to look up |
required |
Returns:
Type | Description |
---|---|
dict
|
A dict containing:
- name: (str) Field name
- display: (str) Resolved field name, whether that's a field label or fallback to inputted |
Source code in nautobot/core/views/utils.py
nautobot.apps.views.csv_format(data)
¶
Convert the given list of data to a CSV row string.
Encapsulate any data which contains a comma within double quotes.
Obsolete, as CSV rendering in Nautobot core is now handled by nautobot.core.api.renderers.NautobotCSVRenderer.
Source code in nautobot/core/views/utils.py
nautobot.apps.views.get_csv_form_fields_from_serializer_class(serializer_class)
¶
From the given serializer class, build a list of field dicts suitable for rendering in the CSV import form.
Source code in nautobot/core/views/utils.py
nautobot.apps.views.get_paginate_count(request)
¶
Determine the length of a page, using the following in order:
1. per_page URL query parameter
2. Saved user preference
3. PAGINATE_COUNT global setting.
Source code in nautobot/core/views/paginator.py
nautobot.apps.views.handle_protectederror(obj_list, request, e)
¶
Generate a user-friendly error message in response to a ProtectedError exception.
Source code in nautobot/core/views/utils.py
nautobot.apps.views.prepare_cloned_fields(instance)
¶
Compile an object's clone_fields
list into a string of URL query parameters. Tags are automatically cloned where
applicable.