Add common TypedDicts used for M2M

changes/310.added

@@ -0,0 +1 @@
+Added common TypedDicts for Contrib SSoT.

docs/user/modeling.md

@@ -128,6 +128,16 @@ class IPAddressDict(TypedDict):
     prefix_length: int
 ```
 
+!!! note
+    Common `TypedDict` objects are included with `nautobot_ssot.contrib.typeddicts` including:
+
+    `ContentTypeDict`, `TagDict`, `LocationDict`, `DeviceDict`, `InterfaceDict`, `PrefixDict`, `VLANDict`, `IPAddressDict`, `VirtualMachineDict`
+
+    ```
+    # Example
+    from nautobot_ssot.contrib.typeddicts import LocationDict
+    ```
+
 Having defined this, we can now define our diffsync model:
 
 ```python

nautobot_ssot/contrib/typeddicts.py

@@ -0,0 +1,74 @@
+"""Common TypedDict definitions used in Many-to-Many relationships."""
+
+from typing import TypedDict
+
+
+class ContentTypeDict(TypedDict):
+    """TypedDict for Django Content Types."""
+
+    app_label: str
+    model: str
+
+
+class TagDict(TypedDict):
+    """TypedDict for Nautobot Tags."""
+
+    name: str
+
+
+class LocationDict(TypedDict):
+    """TypedDict for DCIM Locations."""
+
+    name: str
+    parent__name: str
+
+
+class DeviceDict(TypedDict):
+    """TypedDict for DCIM Devices."""
+
+    name: str
+    location__name: str
+    tenant__name: str
+    rack__name: str
+    rack__rack_group__name: str
+    position: int
+    face: str
+    virtual_chassis__name: str
+    vc_position: int
+
+
+class InterfaceDict(TypedDict):
+    """TypedDict for DCIM INterfaces."""
+
+    name: str
+    device__name: str
+
+
+class PrefixDict(TypedDict):
+    """TypedDict for IPAM Prefixes."""
+
+    network: str
+    prefix_length: int
+    namespace__name: str
+
+
+class VLANDict(TypedDict):
+    """TypedDict for IPAM VLANs."""
+
+    vid: int
+    vlan_group__name: str
+
+
+class IPAddressDict(TypedDict):
+    """TypedDict for IPAM IP Address."""
+
+    host: str
+    prefix_length: int
+
+
+class VirtualMachineDict(TypedDict):
+    """TypedDict for IPAM ."""
+
+    name: str
+    cluster__name: str
+    tenant__name: str

nautobot_ssot/integrations/bootstrap/diffsync/adapters/bootstrap.py

@@ -485,7 +485,9 @@ def load_circuit(self, bs_circuit, branch_vars):
     def load_circuit_termination(self, bs_circuit_termination, branch_vars):
         """Load CircuitTermination objects from Bootstrap into DiffSync models."""
         if self.job.debug:
-            self.job.logger.debug(f"Loading Bootstrap CircuitTermination {bs_circuit_termination} into DiffSync models.")
+            self.job.logger.debug(
+                f"Loading Bootstrap CircuitTermination {bs_circuit_termination} into DiffSync models."
+            )
         _parts = bs_circuit_termination["name"].split("__")
         _circuit_id = _parts[0]
         _provider = _parts[1]

nautobot_ssot/integrations/bootstrap/diffsync/adapters/nautobot.py

@@ -360,7 +360,9 @@ def load_location_type(self):
         """Method to load LocationType objects from Nautobot into NautobotLocationType DiffSync models."""
         for nb_location_type in LocationType.objects.all():
             if self.job.debug:
-                self.job.logger.debug(f"Loading Nautobot LocationType: {nb_location_type}, with ID {nb_location_type.id}")
+                self.job.logger.debug(
+                    f"Loading Nautobot LocationType: {nb_location_type}, with ID {nb_location_type.id}"
+                )
             try:
                 self.get(self.location_type, nb_location_type.name)
             except ObjectNotFound: