illumio-pylo 0.3.8__tar.gz → 0.3.10__tar.gz

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/.github/workflows/doxygen-publish.yml

@@ -3,7 +3,7 @@ name: Publish API Docs on GitHub Pages
 
 on:
   release:
-    types: [published]
+    types: [released]
     branches:
       - master
 

{illumio_pylo-0.3.8/illumio_pylo.egg-info → illumio_pylo-0.3.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: illumio_pylo
-Version: 0.3.8
+Version: 0.3.10
 Summary: A set of tools and library for working with Illumio PCE
 Home-page: https://github.com/cpainchaud/pylo
 Author: Christophe Painchaud
@@ -187,7 +187,7 @@ Requires-Python: >=3.11
 License-File: LICENSE
 Requires-Dist: click==8.1.7
 Requires-Dist: colorama~=0.4.4
-Requires-Dist: cryptography==42.0.7
+Requires-Dist: cryptography==43.0.1
 Requires-Dist: openpyxl~=3.1.3
 Requires-Dist: paramiko~=3.4.0
 Requires-Dist: prettytable~=3.10.0

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/API/APIConnector.py

@@ -12,7 +12,8 @@ from .JsonPayloadTypes import LabelGroupObjectJsonStructure, LabelObjectCreation
     LabelDimensionObjectStructure, AuditLogApiReplyEventJsonStructure, WorkloadsGetQueryLabelFilterJsonStructure, \
     NetworkDeviceObjectJsonStructure, NetworkDeviceEndpointObjectJsonStructure, HrefReference, \
     WorkloadObjectCreateJsonStructure, WorkloadObjectMultiCreateJsonRequestPayload, \
-    WorkloadBulkUpdateEntryJsonStructure, WorkloadBulkUpdateResponseEntry, VenObjectJsonStructure
+    WorkloadBulkUpdateEntryJsonStructure, WorkloadBulkUpdateResponseEntry, VenObjectJsonStructure, \
+    VENUnpairApiResponseObjectJsonStructure
 
 try:
     import requests as requests
@@ -44,19 +45,19 @@ def get_field_or_die(field_name: str, data):
 
 
 ObjectTypes = Literal['iplists', 'workloads', 'virtual_services', 'labels', 'labelgroups', 'services', 'rulesets',
-                     'security_principals', 'label_dimensions']
+                        'security_principals', 'label_dimensions']
 
 all_object_types: Dict[ObjectTypes, ObjectTypes] = {
-        'iplists': 'iplists',
-        'workloads': 'workloads',
-        'virtual_services': 'virtual_services',
-        'labels': 'labels',
-        'labelgroups': 'labelgroups',
-        'services': 'services',
-        'rulesets': 'rulesets',
-        'security_principals': 'security_principals',
-        'label_dimensions': 'label_dimensions'
-    }
+    'iplists': 'iplists',
+    'workloads': 'workloads',
+    'virtual_services': 'virtual_services',
+    'labels': 'labels',
+    'labelgroups': 'labelgroups',
+    'services': 'services',
+    'rulesets': 'rulesets',
+    'security_principals': 'security_principals',
+    'label_dimensions': 'label_dimensions'
+}
 
 
 class APIConnector:
@@ -69,7 +70,7 @@ class APIConnector:
             port = str(port)
         self.port: int = port
         self._api_key: str = api_key
-        self._decrypted_api_key: str = None
+        self._decrypted_api_key: Optional[str] = None
         self.api_user: str = api_user
         self.org_id: int = org_id
         self.skipSSLCertCheck: bool = skip_ssl_cert_check
@@ -86,7 +87,6 @@ class APIConnector:
             return self._decrypted_api_key
         return self._api_key
 
-
     @staticmethod
     def get_all_object_types_names_except(exception_list: List[ObjectTypes]):
 
@@ -138,7 +138,7 @@ class APIConnector:
         connector = pylo.APIConnector(fqdn_or_profile_name, port, user, password, skip_ssl_cert_check=True, name=name)
         return connector
 
-    def _make_base_url(self, path: str='') -> str:
+    def _make_base_url(self, path: str = '') -> str:
         # remove leading '/' from path if exists
         if len(path) > 0 and path[0] == '/':
             path = path[1:]
