nautobot 2.4.0__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of nautobot might be problematic. Click here for more details.

Files changed (592) hide show
  1. nautobot/apps/__init__.py +1 -1
  2. nautobot/apps/api.py +8 -8
  3. nautobot/apps/change_logging.py +2 -2
  4. nautobot/apps/choices.py +4 -4
  5. nautobot/apps/events.py +3 -3
  6. nautobot/apps/factory.py +2 -2
  7. nautobot/apps/filters.py +1 -1
  8. nautobot/apps/forms.py +20 -20
  9. nautobot/apps/graphql.py +2 -2
  10. nautobot/apps/jobs.py +8 -8
  11. nautobot/apps/models.py +19 -19
  12. nautobot/apps/tables.py +1 -1
  13. nautobot/apps/testing.py +10 -10
  14. nautobot/apps/ui.py +2 -2
  15. nautobot/apps/utils.py +7 -7
  16. nautobot/apps/views.py +7 -7
  17. nautobot/circuits/api/serializers.py +0 -1
  18. nautobot/circuits/api/views.py +8 -4
  19. nautobot/circuits/tables.py +1 -2
  20. nautobot/circuits/templates/circuits/circuit_create.html +7 -1
  21. nautobot/circuits/views.py +3 -3
  22. nautobot/cloud/api/views.py +10 -6
  23. nautobot/cloud/models.py +1 -1
  24. nautobot/cloud/views.py +16 -0
  25. nautobot/core/api/fields.py +5 -5
  26. nautobot/core/api/filter_backends.py +9 -3
  27. nautobot/core/api/schema.py +2 -13
  28. nautobot/core/api/serializers.py +34 -40
  29. nautobot/core/api/views.py +4 -56
  30. nautobot/core/celery/log.py +4 -4
  31. nautobot/core/celery/schedulers.py +1 -1
  32. nautobot/core/choices.py +2 -2
  33. nautobot/core/events/__init__.py +3 -3
  34. nautobot/core/filters.py +16 -21
  35. nautobot/core/fixtures/user-data.json +59 -0
  36. nautobot/core/forms/__init__.py +19 -19
  37. nautobot/core/forms/fields.py +11 -14
  38. nautobot/core/forms/forms.py +2 -33
  39. nautobot/core/graphql/types.py +1 -1
  40. nautobot/core/jobs/__init__.py +7 -28
  41. nautobot/core/jobs/cleanup.py +12 -48
  42. nautobot/core/jobs/groups.py +1 -1
  43. nautobot/core/management/commands/validate_models.py +1 -1
  44. nautobot/core/models/__init__.py +1 -1
  45. nautobot/core/models/query_functions.py +2 -2
  46. nautobot/core/models/tree_queries.py +3 -6
  47. nautobot/core/settings.py +2 -29
  48. nautobot/core/settings.yaml +0 -21
  49. nautobot/core/tables.py +60 -74
  50. nautobot/core/templates/inc/media.html +0 -3
  51. nautobot/core/templates/inc/nav_menu.html +0 -1
  52. nautobot/core/templates/nautobot_config.py.j2 +0 -13
  53. nautobot/core/templates/search.html +0 -7
  54. nautobot/core/templates/utilities/render_jinja2.html +1 -1
  55. nautobot/core/templates/utilities/templatetags/tag.html +1 -1
  56. nautobot/core/templates/utilities/theme_preview.html +0 -7
  57. nautobot/core/templatetags/helpers.py +2 -11
  58. nautobot/core/testing/__init__.py +8 -8
  59. nautobot/core/testing/api.py +15 -170
  60. nautobot/core/testing/filters.py +2 -25
  61. nautobot/core/testing/forms.py +0 -2
  62. nautobot/core/testing/mixins.py +2 -7
  63. nautobot/core/testing/views.py +29 -44
  64. nautobot/core/tests/integration/test_app_home.py +1 -0
  65. nautobot/core/tests/integration/test_app_navbar.py +1 -0
  66. nautobot/core/tests/integration/test_filters.py +2 -0
  67. nautobot/core/tests/integration/test_home.py +1 -0
  68. nautobot/core/tests/integration/test_navbar.py +1 -0
  69. nautobot/core/tests/integration/test_view_authentication.py +0 -1
  70. nautobot/core/tests/runner.py +1 -1
  71. nautobot/core/tests/test_api.py +1 -98
  72. nautobot/core/tests/test_csv.py +3 -25
  73. nautobot/core/tests/test_forms.py +0 -1
  74. nautobot/core/tests/test_jobs.py +1 -303
  75. nautobot/core/tests/test_settings_schema.py +0 -7
  76. nautobot/core/tests/test_tables.py +0 -100
  77. nautobot/core/tests/test_utils.py +1 -63
  78. nautobot/core/tests/test_views.py +3 -30
  79. nautobot/core/ui/nav.py +0 -1
  80. nautobot/core/ui/object_detail.py +1 -15
  81. nautobot/core/urls.py +0 -11
  82. nautobot/core/utils/lookup.py +8 -11
  83. nautobot/core/utils/requests.py +9 -24
  84. nautobot/core/views/__init__.py +0 -42
  85. nautobot/core/views/generic.py +176 -78
  86. nautobot/core/views/mixins.py +34 -94
  87. nautobot/core/views/renderers.py +6 -6
  88. nautobot/dcim/api/serializers.py +62 -54
  89. nautobot/dcim/api/views.py +113 -47
  90. nautobot/dcim/filters/__init__.py +2 -31
  91. nautobot/dcim/forms.py +17 -36
  92. nautobot/dcim/graphql/types.py +2 -2
  93. nautobot/dcim/models/__init__.py +1 -1
  94. nautobot/dcim/models/device_component_templates.py +2 -2
  95. nautobot/dcim/models/device_components.py +20 -22
  96. nautobot/dcim/models/devices.py +1 -10
  97. nautobot/dcim/models/locations.py +3 -3
  98. nautobot/dcim/models/power.py +5 -6
  99. nautobot/dcim/models/racks.py +4 -4
  100. nautobot/dcim/tables/__init__.py +3 -3
  101. nautobot/dcim/tables/devices.py +5 -7
  102. nautobot/dcim/tables/devicetypes.py +2 -2
  103. nautobot/dcim/tables/racks.py +1 -1
  104. nautobot/dcim/templates/dcim/controller_create.html +7 -1
  105. nautobot/dcim/templates/dcim/controller_retrieve.html +9 -1
  106. nautobot/dcim/templates/dcim/controllermanageddevicegroup_create.html +0 -2
  107. nautobot/dcim/templates/dcim/controllermanageddevicegroup_retrieve.html +0 -5
  108. nautobot/dcim/templates/dcim/device.html +9 -1
  109. nautobot/dcim/templates/dcim/device_edit.html +37 -36
  110. nautobot/dcim/templates/dcim/location.html +9 -1
  111. nautobot/dcim/templates/dcim/location_edit.html +7 -1
  112. nautobot/dcim/templates/dcim/rack.html +9 -1
  113. nautobot/dcim/templates/dcim/rack_edit.html +7 -1
  114. nautobot/dcim/templates/dcim/rackreservation.html +9 -1
  115. nautobot/dcim/templates/dcim/virtualdevicecontext_retrieve.html +9 -1
  116. nautobot/dcim/templates/dcim/virtualdevicecontext_update.html +7 -1
  117. nautobot/dcim/tests/test_api.py +3 -16
  118. nautobot/dcim/tests/test_filters.py +0 -33
  119. nautobot/dcim/tests/test_forms.py +2 -51
  120. nautobot/dcim/tests/test_graphql.py +0 -52
  121. nautobot/dcim/tests/test_models.py +5 -34
  122. nautobot/dcim/tests/test_views.py +83 -21
  123. nautobot/dcim/views.py +13 -1
  124. nautobot/extras/api/customfields.py +2 -2
  125. nautobot/extras/api/serializers.py +85 -90
  126. nautobot/extras/api/views.py +27 -22
  127. nautobot/extras/constants.py +0 -2
  128. nautobot/extras/filters/__init__.py +6 -8
  129. nautobot/extras/forms/base.py +2 -2
  130. nautobot/extras/forms/forms.py +31 -139
  131. nautobot/extras/forms/mixins.py +5 -13
  132. nautobot/extras/group_sync.py +3 -3
  133. nautobot/extras/health_checks.py +2 -1
  134. nautobot/extras/jobs.py +12 -70
  135. nautobot/extras/managers.py +1 -3
  136. nautobot/extras/migrations/0018_joblog_data_migration.py +9 -7
  137. nautobot/extras/models/__init__.py +1 -1
  138. nautobot/extras/models/contacts.py +1 -1
  139. nautobot/extras/models/customfields.py +11 -12
  140. nautobot/extras/models/groups.py +9 -11
  141. nautobot/extras/models/jobs.py +4 -23
  142. nautobot/extras/models/models.py +2 -2
  143. nautobot/extras/plugins/__init__.py +2 -13
  144. nautobot/extras/plugins/marketplace_manifest.yml +79 -84
  145. nautobot/extras/plugins/tables.py +14 -16
  146. nautobot/extras/plugins/views.py +69 -65
  147. nautobot/extras/registry.py +1 -1
  148. nautobot/extras/secrets/__init__.py +2 -2
  149. nautobot/extras/tables.py +5 -7
  150. nautobot/extras/templates/extras/dynamicgroup.html +9 -1
  151. nautobot/extras/templates/extras/job_detail.html +0 -16
  152. nautobot/extras/templates/extras/job_edit.html +0 -1
  153. nautobot/extras/templates/extras/jobqueue_retrieve.html +9 -1
  154. nautobot/extras/templates/extras/marketplace.html +11 -29
  155. nautobot/extras/templates/extras/plugin_detail.html +15 -32
  156. nautobot/extras/templates/extras/plugins_tiles.html +10 -21
  157. nautobot/extras/test_jobs/api_test_job.py +1 -1
  158. nautobot/extras/test_jobs/atomic_transaction.py +2 -2
  159. nautobot/extras/test_jobs/dry_run.py +1 -1
  160. nautobot/extras/test_jobs/fail.py +5 -5
  161. nautobot/extras/test_jobs/file_output.py +1 -1
  162. nautobot/extras/test_jobs/file_upload_fail.py +1 -1
  163. nautobot/extras/test_jobs/file_upload_pass.py +1 -1
  164. nautobot/extras/test_jobs/ipaddress_vars.py +1 -3
  165. nautobot/extras/test_jobs/jobs_module/jobs_submodule/jobs.py +1 -1
  166. nautobot/extras/test_jobs/location_with_custom_field.py +1 -1
  167. nautobot/extras/test_jobs/log_redaction.py +1 -1
  168. nautobot/extras/test_jobs/log_skip_db_logging.py +1 -1
  169. nautobot/extras/test_jobs/modify_db.py +1 -1
  170. nautobot/extras/test_jobs/object_var_optional.py +1 -1
  171. nautobot/extras/test_jobs/object_var_required.py +1 -1
  172. nautobot/extras/test_jobs/object_vars.py +1 -1
  173. nautobot/extras/test_jobs/pass.py +3 -3
  174. nautobot/extras/test_jobs/profiling.py +1 -1
  175. nautobot/extras/test_jobs/relative_import.py +3 -3
  176. nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py +1 -1
  177. nautobot/extras/test_jobs/task_queues.py +1 -1
  178. nautobot/extras/tests/integration/test_plugin_banner.py +2 -0
  179. nautobot/extras/tests/test_api.py +13 -13
  180. nautobot/extras/tests/test_customfields.py +1 -1
  181. nautobot/extras/tests/test_datasources.py +1 -2
  182. nautobot/extras/tests/test_dynamicgroups.py +1 -1
  183. nautobot/extras/tests/test_filters.py +6 -6
  184. nautobot/extras/tests/test_forms.py +1 -20
  185. nautobot/extras/tests/test_jobs.py +19 -160
  186. nautobot/extras/tests/test_models.py +10 -10
  187. nautobot/extras/tests/test_plugins.py +9 -62
  188. nautobot/extras/tests/test_relationships.py +9 -120
  189. nautobot/extras/tests/test_views.py +191 -52
  190. nautobot/extras/utils.py +2 -3
  191. nautobot/extras/views.py +98 -30
  192. nautobot/ipam/api/fields.py +3 -3
  193. nautobot/ipam/api/serializers.py +33 -41
  194. nautobot/ipam/api/views.py +117 -68
  195. nautobot/ipam/factory.py +1 -1
  196. nautobot/ipam/filters.py +2 -3
  197. nautobot/ipam/lookups.py +62 -101
  198. nautobot/ipam/models.py +16 -66
  199. nautobot/ipam/querysets.py +2 -2
  200. nautobot/ipam/tables.py +7 -23
  201. nautobot/ipam/templates/ipam/ipaddress.html +9 -1
  202. nautobot/ipam/templates/ipam/ipaddress_bulk_add.html +7 -1
  203. nautobot/ipam/templates/ipam/ipaddress_edit.html +7 -1
  204. nautobot/ipam/templates/ipam/prefix.html +9 -1
  205. nautobot/ipam/templates/ipam/prefix_edit.html +7 -1
  206. nautobot/ipam/templates/ipam/vlan.html +9 -1
  207. nautobot/ipam/templates/ipam/vlan_edit.html +7 -1
  208. nautobot/ipam/templates/ipam/vrf_edit.html +7 -1
  209. nautobot/ipam/tests/test_api.py +3 -416
  210. nautobot/ipam/tests/test_forms.py +47 -49
  211. nautobot/ipam/tests/test_migrations.py +30 -30
  212. nautobot/ipam/tests/test_models.py +34 -95
  213. nautobot/ipam/tests/test_querysets.py +1 -63
  214. nautobot/ipam/tests/test_views.py +0 -3
  215. nautobot/ipam/utils/__init__.py +6 -36
  216. nautobot/ipam/views.py +87 -61
  217. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.css.map +1 -1
  218. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.min.css.map +1 -1
  219. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css +2 -40
  220. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css.map +1 -1
  221. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css +1 -1
  222. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css.map +1 -1
  223. nautobot/project-static/docs/404.html +4 -46
  224. nautobot/project-static/docs/apps/index.html +4 -46
  225. nautobot/project-static/docs/apps/nautobot-apps.html +6 -47
  226. nautobot/project-static/docs/assets/_mkdocstrings.css +1 -25
  227. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js → bundle.83f73b43.min.js} +2 -2
  228. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js.map → bundle.83f73b43.min.js.map} +2 -2
  229. nautobot/project-static/docs/code-reference/nautobot/apps/__init__.html +10 -62
  230. nautobot/project-static/docs/code-reference/nautobot/apps/admin.html +7 -59
  231. nautobot/project-static/docs/code-reference/nautobot/apps/api.html +122 -374
  232. nautobot/project-static/docs/code-reference/nautobot/apps/change_logging.html +18 -90
  233. nautobot/project-static/docs/code-reference/nautobot/apps/choices.html +21 -95
  234. nautobot/project-static/docs/code-reference/nautobot/apps/config.html +6 -53
  235. nautobot/project-static/docs/code-reference/nautobot/apps/constants.html +5 -52
  236. nautobot/project-static/docs/code-reference/nautobot/apps/datasources.html +17 -79
  237. nautobot/project-static/docs/code-reference/nautobot/apps/events.html +28 -102
  238. nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.html +21 -108
  239. nautobot/project-static/docs/code-reference/nautobot/apps/factory.html +38 -131
  240. nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +65 -239
  241. nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +165 -581
  242. nautobot/project-static/docs/code-reference/nautobot/apps/graphql.html +36 -109
  243. nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html +167 -453
  244. nautobot/project-static/docs/code-reference/nautobot/apps/models.html +211 -493
  245. nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html +8 -60
  246. nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html +15 -71
  247. nautobot/project-static/docs/code-reference/nautobot/apps/tables.html +55 -407
  248. nautobot/project-static/docs/code-reference/nautobot/apps/testing.html +205 -585
  249. nautobot/project-static/docs/code-reference/nautobot/apps/ui.html +412 -858
  250. nautobot/project-static/docs/code-reference/nautobot/apps/urls.html +7 -59
  251. nautobot/project-static/docs/code-reference/nautobot/apps/utils.html +186 -448
  252. nautobot/project-static/docs/code-reference/nautobot/apps/views.html +147 -365
  253. nautobot/project-static/docs/development/apps/api/configuration-view.html +4 -46
  254. nautobot/project-static/docs/development/apps/api/database-backend-config.html +4 -46
  255. nautobot/project-static/docs/development/apps/api/models/django-admin.html +4 -46
  256. nautobot/project-static/docs/development/apps/api/models/global-search.html +4 -46
  257. nautobot/project-static/docs/development/apps/api/models/graphql.html +4 -46
  258. nautobot/project-static/docs/development/apps/api/models/index.html +4 -46
  259. nautobot/project-static/docs/development/apps/api/nautobot-app-config.html +4 -46
  260. nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +4 -46
  261. nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +4 -46
  262. nautobot/project-static/docs/development/apps/api/platform-features/git-repository-content.html +4 -46
  263. nautobot/project-static/docs/development/apps/api/platform-features/index.html +4 -46
  264. nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +4 -46
  265. nautobot/project-static/docs/development/apps/api/platform-features/jobs.html +4 -46
  266. nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +4 -46
  267. nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +4 -46
  268. nautobot/project-static/docs/development/apps/api/platform-features/table-extensions.html +7 -68
  269. nautobot/project-static/docs/development/apps/api/platform-features/uniquely-identify-objects.html +4 -46
  270. nautobot/project-static/docs/development/apps/api/prometheus.html +4 -46
  271. nautobot/project-static/docs/development/apps/api/setup.html +4 -46
  272. nautobot/project-static/docs/development/apps/api/testing.html +4 -46
  273. nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +4 -46
  274. nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +4 -46
  275. nautobot/project-static/docs/development/apps/api/ui-extensions/index.html +4 -46
  276. nautobot/project-static/docs/development/apps/api/ui-extensions/navigation.html +4 -46
  277. nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +4 -46
  278. nautobot/project-static/docs/development/apps/api/views/base-template.html +4 -46
  279. nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +4 -46
  280. nautobot/project-static/docs/development/apps/api/views/django-generic-views.html +4 -46
  281. nautobot/project-static/docs/development/apps/api/views/help-documentation.html +4 -46
  282. nautobot/project-static/docs/development/apps/api/views/index.html +4 -46
  283. nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +4 -46
  284. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +4 -46
  285. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +4 -46
  286. nautobot/project-static/docs/development/apps/api/views/notes.html +4 -46
  287. nautobot/project-static/docs/development/apps/api/views/rest-api.html +6 -52
  288. nautobot/project-static/docs/development/apps/api/views/urls.html +4 -46
  289. nautobot/project-static/docs/development/apps/index.html +4 -46
  290. nautobot/project-static/docs/development/apps/migration/code-updates.html +4 -46
  291. nautobot/project-static/docs/development/apps/migration/dependency-updates.html +4 -46
  292. nautobot/project-static/docs/development/apps/migration/from-v1.html +4 -46
  293. nautobot/project-static/docs/development/apps/migration/model-updates/dcim.html +4 -46
  294. nautobot/project-static/docs/development/apps/migration/model-updates/extras.html +4 -46
  295. nautobot/project-static/docs/development/apps/migration/model-updates/global.html +4 -46
  296. nautobot/project-static/docs/development/apps/migration/model-updates/ipam.html +4 -46
  297. nautobot/project-static/docs/development/apps/migration/ui-component-framework/best-practices.html +8 -50
  298. nautobot/project-static/docs/development/apps/migration/ui-component-framework/custom-content.html +4 -46
  299. nautobot/project-static/docs/development/apps/migration/ui-component-framework/index.html +14 -211
  300. nautobot/project-static/docs/development/apps/migration/ui-component-framework/migration-steps.html +4 -46
  301. nautobot/project-static/docs/development/apps/porting-from-netbox.html +4 -46
  302. nautobot/project-static/docs/development/core/application-registry.html +4 -46
  303. nautobot/project-static/docs/development/core/best-practices.html +4 -46
  304. nautobot/project-static/docs/development/core/bootstrap-ui.html +4 -46
  305. nautobot/project-static/docs/development/core/caching.html +4 -46
  306. nautobot/project-static/docs/development/core/controllers.html +4 -46
  307. nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +74 -73
  308. nautobot/project-static/docs/development/core/generic-views.html +4 -46
  309. nautobot/project-static/docs/development/core/getting-started.html +224 -249
  310. nautobot/project-static/docs/development/core/homepage.html +7 -49
  311. nautobot/project-static/docs/development/core/index.html +4 -46
  312. nautobot/project-static/docs/development/core/{minikube-dev-environment-for-k8s-jobs.html → local-k8s.html} +168 -469
  313. nautobot/project-static/docs/development/core/model-checklist.html +12 -56
  314. nautobot/project-static/docs/development/core/model-features.html +4 -46
  315. nautobot/project-static/docs/development/core/natural-keys.html +4 -46
  316. nautobot/project-static/docs/development/core/navigation-menu.html +4 -46
  317. nautobot/project-static/docs/development/core/release-checklist.html +7 -49
  318. nautobot/project-static/docs/development/core/role-internals.html +4 -46
  319. nautobot/project-static/docs/development/core/settings.html +4 -46
  320. nautobot/project-static/docs/development/core/style-guide.html +7 -49
  321. nautobot/project-static/docs/development/core/templates.html +4 -46
  322. nautobot/project-static/docs/development/core/testing.html +4 -46
  323. nautobot/project-static/docs/development/core/ui-component-framework.html +273 -369
  324. nautobot/project-static/docs/development/core/user-preferences.html +4 -46
  325. nautobot/project-static/docs/development/index.html +4 -46
  326. nautobot/project-static/docs/development/jobs/index.html +122 -216
  327. nautobot/project-static/docs/development/jobs/migration/from-v1.html +4 -46
  328. nautobot/project-static/docs/index.html +23 -54
  329. nautobot/project-static/docs/objects.inv +0 -0
  330. nautobot/project-static/docs/overview/application_stack.html +7 -47
  331. nautobot/project-static/docs/overview/design_philosophy.html +4 -46
  332. nautobot/project-static/docs/release-notes/index.html +12 -52
  333. nautobot/project-static/docs/release-notes/version-1.0.html +193 -234
  334. nautobot/project-static/docs/release-notes/version-1.1.html +190 -231
  335. nautobot/project-static/docs/release-notes/version-1.2.html +265 -306
  336. nautobot/project-static/docs/release-notes/version-1.3.html +291 -332
  337. nautobot/project-static/docs/release-notes/version-1.4.html +377 -417
  338. nautobot/project-static/docs/release-notes/version-1.5.html +566 -605
  339. nautobot/project-static/docs/release-notes/version-1.6.html +447 -904
  340. nautobot/project-static/docs/release-notes/version-2.0.html +489 -528
  341. nautobot/project-static/docs/release-notes/version-2.1.html +324 -363
  342. nautobot/project-static/docs/release-notes/version-2.2.html +317 -356
  343. nautobot/project-static/docs/release-notes/version-2.3.html +352 -997
  344. nautobot/project-static/docs/release-notes/version-2.4.html +101 -417
  345. nautobot/project-static/docs/requirements.txt +2 -2
  346. nautobot/project-static/docs/search/search_index.json +1 -1
  347. nautobot/project-static/docs/sitemap.xml +287 -295
  348. nautobot/project-static/docs/sitemap.xml.gz +0 -0
  349. nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html +4 -46
  350. nautobot/project-static/docs/user-guide/administration/configuration/authentication/remote.html +4 -46
  351. nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html +6 -48
  352. nautobot/project-static/docs/user-guide/administration/configuration/index.html +4 -46
  353. nautobot/project-static/docs/user-guide/administration/configuration/redis.html +4 -46
  354. nautobot/project-static/docs/user-guide/administration/configuration/settings.html +8 -110
  355. nautobot/project-static/docs/user-guide/administration/configuration/time-zones.html +4 -46
  356. nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html +4 -46
  357. nautobot/project-static/docs/user-guide/administration/guides/docker.html +4 -46
  358. nautobot/project-static/docs/user-guide/administration/guides/health-checks.html +4 -46
  359. nautobot/project-static/docs/user-guide/administration/guides/permissions.html +4 -46
  360. nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html +4 -46
  361. nautobot/project-static/docs/user-guide/administration/guides/replicating-nautobot.html +4 -46
  362. nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html +4 -46
  363. nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html +6 -48
  364. nautobot/project-static/docs/user-guide/administration/guides/selinux-troubleshooting.html +4 -46
  365. nautobot/project-static/docs/user-guide/administration/installation/app-install.html +4 -46
  366. nautobot/project-static/docs/user-guide/administration/installation/external-authentication.html +4 -46
  367. nautobot/project-static/docs/user-guide/administration/installation/http-server.html +8 -66
  368. nautobot/project-static/docs/user-guide/administration/installation/index.html +4 -46
  369. nautobot/project-static/docs/user-guide/administration/installation/install_system.html +5 -47
  370. nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +4 -46
  371. nautobot/project-static/docs/user-guide/administration/installation/services.html +4 -46
  372. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-netbox.html +4 -46
  373. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +4 -46
  374. nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +4 -46
  375. nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html +4 -46
  376. nautobot/project-static/docs/user-guide/administration/upgrading/database-backup.html +4 -46
  377. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/after-you-upgrade.html +4 -46
  378. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/before-you-upgrade.html +4 -46
  379. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/for-developers.html +4 -46
  380. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/index.html +4 -46
  381. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/whats-changed.html +8 -49
  382. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/region-and-site-data-migration-guide.html +4 -46
  383. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +4 -46
  384. nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +4 -46
  385. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuit.html +4 -46
  386. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittermination.html +4 -46
  387. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittype.html +4 -46
  388. nautobot/project-static/docs/user-guide/core-data-model/circuits/provider.html +4 -46
  389. nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +4 -46
  390. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloud.html +4 -46
  391. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudaccount.html +4 -46
  392. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetwork.html +4 -46
  393. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetworkprefixassignment.html +4 -46
  394. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudresourcetype.html +4 -46
  395. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservice.html +4 -46
  396. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservicenetworkassignment.html +4 -46
  397. nautobot/project-static/docs/user-guide/core-data-model/dcim/cable.html +4 -46
  398. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +4 -46
  399. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +4 -46
  400. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +4 -46
  401. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +4 -46
  402. nautobot/project-static/docs/user-guide/core-data-model/dcim/controller.html +4 -46
  403. nautobot/project-static/docs/user-guide/core-data-model/dcim/controllermanageddevicegroup.html +4 -46
  404. nautobot/project-static/docs/user-guide/core-data-model/dcim/device.html +4 -46
  405. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +4 -46
  406. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +4 -46
  407. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicefamily.html +4 -46
  408. nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +4 -46
  409. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +4 -46
  410. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +4 -46
  411. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +4 -46
  412. nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +4 -46
  413. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +4 -46
  414. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +4 -46
  415. nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +4 -46
  416. nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +4 -46
  417. nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +4 -46
  418. nautobot/project-static/docs/user-guide/core-data-model/dcim/manufacturer.html +4 -46
  419. nautobot/project-static/docs/user-guide/core-data-model/dcim/module.html +4 -46
  420. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebay.html +4 -46
  421. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebaytemplate.html +4 -46
  422. nautobot/project-static/docs/user-guide/core-data-model/dcim/moduletype.html +4 -46
  423. nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +4 -46
  424. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerfeed.html +4 -46
  425. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +4 -46
  426. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +4 -46
  427. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerpanel.html +4 -46
  428. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +4 -46
  429. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +4 -46
  430. nautobot/project-static/docs/user-guide/core-data-model/dcim/rack.html +4 -46
  431. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackgroup.html +4 -46
  432. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackreservation.html +4 -46
  433. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +4 -46
  434. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +4 -46
  435. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareimagefile.html +4 -46
  436. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareversion.html +4 -46
  437. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualchassis.html +4 -46
  438. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualdevicecontext.html +4 -46
  439. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +12 -50
  440. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +4 -46
  441. nautobot/project-static/docs/user-guide/core-data-model/extras/contact.html +4 -46
  442. nautobot/project-static/docs/user-guide/core-data-model/extras/team.html +4 -46
  443. nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +4 -46
  444. nautobot/project-static/docs/user-guide/core-data-model/ipam/namespace.html +4 -46
  445. nautobot/project-static/docs/user-guide/core-data-model/ipam/prefix.html +4 -46
  446. nautobot/project-static/docs/user-guide/core-data-model/ipam/rir.html +4 -46
  447. nautobot/project-static/docs/user-guide/core-data-model/ipam/routetarget.html +4 -46
  448. nautobot/project-static/docs/user-guide/core-data-model/ipam/service.html +4 -46
  449. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +4 -46
  450. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +4 -46
  451. nautobot/project-static/docs/user-guide/core-data-model/ipam/vrf.html +4 -46
  452. nautobot/project-static/docs/user-guide/core-data-model/overview/introduction.html +7 -49
  453. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenant.html +4 -46
  454. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenantgroup.html +4 -46
  455. nautobot/project-static/docs/user-guide/core-data-model/virtualization/cluster.html +4 -46
  456. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustergroup.html +4 -46
  457. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustertype.html +4 -46
  458. nautobot/project-static/docs/user-guide/core-data-model/virtualization/virtualmachine.html +4 -46
  459. nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +4 -46
  460. nautobot/project-static/docs/user-guide/core-data-model/wireless/index.html +4 -46
  461. nautobot/project-static/docs/user-guide/core-data-model/wireless/radioprofile.html +4 -46
  462. nautobot/project-static/docs/user-guide/core-data-model/wireless/supporteddatarate.html +4 -46
  463. nautobot/project-static/docs/user-guide/core-data-model/wireless/wirelessnetwork.html +4 -46
  464. nautobot/project-static/docs/user-guide/feature-guides/contacts-and-teams.html +4 -46
  465. nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +4 -46
  466. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-devices.html +4 -46
  467. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-location-types-and-locations.html +4 -46
  468. nautobot/project-static/docs/user-guide/feature-guides/getting-started/index.html +4 -46
  469. nautobot/project-static/docs/user-guide/feature-guides/getting-started/interfaces.html +4 -46
  470. nautobot/project-static/docs/user-guide/feature-guides/getting-started/ipam.html +4 -46
  471. nautobot/project-static/docs/user-guide/feature-guides/getting-started/platforms.html +4 -46
  472. nautobot/project-static/docs/user-guide/feature-guides/getting-started/search-bar.html +4 -46
  473. nautobot/project-static/docs/user-guide/feature-guides/getting-started/tenants.html +4 -46
  474. nautobot/project-static/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.html +4 -46
  475. nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html +7 -51
  476. nautobot/project-static/docs/user-guide/feature-guides/graphql.html +4 -46
  477. nautobot/project-static/docs/user-guide/feature-guides/ip-address-merge-tool.html +4 -46
  478. nautobot/project-static/docs/user-guide/feature-guides/relationships.html +4 -46
  479. nautobot/project-static/docs/user-guide/feature-guides/software-image-files-and-versions.html +7 -49
  480. nautobot/project-static/docs/user-guide/index.html +4 -46
  481. nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html +4 -46
  482. nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +8 -50
  483. nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +4 -46
  484. nautobot/project-static/docs/user-guide/platform-functionality/customlink.html +4 -46
  485. nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +4 -46
  486. nautobot/project-static/docs/user-guide/platform-functionality/events.html +4 -46
  487. nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html +4 -46
  488. nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html +4 -46
  489. nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +4 -46
  490. nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +4 -46
  491. nautobot/project-static/docs/user-guide/platform-functionality/graphqlquery.html +4 -46
  492. nautobot/project-static/docs/user-guide/platform-functionality/imageattachment.html +4 -46
  493. nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +7 -50
  494. nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +4 -46
  495. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +7 -49
  496. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +4 -46
  497. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobqueue.html +4 -46
  498. nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +4 -46
  499. nautobot/project-static/docs/user-guide/platform-functionality/napalm.html +4 -46
  500. nautobot/project-static/docs/user-guide/platform-functionality/note.html +4 -46
  501. nautobot/project-static/docs/user-guide/platform-functionality/objectmetadata.html +4 -46
  502. nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +5 -47
  503. nautobot/project-static/docs/user-guide/platform-functionality/rendering-jinja-templates.html +4 -46
  504. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +4 -46
  505. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +25 -94
  506. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +5 -74
  507. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html +4 -46
  508. nautobot/project-static/docs/user-guide/platform-functionality/role.html +4 -46
  509. nautobot/project-static/docs/user-guide/platform-functionality/savedview.html +4 -46
  510. nautobot/project-static/docs/user-guide/platform-functionality/secret.html +4 -46
  511. nautobot/project-static/docs/user-guide/platform-functionality/staticgroupassociation.html +4 -46
  512. nautobot/project-static/docs/user-guide/platform-functionality/status.html +4 -46
  513. nautobot/project-static/docs/user-guide/platform-functionality/tag.html +4 -46
  514. nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +4 -46
  515. nautobot/project-static/docs/user-guide/platform-functionality/users/objectpermission.html +4 -46
  516. nautobot/project-static/docs/user-guide/platform-functionality/users/token.html +4 -46
  517. nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +4 -46
  518. nautobot/project-static/js/forms.js +1 -1
  519. nautobot/tenancy/api/views.py +13 -9
  520. nautobot/tenancy/views.py +2 -4
  521. nautobot/users/admin.py +1 -1
  522. nautobot/users/api/serializers.py +4 -5
  523. nautobot/users/api/views.py +3 -3
  524. nautobot/virtualization/api/serializers.py +4 -4
  525. nautobot/virtualization/api/views.py +24 -5
  526. nautobot/virtualization/filters.py +3 -20
  527. nautobot/virtualization/models.py +1 -1
  528. nautobot/virtualization/tables.py +2 -2
  529. nautobot/virtualization/templates/virtualization/cluster_edit.html +7 -1
  530. nautobot/virtualization/templates/virtualization/virtualmachine.html +9 -1
  531. nautobot/virtualization/templates/virtualization/virtualmachine_edit.html +8 -2
  532. nautobot/virtualization/tests/test_filters.py +0 -17
  533. nautobot/wireless/filters.py +2 -2
  534. nautobot/wireless/forms.py +1 -1
  535. nautobot/wireless/templates/wireless/wirelessnetwork_retrieve.html +9 -1
  536. nautobot/wireless/tests/test_filters.py +1 -29
  537. nautobot/wireless/views.py +10 -0
  538. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/METADATA +6 -6
  539. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/RECORD +543 -591
  540. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/WHEEL +1 -1
  541. nautobot/core/api/constants.py +0 -11
  542. nautobot/core/jobs/bulk_actions.py +0 -248
  543. nautobot/core/templates/about.html +0 -67
  544. nautobot/core/templates/inc/tenancy_form_panel.html +0 -9
  545. nautobot/core/templates/inc/tenant_table_row.html +0 -11
  546. nautobot/core/utils/querysets.py +0 -64
  547. nautobot/dcim/migrations/0067_controllermanageddevicegroup_tenant.py +0 -25
  548. nautobot/dcim/tests/integration/test_controller.py +0 -62
  549. nautobot/dcim/tests/integration/test_controller_managed_device_group.py +0 -71
  550. nautobot/dcim/tests/test_jobs.py +0 -118
  551. nautobot/extras/migrations/0120_job_is_singleton_job_is_singleton_override.py +0 -22
  552. nautobot/extras/migrations/0121_alter_team_contacts.py +0 -17
  553. nautobot/extras/test_jobs/singleton.py +0 -16
  554. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit.png +0 -0
  555. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit_button.png +0 -0
  556. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_nav.png +0 -0
  557. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_view.png +0 -0
  558. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue.png +0 -0
  559. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_add.png +0 -0
  560. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_config.png +0 -0
  561. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_completed.png +0 -0
  562. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_nav.png +0 -0
  563. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_pending.png +0 -0
  564. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_run_form.png +0 -0
  565. nautobot/project-static/docs/media/development/core/kubernetes/k8s_nautobot_login.png +0 -0
  566. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_job.png +0 -0
  567. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_scheduled_job_form.png +0 -0
  568. nautobot/project-static/docs/media/development/core/kubernetes/k8s_scheduled_job_result.png +0 -0
  569. nautobot/project-static/docs/media/development/core/ui-component-framework/buttons-example.png +0 -0
  570. nautobot/project-static/docs/media/development/core/ui-component-framework/cluster-type-before-after-example.png +0 -0
  571. nautobot/project-static/docs/media/development/core/ui-component-framework/object-fields-panel-example_2.png +0 -0
  572. nautobot/project-static/docs/media/development/core/ui-component-framework/stats-panel-example-code.png +0 -0
  573. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/central-mode.png +0 -0
  574. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-add.png +0 -0
  575. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-1.png +0 -0
  576. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-2.png +0 -0
  577. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-add.png +0 -0
  578. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-create.png +0 -0
  579. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-add.png +0 -0
  580. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-create.png +0 -0
  581. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-add.png +0 -0
  582. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-1.png +0 -0
  583. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-2.png +0 -0
  584. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-add.png +0 -0
  585. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-create.png +0 -0
  586. nautobot/project-static/docs/user-guide/feature-guides/wireless-networks-and-controllers.html +0 -9444
  587. nautobot/project-static/docs/user-guide/platform-functionality/jobs/kubernetes-job-support.html +0 -9722
  588. nautobot/wireless/tests/integration/__init__.py +0 -0
  589. nautobot/wireless/tests/integration/test_radio_profile.py +0 -42
  590. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/LICENSE.txt +0 -0
  591. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/NOTICE +0 -0
  592. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/entry_points.txt +0 -0
