zeroc-ice 3.7.11__cp314-cp314-win_amd64.whl → 3.8.0.post1__cp314-cp314-win_amd64.whl

Ice/Properties.py

@@ -0,0 +1,371 @@
+# Copyright (c) ZeroC, Inc.
+
+from typing import Self, final, overload
+
+import IcePy
+
+
+@final
+class Properties:
+    """
+    Represents a set of properties used to configure Ice and Ice-based applications. A property is a key/value pair,
+    where both the key and the value are strings. By convention, property keys should have the form
+    ``application-name[.category[.sub-category]].name``.
+    """
+
+    @overload
+    def __init__(self, args: list[str] | None = None, defaults: Self | None = None): ...
+
+    @overload
+    def __init__(self, *, properties: IcePy.Properties): ...
+
+    def __init__(
+        self, args: list[str] | None = None, defaults: Self | None = None, properties: IcePy.Properties | None = None
+    ):
+        """
+        Initialize a new instance of the Properties class.
+
+        This constructor loads the configuration files specified by the ``Ice.Config`` property or the
+        ``ICE_CONFIG`` environment variable, and then parses Ice properties from ``args``.
+
+        Parameters
+        ----------
+        args : list[str] | None, optional
+            The command-line arguments. Arguments starting with ``--`` and one of the reserved prefixes
+            (``Ice``, ``IceSSL``, etc.) are parsed as properties and removed from the list. If there is
+            an argument starting with ``--Ice.Config``, the specified configuration file is loaded. When
+            the same property is set in both a configuration file and a command-line argument, the
+            command-line setting takes precedence.
+        defaults : Self | None, optional
+            Default values for the new Properties object. Settings in configuration files and command-line
+            arguments override these defaults.
+
+        Notes
+        -----
+        When there is no ``--Ice.Config`` command-line argument, this constructor loads properties from
+        the files specified by the ``ICE_CONFIG`` environment variable.
+
+        Examples
+        --------
+        .. code-block:: python
+            # Create a new empty property set.
+            properties = Ice.Properties()
+
+            # Create a property set from command-line arguments.
+            properties = Ice.Properties(sys.argv)
+
+            # Create a property set using default values.
+            defaultProperties = Ice.Properties()
+            defaultProperties.setProperty("Ice.Trace.Protocol", "1")
+            properties = Ice.Properties(defaults=defaultProperties)
+
+            # Combine command-line parsing with default values.
+            defaultProperties = Ice.Properties()
+            defaultProperties.setProperty("Ice.Trace.Protocol", "1")
+            properties = Ice.Properties(sys.argv, defaultProperties)
+        """
+        if isinstance(properties, IcePy.Properties):
+            self._impl = properties
+        else:
+            self._impl = IcePy.createProperties(args, defaults)
+
+    def getProperty(self, key: str) -> str:
+        """
+        Gets a property by key.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        str
+            The property value, or the empty string if the property is not set.
+        """
+        return self._impl.getProperty(key)
+
+    def getIceProperty(self, key: str) -> str:
+        """
+        Gets an Ice property by key.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        str
+            The property value, or the default value for this property if the property is not set.
+
+        Raises
+        ------
+        PropertyException
+            If the property is not a known Ice property.
+        """
+        return self._impl.getIceProperty(key)
+
+    def getPropertyWithDefault(self, key: str, value: str) -> str:
+        """
+        Gets a property by key.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+        value : str
+            The default value to return if the property is not set.
+
+        Returns
+        -------
+        str
+            The property value or the default value if the property is not set.
+        """
+        return self._impl.getPropertyWithDefault(key, value)
+
+    def getPropertyAsInt(self, key: str) -> int:
+        """
+        Gets a property as an integer.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        int
+            The property value interpreted as an integer, or ``0`` if the property is not set.
+
+        Raises
+        ------
+        PropertyException
+            If the property value is not a valid integer.
+        """
+        return self._impl.getPropertyAsInt(key)
+
+    def getIcePropertyAsInt(self, key: str) -> int:
+        """
+        Gets an Ice property as an integer.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        int
+            The property value interpreted as an integer, or the default value if the property is not set.
+
+        Raises
+        ------
+        PropertyException
+            If the property is not a known Ice property or the value is not a valid integer.
+        """
+        return self._impl.getIcePropertyAsInt(key)
+
+    def getPropertyAsIntWithDefault(self, key: str, value: int) -> int:
+        """
+        Gets a property as an integer.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+        value : int
+            The default value to return if the property does not exist.
+
+        Returns
+        -------
+        int
+            The property value interpreted as an integer, or the default value if the property is not set.
+
+        Raises
+        ------
+        PropertyException
+            If the property value is not a valid integer.
+        """
+        return self._impl.getPropertyAsIntWithDefault(key, value)
+
+    def getPropertyAsList(self, key: str) -> list[str]:
+        """
+        Gets a property as a list of strings.
+
+        The strings must be separated by whitespace or comma. The strings in the list can contain whitespace and commas
+        if they are enclosed in single or double quotes. If quotes are mismatched, an empty list is returned.
+        Within single quotes or double quotes, you can escape the quote in question with a backslash,
+        e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        list[str]
+            The property value interpreted as a list of strings, or an empty list if the property is not set.
+        """
+        return self._impl.getPropertyAsList(key)
+
+    def getIcePropertyAsList(self, key: str) -> list[str]:
+        """
+        Gets an Ice property as a list of strings.
+
+        The strings must be separated by whitespace or comma. The strings in the list can contain whitespace and commas
+        if they are enclosed in single or double quotes. If quotes are mismatched, the default list is returned.
+        Within single quotes or double quotes, you can escape the quote in question with a backslash,
+        e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+
+        Returns
+        -------
+        list[str]
+            The property value interpreted as a list of strings, or the default value if the property is not set.
+
+        Raises
+        ------
+        PropertyException
+            If the property is not a known Ice property.
+        """
+        return self._impl.getIcePropertyAsList(key)
+
+    def getPropertyAsListWithDefault(self, key: str, value: list[str]) -> list[str]:
+        """
+        Gets a property as a list of strings.
+
+        The strings must be separated by whitespace or comma. The strings in the list can contain whitespace and commas
+        if they are enclosed in single or double quotes. If quotes are mismatched, the default list is returned.
+        Within single quotes or double quotes, you can escape the quote in question with a backslash,
+        e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+        value : list[str]
+            The default value to use if the property is not set.
+
+        Returns
+        -------
+        list[str]
+            The property value interpreted as a list of strings, or the default value if the property is not set.
+        """
+        return self._impl.getPropertyAsListWithDefault(key, value)
+
+    def getPropertiesForPrefix(self, prefix: str) -> dict[str, str]:
+        """
+        Gets all properties whose keys begin with the given prefix.
+        If ``prefix`` is the empty string, then all properties are returned.
+
+        Parameters
+        ----------
+        prefix : str
+            The prefix to search for.
+
+        Returns
+        -------
+        dict[str, str]
+            The matching property set.
+        """
+        return self._impl.getPropertiesForPrefix(prefix)
+
+    def setProperty(self, key: str, value: str) -> None:
+        """
+        Sets a property. To unset a property, set it to the empty string.
+
+        Parameters
+        ----------
+        key : str
+            The property key.
+        value : str
+            The property value.
+        """
+        self._impl.setProperty(key, value)
+
+    def getCommandLineOptions(self) -> list[str]:
+        """
+        Gets a sequence of command-line options that is equivalent to this property set.
+        Each element of the returned sequence is a command-line option of the form ``--key=value``.
+
+        Returns
+        -------
+        list[str]
+            The command line options for this property set.
+        """
+        return self._impl.getCommandLineOptions()
+
+    def parseCommandLineOptions(self, prefix: str, options: list[str]) -> list[str]:
+        """
+        Converts a sequence of command-line options into properties.
+
+        All options that start with ``--prefix.`` are converted into properties.
+        If the prefix is empty, all options that begin with ``--`` are converted to properties.
+
+        Parameters
+        ----------
+        prefix : str
+            The property prefix, or the empty string to convert all options starting with ``--``.
+        options : list[str]
+            The command-line options.
+
+        Returns
+        -------
+        list[str]
+            The command-line options that do not start with the specified prefix, in their original order.
+        """
+        return self._impl.parseCommandLineOptions(prefix, options)
+
+    def parseIceCommandLineOptions(self, options: list[str]) -> list[str]:
+        """
+        Converts a sequence of command-line options into properties.
+
+        All options that start with one of the reserved Ice prefixes (``--Ice``, ``--IceSSL``, etc.) are converted into
+        properties.
+
+        Parameters
+        ----------
+        options : list[str]
+            The command-line options.
+
+        Returns
+        -------
+        list[str]
+            The command-line options that do not start with one of the reserved prefixes, in their original order.
+        """
+        return self._impl.parseIceCommandLineOptions(options)
+
+    def load(self, file: str) -> None:
+        """
+        Loads properties from a file.
+
+        Parameters
+        ----------
+        file : str
+            The property file.
+        """
+        self._impl.load(file)
+
+    def clone(self) -> "Properties":
+        """
+        Creates a copy of this property set.
+
+        Returns
+        -------
+        Properties
+            A copy of this property set.
+        """
+        return Properties(properties=self._impl.clone())
+
+    def __iter__(self):
+        dict = self._impl.getPropertiesForPrefix("")
+        return iter(dict)
+
+    def __str__(self) -> str:
+        return str(self._impl)