@@ -222,7 +222,7 @@ class APIConnector:
                 raise pylo.PyloApiEx("PCE connectivity or low level issue: {}".format(e))
 
             answer_size = len(req.content) / 1024
-            log.info("URL downloaded (size "+str( int(answer_size) )+"KB) Reply headers:\n" +
+            log.info("URL downloaded (size "+str(int(answer_size))+"KB) Reply headers:\n" +
                      "HTTP " + method + " " + url + " STATUS " + str(req.status_code) + " " + req.reason)
             log.info(req.headers)
             # log.info("Request Body:" + pylo.nice_json(json_arguments))
@@ -247,7 +247,9 @@ class APIConnector:
                 retry_loop_times = 0
 
                 while True:
-                    log.info("Sleeping " + str(retry_interval) + " seconds before polling for job status, elapsed " + str(retry_interval*retry_loop_times) + " seconds so far" )
+                    log.info(
+                        "Sleeping " + str(retry_interval) + " seconds before polling for job status, elapsed " + str(
+                            retry_interval * retry_loop_times) + " seconds so far")
                     retry_loop_times += 1
                     time.sleep(retry_interval)
                     job_poll = self.do_get_call(job_location, include_org_id=False)
@@ -304,17 +306,18 @@ class APIConnector:
                                 continue
 
                 if req.status_code == 403:
-                    raise pylo.PyloApiRequestForbiddenEx('API returned error status "' + str(req.status_code) + ' ' + req.reason
-                                                        + '" and error message: ' + req.text)
+                    raise pylo.PyloApiRequestForbiddenEx(
+                        'API returned error status "' + str(req.status_code) + ' ' + req.reason
+                        + '" and error message: ' + req.text)
 
                 raise pylo.PyloApiEx('API returned error status "' + str(req.status_code) + ' ' + req.reason
-                                + '" and error message: ' + req.text)
+                                     + '" and error message: ' + req.text)
 
             if return_headers:
                 return req.headers
 
             if json_output_expected:
-                log.info("Parsing API answer to JSON (with a size of " + str( int(answer_size) ) + "KB)")
+                log.info("Parsing API answer to JSON (with a size of " + str(int(answer_size)) + "KB)")
                 json_out = req.json()
                 log.info("Done!")
                 if answer_size < 5:
@@ -387,7 +390,6 @@ class APIConnector:
             if 'label_dimensions' in objects_to_load:
                 del objects_to_load['label_dimensions']
 
-
         threads_count = 4
         data: PCEObjectsJsonStructure = pylo.Organization.create_fake_empty_config()
         errors = []