@@ -18,7 +18,7 @@
18
18
 
19
19
 
20
20
  <link rel="icon" href="../../../assets/favicon.ico">
21
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
21
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
22
22
 
23
23
 
24
24
 
@@ -2112,27 +2112,6 @@
2112
2112
 
2113
2113
 
2114
2114
 
2115
-
2116
-
2117
-
2118
-
2119
-
2120
-
2121
- <li class="md-nav__item">
2122
- <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
2123
-
2124
-
2125
- <span class="md-ellipsis">
2126
- Wireless Networks and Controllers
2127
- </span>
2128
-
2129
-
2130
- </a>
2131
- </li>
2132
-
2133
-
2134
-
2135
-
2136
2115
  </ul>
2137
2116
  </nav>
2138
2117
 
@@ -5152,27 +5131,6 @@
5152
5131
 
5153
5132
 
5154
5133
 
5155
- <li class="md-nav__item">
5156
- <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
5157
-
5158
-
5159
- <span class="md-ellipsis">
5160
- Kubernetes Job Support
5161
- </span>
5162
-
5163
-
5164
- </a>
5165
- </li>
5166
-
5167
-
5168
-
5169
-
5170
-
5171
-
5172
-
5173
-
5174
-
5175
-
5176
5134
  <li class="md-nav__item">
5177
5135
  <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
5178
5136
 
@@ -8857,11 +8815,11 @@
8857
8815
 
8858
8816
 
8859
8817
  <li class="md-nav__item">
8860
- <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
8818
+ <a href="../../../development/core/local-k8s.html" class="md-nav__link">
8861
8819
 
8862
8820
 
8863
8821
  <span class="md-ellipsis">
8864
- Minikube Dev Environment for K8s Jobs
8822
+ Local Kubernetes Cluster
8865
8823
  </span>
8866
8824
 
8867
8825
 
@@ -10518,12 +10476,7 @@
10518
10476
 
10519
10477
  <div class="doc doc-contents first">
10520
10478
 
10521
- <p>Nautobot utility functions.</p>
10522
-
10523
-
10524
-
10525
-
10526
-
10479
+ <p>Nautobot utility functions.</p>
10527
10480
 
10528
10481
 
10529
10482
 
@@ -10549,15 +10502,10 @@
10549
10502
 
10550
10503
  <div class="doc doc-contents ">
10551
10504
  <p class="doc doc-class-bases">
10552
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
10553
-
10554
-
10555
- <p>Helper class to get ContentType for models that implements the to_objectchange method for change logging.</p>
10556
-
10557
-
10558
-
10505
+ Bases: <code><autoref identifier="nautobot.extras.utils.FeaturedQueryMixin" optional hover>FeaturedQueryMixin</autoref></code></p>
10559
10506
 
10560
10507
 
10508
+ <p>Helper class to get ContentType for models that implements the to_objectchange method for change logging.</p>
10561
10509
 
10562
10510
 
10563
10511
 
@@ -10583,7 +10531,7 @@
10583
10531
 
