_id
stringlengths
2
7
title
stringlengths
1
88
partition
stringclasses
3 values
text
stringlengths
31
13.1k
language
stringclasses
1 value
meta_information
dict
q9600
_IPopoService.__get_stored_instances
train
def __get_stored_instances(self, factory_name): # type: (str) -> List[StoredInstance] """ Retrieves the list of all stored instances objects corresponding to the given factory name :param factory_name: A factory name :return: All components instantiated from the given factory """
python
{ "resource": "" }
q9601
_IPopoService.__try_instantiate
train
def __try_instantiate(self, component_context, instance): # type: (ComponentContext, object) -> bool """ Instantiates a component, if all of its handlers are there. Returns False if a handler is missing. :param component_context: A ComponentContext bean :param instance: The component instance :return: True if the component has started, False if a handler is missing """ with self.__instances_lock: # Extract information about the component factory_context = component_context.factory_context handlers_ids = factory_context.get_handlers_ids() name = component_context.name factory_name = factory_context.name try: # Get handlers handler_factories = self.__get_handler_factories(handlers_ids) except KeyError:
python
{ "resource": "" }
q9602
_IPopoService._autorestart_store_components
train
def _autorestart_store_components(self, bundle): # type: (Bundle) -> None """ Stores the components of the given bundle with the auto-restart property :param bundle: A Bundle object """ with self.__instances_lock: # Prepare the list of components store = self.__auto_restart.setdefault(bundle, []) for stored_instance in self.__instances.values():
python
{ "resource": "" }
q9603
_IPopoService._autorestart_components
train
def _autorestart_components(self, bundle): # type: (Bundle) -> None """ Restart the components of the given bundle :param bundle: A Bundle object """ with self.__instances_lock: instances = self.__auto_restart.get(bundle) if not instances: # Nothing to do return for factory, name, properties in instances: try: # Instantiate the given component self.instantiate(factory, name, properties) except Exception as ex: # Log error, but continue to work _logger.exception(
python
{ "resource": "" }
q9604
_IPopoService._fire_ipopo_event
train
def _fire_ipopo_event(self, kind, factory_name, instance_name=None): # type: (int, str, Optional[str]) -> None """ Triggers an iPOPO event :param kind: Kind of event :param factory_name: Name of the factory associated to the event :param instance_name: Name of the component instance associated to the event """ with self.__listeners_lock: # Use a copy of the list of
python
{ "resource": "" }
q9605
_IPopoService._prepare_instance_properties
train
def _prepare_instance_properties(self, properties, factory_properties): # type: (dict, dict) -> dict """ Prepares the properties of a component instance, based on its configuration, factory and framework properties :param properties: Component instance properties :param factory_properties: Component factory "default" properties :return: The merged properties """ # Normalize given properties if properties is None or not isinstance(properties, dict): properties = {} # Use framework properties to fill missing ones
python
{ "resource": "" }
q9606
_IPopoService._register_bundle_factories
train
def _register_bundle_factories(self, bundle): # type: (Bundle) -> None """ Registers all factories found in the given bundle :param bundle: A bundle """ # Load the bundle factories factories = _load_bundle_factories(bundle) for context, factory_class in factories: try: # Register each found factory self._register_factory(context.name, factory_class, False) except ValueError as ex: # Already known factory _logger.error( "Cannot register factory '%s' of bundle %d (%s): %s", context.name, bundle.get_bundle_id(), bundle.get_symbolic_name(),
python
{ "resource": "" }
q9607
_IPopoService._register_factory
train
def _register_factory(self, factory_name, factory, override): # type: (str, type, bool) -> None """ Registers a component factory :param factory_name: The name of the factory :param factory: The factory class object :param override: If true, previous factory is overridden, else an exception is risen if a previous factory with that name already exists :raise ValueError: The factory name already exists or is invalid :raise TypeError: Invalid factory type """ if not factory_name or not is_string(factory_name): raise ValueError("A factory name must be a non-empty string") if not inspect.isclass(factory): raise TypeError( "Invalid factory class '{0}'".format(type(factory).__name__) ) with self.__factories_lock: if factory_name in self.__factories:
python
{ "resource": "" }
q9608
_IPopoService._unregister_bundle_factories
train
def _unregister_bundle_factories(self, bundle): # type: (Bundle) -> None """ Unregisters all factories of the given bundle :param bundle: A bundle """ with self.__factories_lock: # Find out which factories must be removed to_remove = [ factory_name for factory_name in self.__factories if self.get_factory_bundle(factory_name) is bundle ] # Remove all of them
python
{ "resource": "" }
q9609
_IPopoService.bundle_changed
train
def bundle_changed(self, event): # type: (BundleEvent) -> None """ A bundle event has been triggered :param event: The bundle event """ kind = event.get_kind() bundle = event.get_bundle() if kind == BundleEvent.STOPPING_PRECLEAN: # A bundle is gone, remove its factories after the deactivator has # been called. That way, the deactivator can kill manually started # components. self._unregister_bundle_factories(bundle) elif kind == BundleEvent.STARTED:
python
{ "resource": "" }
q9610
_IPopoService.instantiate
train
def instantiate(self, factory_name, name, properties=None): # type: (str, str, dict) -> Any """ Instantiates a component from the given factory, with the given name :param factory_name: Name of the component factory :param name: Name of the instance to be started :param properties: Initial properties of the component instance :return: The component instance :raise TypeError: The given factory is unknown :raise ValueError: The given name or factory name is invalid, or an instance with the given name already exists :raise Exception: Something wrong occurred in the factory """ # Test parameters if not factory_name or not is_string(factory_name): raise ValueError("Invalid factory name") if not name or not is_string(name): raise ValueError("Invalid component name") if not self.running: # Stop working if the framework is stopping raise ValueError("Framework is stopping") with self.__instances_lock: if name in self.__instances or name in self.__waiting_handlers: raise ValueError( "'{0}' is an already running instance name".format(name) ) with self.__factories_lock: # Can raise a TypeError exception
python
{ "resource": "" }
q9611
_IPopoService.retry_erroneous
train
def retry_erroneous(self, name, properties_update=None): # type: (str, dict) -> int """ Removes the ERRONEOUS state of the given component, and retries a validation :param name: Name of the component to retry :param properties_update: A dictionary to update the initial properties of the component :return: The new state of the component :raise ValueError: Invalid component name """
python
{ "resource": "" }
q9612
_IPopoService.invalidate
train
def invalidate(self, name): # type: (str) -> None """ Invalidates the given component :param name: Name of the component to invalidate :raise ValueError: Invalid component name """ with self.__instances_lock: try: stored_instance = self.__instances[name] except KeyError: raise ValueError(
python
{ "resource": "" }
q9613
_IPopoService.kill
train
def kill(self, name): # type: (str) -> None """ Kills the given component :param name: Name of the component to kill :raise ValueError: Invalid component name """ if not name: raise ValueError("Name can't be None or empty") with self.__instances_lock: try: # Running instance stored_instance = self.__instances.pop(name) # Store the reference to the factory context factory_context = stored_instance.context.factory_context # Kill it stored_instance.kill() # Update the singleton state flag factory_context.is_singleton_active = False except KeyError: # Queued instance
python
{ "resource": "" }
q9614
_IPopoService.register_factory
train
def register_factory(self, bundle_context, factory): # type: (BundleContext, type) -> bool """ Registers a manually created factory, using decorators programmatically :param bundle_context: The factory bundle context :param factory: A manipulated class :return: True if the factory has been registered :raise ValueError: Invalid parameter, or factory already registered :raise TypeError: Invalid factory type (not a manipulated class) """ if factory is None or bundle_context is None: # Invalid parameter, to nothing
python
{ "resource": "" }
q9615
_IPopoService.unregister_factory
train
def unregister_factory(self, factory_name): # type: (str) -> bool """ Unregisters the given component factory :param factory_name: Name of the factory to unregister :return: True the factory has been removed, False if the factory is unknown """ if not factory_name or not is_string(factory_name): # Invalid name return False with self.__factories_lock: try: # Remove the factory from the registry factory_class = self.__factories.pop(factory_name) except KeyError: # Unknown factory return False # Trigger an event self._fire_ipopo_event( constants.IPopoEvent.UNREGISTERED, factory_name ) # Invalidate and delete all components of this factory
python
{ "resource": "" }
q9616
_IPopoService.get_instances
train
def get_instances(self): # type: () -> List[Tuple[str, str, int]] """ Retrieves the list of the currently registered component instances :return: A list of (name, factory name, state) tuples. """ with self.__instances_lock:
python
{ "resource": "" }
q9617
_IPopoService.get_waiting_components
train
def get_waiting_components(self): # type: () -> List[Tuple[str, str, Set[str]]] """ Returns the list of the instances waiting for their handlers :return: A list of (name, factory name, missing handlers) tuples """ with self.__instances_lock:
python
{ "resource": "" }
q9618
_IPopoService.get_factory_bundle
train
def get_factory_bundle(self, name): # type: (str) -> Bundle """ Retrieves the Pelix Bundle object that registered the given factory :param name: The name of a factory :return: The Bundle that registered the given factory :raise ValueError: Invalid factory """ with self.__factories_lock: try: factory = self.__factories[name] except KeyError: raise
python
{ "resource": "" }
q9619
_IPopoService.get_factory_details
train
def get_factory_details(self, name): # type: (str) -> Dict[str, Any] """ Retrieves a dictionary with details about the given factory * ``name``: The factory name * ``bundle``: The Bundle object of the bundle providing the factory * ``properties``: Copy of the components properties defined by the factory * ``requirements``: List of the requirements defined by the factory * ``id``: Requirement ID (field where it is injected) * ``specification``: Specification of the required service * ``aggregate``: If True, multiple services will be injected * ``optional``: If True, the requirement is optional * ``services``: List of the specifications of the services provided by components of this factory * ``handlers``: Dictionary of the non-built-in handlers required by this factory. The dictionary keys are handler IDs, and it contains a tuple with: * A copy of the configuration of the handler (0) * A flag indicating if the handler is present or not :param name: The name of a factory :return: A dictionary describing the factory :raise ValueError: Invalid factory """ with self.__factories_lock: try: factory = self.__factories[name] except KeyError: raise ValueError("Unknown factory '{0}'".format(name)) context = getattr(factory, constants.IPOPO_FACTORY_CONTEXT) assert isinstance(context, FactoryContext) result = {} # type: Dict[Any, Any] # Factory name & bundle result["name"] = context.name result["bundle"] = context.bundle_context.get_bundle() # Configurable properties # Name -> Default value result["properties"] = { prop_name: context.properties.get(prop_name) for prop_name in context.properties_fields.values() } # Requirements (list of dictionaries) reqs = result["requirements"] = [] handler_requires = context.get_handler(constants.HANDLER_REQUIRES) if handler_requires is not None: for field, requirement in handler_requires.items():
python
{ "resource": "" }
q9620
set_double_stack
train
def set_double_stack(socket_obj, double_stack=True): # type: (socket.socket, bool) -> None """ Sets up the IPv6 double stack according to the operating system :param socket_obj: A socket object :param double_stack: If True, use the double stack, else only support IPv6 :raise AttributeError: Python or system doesn't support V6 :raise socket.error: Error setting up the double stack value """ try: # Use existing value opt_ipv6_only = socket.IPV6_V6ONLY except AttributeError: # Use "known" value if os.name == "nt":
python
{ "resource": "" }
q9621
escape_LDAP
train
def escape_LDAP(ldap_string): # type: (str) -> str # pylint: disable=C0103 """ Escape a string to let it go in an LDAP filter :param ldap_string: The string to escape :return: The protected string """ if not ldap_string: # No content return ldap_string # Protect escape character previously in the string
python
{ "resource": "" }
q9622
unescape_LDAP
train
def unescape_LDAP(ldap_string): # type: (str) -> str # pylint: disable=C0103 """ Unespaces an LDAP string :param ldap_string: The string to unescape :return: The unprotected string """ if ldap_string is None: return None if ESCAPE_CHARACTER not in ldap_string:
python
{ "resource": "" }
q9623
_comparator_presence
train
def _comparator_presence(_, tested_value): """ Tests a filter which simply a joker, i.e. a value presence test """ # The filter value is a joker : simple presence test if tested_value is None: return False elif hasattr(tested_value, "__len__"): #
python
{ "resource": "" }
q9624
_comparator_eq
train
def _comparator_eq(filter_value, tested_value): """ Tests if the filter value is equal to the tested value """ if isinstance(tested_value, ITERABLES): # Convert the list items to strings for value in tested_value: # Try with the string conversion if not is_string(value): value = repr(value) if filter_value == value: # Match !
python
{ "resource": "" }
q9625
_comparator_approximate
train
def _comparator_approximate(filter_value, tested_value): """ Tests if the filter value is nearly equal to the tested value. If the tested value is a string or an array of string, it compares their lower case forms """ lower_filter_value = filter_value.lower() if is_string(tested_value): # Lower case comparison return _comparator_eq(lower_filter_value, tested_value.lower()) elif hasattr(tested_value, "__iter__"): # Extract a list of strings new_tested = [ value.lower() for value in tested_value if is_string(value) ]
python
{ "resource": "" }
q9626
_comparator_approximate_star
train
def _comparator_approximate_star(filter_value, tested_value): """ Tests if the filter value, which contains a joker, is nearly equal to the tested value. If the tested value is a string or an array of string, it compares their lower case forms """ lower_filter_value = filter_value.lower() if is_string(tested_value): # Lower case comparison return _comparator_star(lower_filter_value, tested_value.lower()) elif hasattr(tested_value, "__iter__"): # Extract a list of strings new_tested = [ value.lower() for value in tested_value if is_string(value) ]
python
{ "resource": "" }
q9627
_comparator_lt
train
def _comparator_lt(filter_value, tested_value): """ Tests if the filter value is strictly greater than the tested value tested_value < filter_value """ if is_string(filter_value): value_type = type(tested_value) try: # Try a conversion filter_value = value_type(filter_value) except (TypeError, ValueError): if value_type is int: # Integer/float comparison trick try:
python
{ "resource": "" }
q9628
_compute_comparator
train
def _compute_comparator(string, idx): # type: (str, int) -> Optional[Callable[[Any, Any], bool]] """ Tries to compute the LDAP comparator at the given index Valid operators are : * = : equality * <= : less than * >= : greater than * ~= : approximate :param string: A LDAP filter string :param idx: An index in the given string :return: The corresponding operator, None if unknown """ part1 = string[idx] try: part2 = string[idx + 1] except IndexError: # String is too short (no comparison) return None if part1 == "=": # Equality return _comparator_eq elif part2 != "=": # It's a "strict" operator if part1 == "<": # Strictly lesser return _comparator_lt elif part1 == ">":
python
{ "resource": "" }
q9629
_compute_operation
train
def _compute_operation(string, idx): # type: (str, int) -> Optional[int] """ Tries to compute the LDAP operation at the given index Valid operations are : * & : AND * | : OR * ! : NOT :param string: A LDAP filter string :param idx: An index in the given string :return: The corresponding operator (AND, OR or NOT)
python
{ "resource": "" }
q9630
_skip_spaces
train
def _skip_spaces(string, idx): # type: (str, int) -> int """ Retrieves the next non-space character after idx index in the given string :param string: The string to
python
{ "resource": "" }
q9631
_parse_ldap
train
def _parse_ldap(ldap_filter): # type: (str) -> Optional[LDAPFilter] """ Parses the given LDAP filter string :param ldap_filter: An LDAP filter string :return: An LDAPFilter object, None if the filter was empty :raise ValueError: The LDAP filter string is invalid """ if ldap_filter is None: # Nothing to do return None assert is_string(ldap_filter) # Remove surrounding spaces ldap_filter = ldap_filter.strip() if not ldap_filter: # Empty string return None escaped = False filter_len = len(ldap_filter) root = None stack = [] subfilter_stack = [] idx = 0 while idx < filter_len: if not escaped: if ldap_filter[idx] == "(": # Opening filter : get the operator idx = _skip_spaces(ldap_filter, idx + 1) if idx == -1: raise ValueError( "Missing filter operator: {0}".format(ldap_filter) ) operator = _compute_operation(ldap_filter, idx) if operator is not None: # New sub-filter stack.append(LDAPFilter(operator)) else: # Sub-filter content subfilter_stack.append(idx) elif ldap_filter[idx] == ")": # Ending filter : store it in its parent if subfilter_stack: # criterion finished start_idx = subfilter_stack.pop() criterion = _parse_ldap_criteria( ldap_filter, start_idx, idx ) if stack: top = stack.pop() top.append(criterion)
python
{ "resource": "" }
q9632
get_ldap_filter
train
def get_ldap_filter(ldap_filter): # type: (Any) -> Optional[Union[LDAPFilter, LDAPCriteria]] """ Retrieves the LDAP filter object corresponding to the given filter. Parses it the argument if it is an LDAPFilter instance :param ldap_filter: An LDAP filter (LDAPFilter or string) :return: The corresponding filter, can be None
python
{ "resource": "" }
q9633
combine_filters
train
def combine_filters(filters, operator=AND): # type: (Iterable[Any], int) -> Optional[Union[LDAPFilter, LDAPCriteria]] """ Combines two LDAP filters, which can be strings or LDAPFilter objects :param filters: Filters to combine :param operator: The operator for combination :return: The combined filter, can be None if all filters are None :raise ValueError: Invalid filter string found :raise TypeError: Unknown filter type """ if not filters: return None if not hasattr(filters, "__iter__") or is_string(filters): raise TypeError("Filters argument must be iterable") # Remove None filters and convert others ldap_filters = [] for sub_filter in filters: if sub_filter is None: # Ignore None filters
python
{ "resource": "" }
q9634
LDAPFilter.append
train
def append(self, ldap_filter): """ Appends a filter or a criterion to this filter :param ldap_filter: An LDAP filter or criterion :raise TypeError: If the parameter is not of a known type :raise ValueError: If the more than one filter is associated to a NOT operator """ if not isinstance(ldap_filter, (LDAPFilter, LDAPCriteria)): raise TypeError(
python
{ "resource": "" }
q9635
LDAPFilter.matches
train
def matches(self, properties): """ Tests if the given properties matches this LDAP filter and its children :param properties: A dictionary of properties :return: True if the properties matches this filter, else False """ # Use a generator, and declare it outside of the method call # => seems to be quite a speed up trick generator = ( criterion.matches(properties) for criterion in self.subfilters ) # Extract "if" from loops and use
python
{ "resource": "" }
q9636
LDAPFilter.normalize
train
def normalize(self): """ Returns the first meaningful object in this filter. """ if not self.subfilters: # No sub-filters return None # New sub-filters list new_filters = [] for subfilter in self.subfilters: # Normalize the sub-filter before storing it norm_filter = subfilter.normalize() if norm_filter is not None and norm_filter not in new_filters: new_filters.append(norm_filter) # Update the instance self.subfilters = new_filters
python
{ "resource": "" }
q9637
LDAPCriteria.matches
train
def matches(self, properties): """ Tests if the given criterion matches this LDAP criterion :param properties: A dictionary of properties :return: True if the properties matches this criterion, else False """ try:
python
{ "resource": "" }
q9638
InstallUtils.discovery_multicast
train
def discovery_multicast(self): """ Installs the multicast discovery bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.discovery.multicast").start() with use_waiting_list(self.context) as ipopo:
python
{ "resource": "" }
q9639
InstallUtils.discovery_mdns
train
def discovery_mdns(self): """ Installs the mDNS discovery bundles and instantiates components """ # Remove Zeroconf debug output logging.getLogger("zeroconf").setLevel(logging.WARNING)
python
{ "resource": "" }
q9640
InstallUtils.discovery_mqtt
train
def discovery_mqtt(self): """ Installs the MQTT discovery bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.discovery.mqtt").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery ipopo.add( rs.FACTORY_DISCOVERY_MQTT, "pelix-discovery-mqtt",
python
{ "resource": "" }
q9641
InstallUtils.discovery_redis
train
def discovery_redis(self): """ Installs the Redis discovery bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.discovery.redis").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery ipopo.add( rs.FACTORY_DISCOVERY_REDIS, "pelix-discovery-redis",
python
{ "resource": "" }
q9642
InstallUtils.discovery_zookeeper
train
def discovery_zookeeper(self): """ Installs the ZooKeeper discovery bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.discovery.zookeeper").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery ipopo.add( rs.FACTORY_DISCOVERY_ZOOKEEPER, "pelix-discovery-zookeeper",
python
{ "resource": "" }
q9643
InstallUtils.transport_jsonrpc
train
def transport_jsonrpc(self): """ Installs the JSON-RPC transport bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.json_rpc").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery
python
{ "resource": "" }
q9644
InstallUtils.transport_jabsorbrpc
train
def transport_jabsorbrpc(self): """ Installs the JABSORB-RPC transport bundles and instantiates components """ # Install the bundle self.context.install_bundle( "pelix.remote.transport.jabsorb_rpc" ).start()
python
{ "resource": "" }
q9645
InstallUtils.transport_mqttrpc
train
def transport_mqttrpc(self): """ Installs the MQTT-RPC transport bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.transport.mqtt_rpc").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery ipopo.add( rs.FACTORY_TRANSPORT_MQTTRPC_EXPORTER,
python
{ "resource": "" }
q9646
InstallUtils.transport_xmlrpc
train
def transport_xmlrpc(self): """ Installs the XML-RPC transport bundles and instantiates components """ # Install the bundle self.context.install_bundle("pelix.remote.xml_rpc").start() with use_waiting_list(self.context) as ipopo: # Instantiate the discovery
python
{ "resource": "" }
q9647
Configuration.get_properties
train
def get_properties(self): """ Return the properties of this Configuration object. The Dictionary object returned is a private copy for the caller and may be changed without influencing the stored configuration. If called just after the configuration is created and before update has been called, this method returns None. :return: A private copy of the properties for the caller or null. These properties must not contain the "service.bundleLocation" property. The value of this property may be obtained from the get_bundle_location() method. """ with self.__lock:
python
{ "resource": "" }
q9648
Configuration.__properties_update
train
def __properties_update(self, properties): """ Internal update of configuration properties. Does not notifies the ConfigurationAdmin of this modification. :param properties: the new set of properties for this configuration :return: True if the properties have been updated, else False """ if not properties: # Nothing to do return False with self.__lock: # Make a copy of the properties properties = properties.copy() # Override properties properties[services.CONFIG_PROP_PID] = self.__pid if self.__location: properties[ services.CONFIG_PROP_BUNDLE_LOCATION ] = self.__location if self.__factory_pid: properties[ services.CONFIG_PROP_FACTORY_PID ] = self.__factory_pid
python
{ "resource": "" }
q9649
Configuration.update
train
def update(self, properties=None): # pylint: disable=W0212 """ If called without properties, only notifies listeners Update the properties of this Configuration object. Stores the properties in persistent storage after adding or overwriting the following properties: * "service.pid" : is set to be the PID of this configuration. * "service.factoryPid" : if this is a factory configuration it is set to the factory PID else it is not set. These system properties are all of type String. If the corresponding Managed Service/Managed Service Factory is registered, its updated method must be called asynchronously. Else, this callback is delayed until aforementioned registration occurs.
python
{ "resource": "" }
q9650
Configuration.delete
train
def delete(self, directory_updated=False): # pylint: disable=W0212 """ Delete this configuration :param directory_updated: If True, tell ConfigurationAdmin to not recall the directory of this deletion (internal use only) """ with self.__lock: if self.__deleted: # Nothing to do return # Update status self.__deleted = True
python
{ "resource": "" }
q9651
Configuration.matches
train
def matches(self, ldap_filter): """ Tests if this configuration matches the given filter. :param ldap_filter: A parsed LDAP filter object :return: True if the properties of this configuration matches the filter """
python
{ "resource": "" }
q9652
_package_exists
train
def _package_exists(path): # type: (str) -> bool """ Checks if the given Python path matches a valid file or a valid container file :param path: A Python path :return: True if the module or its container exists """ while path:
python
{ "resource": "" }
q9653
normalize_path
train
def normalize_path(): """ Normalizes sys.path to avoid the use of relative folders """ # Normalize Python paths whole_path = [ os.path.abspath(path) for path in sys.path if os.path.exists(path) ] # Keep the "dynamic" current folder indicator and add the "static" # current path # Use an OrderedDict to have a faster lookup (path not in whole_set) whole_set = collections.OrderedDict((("", 1), (os.getcwd(), 1))) # Add original path entries for path in whole_path: if path not in whole_set: whole_set[path] = 1 # Set the new content of sys.path (still ordered thanks to OrderedDict) sys.path = list(whole_set)
python
{ "resource": "" }
q9654
Bundle.__get_activator_method
train
def __get_activator_method(self, method_name): """ Retrieves the requested method of the activator, or returns None :param method_name: A method name :return: A method, or None """ # Get the activator activator = getattr(self.__module, ACTIVATOR, None) if activator is None: # Get the old activator activator = getattr(self.__module, ACTIVATOR_LEGACY, None) if activator is not None: # Old activator found: print a deprecation warning
python
{ "resource": "" }
q9655
Bundle._fire_bundle_event
train
def _fire_bundle_event(self, kind): # type: (int) -> None """ Fires a bundle event of
python
{ "resource": "" }
q9656
Bundle.get_registered_services
train
def get_registered_services(self): # type: () -> List[ServiceReference] """ Returns this bundle's ServiceReference list for all services it has registered or an empty list The list is valid at the time of the call to this method, however, as the Framework is a very dynamic environment, services can be
python
{ "resource": "" }
q9657
Bundle.get_services_in_use
train
def get_services_in_use(self): # type: () -> List[ServiceReference] """ Returns this bundle's ServiceReference list for all services it is using or an empty list. A bundle is considered to be using a service if its use count for that service is greater than zero. The list is valid at the time of the call to this method,
python
{ "resource": "" }
q9658
Bundle.start
train
def start(self): """ Starts the bundle. Does nothing if the bundle is already starting or active. :raise BundleException: The framework is not yet started or the bundle activator failed. """ if self.__framework._state not in (Bundle.STARTING, Bundle.ACTIVE): # Framework is not running raise BundleException( "Framework must be started before its bundles" ) with self._lock: if self._state in (Bundle.ACTIVE, Bundle.STARTING): # Already started bundle, do nothing return # Store the bundle current state previous_state = self._state # Starting... self._state = Bundle.STARTING self._fire_bundle_event(BundleEvent.STARTING)
python
{ "resource": "" }
q9659
Bundle.stop
train
def stop(self): """ Stops the bundle. Does nothing if the bundle is already stopped. :raise BundleException: The bundle activator failed. """ if self._state != Bundle.ACTIVE: # Invalid state return exception = None with self._lock: # Store the bundle current state previous_state = self._state # Stopping... self._state = Bundle.STOPPING self._fire_bundle_event(BundleEvent.STOPPING) # Call the activator, if any stopper = self.__get_activator_method("stop") if stopper is not None: try: # Call the start method stopper(self.__context) except (FrameworkException, BundleException) as ex: # Restore previous state self._state = previous_state # Re-raise directly Pelix exceptions _logger.exception( "Pelix error raised by %s while stopping", self.__name ) exception = ex except Exception as ex: _logger.exception( "Error raised by %s while stopping", self.__name ) # Store the exception (raised after service clean up) exception = BundleException(ex) # Hide remaining services self.__framework._hide_bundle_services(self)
python
{ "resource": "" }
q9660
Bundle.__unregister_services
train
def __unregister_services(self): """ Unregisters all bundle services """ # Copy the services list, as it will be modified during the process with self.__registration_lock: registered_services = self.__registered_services.copy() for registration in registered_services: try: registration.unregister() except BundleException: # Ignore errors at this level
python
{ "resource": "" }
q9661
Bundle.uninstall
train
def uninstall(self): """ Uninstalls the bundle """ with self._lock: if self._state == Bundle.ACTIVE: self.stop() # Change the bundle state
python
{ "resource": "" }
q9662
Bundle.update
train
def update(self): """ Updates the bundle """ with self._lock: # Was it active ? restart = self._state == Bundle.ACTIVE # Send the update event self._fire_bundle_event(BundleEvent.UPDATE_BEGIN) try: # Stop the bundle self.stop() except: # Something wrong occurred, notify listeners self._fire_bundle_event(BundleEvent.UPDATE_FAILED) raise # Change the source file age module_stat = None module_file = getattr(self.__module, "__file__", None) if module_file is not None and os.path.isfile(module_file): try: module_stat = os.stat(module_file) # Change modification time to bypass weak time resolution # of the underlying file system os.utime( module_file, (module_stat.st_atime, module_stat.st_mtime + 1), ) except OSError: # Can't touch the file _logger.warning( "Failed to update the modification time of '%s'. " "The bundle update might not reflect the latest " "changes.", module_file, ) # Clean up the module constants (otherwise kept by reload) # Keep special members (__name__, __file__, ...) old_content = self.__module.__dict__.copy() for name in list(self.__module.__dict__): if not (name.startswith("__") and name.endswith("__")): del self.__module.__dict__[name] try: # Reload the module reload_module(self.__module) except (ImportError, SyntaxError) as ex:
python
{ "resource": "" }
q9663
Framework.get_bundle_by_id
train
def get_bundle_by_id(self, bundle_id): # type: (int) -> Union[Bundle, Framework] """ Retrieves the bundle with the given ID :param bundle_id: ID of an installed bundle :return: The requested bundle :raise BundleException: The ID is invalid """ if bundle_id == 0: # "System bundle" return self
python
{ "resource": "" }
q9664
Framework.get_bundle_by_name
train
def get_bundle_by_name(self, bundle_name): # type: (str) -> Optional[Bundle] """ Retrieves the bundle with the given name :param bundle_name: Name of the bundle to look for :return: The requested bundle, None if not found """ if bundle_name is None: # Nothing to do return None if bundle_name is self.get_symbolic_name(): # System bundle requested
python
{ "resource": "" }
q9665
Framework.get_bundles
train
def get_bundles(self): # type: () -> List[Bundle] """ Returns the list of all installed bundles :return: the list of all installed bundles """ with self.__bundles_lock: return
python
{ "resource": "" }
q9666
Framework.get_property
train
def get_property(self, name): # type: (str) -> object """ Retrieves a framework or system property. As framework properties don't
python
{ "resource": "" }
q9667
Framework.install_bundle
train
def install_bundle(self, name, path=None): # type: (str, str) -> Bundle """ Installs the bundle with the given name *Note:* Before Pelix 0.5.0, this method returned the ID of the installed bundle, instead of the Bundle object. **WARNING:** The behavior of the loading process is subject to changes, as it does not allow to safely run multiple frameworks in the same Python interpreter, as they might share global module values. :param name: A bundle name :param path: Preferred path to load the module :return: The installed Bundle object :raise BundleException: Something happened """ with self.__bundles_lock: # A bundle can't be installed twice for bundle in self.__bundles.values(): if bundle.get_symbolic_name() == name: _logger.debug("Already installed bundle: %s", name) return bundle # Load the module try: if path: # Use the given path in priority sys.path.insert(0, path) try: # The module has already been loaded module_ = sys.modules[name] except KeyError: # Load the module # __import__(name) -> package level # import_module -> module level module_ = importlib.import_module(name) except (ImportError, IOError) as ex: # Error importing the module raise BundleException(
python
{ "resource": "" }
q9668
Framework.install_package
train
def install_package(self, path, recursive=False, prefix=None): # type: (str, bool, str) -> tuple """ Installs all the modules found in the given package :param path: Path of the package (folder) :param recursive: If True, install the sub-packages too :param prefix: (**internal**) Prefix for all found modules :return: A 2-tuple, with the list of installed bundles and the list of failed modules names :raise ValueError: Invalid path """ if not path: raise ValueError("Empty path") elif not is_string(path): raise ValueError("Path must be a string") # Use an absolute path path = os.path.abspath(path) if not os.path.exists(path): raise ValueError("Nonexistent path: {0}".format(path)) # Create a simple visitor def visitor(fullname, is_package, module_path): # pylint: disable=W0613 """ Package visitor: accepts everything in recursive mode, else avoids packages """ return recursive or not is_package # Set up the prefix if needed if prefix is
python
{ "resource": "" }
q9669
Framework.install_visiting
train
def install_visiting(self, path, visitor, prefix=None): """ Installs all the modules found in the given path if they are accepted by the visitor. The visitor must be a callable accepting 3 parameters: * fullname: The full name of the module * is_package: If True, the module is a package * module_path: The path to the module file :param path: Root search path :param visitor: The visiting callable :param prefix: (**internal**) Prefix for all found modules :return: A 2-tuple, with the list of installed bundles and the list of failed modules names :raise ValueError: Invalid path or visitor """ # Validate the path if not path: raise ValueError("Empty path") elif not is_string(path): raise ValueError("Path must be a string") # Validate the visitor if visitor is None: raise ValueError("No visitor method given") # Use an absolute path path = os.path.abspath(path) if not os.path.exists(path): raise ValueError("Inexistent path: {0}".format(path)) # Set up the prefix if needed if prefix is None: prefix = os.path.basename(path) bundles = set() failed = set() with self.__bundles_lock: # Walk through the folder to find modules for name, is_package in walk_modules(path): # Ignore '__main__' modules if name == "__main__": continue # Compute the full name of the module fullname = ".".join((prefix, name)) if prefix else name try: if visitor(fullname, is_package, path):
python
{ "resource": "" }
q9670
Framework.register_service
train
def register_service( self, bundle, clazz, service, properties, send_event, factory=False, prototype=False, ): # type: (Bundle, Union[List[Any], type, str], object, dict, bool, bool, bool) -> ServiceRegistration """ Registers a service and calls the listeners :param bundle: The bundle registering the service :param clazz: Name(s) of the interface(s) implemented by service :param service: The service to register :param properties: Service properties :param send_event: If not, doesn't trigger a service registered event :param factory: If True, the given service is a service factory :param prototype: If True, the given service is a prototype service factory (the factory argument is considered True) :return: A ServiceRegistration object :raise BundleException: An error occurred while registering the service """ if bundle is None or service is None or not clazz:
python
{ "resource": "" }
q9671
Framework.start
train
def start(self): # type: () -> bool """ Starts the framework :return: True if the bundle has been started, False if it was already running :raise BundleException: A bundle failed to start """ with self._lock: if self._state in (Bundle.STARTING, Bundle.ACTIVE): # Already started framework return False # Reset the stop event self._fw_stop_event.clear() # Starting... self._state = Bundle.STARTING self._dispatcher.fire_bundle_event( BundleEvent(BundleEvent.STARTING, self) ) # Start all registered bundles (use a copy, just in case...) for bundle in self.__bundles.copy().values(): try: bundle.start() except FrameworkException as ex: # Important error
python
{ "resource": "" }
q9672
Framework.stop
train
def stop(self): # type: () -> bool """ Stops the framework :return: True if the framework stopped, False it wasn't running """ with self._lock: if self._state != Bundle.ACTIVE: # Invalid state return False # Hide all services (they will be deleted by bundle.stop()) for bundle in self.__bundles.values(): self._registry.hide_bundle_services(bundle) # Stopping... self._state = Bundle.STOPPING self._dispatcher.fire_bundle_event( BundleEvent(BundleEvent.STOPPING, self) ) # Notify listeners that the bundle is stopping self._dispatcher.fire_framework_stopping()
python
{ "resource": "" }
q9673
Framework.delete
train
def delete(self, force=False): """ Deletes the current framework :param force: If True, stops the framework before deleting it :return: True if the framework has been delete, False if is couldn't
python
{ "resource": "" }
q9674
Framework.unregister_service
train
def unregister_service(self, registration): # type: (ServiceRegistration) -> bool """ Unregisters the given service :param registration: A ServiceRegistration to the service to unregister :raise BundleException: Invalid reference """ # Get the Service Reference reference = registration.get_reference() # Remove the service from the registry svc_instance = self._registry.unregister(reference) # Keep a track of the unregistering reference self.__unregistering_services[reference] = svc_instance # Call the listeners event = ServiceEvent(ServiceEvent.UNREGISTERING, reference)
python
{ "resource": "" }
q9675
Framework.update
train
def update(self): """ Stops and starts the framework, if the framework is active. :raise BundleException: Something wrong occurred while stopping or starting
python
{ "resource": "" }
q9676
Framework.wait_for_stop
train
def wait_for_stop(self, timeout=None): # type: (Optional[int]) -> bool """ Waits for the framework to stop. Does nothing if the framework bundle is not in ACTIVE state. Uses a threading.Condition object :param timeout: The maximum time to wait (in
python
{ "resource": "" }
q9677
ServiceObjects.unget_service
train
def unget_service(self, service): # type: (Any) -> bool """ Releases a service object for the associated service. :param service: An instance of a service returned by ``get_service()`` :return: True
python
{ "resource": "" }
q9678
BundleContext.get_service_reference
train
def get_service_reference(self, clazz, ldap_filter=None): # type: (Optional[str], Optional[str]) -> Optional[ServiceReference] """ Returns a ServiceReference object for a service that implements and was registered under the specified class :param clazz: The class name with which the service was registered. :param ldap_filter: A filter on service properties
python
{ "resource": "" }
q9679
BundleContext.get_service_references
train
def get_service_references(self, clazz, ldap_filter=None): # type: (Optional[str], Optional[str]) -> Optional[List[ServiceReference]] """ Returns the service references for services that were registered under the specified class by this bundle and matching the given filter :param clazz: The class name with which
python
{ "resource": "" }
q9680
BundleContext.register_service
train
def register_service( self, clazz, service, properties, send_event=True, factory=False, prototype=False, ): # type: (Union[List[Any], type, str], object, dict, bool, bool, bool) -> ServiceRegistration """ Registers a service :param clazz: Class or Classes (list) implemented by this service :param service: The service instance :param properties: The services properties (dictionary) :param send_event: If not, doesn't trigger a service registered event :param factory: If True, the given service is a service factory :param prototype: If True, the given service is a prototype service
python
{ "resource": "" }
q9681
BundleContext.unget_service
train
def unget_service(self, reference): # type: (ServiceReference) -> bool """ Disables a reference to the service
python
{ "resource": "" }
q9682
FrameworkFactory.get_framework
train
def get_framework(cls, properties=None): # type: (Optional[dict]) -> Framework """ If it doesn't exist yet, creates a framework with the given properties, else returns the current framework instance. :return: A Pelix instance """
python
{ "resource": "" }
q9683
FrameworkFactory.delete_framework
train
def delete_framework(cls, framework=None): # type: (Optional[Framework]) -> bool # pylint: disable=W0212 """ Removes the framework singleton :return: True on success, else False """ if framework is None: framework = cls.__singleton if framework is cls.__singleton: # Stop the framework try: framework.stop() except: _logger.exception("Error stopping the framework") # Uninstall its bundles bundles = framework.get_bundles() for bundle in bundles: try: bundle.uninstall() except:
python
{ "resource": "" }
q9684
get_matching_interfaces
train
def get_matching_interfaces(object_class, exported_intfs): # type: (List[str], Optional[List[str]]) -> Optional[List[str]] """ Returns the list of interfaces matching the export property :param object_class: The specifications of the service :param exported_intfs: The declared exported interfaces :return: The list of declared exported interfaces """ if object_class is None or exported_intfs is None:
python
{ "resource": "" }
q9685
get_prop_value
train
def get_prop_value(name, props, default=None): # type: (str, Dict[str, Any], Any) -> Any """ Returns the value of a property or the default one :param name: Name of a property :param props: Dictionary of properties :param default: Default value
python
{ "resource": "" }
q9686
set_prop_if_null
train
def set_prop_if_null(name, props, if_null): # type: (str, Dict[str, Any], Any) -> None """ Updates the value of a property if the previous one was None :param name: Name of the property :param props: Dictionary
python
{ "resource": "" }
q9687
get_string_plus_property_value
train
def get_string_plus_property_value(value): # type: (Any) -> Optional[List[str]] """ Converts a string or list of string into a list of strings :param value: A string or a list of strings :return: A list of strings or None """ if value: if isinstance(value, str):
python
{ "resource": "" }
q9688
get_string_plus_property
train
def get_string_plus_property(name, props, default=None): # type: (str, Dict[str, Any], Optional[Any]) -> Any """ Returns the value of the given property or the default value :param name: A property name
python
{ "resource": "" }
q9689
get_exported_interfaces
train
def get_exported_interfaces(svc_ref, overriding_props=None): # type: (ServiceReference, Optional[Dict[str, Any]]) -> Optional[List[str]] """ Looks for the interfaces exported by a service :param svc_ref: Service reference :param overriding_props: Properties overriding service ones :return: The list of exported interfaces """ # first check overriding_props for service.exported.interfaces exported_intfs = get_prop_value( SERVICE_EXPORTED_INTERFACES, overriding_props
python
{ "resource": "" }
q9690
validate_exported_interfaces
train
def validate_exported_interfaces(object_class, exported_intfs): # type: (List[str], List[str]) -> bool """ Validates that the exported interfaces are all provided by the service :param object_class: The specifications of a service :param exported_intfs: The exported specifications :return: True if the exported specifications are all provided by the service """ if (
python
{ "resource": "" }
q9691
get_package_versions
train
def get_package_versions(intfs, props): # type: (List[str], Dict[str, Any]) -> List[Tuple[str, str]] """ Gets the package version of interfaces :param intfs: A list of interfaces :param props: A dictionary containing endpoint package versions :return: A list of tuples (package name, version) """ result = [] for intf in intfs:
python
{ "resource": "" }
q9692
get_rsa_props
train
def get_rsa_props( object_class, exported_cfgs, remote_intents=None, ep_svc_id=None, fw_id=None, pkg_vers=None, service_intents=None, ): """ Constructs a dictionary of RSA properties from the given arguments :param object_class: Service specifications :param exported_cfgs: Export configurations :param remote_intents: Supported remote intents :param ep_svc_id: Endpoint service ID :param fw_id: Remote Framework ID :param pkg_vers: Version number of the specification package :param service_intents: Service intents :return: A dictionary of properties """ results = {} if not object_class: raise ArgumentError( "object_class", "object_class must be an [] of Strings" ) results["objectClass"] = object_class if not exported_cfgs: raise ArgumentError( "exported_cfgs", "exported_cfgs must be an array of Strings" )
python
{ "resource": "" }
q9693
get_ecf_props
train
def get_ecf_props(ep_id, ep_id_ns, rsvc_id=None, ep_ts=None): """ Prepares the ECF properties :param ep_id: Endpoint ID :param ep_id_ns: Namespace of the Endpoint ID :param rsvc_id: Remote service ID :param ep_ts: Timestamp of the endpoint :return: A dictionary of ECF properties """ results = {} if not ep_id: raise ArgumentError("ep_id", "ep_id must be a valid endpoint id") results[ECF_ENDPOINT_ID] = ep_id
python
{ "resource": "" }
q9694
get_edef_props
train
def get_edef_props( object_class, exported_cfgs, ep_namespace, ep_id, ecf_ep_id, ep_rsvc_id, ep_ts, remote_intents=None, fw_id=None, pkg_ver=None, service_intents=None, ): """ Prepares the EDEF properties of an endpoint, merge of RSA and ECF properties """ osgi_props = get_rsa_props( object_class,
python
{ "resource": "" }
q9695
get_dot_properties
train
def get_dot_properties(prefix, props, remove_prefix): # type: (str, Dict[str, Any], bool) -> Dict[str, Any] """ Gets the properties starting with the given prefix """ result_props = {} if props: dot_keys = [x for x in props.keys() if x.startswith(prefix + ".")] for dot_key in dot_keys:
python
{ "resource": "" }
q9696
copy_non_reserved
train
def copy_non_reserved(props, target): # type: (Dict[str, Any], Dict[str, Any]) -> Dict[str, Any] """ Copies all properties with non-reserved names from ``props`` to ``target`` :param props: A dictionary of properties :param target: Another dictionary :return: The target dictionary """ target.update(
python
{ "resource": "" }
q9697
copy_non_ecf
train
def copy_non_ecf(props, target): # type: (Dict[str, Any], Dict[str, Any]) -> Dict[str, Any] """ Copies non-ECF properties from ``props`` to ``target`` :param props: An input dictionary :param target: The dictionary to copy non-ECF properties to
python
{ "resource": "" }
q9698
set_append
train
def set_append(input_set, item): # type: (set, Any) -> set """ Appends in-place the given item to the set. If the item is a list, all elements are added to the set. :param input_set: An existing set :param item: The item or list of items to add :return: The given set """
python
{ "resource": "" }
q9699
RemoteServiceAdminEvent.fromimportreg
train
def fromimportreg(cls, bundle, import_reg): # type: (Bundle, ImportRegistration) -> RemoteServiceAdminEvent """ Creates a RemoteServiceAdminEvent object from an ImportRegistration """ exc = import_reg.get_exception() if exc: return RemoteServiceAdminEvent( RemoteServiceAdminEvent.IMPORT_ERROR, bundle,
python
{ "resource": "" }