@@ -660,7 +662,7 @@ class APIConnector:
     def objects_workload_get(self,
                              include_deleted=False,
                              filter_by_ip: str = None,
-                             filter_by_label: WorkloadsGetQueryLabelFilterJsonStructure=None,
+                             filter_by_label: WorkloadsGetQueryLabelFilterJsonStructure = None,
                              filter_by_name: str = None,
                              filter_by_managed: bool = None,
                              filer_by_policy_health: Literal['active', 'warning', 'error'] = None,
@@ -787,12 +789,11 @@ class APIConnector:
 
             try:
                 result = self.connector.objects_workload_delete_multi(list(self._hrefs.keys()))
-            except Exception as ex:  #global exception means something really bad happened we log errors for all workloads
+            except Exception as ex:  # global exception means something really bad happened we log errors for all workloads
                 for href in self._hrefs.keys():
                     self._errors[href] = str(ex)
                 return
 
-
             # print(pylo.nice_json(result))
             if not type(result) is list:
                 raise pylo.PyloApiEx("API didnt return expected JSON format", result)
@@ -816,28 +817,65 @@ class APIConnector:
             if len(agents_to_unpair) > 0:
                 self._unpair_agents(agents_to_unpair)
 
+        def _mark_error(self, href: str, error_msg: str):
+            # does href contains "/ven' ?
+            if href.find("/vens/") > -1:
+                # replace '/vens/' with '/workloads/'
+                other_href = href.replace('/vens/', '/workloads/')
+            else:
+                # replace '/workloads/' with '/vens/'
+                other_href = href.replace('/workloads/', '/vens/')
+
+            # is href in self._hrefs ?
+            if href in self._hrefs:
+                self._errors[href] = error_msg
+                return
+
+            # is other_href in self._hrefs ?
+            if other_href in self._hrefs:
+                self._errors[other_href] = error_msg
+                return
+
+            # may be it's in self._workloads
+            if href in self._workloads:
+                self._errors[href] = error_msg
+                return
+
+            if other_href in self._workloads:
+                self._errors[other_href] = error_msg
+                return
+
+            raise pylo.PyloEx("Error for unknown href '{}'".format(href))
+
         def _unpair_agents(self, workloads_hrefs: [str]):
-            for href in workloads_hrefs:
+
+            # split in batches of 500 href
+            workloads_hrefs_batches = [workloads_hrefs[i:i + 500] for i in range(0, len(workloads_hrefs), 500)]
+
+            for workloads_hrefs_batch in workloads_hrefs_batches:
                 retry_count = 5
-                api_result = None
 
                 while retry_count >= 0:
                     retry_count -= 1
                     try:
-                        api_result = self.connector.objects_workload_unpair_multi([href])
+                        api_result = self.connector.objects_workload_unpair_multi(workloads_hrefs_batch)
+                        for error in api_result['errors']:
+                            for errored_href in error['hrefs']:
+                                self._mark_error(errored_href, error['token'])
                         break
 
                     except pylo.PyloApiTooManyRequestsEx as ex:
                         if retry_count <= 0:
-                            self._errors[href] = str(ex)
+                            for href in workloads_hrefs_batch:
+                                self._mark_error(href, str(ex))
                             break
                         time.sleep(6)
 
                     except pylo.PyloApiEx as ex:
-                        self._errors[href] = str(ex)
+                        for href in workloads_hrefs_batch:
+                            self._mark_error(href, str(ex))
                         break
 
-
         def count_entries(self):
             return len(self._hrefs)
 
@@ -847,7 +885,7 @@ class APIConnector:
     def new_tracker_workload_multi_delete(self):
         return APIConnector.WorkloadMultiDeleteTracker(self)
 
-    def objects_workload_delete_multi(self, href_or_workload_array: Union[List['pylo.Workload'],List[str]]):
+    def objects_workload_delete_multi(self, href_or_workload_array: Union[List['pylo.Workload'], List[str]]):
         if len(href_or_workload_array) < 1:
             return
 
@@ -867,33 +905,33 @@ class APIConnector:
 
         return self.do_put_call(path=path, json_arguments=json_data, json_output_expected=True)
 
-    def objects_workload_unpair_multi(self, href_or_workload_array):
-        """
-
-        :type href_or_workload_array: list[str]|list[pylo.Workload]
-        """
+    def objects_workload_unpair_multi(self, href_or_workload_array: Union[List['pylo.Workload'], List[str]]) -> VENUnpairApiResponseObjectJsonStructure:
 
         if len(href_or_workload_array) < 1:
-            return
+            raise pylo.PyloEx("HREF list of workloads/VENs to unpair is empty")
 
         json_data = {
-            "ip_table_restore": "disable",
-            "workloads": []
+            "firewall_restore": "saved",
+            "vens": []
         }
 
         if type(href_or_workload_array[0]) is str:
+            href: str
             for href in href_or_workload_array:
-                json_data['workloads'].append({"href": href})
+                # href may contain '/workloads/', we want to replace it with '/vens/'
+                new_href = href.replace('/workloads/', '/vens/')
+                json_data['vens'].append({"href": new_href})
         else:
-            href: 'pylo.Workload'
-            for href in href_or_workload_array:
-                json_data['workloads'].append({"href": href.href})
+            workload: 'pylo.Workload'
+            for workload in href_or_workload_array:
+                new_href = workload.href.replace('/workloads/', '/vens/')
+                json_data['vens'].append({"href": new_href})
 
         # print(json_data)
 
-        path = "/workloads/unpair"
+        path = "/vens/unpair"
 
-        return self.do_put_call(path=path, json_arguments=json_data, json_output_expected=False)
+        return self.do_put_call(path=path, json_arguments=json_data, json_output_expected=True)
 
     def objects_workload_create_single_unmanaged(self, json_object: WorkloadObjectCreateJsonStructure):
         path = '/workloads'
@@ -923,8 +961,7 @@ class APIConnector:
 
         return self.do_delete_call(path=path, json_output_expected=False, include_org_id=False)
 
-    def objects_network_device_get(self,
-                                       max_results: int = None) -> List[NetworkDeviceObjectJsonStructure]:
+    def objects_network_device_get(self, max_results: int = None) -> List[NetworkDeviceObjectJsonStructure]:
         path = '/network_devices'
         data = {}
 
@@ -1069,7 +1106,7 @@ class APIConnector:
             'enabled': enabled,
             'stateless': stateless,
             'consuming_security_principals': consuming_security_principals,
-            'resolve_labels_as': {'providers': resolve_providers, 'consumers': resolve_consumers,},
+            'resolve_labels_as': {'providers': resolve_providers, 'consumers': resolve_consumers},
             'consumers': consumers_json,
             'providers': providers_json,
             'ingress_services': services_json
@@ -1270,7 +1307,7 @@ class APIConnector:
         # get current timestamp to ensure we don't wait too long
         start_time = time.time()
 
-        query_status = None # Json response from API for specific query
+        query_status = None  # Json response from API for specific query
 
         while True:
             # check that we don't wait too long
@@ -1325,12 +1362,12 @@ class APIConnector:
                            check_for_update_interval_seconds: int = 10) -> 'pylo.ExplorerQuery':
         return pylo.ExplorerQuery(self, max_results, max_running_time_seconds, check_for_update_interval_seconds)
 
-
     def new_audit_log_query(self, max_results: int = 10000, max_running_time_seconds: int = 1800,
                             check_for_update_interval_seconds: int = 10) -> 'pylo.AuditLogQuery':
-        return pylo.AuditLogQuery(self, max_results, max_running_time_seconds )
+        return pylo.AuditLogQuery(self, max_results, max_running_time_seconds)
 
-    def audit_log_query(self, max_results = 1000, event_type: Optional[str] = None) -> List[AuditLogApiReplyEventJsonStructure]:
+    def audit_log_query(self, max_results=1000, event_type: Optional[str] = None) \
+            -> List[AuditLogApiReplyEventJsonStructure]:
         url = '/events'
         args = {'max_results': max_results}
         if event_type is not None:
@@ -1338,7 +1375,6 @@ class APIConnector:
 
         return self.do_get_call(path=url, params=args)
 
-
     def get_pce_ui_workload_url(self, href: str) -> str:
         # extract UUID from workload HREF:
         uuid = href.split('/')[-1]

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/API/JsonPayloadTypes.py

@@ -150,6 +150,14 @@ class VenObjectJsonStructure(TypedDict):
     os_platform: Optional[str]
     uid: Optional[str]
 
+class VENUnpairApiResponseSingleErrorObjectJsonStructure(TypedDict):
+    token: str
+    message: str
+    hrefs: List[str]
+
+class VENUnpairApiResponseObjectJsonStructure(TypedDict):
+    errors: List[VENUnpairApiResponseSingleErrorObjectJsonStructure]
+
 
 class RuleServiceReferenceObjectJsonStructure(TypedDict):
     href: str
@@ -186,6 +194,7 @@ class RulesetObjectJsonStructure(TypedDict):
     scopes: List[List[RulesetScopeEntryLineJsonStructure]]
     updated_at: str
     updated_by: Optional[HrefReferenceWithName]
+    enabled: bool
 
 
 class RulesetObjectUpdateStructure(TypedDict):
@@ -258,6 +267,7 @@ class PCEObjectsJsonStructure(TypedDict):
     virtual_services: List[VirtualServiceObjectJsonStructure]
     workloads: List[WorkloadObjectJsonStructure]
     label_dimensions: List[LabelDimensionObjectStructure]
+    pce_version: str
 
 
 class PCECacheFileJsonStructure(TypedDict):

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/Helpers/functions.py

@@ -2,6 +2,7 @@ import json
 import os
 import re
 import time
+import functools
 
 
 def nice_json(json_obj):