10584
10532
  <div class="doc doc-contents ">
10585
10533
 
10586
- <p>Return a list of classes that implement the to_objectchange method</p>
10534
+ <p>Return a list of classes that implement the to_objectchange method</p>
10587
10535
 
10588
10536
  </div>
10589
10537
 
@@ -10611,17 +10559,12 @@
10611
10559
  <div class="doc doc-contents ">
10612
10560
 
10613
10561
 
10614
- <p>Helper class that delays evaluation of the registry contents for the functionality store
10562
+ <p>Helper class that delays evaluation of the registry contents for the functionality store
10615
10563
  until it has been populated.</p>
10616
10564
 
10617
10565
 
10618
10566
 
10619
10567
 
10620
-
10621
-
10622
-
10623
-
10624
-
10625
10568
  <div class="doc doc-children">
10626
10569
 
10627
10570
 
@@ -10643,7 +10586,7 @@ until it has been populated.</p>
10643
10586
 
10644
10587
  <div class="doc doc-contents ">
10645
10588
 
10646
- <p>Given an extras feature, return a iterable of app_label: [models] for content type lookup.</p>
10589
+ <p>Given an extras feature, return a iterable of app_label: [models] for content type lookup.</p>
10647
10590
  <p>Misnamed, as it returns an iterable of (key, value) (i.e. dict.items()) rather than an actual dict.</p>
10648
10591
  <p>Raises a KeyError if the given feature doesn't exist.</p>
10649
10592
 
@@ -10662,7 +10605,7 @@ until it has been populated.</p>
10662
10605
 
10663
10606
  <div class="doc doc-contents ">
10664
10607
 
10665
- <p>Given an extras feature, return a list of 2-tuple of <code>(model_label, pk)</code>
10608
+ <p>Given an extras feature, return a list of 2-tuple of <code>(model_label, pk)</code>
10666
10609
  suitable for use as <code>choices</code> on a choice field:</p>
10667
10610
  <div class="highlight"><pre><span></span><code>&gt;&gt;&gt; FeatureQuery(&#39;statuses&#39;).get_choices()
10668
10611
  [(&#39;dcim.device&#39;, 13), (&#39;dcim.rack&#39;, 34)]
@@ -10684,7 +10627,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10684
10627
 
10685
10628
  <div class="doc doc-contents ">
10686
10629
 
10687
- <p>Given an extras feature, return a Q object for content type lookup</p>
10630
+ <p>Given an extras feature, return a Q object for content type lookup</p>
10688
10631
 
10689
10632
  </div>
10690
10633
 
@@ -10701,7 +10644,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10701
10644
 
10702
10645
  <div class="doc doc-contents ">
10703
10646
 
10704
- <p>Return a list of model classes that declare this feature.</p>
10647
+ <p>Return a list of model classes that declare this feature.</p>
10705
10648
  <p>Cache is cleared by post_migrate signal (nautobot.extras.signals.post_migrate_clear_content_type_caches).</p>
10706
10649
 
10707
10650
  </div>
@@ -10730,12 +10673,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10730
10673
  <div class="doc doc-contents ">
10731
10674
 
10732
10675
 
10733
- <p>Mixin class that gets a list of featured models.</p>
10734
-
10735
-
10736
-
10737
-
10738
-
10676
+ <p>Mixin class that gets a list of featured models.</p>
10739
10677
 
10740
10678
 
10741
10679
 
@@ -10761,7 +10699,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10761
10699
 
10762
10700
  <div class="doc doc-contents ">
10763
10701
 
10764
- <p>Given an extras feature, return a Q object for content type lookup</p>
10702
+ <p>Given an extras feature, return a Q object for content type lookup</p>
10765
10703
 
10766
10704
  </div>
10767
10705
 
@@ -10778,7 +10716,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10778
10716
 
10779
10717
  <div class="doc doc-contents ">
10780
10718
 
10781
- <p>Return a list of classes that has implements this <code>name</code>.</p>
10719
+ <p>Return a list of classes that has implements this <code>name</code>.</p>
10782
10720
 
10783
10721
  </div>
10784
10722
 
@@ -10809,11 +10747,6 @@ suitable for use as <code>choices</code> on a choice field:</p>
10809
10747
 
10810
10748
 
10811
10749
 
10812
-
10813
-
10814
-
10815
-
10816
-
10817
10750
  <div class="doc doc-children">
10818
10751
 
10819
10752
 
@@ -10838,7 +10771,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10838
10771
 
10839
10772
  <div class="doc doc-contents ">
10840
10773
 
10841
- <p>Current checked out repository head commit.</p>
10774
+ <p>Current checked out repository head commit.</p>
10842
10775
  </div>
10843
10776
 
10844
10777
  </div>
@@ -10856,7 +10789,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10856
10789
 
10857
10790
  <div class="doc doc-contents ">
10858
10791
 
10859
- <p>Ensure that we have a clone of the given remote Git repository URL at the given local directory path.</p>
10792
+ <p>Ensure that we have a clone of the given remote Git repository URL at the given local directory path.</p>
10860
10793
 
10861
10794
 
10862
10795
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -10871,11 +10804,9 @@ suitable for use as <code>choices</code> on a choice field:</p>
10871
10804
  </thead>
10872
10805
  <tbody>
10873
10806
  <tr class="doc-section-item">
10807
+ <td><code>path</code></td>
10874
10808
  <td>
10875
- <code>path</code>
10876
- </td>
10877
- <td>
10878
- <code>str</code>
10809
+ <code><autoref identifier="str" optional>str</autoref></code>
10879
10810
  </td>
10880
10811
  <td>
10881
10812
  <div class="doc-md-description">
@@ -10887,11 +10818,9 @@ suitable for use as <code>choices</code> on a choice field:</p>
10887
10818
  </td>
10888
10819
  </tr>
10889
10820
  <tr class="doc-section-item">
10821
+ <td><code>url</code></td>
10890
10822
  <td>
10891
- <code>url</code>
10892
- </td>
10893
- <td>
10894
- <code>str</code>
10823
+ <code><autoref identifier="str" optional>str</autoref></code>
10895
10824
  </td>
10896
10825
  <td>
10897
10826
  <div class="doc-md-description">
@@ -10903,11 +10832,9 @@ suitable for use as <code>choices</code> on a choice field:</p>
10903
10832
  </td>
10904
10833
  </tr>
10905
10834
  <tr class="doc-section-item">
10835
+ <td><code>clone_initially</code></td>
10906
10836
  <td>
10907
- <code>clone_initially</code>
10908
- </td>
10909
- <td>
10910
- <code>bool</code>
10837
+ <code><autoref identifier="bool" optional>bool</autoref></code>
10911
10838
  </td>
10912
10839
  <td>
10913
10840
  <div class="doc-md-description">
@@ -10936,7 +10863,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10936
10863
 
10937
10864
  <div class="doc doc-contents ">
10938
10865
 
10939
- <p>Check out the given branch, and optionally the specified commit within that branch.</p>
10866
+ <p>Check out the given branch, and optionally the specified commit within that branch.</p>
10940
10867
 
10941
10868
 
10942
10869
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -10951,11 +10878,9 @@ suitable for use as <code>choices</code> on a choice field:</p>
10951
10878
  </thead>
10952
10879
  <tbody>
10953
10880
  <tr class="doc-section-item">
10881
+ <td><code>branch</code></td>
10954
10882
  <td>
10955
- <code>branch</code>
10956
- </td>
10957
- <td>
10958
- <code>str</code>
10883
+ <code><autoref identifier="str" optional>str</autoref></code>
10959
10884
  </td>
10960
10885
  <td>
10961
10886
  <div class="doc-md-description">
@@ -10967,11 +10892,9 @@ suitable for use as <code>choices</code> on a choice field:</p>
10967
10892
  </td>
10968
10893
  </tr>
10969
10894
  <tr class="doc-section-item">
10895
+ <td><code>commit_hexsha</code></td>
10970
10896
  <td>
10971
- <code>commit_hexsha</code>
10972
- </td>
10973
- <td>
10974
- <code>str</code>
10897
+ <code><autoref identifier="str" optional>str</autoref></code>
10975
10898
  </td>
10976
10899
  <td>
10977
10900
  <div class="doc-md-description">
@@ -10984,7 +10907,7 @@ suitable for use as <code>choices</code> on a choice field:</p>
10984
10907
  </tr>
10985
10908
  </tbody>
10986
10909
  </table>
10987
- <p>If <code>commit_hexsha</code> is specified and <code>branch</code> is either a tag or a commit identifier, they must match.
10910
+ <p>If <code>commit_hexsha</code> is specified and <code>branch</code> is either a tag or a commit identifier, they must match.
10988
10911
  If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch name, it must contain the specified commit.</p>
10989
10912
 
10990
10913
 
@@ -10999,7 +10922,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
10999
10922
  <tbody>
11000
10923
  <tr class="doc-section-item">
11001
10924
  <td>
11002
- <code>(str, bool)</code>
10925
+ <code>(<autoref identifier="str" optional>str</autoref>, <autoref identifier="bool" optional>bool</autoref>)</code>
11003
10926
  </td>
11004
10927
  <td>
11005
10928
  <div class="doc-md-description">
@@ -11035,15 +10958,10 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11035
10958
 
11036
10959
  <div class="doc doc-contents ">
11037
10960
  <p class="doc doc-class-bases">
11038
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
11039
-
11040
-
11041
- <p>Helper class to get ContentType models that implements role.</p>
11042
-
11043
-
11044
-
10961
+ Bases: <code><autoref identifier="nautobot.extras.utils.FeaturedQueryMixin" optional hover>FeaturedQueryMixin</autoref></code></p>
11045
10962
 
11046
10963
 
10964
+ <p>Helper class to get ContentType models that implements role.</p>
11047
10965
 
11048
10966
 
11049
10967
 
@@ -11069,7 +10987,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11069
10987
 
11070
10988
  <div class="doc doc-contents ">
11071
10989
 
11072
- <p>Return a list of classes that implements roles e.g roles = ...</p>
10990
+ <p>Return a list of classes that implements roles e.g roles = ...</p>
11073
10991
 
11074
10992
  </div>
11075
10993
 
@@ -11096,15 +11014,10 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11096
11014
 
11097
11015
  <div class="doc doc-contents ">
11098
11016
  <p class="doc doc-class-bases">
11099
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.utils.FeaturedQueryMixin" href="#nautobot.apps.utils.FeaturedQueryMixin">FeaturedQueryMixin</a></code></p>
11100
-
11101
-
11102
- <p>Helper class to get ContentType models that implements tags(TagsField)</p>
11103
-
11104
-
11105
-
11017
+ Bases: <code><autoref identifier="nautobot.extras.utils.FeaturedQueryMixin" optional hover>FeaturedQueryMixin</autoref></code></p>
11106
11018
 
11107
11019
 
11020
+ <p>Helper class to get ContentType models that implements tags(TagsField)</p>
11108
11021
 
11109
11022
 
11110
11023
 
@@ -11130,7 +11043,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11130
11043
 
11131
11044
  <div class="doc doc-contents ">
11132
11045
 
11133
- <p>Return a list of classes that has implements tags e.g tags = TagsField(...)</p>
11046
+ <p>Return a list of classes that has implements tags e.g tags = TagsField(...)</p>
11134
11047
 
11135
11048
  </div>
11136
11049
 
@@ -11156,7 +11069,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11156
11069
 
11157
11070
  <div class="doc doc-contents ">
11158
11071
 
11159
- <p>Return lookup expr with its verbose name</p>
11072
+ <p>Return lookup expr with its verbose name</p>
11160
11073
 
11161
11074
 
11162
11075
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -11171,11 +11084,9 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11171
11084
  </thead>
11172
11085
  <tbody>
11173
11086
  <tr class="doc-section-item">
11087
+ <td><code>field_name</code></td>
11174
11088
  <td>
11175
- <code>field_name</code>
11176
- </td>
11177
- <td>
11178
- <code>str</code>
11089
+ <code><autoref identifier="str" optional>str</autoref></code>
11179
11090
  </td>
11180
11091
  <td>
11181
11092
  <div class="doc-md-description">
@@ -11187,11 +11098,9 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11187
11098
  </td>
11188
11099
  </tr>
11189
11100
  <tr class="doc-section-item">
11101
+ <td><code>_verbose_name</code></td>
11190
11102
  <td>
11191
- <code>_verbose_name</code>
11192
- </td>
11193
- <td>
11194
- <code>str</code>
11103
+ <code><autoref identifier="str" optional>str</autoref></code>
11195
11104
  </td>
11196
11105
  <td>
11197
11106
  <div class="doc-md-description">
@@ -11226,7 +11135,7 @@ If <code>commit_hexsha</code> is specified and <code>branch</code> is a branch n
11226
11135
 
11227
11136
  <div class="doc doc-contents ">
11228
11137
 
11229
- <p>Helper method to check if a key field is Python/GraphQL safe.
11138
+ <p>Helper method to check if a key field is Python/GraphQL safe.
11230
11139
  Used in CustomField, ComputedField and Relationship models.</p>
11231
11140
 
11232
11141
  </div>
@@ -11244,7 +11153,7 @@ Used in CustomField, ComputedField and Relationship models.</p>
11244
11153
 
11245
11154
  <div class="doc doc-contents ">
11246
11155
 
11247
- <p>Decorator to mark a class as deprecated with a custom message about what to do instead of subclassing it.</p>
11156
+ <p>Decorator to mark a class as deprecated with a custom message about what to do instead of subclassing it.</p>
11248
11157
 
11249
11158
  </div>
11250
11159
 
@@ -11261,7 +11170,7 @@ Used in CustomField, ComputedField and Relationship models.</p>
11261
11170
 
11262
11171
  <div class="doc doc-contents ">
11263
11172
 
11264
- <p>Decorator to mark a class as deprecated and suggest a replacement class if it is subclassed from.</p>
11173
+ <p>Decorator to mark a class as deprecated and suggest a replacement class if it is subclassed from.</p>
11265
11174
 
11266
11175
  </div>
11267
11176
 
@@ -11278,7 +11187,7 @@ Used in CustomField, ComputedField and Relationship models.</p>
11278
11187
 
11279
11188
  <div class="doc doc-contents ">
11280
11189
 
11281
- <div class="highlight"><pre><span></span><code>Convert Git diff log into a list splitted by \n
11190
+ <div class="highlight"><pre><span></span><code>Convert Git diff log into a list splitted by \n
11282
11191
 
11283
11192
  Example:
11284
11193
  &gt;&gt;&gt; git_log = &quot;M index.html
@@ -11302,7 +11211,7 @@ Example:
11302
11211
 
11303
11212
  <div class="doc doc-contents ">
11304
11213
 
11305
- <p>Convert request QueryDict/GET into an acceptable factory formset QueryDict
11214
+ <p>Convert request QueryDict/GET into an acceptable factory formset QueryDict
11306
11215
  while discarding <code>querydict</code> params which are not part of <code>filterset_class</code> params</p>
11307
11216
 
11308
11217
 
@@ -11318,11 +11227,9 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11318
11227
  </thead>
11319
11228
  <tbody>
11320
11229
  <tr class="doc-section-item">
11230
+ <td><code>request_querydict</code></td>
11321
11231
  <td>
11322
- <code>request_querydict</code>
11323
- </td>
11324
- <td>
11325
- <code><span title="django.http.QueryDict">QueryDict</span></code>
11232
+ <code><autoref identifier="django.http.QueryDict" optional hover>QueryDict</autoref></code>
11326
11233
  </td>
11327
11234
  <td>
11328
11235
  <div class="doc-md-description">
@@ -11334,11 +11241,9 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11334
11241
  </td>
11335
11242
  </tr>
11336
11243
  <tr class="doc-section-item">
11244
+ <td><code>filterset</code></td>
11337
11245
  <td>
11338
- <code>filterset</code>
11339
- </td>
11340
- <td>
11341
- <code>FilterSet</code>
11246
+ <code><autoref identifier="FilterSet" optional>FilterSet</autoref></code>
11342
11247
  </td>
11343
11248
  <td>
11344
11249
  <div class="doc-md-description">
@@ -11384,7 +11289,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11384
11289
 
11385
11290
  <div class="doc doc-contents ">
11386
11291
 
11387
- <p>Decorator that wraps a models existing clean method to also execute registered plugin custom validators</p>
11292
+ <p>Decorator that wraps a models existing clean method to also execute registered plugin custom validators</p>
11388
11293
  <p>:param model_clean_func: The original model clean method which is to be wrapped</p>
11389
11294
 
11390
11295
  </div>
@@ -11402,7 +11307,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11402
11307
 
11403
11308
  <div class="doc doc-contents ">
11404
11309
 
11405
- <p>Deep merge two dictionaries (new into original) and return a new dict</p>
11310
+ <p>Deep merge two dictionaries (new into original) and return a new dict</p>
11406
11311
 
11407
11312
  </div>
11408
11313
 
@@ -11419,7 +11324,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11419
11324
 
11420
11325
  <div class="doc doc-contents ">
11421
11326
 
11422
- <p>Ensure <code>query_params</code> includes <code>content_type</code> and <code>field_name</code> and <code>content_type</code> is a valid ContentType.</p>
11327
+ <p>Ensure <code>query_params</code> includes <code>content_type</code> and <code>field_name</code> and <code>content_type</code> is a valid ContentType.</p>
11423
11328
  <p>Return the 'ContentTypes' model and 'field_name' if validation was successful.</p>
11424
11329
 
11425
11330
  </div>
@@ -11437,7 +11342,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11437
11342
 
11438
11343
  <div class="doc doc-contents ">
11439
11344
 
11440
- <p>For instances of model that have an invalid NULL status field, create and use a special status_model instance.</p>
11345
+ <p>For instances of model that have an invalid NULL status field, create and use a special status_model instance.</p>
11441
11346
 
11442
11347
  </div>
11443
11348
 
@@ -11454,7 +11359,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11454
11359
 
11455
11360
  <div class="doc doc-contents ">
11456
11361
 
11457
- <p>Flatten nested dictionaries into a single level by joining key names with a separator.</p>
11362
+ <p>Flatten nested dictionaries into a single level by joining key names with a separator.</p>
11458
11363
  <p>:param d: The dictionary to be flattened
11459
11364
  :param prefix: Initial prefix (if any)
11460
11365
  :param separator: The character to use when concatenating key names</p>
@@ -11474,7 +11379,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11474
11379
 
11475
11380
  <div class="doc doc-contents ">
11476
11381
 
11477
- <p>Flatten a nested iterable such as a list of lists, keeping strings intact.</p>
11382
+ <p>Flatten a nested iterable such as a list of lists, keeping strings intact.</p>
11478
11383
  <p>:param iterable: The iterable to be flattened
11479
11384
  :returns: generator</p>
11480
11385
 
@@ -11493,7 +11398,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11493
11398
 
11494
11399
  <div class="doc doc-contents ">
11495
11400
 
11496
- <p>Return the ideal foreground color (black or white) for a given background color in hexadecimal RGB format.</p>
11401
+ <p>Return the ideal foreground color (black or white) for a given background color in hexadecimal RGB format.</p>
11497
11402
 
11498
11403
  </div>
11499
11404
 
@@ -11510,7 +11415,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11510
11415
 
11511
11416
  <div class="doc doc-contents ">
11512
11417
 
11513
- <p>Return a cryptographic signature that can be used to verify the authenticity of webhook data.</p>
11418
+ <p>Return a cryptographic signature that can be used to verify the authenticity of webhook data.</p>
11514
11419
 
11515
11420
  </div>
11516
11421
 
@@ -11527,7 +11432,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11527
11432
 
11528
11433
  <div class="doc doc-contents ">
11529
11434
 
11530
- <p>Return all lookup expressions for <code>field_name</code> in <code>model</code> filterset</p>
11435
+ <p>Return all lookup expressions for <code>field_name</code> in <code>model</code> filterset</p>
11531
11436
 
11532
11437
  </div>
11533
11438
 
@@ -11544,7 +11449,7 @@ while discarding <code>querydict</code> params which are not part of <code>filte
11544
11449
 
11545
11450
  <div class="doc doc-contents ">
11546
11451
 
11547
- <p>Returns the name of the base template, if the base_template is not None
11452
+ <p>Returns the name of the base template, if the base_template is not None
11548
11453
  Otherwise, default to using "<app>/<model>.html" as the base template, if it exists.
11549
11454
  Otherwise, check if "<app>/<model>_retrieve.html" used in <code>NautobotUIViewSet</code> exists.
11550
11455
  If both templates do not exist, fall back to "base.html".</p>
@@ -11564,7 +11469,7 @@ If both templates do not exist, fall back to "base.html".</p>
11564
11469
 
11565
11470
  <div class="doc doc-contents ">
11566
11471
 
11567
- <p>Return a dictionary of celery queues and the number of workers active on the queue in
11472
+ <p>Return a dictionary of celery queues and the number of workers active on the queue in
11568
11473
  the form {queue_name: num_workers}</p>
11569
11474
 
11570
11475
  </div>
@@ -11582,7 +11487,7 @@ the form {queue_name: num_workers}</p>
11582
11487
 
11583
11488
  <div class="doc doc-contents ">
11584
11489
 
11585
- <p>Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered
11490
+ <p>Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered
11586
11491
  by the model class. If an instance is provided, the queryset will also be filtered by the instance id.</p>
11587
11492
 
11588
11493
  </div>
@@ -11600,7 +11505,7 @@ by the model class. If an instance is provided, the queryset will also be filter
11600
11505
 
11601
11506
  <div class="doc doc-contents ">
11602
11507
 
11603
- <p>Return a label for a given field name and value.</p>
11508
+ <p>Return a label for a given field name and value.</p>
11604
11509
 
11605
11510
 
11606
11511
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -11615,11 +11520,9 @@ by the model class. If an instance is provided, the queryset will also be filter
11615
11520
  </thead>
11616
11521
  <tbody>
11617
11522
  <tr class="doc-section-item">
11523
+ <td><code>filter_field</code></td>
11618
11524
  <td>
11619
- <code>filter_field</code>
11620
- </td>
11621
- <td>
11622
- <code>Filter</code>
11525
+ <code><autoref identifier="Filter" optional>Filter</autoref></code>
11623
11526
  </td>
11624
11527
  <td>
11625
11528
  <div class="doc-md-description">
@@ -11645,7 +11548,7 @@ by the model class. If an instance is provided, the queryset will also be filter
11645
11548
  <tbody>
11646
11549
  <tr class="doc-section-item">
11647
11550
  <td>
11648
- <code>str</code>
11551
+ <code><autoref identifier="str" optional>str</autoref></code>
11649
11552
  </td>
11650
11553
  <td>
11651
11554
  <div class="doc-md-description">
@@ -11671,7 +11574,7 @@ by the model class. If an instance is provided, the queryset will also be filter
11671
11574
 
11672
11575
  <div class="doc doc-contents ">
11673
11576
 
11674
- <p>Remove any <code>non_filter_params</code> and fields that are not a part of the filterset from <code>filter_params</code>
11577
+ <p>Remove any <code>non_filter_params</code> and fields that are not a part of the filterset from <code>filter_params</code>
11675
11578
  to return only queryset filterable parameters.</p>
11676
11579
 
11677
11580
 
@@ -11687,11 +11590,9 @@ to return only queryset filterable parameters.</p>
11687
11590
  </thead>
11688
11591
  <tbody>
11689
11592
  <tr class="doc-section-item">
11593
+ <td><code>filter_params</code></td>
11690
11594
  <td>
11691
- <code>filter_params</code>
11692
- </td>
11693
- <td>
11694
- <code><span title="django.http.QueryDict">QueryDict</span></code>
11595
+ <code><autoref identifier="django.http.QueryDict" optional hover>QueryDict</autoref></code>
11695
11596
  </td>
11696
11597
  <td>
11697
11598
  <div class="doc-md-description">
@@ -11703,11 +11604,9 @@ to return only queryset filterable parameters.</p>
11703
11604
  </td>
11704
11605
  </tr>
11705
11606
  <tr class="doc-section-item">
11607
+ <td><code>non_filter_params</code></td>
11706
11608
  <td>
11707
- <code>non_filter_params</code>
11708
- </td>
11709
- <td>
11710
- <code>list</code>
11609
+ <code><autoref identifier="list" optional>list</autoref></code>
11711
11610
  </td>
11712
11611
  <td>
11713
11612
  <div class="doc-md-description">
@@ -11719,11 +11618,9 @@ to return only queryset filterable parameters.</p>
11719
11618
  </td>
11720
11619
  </tr>
11721
11620
  <tr class="doc-section-item">
11621
+ <td><code>filterset</code></td>
11722
11622
  <td>
11723
- <code>filterset</code>
11724
- </td>
11725
- <td>
11726
- <code>FilterSet</code>
11623
+ <code><autoref identifier="FilterSet" optional>FilterSet</autoref></code>
11727
11624
  </td>
11728
11625
  <td>
11729
11626
  <div class="doc-md-description">
@@ -11749,7 +11646,7 @@ to return only queryset filterable parameters.</p>
11749
11646
  <tbody>
11750
11647
  <tr class="doc-section-item">
11751
11648
  <td>
11752
- <code><span title="django.http.QueryDict">QueryDict</span></code>
11649
+ <code><autoref identifier="django.http.QueryDict" optional hover>QueryDict</autoref></code>
11753
11650
  </td>
11754
11651
  <td>
11755
11652
  <div class="doc-md-description">
@@ -11775,7 +11672,7 @@ to return only queryset filterable parameters.</p>
11775
11672
 
11776
11673
  <div class="doc doc-contents ">
11777
11674
 
11778
- <p>Return the <code>FilterSet</code> class associated with a given <code>model</code>.</p>
11675
+ <p>Return the <code>FilterSet</code> class associated with a given <code>model</code>.</p>
11779
11676
  <p>The <code>FilterSet</code> class is expected to be in the <code>filters</code> module within the application
11780
11677
  associated with the model and its name is expected to be <code>{ModelName}FilterSet</code>.</p>
11781
11678
  <p>If a matching <code>FilterSet</code> is not found, this will return <code>None</code>.</p>
@@ -11793,11 +11690,9 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
11793
11690
  </thead>
11794
11691
  <tbody>
11795
11692
  <tr class="doc-section-item">
11693
+ <td><code>model</code></td>
11796
11694
  <td>
11797
- <code>model</code>
11798
- </td>
11799
- <td>
11800
- <code>BaseModel</code>
11695
+ <code><autoref identifier="BaseModel" optional>BaseModel</autoref></code>
11801
11696
  </td>
11802
11697
  <td>
11803
11698
  <div class="doc-md-description">
@@ -11823,7 +11718,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
11823
11718
  <tbody>
11824
11719
  <tr class="doc-section-item">
11825
11720
  <td>
11826
- <code>Union[FilterSet, None]</code>
11721
+ <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="FilterSet" optional>FilterSet</autoref>, None]</code>
11827
11722
  </td>
11828
11723
  <td>
11829
11724
  <div class="doc-md-description">
@@ -11849,7 +11744,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
11849
11744
 
11850
11745
  <div class="doc doc-contents ">
11851
11746
 
11852
- <p>Return the relevant form field instance for a filterset parameter e.g DynamicModelMultipleChoiceField, forms.IntegerField e.t.c</p>
11747
+ <p>Return the relevant form field instance for a filterset parameter e.g DynamicModelMultipleChoiceField, forms.IntegerField e.t.c</p>
11853
11748
 
11854
11749
  </div>
11855
11750
 
@@ -11866,7 +11761,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
11866
11761
 
11867
11762
  <div class="doc doc-contents ">
11868
11763
 
11869
- <p>Return the <code>Form</code> class associated with a given <code>model</code>.</p>
11764
+ <p>Return the <code>Form</code> class associated with a given <code>model</code>.</p>
11870
11765
  <p>The <code>Form</code> class is expected to be in the <code>forms</code> module within the application
11871
11766
  associated with the model and its name is expected to be <code>{ModelName}{form_prefix}Form</code>.</p>
11872
11767
  <p>If a matching <code>Form</code> is not found, this will return <code>None</code>.</p>
@@ -11884,11 +11779,9 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11884
11779
  </thead>
11885
11780
  <tbody>
11886
11781
  <tr class="doc-section-item">
11782
+ <td><code>form_prefix</code></td>
11887
11783
  <td>
11888
- <code>form_prefix</code>
11889
- </td>
11890
- <td>
11891
- <code>str</code>
11784
+ <code><autoref identifier="str" optional>str</autoref></code>
11892
11785
  </td>
11893
11786
  <td>
11894
11787
  <div class="doc-md-description">
@@ -11915,7 +11808,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11915
11808
  <tbody>
11916
11809
  <tr class="doc-section-item">
11917
11810
  <td>
11918
- <code>Union[Form, None]</code>
11811
+ <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="Form" optional>Form</autoref>, None]</code>
11919
11812
  </td>
11920
11813
  <td>
11921
11814
  <div class="doc-md-description">
@@ -11941,7 +11834,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11941
11834
 
11942
11835
  <div class="doc doc-contents ">
11943
11836
 
11944
- <p>Get latest known Nautobot release from cache, or if not available, queue up a background task to populate the cache.</p>
11837
+ <p>Get latest known Nautobot release from cache, or if not available, queue up a background task to populate the cache.</p>
11945
11838
 
11946
11839
 
11947
11840
  <p><span class="doc-section-title">Returns:</span></p>
@@ -11955,7 +11848,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11955
11848
  <tbody>
11956
11849
  <tr class="doc-section-item">
11957
11850
  <td>
11958
- <code>(Version, str)</code>
11851
+ <code>(<autoref identifier="Version" optional>Version</autoref>, <autoref identifier="str" optional>str</autoref>)</code>
11959
11852
  </td>
11960
11853
  <td>
11961
11854
  <div class="doc-md-description">
@@ -11965,7 +11858,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11965
11858
  </tr>
11966
11859
  <tr class="doc-section-item">
11967
11860
  <td>
11968
- <code>(unknown, None)</code>
11861
+ <code>(<autoref identifier="unknown" optional>unknown</autoref>, None)</code>
11969
11862
  </td>
11970
11863
  <td>
11971
11864
  <div class="doc-md-description">
@@ -11991,7 +11884,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
11991
11884
 
11992
11885
  <div class="doc doc-contents ">
11993
11886
 
11994
- <p>Given a full model name in dotted format (example: <code>dcim.model</code>), a model class is returned if valid.</p>
11887
+ <p>Given a full model name in dotted format (example: <code>dcim.model</code>), a model class is returned if valid.</p>
11995
11888
  <p>:param model_name: Full dotted name for a model as a string (ex: <code>dcim.model</code>)
11996
11889
  :type model_name: str</p>
11997
11890
  <p>:raises TypeError: If given model name is not found.</p>
@@ -12012,7 +11905,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
12012
11905
 
12013
11906
  <div class="doc doc-contents ">
12014
11907
 
12015
- <p>Resolve the named permission for a given model (or instance) and action (e.g. view or add).</p>
11908
+ <p>Resolve the named permission for a given model (or instance) and action (e.g. view or add).</p>
12016
11909
  <p>:param model: A model or instance
12017
11910
  :param action: View, add, change, or delete (string)</p>
12018
11911
 
@@ -12031,7 +11924,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
12031
11924
 
12032
11925
  <div class="doc doc-contents ">
12033
11926
 
12034
- <p>Return the appropriate class associated with a given model matching the <code>module_name</code> and
11927
+ <p>Return the appropriate class associated with a given model matching the <code>module_name</code> and
12035
11928
  <code>object_suffix</code>.</p>
12036
11929
  <p>The given <code>model</code> can either be a model class, a model instance, or a dotted representation (ex: <code>dcim.device</code>).</p>
12037
11930
  <p>The object class is expected to be in the module within the application
@@ -12051,11 +11944,9 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
12051
11944
  </thead>
12052
11945
  <tbody>
12053
11946
  <tr class="doc-section-item">
11947
+ <td><code>model</code></td>
12054
11948
  <td>
12055
- <code>model</code>
12056
- </td>
12057
- <td>
12058
- <code>Union[BaseModel, str]</code>
11949
+ <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="BaseModel" optional>BaseModel</autoref>, <autoref identifier="str" optional>str</autoref>]</code>
12059
11950
  </td>