Ice/PropertiesAdmin.py

@@ -0,0 +1,302 @@
+# Copyright (c) ZeroC, Inc.
+
+# slice2py version 3.8.0
+
+from __future__ import annotations
+import IcePy
+
+from Ice.Object import Object
+
+from Ice.ObjectPrx import ObjectPrx
+from Ice.ObjectPrx import checkedCast
+from Ice.ObjectPrx import checkedCastAsync
+from Ice.ObjectPrx import uncheckedCast
+
+from Ice.OperationMode import OperationMode
+
+from Ice.PropertiesAdmin_forward import _Ice_PropertiesAdminPrx_t
+
+from Ice.PropertyDict import _Ice_PropertyDict_t
+
+from abc import ABC
+from abc import abstractmethod
+
+from typing import TYPE_CHECKING
+from typing import overload
+
+if TYPE_CHECKING:
+    from Ice.Current import Current
+    from collections.abc import Awaitable
+    from collections.abc import Mapping
+    from collections.abc import Sequence
+
+
+class PropertiesAdminPrx(ObjectPrx):
+    """
+    Provides remote access to the properties of a communicator.
+    
+    Notes
+    -----
+        The Slice compiler generated this proxy class from Slice interface ``::Ice::PropertiesAdmin``.
+    """
+
+    def getProperty(self, key: str, context: dict[str, str] | None = None) -> str:
+        """
+        Gets a property by key.
+        
+        Parameters
+        ----------
+        key : str
+            The property key.
+        context : dict[str, str]
+            The request context for the invocation.
+        
+        Returns
+        -------
+        str
+            The property value. This value is empty if the property is not set.
+        """
+        return PropertiesAdmin._op_getProperty.invoke(self, ((key, ), context))
+
+    def getPropertyAsync(self, key: str, context: dict[str, str] | None = None) -> Awaitable[str]:
+        """
+        Gets a property by key.
+        
+        Parameters
+        ----------
+        key : str
+            The property key.
+        context : dict[str, str]
+            The request context for the invocation.
+        
+        Returns
+        -------
+        Awaitable[str]
+            The property value. This value is empty if the property is not set.
+        """
+        return PropertiesAdmin._op_getProperty.invokeAsync(self, ((key, ), context))
+
+    def getPropertiesForPrefix(self, prefix: str, context: dict[str, str] | None = None) -> dict[str, str]:
+        """
+        Gets all properties whose keys begin with ``prefix``. If ``prefix`` is the empty string then all properties
+        are returned.
+        
+        Parameters
+        ----------
+        prefix : str
+            The prefix to search for. May be empty.
+        context : dict[str, str]
+            The request context for the invocation.
+        
+        Returns
+        -------
+        dict[str, str]
+            The matching property set.
+        """
+        return PropertiesAdmin._op_getPropertiesForPrefix.invoke(self, ((prefix, ), context))
+
+    def getPropertiesForPrefixAsync(self, prefix: str, context: dict[str, str] | None = None) -> Awaitable[dict[str, str]]:
+        """
+        Gets all properties whose keys begin with ``prefix``. If ``prefix`` is the empty string then all properties
+        are returned.
+        
+        Parameters
+        ----------
+        prefix : str
+            The prefix to search for. May be empty.
+        context : dict[str, str]
+            The request context for the invocation.
+        
+        Returns
+        -------
+        Awaitable[dict[str, str]]
+            The matching property set.
+        """
+        return PropertiesAdmin._op_getPropertiesForPrefix.invokeAsync(self, ((prefix, ), context))
+
+    def setProperties(self, newProperties: Mapping[str, str], context: dict[str, str] | None = None) -> None:
+        """
+        Updates the communicator's properties with the given property set. If an entry in ``newProperties`` matches
+        the name of an existing property, that property's value is replaced with the new value. If the new value is
+        the empty string, the property is removed. Existing properties that are not modified or removed by the
+        entries in ``newProperties`` are not affected by this update.
+        
+        Parameters
+        ----------
+        newProperties : Mapping[str, str]
+            Properties to add, change, or remove.
+        context : dict[str, str]
+            The request context for the invocation.
+        """
+        return PropertiesAdmin._op_setProperties.invoke(self, ((newProperties, ), context))
+
+    def setPropertiesAsync(self, newProperties: Mapping[str, str], context: dict[str, str] | None = None) -> Awaitable[None]:
+        """
+        Updates the communicator's properties with the given property set. If an entry in ``newProperties`` matches
+        the name of an existing property, that property's value is replaced with the new value. If the new value is
+        the empty string, the property is removed. Existing properties that are not modified or removed by the
+        entries in ``newProperties`` are not affected by this update.
+        
+        Parameters
+        ----------
+        newProperties : Mapping[str, str]
+            Properties to add, change, or remove.
+        context : dict[str, str]
+            The request context for the invocation.
+        
+        Returns
+        -------
+        Awaitable[None]
+            An awaitable that is completed when the invocation completes.
+        """
+        return PropertiesAdmin._op_setProperties.invokeAsync(self, ((newProperties, ), context))
+
+    @staticmethod
+    def checkedCast(
+        proxy: ObjectPrx | None,
+        facet: str | None = None,
+        context: dict[str, str] | None = None
+    ) -> PropertiesAdminPrx | None:
+        return checkedCast(PropertiesAdminPrx, proxy, facet, context)
+
+    @staticmethod
+    def checkedCastAsync(
+        proxy: ObjectPrx | None,
+        facet: str | None = None,
+        context: dict[str, str] | None = None
+    ) -> Awaitable[PropertiesAdminPrx | None ]:
+        return checkedCastAsync(PropertiesAdminPrx, proxy, facet, context)
+
+    @overload
+    @staticmethod
+    def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> PropertiesAdminPrx:
+        ...
+
+    @overload
+    @staticmethod
+    def uncheckedCast(proxy: None, facet: str | None = None) -> None:
+        ...
+
+    @staticmethod
+    def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> PropertiesAdminPrx | None:
+        return uncheckedCast(PropertiesAdminPrx, proxy, facet)
+
+    @staticmethod
+    def ice_staticId() -> str:
+        return "::Ice::PropertiesAdmin"
+
+IcePy.defineProxy("::Ice::PropertiesAdmin", PropertiesAdminPrx)
+
+class PropertiesAdmin(Object, ABC):
+    """
+    Provides remote access to the properties of a communicator.
+    
+    Notes
+    -----
+        The Slice compiler generated this skeleton class from Slice interface ``::Ice::PropertiesAdmin``.
+    """
+
+    _ice_ids: Sequence[str] = ("::Ice::Object", "::Ice::PropertiesAdmin", )
+    _op_getProperty: IcePy.Operation
+    _op_getPropertiesForPrefix: IcePy.Operation
+    _op_setProperties: IcePy.Operation
+
+    @staticmethod
+    def ice_staticId() -> str:
+        return "::Ice::PropertiesAdmin"
+
+    @abstractmethod
+    def getProperty(self, key: str, current: Current) -> str | Awaitable[str]:
+        """
+        Gets a property by key.
+        
+        Parameters
+        ----------
+        key : str
+            The property key.
+        current : Ice.Current
+            The Current object for the dispatch.
+        
+        Returns
+        -------
+        str | Awaitable[str]
+            The property value. This value is empty if the property is not set.
+        """
+        pass
+
+    @abstractmethod
+    def getPropertiesForPrefix(self, prefix: str, current: Current) -> Mapping[str, str] | Awaitable[Mapping[str, str]]:
+        """
+        Gets all properties whose keys begin with ``prefix``. If ``prefix`` is the empty string then all properties
+        are returned.
+        
+        Parameters
+        ----------
+        prefix : str
+            The prefix to search for. May be empty.
+        current : Ice.Current
+            The Current object for the dispatch.
+        
+        Returns
+        -------
+        Mapping[str, str] | Awaitable[Mapping[str, str]]
+            The matching property set.
+        """
+        pass
+
+    @abstractmethod
+    def setProperties(self, newProperties: dict[str, str], current: Current) -> None | Awaitable[None]:
+        """
+        Updates the communicator's properties with the given property set. If an entry in ``newProperties`` matches
+        the name of an existing property, that property's value is replaced with the new value. If the new value is
+        the empty string, the property is removed. Existing properties that are not modified or removed by the
+        entries in ``newProperties`` are not affected by this update.
+        
+        Parameters
+        ----------
+        newProperties : dict[str, str]
+            Properties to add, change, or remove.
+        current : Ice.Current
+            The Current object for the dispatch.
+        
+        Returns
+        -------
+        None | Awaitable[None]
+            None or an awaitable that completes when the dispatch completes.
+        """
+        pass
+
+PropertiesAdmin._op_getProperty = IcePy.Operation(
+    "getProperty",
+    "getProperty",
+    OperationMode.Normal,
+    None,
+    (),
+    (((), IcePy._t_string, False, 0),),
+    (),
+    ((), IcePy._t_string, False, 0),
+    ())
+
+PropertiesAdmin._op_getPropertiesForPrefix = IcePy.Operation(
+    "getPropertiesForPrefix",
+    "getPropertiesForPrefix",
+    OperationMode.Normal,
+    None,
+    (),
+    (((), IcePy._t_string, False, 0),),
+    (),
+    ((), _Ice_PropertyDict_t, False, 0),
+    ())
+
+PropertiesAdmin._op_setProperties = IcePy.Operation(
+    "setProperties",
+    "setProperties",
+    OperationMode.Normal,
+    None,
+    (),
+    (((), _Ice_PropertyDict_t, False, 0),),
+    (),
+    None,
+    ())
+
+__all__ = ["PropertiesAdmin", "PropertiesAdminPrx", "_Ice_PropertiesAdminPrx_t"]

Ice/PropertiesAdmin_forward.py

@@ -0,0 +1,10 @@
+# Copyright (c) ZeroC, Inc.
+
+# slice2py version 3.8.0
+
+from __future__ import annotations
+import IcePy
+
+_Ice_PropertiesAdminPrx_t = IcePy.declareProxy("::Ice::PropertiesAdmin")
+
+__all__ = ["_Ice_PropertiesAdminPrx_t"]

Ice/PropertyDict.py

@@ -0,0 +1,10 @@
+# Copyright (c) ZeroC, Inc.
+
+# slice2py version 3.8.0
+
+from __future__ import annotations
+import IcePy
+
+_Ice_PropertyDict_t = IcePy.defineDictionary("::Ice::PropertyDict", (), IcePy._t_string, IcePy._t_string)
+
+__all__ = ["_Ice_PropertyDict_t"]