@@ -133,7 +134,7 @@ ___ipv6_pattern = re.compile(r"""
 def is_valid_ipv6(ip):
     """Validates IPv6 addresses.
     """
-    #print("testing ({})".format(ip))
+    # print("testing ({})".format(ip))
     return ___ipv6_pattern.match(ip) is not None
 
 
@@ -145,22 +146,16 @@ __clocks_start = {}
 __clocks_end = {}
 
 
-def clock_start(name:str = 'default'):
+def clock_start(name: str = 'default'):
     __clocks_start[name] = time.time()
 
 
-def clock_stop(name:str = 'default'):
+def clock_stop(name: str = 'default'):
     __clocks_end[name] = time.time()
 
 
-import functools
-
-
-def clock_elapsed_str(name:str = 'default'):
-    t = time.time()-__clocks_start[name]
+def clock_elapsed_str(name: str = 'default'):
+    t = time.time() - __clocks_start[name]
     return "%d:%02d:%02d.%03d" % \
-           functools.reduce(lambda ll,b : divmod(ll[0],b) + ll[1:],
-                  [(t*1000,),1000,60,60])
-    return "{}".format(time.time()-__clocks_start[name])
-
-
+        functools.reduce(lambda ll, b: divmod(ll[0], b) + ll[1:],
+                         [(t * 1000,), 1000, 60, 60])

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/IPList.py

@@ -1,6 +1,3 @@
-from typing import Dict, Optional
-
-import illumio_pylo as pylo
 from .API.JsonPayloadTypes import IPListObjectJsonStructure
 from illumio_pylo import log
 from .Helpers import *
@@ -59,15 +56,15 @@ class IPList(pylo.ReferenceTracker):
             self.raw_entries[entry] = entry
 
     def get_ip4map(self) -> pylo.IP4Map:
-        map = pylo.IP4Map()
+        new_map = pylo.IP4Map()
 
         for entry in self.raw_entries:
             if entry[0] == '!':
-                map.subtract_from_text(entry[1:], ignore_ipv6=True)
+                new_map.subtract_from_text(entry[1:], ignore_ipv6=True)
             else:
-                map.add_from_text(entry, ignore_ipv6=True)
+                new_map.add_from_text(entry, ignore_ipv6=True)
 
-        return map
+        return new_map
 
     def get_raw_entries_as_string_list(self, separator=',') -> str:
         return pylo.string_list_to_text(self.raw_entries.values(), separator=separator)
@@ -115,7 +112,7 @@ class IPListStore:
     def find_by_href(self, href: str) -> Optional['pylo.IPList']:
         return self.items_by_href.get(href)
 
-    def find_by_name(self, name: str, case_sensitive: bool = True ) -> Optional['pylo.IPList']:
+    def find_by_name(self, name: str, case_sensitive: bool = True) -> Optional['pylo.IPList']:
         if case_sensitive:
             for iplist in self.items_by_href.values():
                 if iplist.name == name:
@@ -126,4 +123,3 @@ class IPListStore:
                 if iplist.name.lower() == lower_name:
                     return iplist
         return None
-

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/IPMap.py

@@ -2,7 +2,7 @@ from .Exception import PyloEx
 from .Helpers.functions import is_valid_ipv6, string_list_to_text
 import ipaddress
 import copy
-from typing import Optional, List, Dict
+from typing import Optional, List
 
 
 def sort_first(val):
@@ -232,13 +232,13 @@ class IP4Map:
 
                 for netmask in range(1, 32, 1):
                     new_end = net_start | masks[netmask]
-                    #print("{}/{}/{}/{}".format(ipaddress.IPv4Address(net_start), ipaddress.IPv4Address(net_end), ipaddress.IPv4Address(new_end), 32 - netmask))
+                    # print("{}/{}/{}/{}".format(ipaddress.IPv4Address(net_start), ipaddress.IPv4Address(net_end), ipaddress.IPv4Address(new_end), 32 - netmask))
 
                     if new_end > net_end:
                         result.append('{}/{}'.format(ipaddress.IPv4Address(net_start), 33 - netmask))
                         net_start = previous_loop_end + 1
                         previous_loop_end = net_start
-                        #print("breaking loop with {}/{}".format(ipaddress.IPv4Address(net_start), ipaddress.IPv4Address(previous_loop_end)))
+                        # print("breaking loop with {}/{}".format(ipaddress.IPv4Address(net_start), ipaddress.IPv4Address(previous_loop_end)))
                         break
 
                     if new_end == net_end:

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/Label.py

@@ -27,4 +27,3 @@ class Label(ReferenceTracker, LabelCommon):
 
     def get_api_reference_json(self) -> LabelHrefRef:
         return {'label': {'href': self.href}}
-

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/LabelCommon.py

@@ -1,6 +1,6 @@
 from typing import Union
 from .Exception import PyloEx
-from .LabelStore import label_type_role, label_type_env, label_type_loc, label_type_app, LabelStore
+from .LabelStore import LabelStore
 
 
 class LabelCommon:

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/LabelStore.py

@@ -1,6 +1,6 @@
 from hashlib import md5
 import random
-from typing import Union, Set, Iterable
+from typing import Set
 # Pylo imports
 from illumio_pylo import log
 from .API.JsonPayloadTypes import LabelObjectJsonStructure, LabelGroupObjectJsonStructure, LabelDimensionObjectStructure
@@ -96,7 +96,7 @@ class LabelStore:
 
     def load_label_groups_from_json(self, json_list: List[LabelGroupObjectJsonStructure]):
         # groups cannot be loaded straight away : we need to extract of their principal properties (name, href and type)
-        #then we can extract their members in case there are nested groups
+        # then we can extract their members in case there are nested groups
         created_groups = []
         for json_label in json_list:
             if 'name' not in json_label or 'href' not in json_label or 'key' not in json_label:
@@ -174,33 +174,34 @@ class LabelStore:
                 data.append(label)
         return data
 
-
     def get_label_groups_as_dict_by_href(self, label_type: Optional[str] = None) -> Dict[str, 'pylo.LabelGroup']:
         label_list = self.get_label_groups(label_type)
         return self.Utils.list_to_dict_by_href(label_list)
 
-
-    def get_both_labels_and_groups(self, label_type: Optional[str] = None) -> List[Union['pylo.Label','pylo.LabelGroup']]:
+    def get_both_labels_and_groups(self, label_type: Optional[str] = None) \
+            -> List[Union['pylo.Label', 'pylo.LabelGroup']]:
         data = []
         if label_type is not None:
             if label_type not in self.label_types_as_set:
-                raise pylo.PyloEx("Invalid label type '%s'. Valid types are: %s" % (label_type, self.label_types_as_set))
+                raise pylo.PyloEx(
+                    "Invalid label type '%s'. Valid types are: %s" % (label_type, self.label_types_as_set))
 
         for label in self._items_by_href.values():
             if label_type is None or label.type == label_type:
                 data.append(label)
         return data
 
-    def get_both_labels_and_groups_as_dict_by_href(self, label_type: Optional[str] = None) -> Dict[str, Union['pylo.Label','pylo.LabelGroup']]:
+    def get_both_labels_and_groups_as_dict_by_href(self, label_type: Optional[str] = None) \
+            -> Dict[str, Union['pylo.Label', 'pylo.LabelGroup']]:
         label_list = self.get_both_labels_and_groups(label_type)
         return self.Utils.list_to_dict_by_href(label_list)
 
-
-    def find_object_by_name(self, name: str|List[str], label_type: Optional[str] = None, case_sensitive: bool = True,
-                           missing_labels_names: Optional[List[str]] = None,
-                           allow_label_group: bool = True,
-                           allow_label: bool = True,
-                           raise_exception_if_not_found: bool = False) -> Optional[Union['pylo.Label','pylo.LabelGroup',List[Union['pylo.Label','pylo.LabelGroup']]]]:
+    def find_object_by_name(self, name: str | List[str], label_type: Optional[str] = None, case_sensitive: bool = True,
+                            missing_labels_names: Optional[List[str]] = None,
+                            allow_label_group: bool = True,
+                            allow_label: bool = True,
+                            raise_exception_if_not_found: bool = False) \
+            -> Optional[Union['pylo.Label', 'pylo.LabelGroup', List[Union['pylo.Label', 'pylo.LabelGroup']]]]:
         """Find a label by its name. If case_sensitive is False, the search is case-insensitive.
         If case_sensitive is False it will return a list of labels with the same name rather than a single object.
         If missing_labels_names is not None, it will be filled with the names of the labels not found.
@@ -218,13 +219,13 @@ class LabelStore:
             for label in self._items_by_href.values():
                 if label_type is not None and label.type != label_type:
                     continue
-                if label.is_label() and allow_label: # ignore groups
+                if label.is_label() and allow_label:  # ignore groups
                     if case_sensitive:
                         if label.name == name:
                             return label
                 elif allow_label_group:
-                        if label.name.lower() == name.lower():
-                            return label
+                    if label.name.lower() == name.lower():
+                        return label
             if raise_exception_if_not_found:
                 raise pylo.PyloEx("Label/group '%s' not found", name)
             if missing_labels_names is not None:
@@ -234,10 +235,10 @@ class LabelStore:
             results = []
             local_notfound_labels = []
             for name_to_find in name:
-                result = self.find_object_by_name(name_to_find, label_type=label_type ,case_sensitive=case_sensitive,
-                                                 allow_label_group=allow_label_group, allow_label=allow_label)
+                result = self.find_object_by_name(name_to_find, label_type=label_type, case_sensitive=case_sensitive,
+                                                  allow_label_group=allow_label_group, allow_label=allow_label)
                 if result is None:
-                        local_notfound_labels.append(name_to_find)
+                    local_notfound_labels.append(name_to_find)
                 else:
                     results.append(result)
             if raise_exception_if_not_found and len(local_notfound_labels) > 0:
@@ -246,9 +247,9 @@ class LabelStore:
                 missing_labels_names.extend(local_notfound_labels)
             return results
 
-    def find_label_by_name(self, name: str|List[str], label_type: Optional[str] = None, case_sensitive: bool = True,
-                            missing_labels_names: Optional[List[str]] = None,
-                            raise_exception_if_not_found: bool = False) -> Optional['pylo.Label'|List['pylo.Label']]:
+    def find_label_by_name(self, name: str | List[str], label_type: Optional[str] = None, case_sensitive: bool = True,
+                           missing_labels_names: Optional[List[str]] = None,
+                           raise_exception_if_not_found: bool = False) -> Optional['pylo.Label' | List['pylo.Label']]:
         """Find a label by its name.
         If case_sensitive is False it will return a list of labels with the same name rather than a single object.
         If missing_labels_names is not None, it will be filled with the names of the labels not found.
@@ -261,12 +262,10 @@ class LabelStore:
                                         allow_label_group=False, allow_label=True,
                                         raise_exception_if_not_found=raise_exception_if_not_found)
 
-
     def find_label_by_name_whatever_type(self, name: str, case_sensitive: bool = True) -> Optional[Union['pylo.Label', 'pylo.LabelGroup']]:
         pylo.log.warn("find_label_by_name_whatever_type is deprecated, use find_label_by_name instead")
         return self.find_label_by_name(name, case_sensitive=case_sensitive)
 
-
     def find_label_by_name_and_type(self, name: str, label_type: str, case_sensitive: bool = True) \
             -> Optional[Union['pylo.Label', 'pylo.LabelGroup']]:
         pylo.log.warn("find_label_by_name_and_type is deprecated, use find_label_by_name instead")
@@ -366,7 +365,7 @@ class LabelStore:
 
         new_label_name = name
         new_label_type = label_type
-        new_label_href = '**fake-label-href**/{}'.format( md5(str(random.random()).encode('utf8')).digest() )
+        new_label_href = '**fake-label-href**/{}'.format(md5(str(random.random()).encode('utf8')).digest())
 
         new_label = pylo.Label(new_label_name, new_label_href, new_label_type, self)
 

{illumio_pylo-0.3.8 → illumio_pylo-0.3.10}/illumio_pylo/LabeledObject.py

@@ -18,10 +18,10 @@ class LabeledObject:
     def get_labels(self) -> Iterable['pylo.Label']:
         return self._labels.values()
 
-    def set_label(self, label :'pylo.Label'):
+    def set_label(self, label: 'pylo.Label'):
         self._labels[label.type] = label
 
-    def get_label_name(self, key: str, not_found_return_value = None):
+    def get_label_name(self, key: str, not_found_return_value=None):
         label = self.get_label(key)
         return label.name if label else not_found_return_value
 
@@ -53,7 +53,6 @@ class LabeledObject:
 
     def is_using_label(self, label: Union['pylo.Label', 'pylo.LabelGroup']) -> bool:
         if isinstance(label, pylo.Label):
-            return label.type in self._labels
+            return label in self._labels
         else:
-            return any([label.type in self._labels for label in label.labels])
-
+            return any([label in self._labels for label in label.get_members().values()])