12060
11951
  <td>
12061
11952
  <div class="doc-md-description">
@@ -12067,11 +11958,9 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
12067
11958
  </td>
12068
11959
  </tr>
12069
11960
  <tr class="doc-section-item">
11961
+ <td><code>module_name</code></td>
12070
11962
  <td>
12071
- <code>module_name</code>
12072
- </td>
12073
- <td>
12074
- <code>str</code>
11963
+ <code><autoref identifier="str" optional>str</autoref></code>
12075
11964
  </td>
12076
11965
  <td>
12077
11966
  <div class="doc-md-description">
@@ -12083,11 +11972,9 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
12083
11972
  </td>
12084
11973
  </tr>
12085
11974
  <tr class="doc-section-item">
11975
+ <td><code>object_suffix</code></td>
12086
11976
  <td>
12087
- <code>object_suffix</code>
12088
- </td>
12089
- <td>
12090
- <code>str</code>
11977
+ <code><autoref identifier="str" optional>str</autoref></code>
12091
11978
  </td>
12092
11979
  <td>
12093
11980
  <div class="doc-md-description">
@@ -12113,7 +12000,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
12113
12000
  <tbody>
12114
12001
  <tr class="doc-section-item">
12115
12002
  <td>
12116
- <code>Union[BaseModel, str]</code>
12003
+ <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="BaseModel" optional>BaseModel</autoref>, <autoref identifier="str" optional>str</autoref>]</code>
12117
12004
  </td>
12118
12005
  <td>
12119
12006
  <div class="doc-md-description">
@@ -12139,7 +12026,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
12139
12026
 
12140
12027
  <div class="doc doc-contents ">
12141
12028
 
12142
- <p>Find the field on <code>from_model</code> that is a relation to <code>to_model</code>.</p>
12029
+ <p>Find the field on <code>from_model</code> that is a relation to <code>to_model</code>.</p>
12143
12030
  <p>If no such field is found, returns None.
12144
12031
  If more than one such field is found, raises an AttributeError.</p>
12145
12032
 
@@ -12156,11 +12043,9 @@ If more than one such field is found, raises an AttributeError.</p>
12156
12043
  </thead>
12157
12044
  <tbody>
12158
12045
  <tr class="doc-section-item">
12046
+ <td><code>from_model</code></td>
12159
12047
  <td>
12160
- <code>from_model</code>
12161
- </td>
12162
- <td>
12163
- <code>BaseModel</code>
12048
+ <code><autoref identifier="BaseModel" optional>BaseModel</autoref></code>
12164
12049
  </td>
12165
12050
  <td>
12166
12051
  <div class="doc-md-description">
@@ -12172,11 +12057,9 @@ If more than one such field is found, raises an AttributeError.</p>
12172
12057
  </td>
12173
12058
  </tr>
12174
12059
  <tr class="doc-section-item">
12060
+ <td><code>to_model</code></td>
12175
12061
  <td>
12176
- <code>to_model</code>
12177
- </td>
12178
- <td>
12179
- <code>BaseModel</code>
12062
+ <code><autoref identifier="BaseModel" optional>BaseModel</autoref></code>
12180
12063
  </td>
12181
12064
  <td>
12182
12065
  <div class="doc-md-description">
@@ -12219,7 +12102,7 @@ If more than one such field is found, raises an AttributeError.</p>
12219
12102
 
12220
12103
  <div class="doc doc-contents ">
12221
12104
 
12222
- <p>Return the URL route name for the given model and action. Does not perform any validation.
12105
+ <p>Return the URL route name for the given model and action. Does not perform any validation.
12223
12106
  Supports both core and App routes.</p>
12224
12107
 
12225
12108
 
@@ -12235,11 +12118,9 @@ Supports both core and App routes.</p>
12235
12118
  </thead>
12236
12119
  <tbody>
12237
12120
  <tr class="doc-section-item">
12121
+ <td><code>model</code></td>
12238
12122
  <td>
12239
- <code>model</code>
12240
- </td>
12241
- <td>
12242
- <code>(<span title="nautobot.core.models.Model">Model</span>, str)</code>
12123
+ <code>(<autoref identifier="nautobot.core.models.Model" optional hover>Model</autoref>, <autoref identifier="str" optional>str</autoref>)</code>
12243
12124
  </td>
12244
12125
  <td>
12245
12126
  <div class="doc-md-description">
@@ -12251,11 +12132,9 @@ Supports both core and App routes.</p>
12251
12132
  </td>
12252
12133
  </tr>
12253
12134
  <tr class="doc-section-item">
12135
+ <td><code>action</code></td>
12254
12136
  <td>
12255
- <code>action</code>
12256
- </td>
12257
- <td>
12258
- <code>str</code>
12137
+ <code><autoref identifier="str" optional>str</autoref></code>
12259
12138
  </td>
12260
12139
  <td>
12261
12140
  <div class="doc-md-description">
@@ -12267,11 +12146,9 @@ Supports both core and App routes.</p>
12267
12146
  </td>
12268
12147
  </tr>
12269
12148
  <tr class="doc-section-item">
12149
+ <td><code>api</code></td>
12270
12150
  <td>
12271
- <code>api</code>
12272
- </td>
12273
- <td>
12274
- <code>bool</code>
12151
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12275
12152
  </td>
12276
12153
  <td>
12277
12154
  <div class="doc-md-description">
@@ -12297,7 +12174,7 @@ Supports both core and App routes.</p>
12297
12174
  <tbody>
12298
12175
  <tr class="doc-section-item">
12299
12176
  <td>
12300
- <code>str</code>
12177
+ <code><autoref identifier="str" optional>str</autoref></code>
12301
12178
  </td>
12302
12179
  <td>
12303
12180
  <div class="doc-md-description">
@@ -12339,7 +12216,7 @@ Supports both core and App routes.</p>
12339
12216
 
12340
12217
  <div class="doc doc-contents ">
12341
12218
 
12342
- <p>Get a value from Django settings (if specified there) or Constance configuration (otherwise).</p>
12219
+ <p>Get a value from Django settings (if specified there) or Constance configuration (otherwise).</p>
12343
12220
  <p>The fallback value is returned <em>only</em> if the requested variable cannot be found at all - this is an error case,
12344
12221
  and will generate warning logs.</p>
12345
12222
 
@@ -12351,14 +12228,14 @@ and will generate warning logs.</p>
12351
12228
 
12352
12229
 
12353
12230
  <h2 id="nautobot.apps.utils.get_table_for_model" class="doc doc-heading">
12354
- <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">get_table_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
12231
+ <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">get_table_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">)</span></code>
12355
12232
 
12356
12233
  <a href="#nautobot.apps.utils.get_table_for_model" class="headerlink" title="Permanent link">&para;</a></h2>
12357
12234
 
12358
12235
 
12359
12236
  <div class="doc doc-contents ">
12360
12237
 
12361
- <p>Return the <code>Table</code> class associated with a given <code>model</code>.</p>
12238
+ <p>Return the <code>Table</code> class associated with a given <code>model</code>.</p>
12362
12239
  <p>The <code>Table</code> class is expected to be in the <code>tables</code> module within the application
12363
12240
  associated with the model and its name is expected to be <code>{ModelName}Table</code>.</p>
12364
12241
  <p>If a matching <code>Table</code> is not found, this will return <code>None</code>.</p>
@@ -12376,11 +12253,9 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12376
12253
  </thead>
12377
12254
  <tbody>
12378
12255
  <tr class="doc-section-item">
12256
+ <td><code>model</code></td>
12379
12257
  <td>
12380
- <code>model</code>
12381
- </td>
12382
- <td>
12383
- <code>BaseModel</code>
12258
+ <code><autoref identifier="BaseModel" optional>BaseModel</autoref></code>
12384
12259
  </td>
12385
12260
  <td>
12386
12261
  <div class="doc-md-description">
@@ -12391,22 +12266,6 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12391
12266
  <em>required</em>
12392
12267
  </td>
12393
12268
  </tr>
12394
- <tr class="doc-section-item">
12395
- <td>
12396
- <code>suffix</code>
12397
- </td>
12398
- <td>
12399
- <code>str</code>
12400
- </td>
12401
- <td>
12402
- <div class="doc-md-description">
12403
- <p>A replacement suffix for the table name (e.g. <code>DetailTable</code>, such as to retrieve <code>FooDetailTable</code>)</p>
12404
- </div>
12405
- </td>
12406
- <td>
12407
- <code>None</code>
12408
- </td>
12409
- </tr>
12410
12269
  </tbody>
