bump to 0.9.1

Author: dmulyalin

docs/norfab_changelog.md

@@ -1,3 +1,10 @@
+## 0.9.1
+
+### BUGS
+
+1. Fixing list and dict annotations to also allow None values for workers tasks.
+
+---
 
 ## 0.9.0
 

norfab/core/inventory.py

@@ -1,26 +1,26 @@
 """
-Simple Local Inventory is an inventory plugin to load 
+Simple Local Inventory is an inventory plugin to load
 inventory data from locally stored files.
 
 Sample inventory file
 
 ```yaml
 broker:
   endpoint: "tcp://127.0.0.1:5555"
-  
+
 logging:
   handlers:
     terminal:
       level: CRITICAL
-    file: 
+    file:
       level: DEBUG
 
 workers:
   nornir-*:
-    - nornir/common.yaml  
+    - nornir/common.yaml
   nornir-worker-1:
     - nornir/nornir-worker-1.yaml
-    
+
 topology:
   broker: True
   workers:
@@ -34,7 +34,7 @@
 broker_endpoint: "tcp://127.0.0.1:5555"
 runner:
   plugin: RetryRunner
-  options: 
+  options:
     num_workers: 100
     num_connectors: 10
     connect_retry: 3
@@ -50,7 +50,7 @@
 and `nornir/nornir-worker-1.yaml` contains
 
 ```yaml
-hosts: 
+hosts:
   csr1000v-1:
     hostname: sandbox-1.lab.com
     platform: cisco_ios
@@ -66,7 +66,7 @@
 ```
 
 Whenever inventory queried to provide data for worker with name `nornir-worker-1`
-Simple Inventory iterates over `workers` dictionary and recursively merges 
+Simple Inventory iterates over `workers` dictionary and recursively merges
 data for keys (glob patterns) that matched worker name.
 """
 

norfab/workers/containerlab_worker.py

@@ -174,7 +174,7 @@ def run_containerlab_command(
         cwd: str = None,
         timeout: int = None,
         ret: Result = None,
-        env: dict = None,
+        env: Union[None, dict] = None,
     ) -> Tuple:
         """
         Executes a containerlab command using subprocess and processes its output.
@@ -533,7 +533,7 @@ def get_nornir_inventory(
         job: Job,
         lab_name: Union[None, str] = None,
         timeout: int = None,
-        groups: list = None,
+        groups: Union[None, list] = None,
         use_default_credentials: bool = True,
     ) -> Result:
         """
@@ -666,8 +666,8 @@ def deploy_netbox(
         job: Job,
         lab_name: str = None,
         tenant: str = None,
-        filters: list = None,
-        devices: list = None,
+        filters: Union[None, list] = None,
+        devices: Union[None, list] = None,
         instance: str = None,
         image: str = None,
         ipv4_subnet: str = "172.100.100.0/24",

norfab/workers/netbox_worker.py

@@ -28,7 +28,7 @@
 # ----------------------------------------------------------------------
 
 
-def _form_query_v4(obj, filters, fields, alias=None):
+def _form_query_v4(obj, filters, fields, alias=None) -> str:
     """
     Helper function to form graphql query for Netbox version 4.
 
@@ -61,7 +61,7 @@ def _form_query_v4(obj, filters, fields, alias=None):
     return query
 
 
-def _form_query_v3(obj, filters, fields, alias=None):
+def _form_query_v3(obj, filters, fields, alias=None) -> str:
     """
     Helper function to form graphql query for Netbox version 3.
 
@@ -579,9 +579,9 @@ def graphql(
         instance: Union[None, str] = None,
         dry_run: bool = False,
         obj: Union[str, dict] = None,
-        filters: dict = None,
-        fields: list = None,
-        queries: dict = None,
+        filters: Union[None, dict] = None,
+        fields: Union[None, list] = None,
+        queries: Union[None, dict] = None,
         query_string: str = None,
     ) -> Result:
         """
@@ -731,10 +731,10 @@ def rest(
     def get_devices(
         self,
         job: Job,
-        filters: list = None,
+        filters: Union[None, list] = None,
         instance: Union[None, str] = None,
         dry_run: bool = False,
-        devices: list = None,
+        devices: Union[None, list] = None,
         cache: Union[bool, str] = None,
     ) -> Result:
         """
@@ -907,7 +907,7 @@ def get_interfaces(
         self,
         job: Job,
         instance: Union[None, str] = None,
-        devices: list = None,
+        devices: Union[None, list] = None,
         ip_addresses: bool = False,
         inventory_items: bool = False,
         dry_run: bool = False,
@@ -1383,7 +1383,7 @@ def get_circuits(
         self,
         job: Job,
         devices: list,
-        cid: list = None,
+        cid: Union[None, list] = None,
         instance: Union[None, str] = None,
         dry_run: bool = False,
         cache: Union[bool, str] = True,
@@ -1574,8 +1574,8 @@ def get_circuits(
     def get_nornir_inventory(
         self,
         job: Job,
-        filters: list = None,
-        devices: list = None,
+        filters: Union[None, list] = None,
+        devices: Union[None, list] = None,
         instance: Union[None, str] = None,
         interfaces: Union[dict, bool] = False,
         connections: Union[dict, bool] = False,
@@ -1738,7 +1738,7 @@ def update_device_facts(
         dry_run: bool = False,
         datasource: str = "nornir",
         timeout: int = 60,
-        devices: list = None,
+        devices: Union[None, list] = None,
         batch_size: int = 10,
         **kwargs,
     ) -> Result:
@@ -1845,7 +1845,7 @@ def update_device_interfaces(
         dry_run: bool = False,
         datasource: str = "nornir",
         timeout: int = 60,
-        devices: list = None,
+        devices: Union[None, list] = None,
         create: bool = True,
         batch_size: int = 10,
         **kwargs,
@@ -2053,7 +2053,7 @@ def update_device_ip(
         dry_run: bool = False,
         datasource: str = "nornir",
         timeout: int = 60,
-        devices: list = None,
+        devices: Union[None, list] = None,
         create: bool = True,
         batch_size: int = 10,
         **kwargs,
@@ -2198,7 +2198,7 @@ def get_next_ip(
         device: str = None,
         interface: str = None,
         vrf: str = None,
-        tags: list = None,
+        tags: Union[None, list] = None,
         dns_name: str = None,
         tenant: str = None,
         comments: str = None,
@@ -2241,12 +2241,12 @@ def get_containerlab_inventory(
         lab_name: str = None,
         tenant: Union[None, str] = None,
         filters: Union[None, list] = None,
-        devices: list = None,
+        devices: Union[None, list] = None,
         instance: Union[None, str] = None,
         image: Union[None, str] = None,
         ipv4_subnet: str = "172.100.100.0/24",
         ports: tuple = (12000, 15000),
-        ports_map: dict = None,
+        ports_map: Union[None, dict] = None,
         progress: bool = False,
         cache: Union[bool, str] = False,
     ) -> Result:

norfab/workers/nornir_worker.py

@@ -523,7 +523,7 @@ def nornir_inventory_load_containerlab(
         self,
         job: Job,
         lab_name: str = None,
-        groups: list = None,
+        groups: Union[None, list] = None,
         clab_workers: str = "all",
         use_default_credentials: bool = True,
         progress: bool = False,

poetry.lock

@@ -3,7 +3,7 @@ name = "norfab"
 
 [tool.poetry]
 name = "norfab"
-version = "0.9.0"
+version = "0.9.1"
 description = "Network Automations Fabric [NorFab] - communication networks automations"
 authors = ["Denis Mulyalin <d.mulyalin@gmail.com>"]
 maintainers = ["Denis Mulyalin <d.mulyalin@gmail.com>"]