12411
12270
  </table>
12412
12271
 
@@ -12422,7 +12281,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12422
12281
  <tbody>
12423
12282
  <tr class="doc-section-item">
12424
12283
  <td>
12425
- <code>Union[Table, None]</code>
12284
+ <code><autoref identifier="Union" optional>Union</autoref>[<autoref identifier="Table" optional>Table</autoref>, None]</code>
12426
12285
  </td>
12427
12286
  <td>
12428
12287
  <div class="doc-md-description">
@@ -12448,7 +12307,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12448
12307
 
12449
12308
  <div class="doc doc-contents ">
12450
12309
 
12451
- <p>Given a URL pattern, construct a URL string that would match that pattern.</p>
12310
+ <p>Given a URL pattern, construct a URL string that would match that pattern.</p>
12452
12311
 
12453
12312
 
12454
12313
  <p><span class="doc-section-title">Examples:</span></p>
@@ -12473,7 +12332,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12473
12332
 
12474
12333
  <div class="doc doc-contents ">
12475
12334
 
12476
- <p>Recursively yield a list of registered URL patterns.</p>
12335
+ <p>Recursively yield a list of registered URL patterns.</p>
12477
12336
 
12478
12337
 
12479
12338
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12488,11 +12347,9 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
12488
12347
  </thead>
12489
12348
  <tbody>
12490
12349
  <tr class="doc-section-item">
12350
+ <td><code>urlconf</code></td>
12491
12351
  <td>
12492
- <code>urlconf</code>
12493
- </td>
12494
- <td>
12495
- <code>URLConf</code>
12352
+ <code><autoref identifier="URLConf" optional>URLConf</autoref></code>
12496
12353
  </td>
12497
12354
  <td>
12498
12355
  <div class="doc-md-description">
@@ -12505,11 +12362,9 @@ Default if unspecified is the value of <code>settings.ROOT_URLCONF</code>, i.e.
12505
12362
  </td>
12506
12363
  </tr>
12507
12364
  <tr class="doc-section-item">
12365
+ <td><code>patterns_list</code></td>
12508
12366
  <td>
12509
- <code>patterns_list</code>
12510
- </td>
12511
- <td>
12512
- <code>list</code>
12367
+ <code><autoref identifier="list" optional>list</autoref></code>
12513
12368
  </td>
12514
12369
  <td>
12515
12370
  <div class="doc-md-description">
@@ -12522,11 +12377,9 @@ Default if unspecified is the <code>url_patterns</code> attribute of the given <
12522
12377
  </td>
12523
12378
  </tr>
12524
12379
  <tr class="doc-section-item">
12380
+ <td><code>base_path</code></td>
12525
12381
  <td>
12526
- <code>base_path</code>
12527
- </td>
12528
- <td>
12529
- <code>str</code>
12382
+ <code><autoref identifier="str" optional>str</autoref></code>
12530
12383
  </td>
12531
12384
  <td>
12532
12385
  <div class="doc-md-description">
@@ -12539,11 +12392,9 @@ Default if unspecified is the string <code>"/"</code>.</p>
12539
12392
  </td>
12540
12393
  </tr>
12541
12394
  <tr class="doc-section-item">
12395
+ <td><code>ignore_redirects</code></td>
12542
12396
  <td>
12543
- <code>ignore_redirects</code>
12544
- </td>
12545
- <td>
12546
- <code>bool</code>
12397
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12547
12398
  </td>
12548
12399
  <td>
12549
12400
  <div class="doc-md-description">
@@ -12569,7 +12420,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
12569
12420
  <tbody>
12570
12421
  <tr class="doc-section-item">
12571
12422
  <td>
12572
- <code>str</code>
12423
+ <code><autoref identifier="str" optional>str</autoref></code>
12573
12424
  </td>
12574
12425
  <td>
12575
12426
  <div class="doc-md-description">
@@ -12644,7 +12495,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
12644
12495
 
12645
12496
  <div class="doc doc-contents ">
12646
12497
 
12647
- <p>Return the <code>UIViewSet</code> or <code>&lt;view_type&gt;View</code> class associated with a given <code>model</code>.</p>
12498
+ <p>Return the <code>UIViewSet</code> or <code>&lt;view_type&gt;View</code> class associated with a given <code>model</code>.</p>
12648
12499
  <p>The view class is expected to be in the <code>views</code> module within the app associated with the model,
12649
12500
  and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code>{ModelName}{view_type}View</code>.</p>
12650
12501
  <p>If neither view class is found, this will return <code>None</code>.</p>
@@ -12664,7 +12515,7 @@ and its name is expected to be either <code>{ModelName}UIViewSet</code> or <code
12664
12515
 
12665
12516
  <div class="doc doc-contents ">
12666
12517
 
12667
- <p>Return a count of the active Celery workers in a specified queue (Could be a JobQueue instance, instance pk or instance name).
12518
+ <p>Return a count of the active Celery workers in a specified queue (Could be a JobQueue instance, instance pk or instance name).
12668
12519
  Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12669
12520
 
12670
12521
  </div>
@@ -12682,7 +12533,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12682
12533
 
12683
12534
  <div class="doc doc-contents ">
12684
12535
 
12685
- <p>Map a hex string like "00ff00" to individual r, g, b integer values.</p>
12536
+ <p>Map a hex string like "00ff00" to individual r, g, b integer values.</p>
12686
12537
 
12687
12538
  </div>
12688
12539
 
@@ -12699,7 +12550,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12699
12550
 
12700
12551
  <div class="doc doc-contents ">
12701
12552
 
12702
- <p>Return a path for uploading image attachments.</p>
12553
+ <p>Return a path for uploading image attachments.</p>
12703
12554
 
12704
12555
  </div>
12705
12556
 
@@ -12716,7 +12567,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12716
12567
 
12717
12568
  <div class="doc doc-contents ">
12718
12569
 
12719
- <p>Validate whether a value is a URL.</p>
12570
+ <p>Validate whether a value is a URL.</p>
12720
12571
 
12721
12572
 
12722
12573
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12731,11 +12582,9 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12731
12582
  </thead>
12732
12583
  <tbody>
12733
12584
  <tr class="doc-section-item">
12585
+ <td><code>value</code></td>
12734
12586
  <td>
12735
- <code>value</code>
12736
- </td>
12737
- <td>
12738
- <code>str</code>
12587
+ <code><autoref identifier="str" optional>str</autoref></code>
12739
12588
  </td>
12740
12589
  <td>
12741
12590
  <div class="doc-md-description">
@@ -12761,7 +12610,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12761
12610
  <tbody>
12762
12611
  <tr class="doc-section-item">
12763
12612
  <td>
12764
- <code>bool</code>
12613
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12765
12614
  </td>
12766
12615
  <td>
12767
12616
  <div class="doc-md-description">
@@ -12787,7 +12636,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12787
12636
 
12788
12637
  <div class="doc doc-contents ">
12789
12638
 
12790
- <p>Make a given RGB color lighter (closer to white).</p>
12639
+ <p>Make a given RGB color lighter (closer to white).</p>
12791
12640
 
12792
12641
  </div>
12793
12642
 
@@ -12804,7 +12653,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12804
12653
 
12805
12654
  <div class="doc doc-contents ">
12806
12655
 
12807
- <p>Merge two dicts into a new dict, but raise a ValueError if any key exists with differing values across both dicts.</p>
12656
+ <p>Merge two dicts into a new dict, but raise a ValueError if any key exists with differing values across both dicts.</p>
12808
12657
 
12809
12658
  </div>
12810
12659
 
@@ -12821,7 +12670,7 @@ Defaults to the <code>CELERY_TASK_DEFAULT_QUEUE</code> setting.</p>
12821
12670
 
12822
12671
  <div class="doc doc-contents ">
12823
12672
 
12824
- <p>When replacing a model, this will update references to the content type on related models such as tags and object changes.</p>
12673
+ <p>When replacing a model, this will update references to the content type on related models such as tags and object changes.</p>
12825
12674
  <p>Since this only updates the content type and not the primary key, this is typically only useful when migrating to a new model
12826
12675
  and preserving the old instance's primary key.</p>
12827
12676
 
@@ -12840,7 +12689,7 @@ and preserving the old instance's primary key.</p>
12840
12689
  <li>RelationshipAssociation.destination_type</li>
12841
12690
  <li>TaggedItem.content_type</li>
12842
12691
  </ul>
12843
- </details> <p>For these one-to-many and many-to-many relationships, the new content type is added
12692
+ </details> <p>For these one-to-many and many-to-many relationships, the new content type is added
12844
12693
  to the related model's content type list, but the old content type is not removed:
12845
12694
  - CustomField.content_types
12846
12695
  - JobButton.content_types
@@ -12865,11 +12714,9 @@ content types if an instance of the new model is using the tag.</p>
12865
12714
  </thead>
12866
12715
  <tbody>
12867
12716
  <tr class="doc-section-item">
12717
+ <td><code>apps</code></td>
12868
12718
  <td>
12869
- <code>apps</code>
12870
- </td>
12871
- <td>
12872
- <code>obj</code>
12719
+ <code><autoref identifier="obj" optional>obj</autoref></code>
12873
12720
  </td>
12874
12721
  <td>
12875
12722
  <div class="doc-md-description">
@@ -12881,11 +12728,9 @@ content types if an instance of the new model is using the tag.</p>
12881
12728
  </td>
12882
12729
  </tr>
12883
12730
  <tr class="doc-section-item">
12731
+ <td><code>old_ct</code></td>
12884
12732
  <td>
12885
- <code>old_ct</code>
12886
- </td>
12887
- <td>
12888
- <code>obj</code>
12733
+ <code><autoref identifier="obj" optional>obj</autoref></code>
12889
12734
  </td>
12890
12735
  <td>
12891
12736
  <div class="doc-md-description">
@@ -12897,11 +12742,9 @@ content types if an instance of the new model is using the tag.</p>
12897
12742
  </td>
12898
12743
  </tr>
12899
12744
  <tr class="doc-section-item">
12745
+ <td><code>new_ct</code></td>
12900
12746
  <td>
12901
- <code>new_ct</code>
12902
- </td>
12903
- <td>
12904
- <code>obj</code>
12747
+ <code><autoref identifier="obj" optional>obj</autoref></code>
12905
12748
  </td>
12906
12749
  <td>
12907
12750
  <div class="doc-md-description">
@@ -12930,7 +12773,7 @@ content types if an instance of the new model is using the tag.</p>
12930
12773
 
12931
12774
  <div class="doc doc-contents ">
12932
12775
 
12933
- <p>Update all <code>model_to_migrate</code> with a value for <code>to_role_field</code> based on <code>from_role_field</code> values.</p>
12776
+ <p>Update all <code>model_to_migrate</code> with a value for <code>to_role_field</code> based on <code>from_role_field</code> values.</p>
12934
12777
 
12935
12778
 
12936
12779
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12945,11 +12788,9 @@ content types if an instance of the new model is using the tag.</p>
12945
12788
  </thead>
12946
12789
  <tbody>
12947
12790
  <tr class="doc-section-item">
12791
+ <td><code>model_to_migrate</code></td>
12948
12792
  <td>
12949
- <code>model_to_migrate</code>
12950
- </td>
12951
- <td>
12952
- <code>Model</code>
12793
+ <code><autoref identifier="Model" optional>Model</autoref></code>
12953
12794
  </td>
12954
12795
  <td>
12955
12796
  <div class="doc-md-description">
@@ -12961,11 +12802,9 @@ content types if an instance of the new model is using the tag.</p>
12961
12802
  </td>
12962
12803
  </tr>
12963
12804
  <tr class="doc-section-item">
12805
+ <td><code>from_role_field_name</code></td>
12964
12806
  <td>
12965
- <code>from_role_field_name</code>
12966
- </td>
12967
- <td>
12968
- <code>str</code>
12807
+ <code><autoref identifier="str" optional>str</autoref></code>
12969
12808
  </td>
12970
12809
  <td>
12971
12810
  <div class="doc-md-description">
@@ -12977,11 +12816,9 @@ content types if an instance of the new model is using the tag.</p>
12977
12816
  </td>
12978
12817
  </tr>
12979
12818
  <tr class="doc-section-item">
12819
+ <td><code>from_role_model</code></td>
12980
12820
  <td>
12981
- <code>from_role_model</code>
12982
- </td>
12983
- <td>
12984
- <code>Model</code>
12821
+ <code><autoref identifier="Model" optional>Model</autoref></code>
12985
12822
  </td>
12986
12823
  <td>
12987
12824
  <div class="doc-md-description">
@@ -12993,11 +12830,9 @@ content types if an instance of the new model is using the tag.</p>
12993
12830
  </td>
12994
12831
  </tr>
12995
12832
  <tr class="doc-section-item">
12833
+ <td><code>from_role_choiceset</code></td>
12996
12834
  <td>
12997
- <code>from_role_choiceset</code>
12998
- </td>
12999
- <td>
13000
- <code>ChoiceSet</code>
12835
+ <code><autoref identifier="ChoiceSet" optional>ChoiceSet</autoref></code>
13001
12836
  </td>
13002
12837
  <td>
13003
12838
  <div class="doc-md-description">
@@ -13009,11 +12844,9 @@ content types if an instance of the new model is using the tag.</p>
13009
12844
  </td>
13010
12845
  </tr>
13011
12846
  <tr class="doc-section-item">
12847
+ <td><code>to_role_field_name</code></td>
13012
12848
  <td>
13013
- <code>to_role_field_name</code>
13014
- </td>
13015
- <td>
13016
- <code>str</code>
12849
+ <code><autoref identifier="str" optional>str</autoref></code>
13017
12850
  </td>
13018
12851
  <td>
13019
12852
  <div class="doc-md-description">
@@ -13025,11 +12858,9 @@ content types if an instance of the new model is using the tag.</p>
13025
12858
  </td>
13026
12859
  </tr>
13027
12860
  <tr class="doc-section-item">
12861
+ <td><code>to_role_model</code></td>
13028
12862
  <td>
13029
- <code>to_role_model</code>
13030
- </td>
13031
- <td>
13032
- <code>Model</code>
12863
+ <code><autoref identifier="Model" optional>Model</autoref></code>
13033
12864
  </td>
13034
12865
  <td>
13035
12866
  <div class="doc-md-description">
@@ -13041,11 +12872,9 @@ content types if an instance of the new model is using the tag.</p>
13041
12872
  </td>
13042
12873
  </tr>
13043
12874
  <tr class="doc-section-item">
12875
+ <td><code>to_role_choiceset</code></td>
13044
12876
  <td>
13045
- <code>to_role_choiceset</code>
13046
- </td>
13047
- <td>
13048
- <code>ChoiceSet</code>
12877
+ <code><autoref identifier="ChoiceSet" optional>ChoiceSet</autoref></code>
13049
12878
  </td>
13050
12879
  <td>
13051
12880
  <div class="doc-md-description">
@@ -13057,11 +12886,9 @@ content types if an instance of the new model is using the tag.</p>
13057
12886
  </td>
13058
12887
  </tr>
13059
12888
  <tr class="doc-section-item">
12889
+ <td><code>is_m2m_field</code></td>
13060
12890
  <td>
13061
- <code>is_m2m_field</code>
13062
- </td>
13063
- <td>
13064
- <code>bool</code>
12891
+ <code><autoref identifier="bool" optional>bool</autoref></code>
13065
12892
  </td>
13066
12893
  <td>
13067
12894
  <div class="doc-md-description">
@@ -13083,111 +12910,22 @@ content types if an instance of the new model is using the tag.</p>
13083
12910
 
13084
12911
 
13085
12912
  <h2 id="nautobot.apps.utils.normalize_querydict" class="doc doc-heading">
13086
- <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">normalize_querydict</span><span class="p">(</span><span class="n">querydict</span><span class="p">,</span> <span class="n">form_class</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">filterset</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
12913
+ <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">normalize_querydict</span><span class="p">(</span><span class="n">querydict</span><span class="p">,</span> <span class="n">form_class</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
13087
12914
 
13088
12915
  <a href="#nautobot.apps.utils.normalize_querydict" class="headerlink" title="Permanent link">&para;</a></h2>
13089
12916
 
13090
12917
 
13091
12918
  <div class="doc doc-contents ">
13092
12919
 
13093
- <p>Converts a QueryDict into a standard, mutable dictionary while preserving multiple values as lists.</p>
13094
-
13095
-
13096
- <details class="example" open>
13097
- <summary>Example</summary>
13098
- <p>A QueryDict like:
13099
- QueryDict('foo=1&amp;bar=2&amp;bar=3&amp;baz=')</p>
13100
- <p _="''" _1_="'1'," _2_="['2'," _3_="'3']," _bar_:="'bar':" _baz_:="'baz':" _foo_:="'foo':">Converts to:</p>
13101
- </details> <p>This function ensures that fields with multiple values are handled correctly, as QueryDict
13102
- does not inherently preserve multiple values as lists.</p>
13103
-
13104
-
13105
- <p><span class="doc-section-title">Parameters:</span></p>
13106
- <table>
13107
- <thead>
13108
- <tr>
13109
- <th>Name</th>
13110
- <th>Type</th>
13111
- <th>Description</th>
13112
- <th>Default</th>
13113
- </tr>
13114
- </thead>
13115
- <tbody>
13116
- <tr class="doc-section-item">
13117
- <td>
13118
- <code>querydict</code>
13119
- </td>
13120
- <td>
13121
- <code><span title="django.http.QueryDict">QueryDict</span></code>
13122
- </td>
13123
- <td>
13124
- <div class="doc-md-description">
13125
- <p>The QueryDict to be normalized.</p>
13126
- </div>
13127
- </td>
13128
- <td>
13129
- <em>required</em>
13130
- </td>
13131
- </tr>
13132
- <tr class="doc-section-item">
13133
- <td>
13134
- <code>form_class</code>
13135
- </td>
13136
- <td>
13137
- <code><span title="django.forms.Form">Form</span></code>
13138
- </td>
13139
- <td>
13140
- <div class="doc-md-description">
13141
- <p>A form class to identify fields that should be treated as
13142
- lists (e.g., <code>MultipleChoiceField</code> or <code>ModelMultipleChoiceField</code>).</p>
13143
- </div>
13144
- </td>
13145
- <td>
13146
- <code>None</code>
13147
- </td>
13148
- </tr>
13149
- <tr class="doc-section-item">
13150
- <td>
13151
- <code>filterset</code>
13152
- </td>
13153
- <td>
13154
- <code><span title="django_filters.FilterSet">FilterSet</span></code>
13155
- </td>
13156
- <td>
13157
- <div class="doc-md-description">
13158
- <p>A FilterSet instance to identify filters that
13159
- should preserve multiple values as lists (e.g., non-single-choice fields).</p>
13160
- </div>
13161
- </td>
13162
- <td>
13163
- <code>None</code>
13164
- </td>
13165
- </tr>
13166
- </tbody>
13167
- </table>
13168
-
13169
-
13170
- <p><span class="doc-section-title">Raises:</span></p>
13171
- <table>
13172
- <thead>
13173
- <tr>
13174
- <th>Type</th>
13175
- <th>Description</th>
13176
- </tr>
13177
- </thead>
13178
- <tbody>
13179
- <tr class="doc-section-item">
13180
- <td>
13181
- <code>AttributeError</code>
13182
- </td>
13183
- <td>
13184
- <div class="doc-md-description">
13185
- <p>If both <code>form_class</code> and <code>filterset</code> are provided.</p>
13186
- </div>
13187
- </td>
13188
- </tr>
13189
- </tbody>
13190
- </table>
12920
+ <p>Convert a QueryDict to a normal, mutable dictionary, preserving list values. For example,</p>
12921
+ <div class="highlight"><pre><span></span><code>QueryDict(&#39;foo=1&amp;bar=2&amp;bar=3&amp;baz=&#39;)
12922
+ </code></pre></div>
12923
+ <p>becomes:</p>
12924
+ <div class="highlight"><pre><span></span><code>{&#39;foo&#39;: &#39;1&#39;, &#39;bar&#39;: [&#39;2&#39;, &#39;3&#39;], &#39;baz&#39;: &#39;&#39;}
12925
+ </code></pre></div>
12926
+ <p>This function is necessary because QueryDict does not provide any built-in mechanism which preserves multiple
12927
+ values.</p>
12928
+ <p>A <code>form_class</code> can be provided as a way to hint which query parameters should be treated as lists.</p>
13191
12929
 
13192
12930
  </div>
13193
12931
 
@@ -13204,7 +12942,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
13204
12942
 
13205
12943
  <div class="doc doc-contents ">
13206
12944
 
13207
- <p>Determine whether a specified permission is exempt from evaluation.</p>
12945
+ <p>Determine whether a specified permission is exempt from evaluation.</p>
13208
12946
  <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
13209
12947
 
13210
12948
  </div>
@@ -13222,7 +12960,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
13222
12960
 
13223
12961
  <div class="doc doc-contents ">
13224
12962
 
13225
- <p>Populate the registry model features with new apps.</p>
12963
+ <p>Populate the registry model features with new apps.</p>
13226
12964
  <p>This function updates the registry model features.</p>
13227
12965
  <p>Behavior:
13228
12966
  - Defines a list of dictionaries called lookup_confs. Each dictionary contains:
@@ -13255,7 +12993,7 @@ should preserve multiple values as lists (e.g., non-single-choice fields).</p>
13255
12993
 
13256
12994
  <div class="doc doc-contents ">
13257
12995
 
13258
- <p>Create or update a job_model record based on the metadata of the provided job_class.</p>
12996
+ <p>Create or update a job_model record based on the metadata of the provided job_class.</p>
13259
12997
  <p>Note that <code>job_model_class</code> and <code>job_queue_class</code> are parameters rather than local imports because
13260
12998
  this function may be called from various initialization processes (such as the "nautobot_database_ready" signal)
13261
12999
  and in that case we need to not import models ourselves.</p>
@@ -13278,7 +13016,7 @@ be calling the two-argument form of this function.</p>
13278
13016
 
13279
13017
  <div class="doc doc-contents ">
13280
13018
 
13281
- <p>field_name (str): f"cf_{cf.key}"</p>
13019
+ <p>field_name (str): f"cf_{cf.key}"</p>
13282
13020
  <p>Helper method to remove the "cf_" prefix</p>
13283
13021
 
13284
13022
  </div>
@@ -13296,7 +13034,7 @@ be calling the two-argument form of this function.</p>
13296
13034
 
13297
13035
  <div class="doc doc-contents ">
13298
13036
 
13299
- <p>Render a Jinja2 template with the provided context. Return the rendered content.</p>
13037
+ <p>Render a Jinja2 template with the provided context. Return the rendered content.</p>
13300
13038
 
13301
13039
  </div>
13302
13040
 
@@ -13313,7 +13051,7 @@ be calling the two-argument form of this function.</p>
13313
13051
 
13314
13052
  <div class="doc doc-contents ">
13315
13053
 
13316
- <p>Given a permission name, return the app_label, action, and model_name components. For example, "dcim.view_location"
13054
+ <p>Given a permission name, return the app_label, action, and model_name components. For example, "dcim.view_location"
13317
13055
  returns ("dcim", "view", "location").</p>
13318
13056
  <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
13319
13057
 
@@ -13332,7 +13070,7 @@ returns ("dcim", "view", "location").</p>
13332
13070
 
13333
13071
  <div class="doc doc-contents ">
13334
13072
 
13335
- <p>Given a permission name, return the relevant ContentType and action. For example, "dcim.view_location" returns
13073
+ <p>Given a permission name, return the relevant ContentType and action. For example, "dcim.view_location" returns
13336
13074
  (Location, "view").</p>
13337
13075
  <p>:param name: Permission name in the format <app_label>.<action>_<model></p>
13338
13076
 
@@ -13351,7 +13089,7 @@ returns ("dcim", "view", "location").</p>
13351
13089
 
13352
13090
  <div class="doc doc-contents ">
13353
13091
 
13354
- <p>Map r, g, b values to a hex string.</p>
13092
+ <p>Map r, g, b values to a hex string.</p>
13355
13093
 
13356
13094
  </div>
13357
13095
 
@@ -13368,7 +13106,7 @@ returns ("dcim", "view", "location").</p>
13368
13106
 
13369
13107
  <div class="doc doc-contents ">
13370
13108
 
13371
- <p>Make an attempt at stripping potentially-sensitive information from the given string, bytes or iterable thereof.</p>
13109
+ <p>Make an attempt at stripping potentially-sensitive information from the given string, bytes or iterable thereof.</p>
13372
13110
  <p>Obviously this will never be 100% foolproof but we can at least try.</p>
13373
13111
  <p>Uses settings.SANITIZER_PATTERNS as the list of (regexp, repl) tuples to apply.</p>
13374
13112
 
@@ -13387,7 +13125,7 @@ returns ("dcim", "view", "location").</p>
13387
13125
 
13388
13126
  <div class="doc doc-contents ">
13389
13127
 
13390
- <p>Return a new dictionary of the different keys. The values of <code>destination_dict</code> are returned. Only the equality of
13128
+ <p>Return a new dictionary of the different keys. The values of <code>destination_dict</code> are returned. Only the equality of
13391
13129
  the first layer of keys/values is checked. <code>exclude</code> is a list or tuple of keys to be ignored.</p>
13392
13130
 
13393
13131
  </div>
@@ -13405,7 +13143,7 @@ the first layer of keys/values is checked. <code>exclude</code> is a list or tup
13405
13143
 
13406
13144
  <div class="doc doc-contents ">
13407
13145
 
13408
- <p>Swap Git status initials with its equivalent.</p>
13146
+ <p>Swap Git status initials with its equivalent.</p>
13409
13147
 
13410
13148
  </div>
13411
13149
 
@@ -13422,7 +13160,7 @@ the first layer of keys/values is checked. <code>exclude</code> is a list or tup
13422
13160
 
13423
13161
  <div class="doc doc-contents ">
13424
13162
 
13425
- <p>Returns a list of 2-tuples for use in the form field <code>choices</code> argument. Appends
13163
+ <p>Returns a list of 2-tuples for use in the form field <code>choices</code> argument. Appends
13426
13164
  worker count to the description.</p>
13427
13165
 
13428
13166
  </div>
@@ -13440,7 +13178,7 @@ worker count to the description.</p>
13440
13178
 
13441
13179
  <div class="doc doc-contents ">
13442
13180
 
13443
- <p>Convert the given length to meters.</p>
13181
+ <p>Convert the given length to meters.</p>
13444
13182
 
13445
13183
  </div>
13446
13184
 
@@ -13457,7 +13195,7 @@ worker count to the description.</p>
13457
13195
 
13458
13196
  <div class="doc doc-contents ">
13459
13197
 
13460
- <p>Helper function that wraps plugin model validator registered clean methods for all applicable models</p>
13198
+ <p>Helper function that wraps plugin model validator registered clean methods for all applicable models</p>
13461
13199
 
13462
13200
  </div>
13463
13201
 
@@ -13616,7 +13354,7 @@ worker count to the description.</p>
13616
13354
  <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
13617
13355
 
13618
13356
 
13619
- <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
13357
+ <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
13620
13358
 
13621
13359
  <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
13622
13360