rucio-clients 37.3.0__py3-none-any.whl → 37.5.0__py3-none-any.whl

rucio/client/exportclient.py

@@ -28,9 +28,15 @@ class ExportClient(BaseClient):
     def export_data(self, distance: bool = True) -> dict[str, Any]:
         """
         Export RSE data (RSE, settings, attributes and distance).
-        :param distance: To include the distance.
+        Parameters
+        ----------
+        distance :
+            To include the distance. Default is True.
 
-        :returns: A dict containing data
+        Returns
+        -------
+
+            A dict containing data
         """
         payload = {'distance': distance}
         path = '/'.join([self.EXPORT_BASEURL])

rucio/client/fileclient.py

@@ -31,10 +31,17 @@ class FileClient(BaseClient):
         """
         List file replicas.
 
-        :param scope: the scope.
-        :param lfn: the lfn.
+        Parameters
+        ----------
+        scope :
+            The scope of the file.
+        lfn :
+            The LFN
 
-        :return: List of replicas.
+        Returns
+        -------
+
+            List of replicas.
         """
         path = '/'.join([self.BASEURL, quote_plus(scope), quote_plus(lfn), 'rses'])
         url = build_url(choice(self.list_hosts), path=path)

rucio/client/importclient.py

@@ -29,7 +29,10 @@ class ImportClient(BaseClient):
         """
         Imports data into Rucio.
 
-        :param data: a dict containing data to be imported into Rucio.
+        Parameters
+        ----------
+        data :
+            A dict containing data to be imported into Rucio.
         """
         path = '/'.join([self.IMPORT_BASEURL])
         url = build_url(choice(self.list_hosts), path=path)

rucio/client/lifetimeclient.py

@@ -45,26 +45,32 @@ class LifetimeClient(BaseClient):
         (files, datasets, containers, or archives) that need to be kept longer than usual. These exceptions
         can be filtered by their ID or approval state (this feature is not available yet).
 
-        :param exception_id: The unique identifier of a specific exception. If provided, returns only that exception.
-        :param states: Filter exceptions by their states. Possible values are:
-                      - `A` (APPROVED): Exception was approved
-                      - `R` (REJECTED): Exception was rejected
-                      - `W` (WAITING): Exception is waiting for approval by an admin (or other authorized account)
+        Parameters
+        ----------
+        exception_id :
+            The unique identifier of a specific exception. If provided, returns only that exception.
+        states :
+            Filter exceptions by their states. Possible values are:
+            * `A` (APPROVED): Exception was approved
+            * `R` (REJECTED): Exception was rejected
+            * `W` (WAITING): Exception is waiting for approval by an admin (or other authorized account)
+
+        Returns
+        -------
 
-        :returns:
             An iterator of dictionaries containing the exception details:
-             - `id`: The unique identifier of the exception
-             - `scope`: The scope of the data identifier
-             - `name`: The name of the data identifier
-             - `did_type`: Type of the data identifier:
-                    `F` (file), `D` (dataset), `C` (container), `A` (archive),
-                    `X` (deleted file), `Y` (deleted dataset), `Z` (deleted container)
-             - `account`: The account that requested the exception
-             - `pattern`: Pattern used for matching data identifiers
-             - `comments`: User provided comments explaining the exception
-             - `state`: Current state of the exception
-             - `created_at`: When the exception was created (returned as timestamp string)
-             - `expires_at`: When the exception expires (returned as timestamp string)
+            * `id`: The unique identifier of the exception
+            * `scope`: The scope of the data identifier
+            * `name`: The name of the data identifier
+            * `did_type`: Type of the data identifier:
+                `F` (file), `D` (dataset), `C` (container), `A` (archive),
+                `X` (deleted file), `Y` (deleted dataset), `Z` (deleted container)
+            * `account`: The account that requested the exception
+            * `pattern`: Pattern used for matching data identifiers
+            * `comments`: User provided comments explaining the exception
+            * `state`: Current state of the exception
+            * `created_at`: When the exception was created (returned as timestamp string)
+            * `expires_at`: When the exception expires (returned as timestamp string)
         """
 
         path = self.LIFETIME_BASEURL + '/'
@@ -98,19 +104,30 @@ class LifetimeClient(BaseClient):
         maximum extension periods. The request includes details about which DIDs should have extended
         lifetimes, who is requesting it, and why it's needed.
 
-        :param dids: List of dictionaries containing the data identifiers to be excepted.
-                    Each dictionary must contain:
-                    - `scope`: The scope of the data identifier
-                    - `name`: The name of the data identifier
-        :param account: The account requesting the exception
-        :param pattern: Associated pattern for the exception request
-        :param comments: Justification for why the exception is needed (e.g. "Needed for my XYZ analysis..")
-        :param expires_at: When the exception should expire (datetime object)
-
-        :returns: A dictionary containing:
-                 - `exceptions`: Dictionary mapping exception IDs to lists of DIDs that were successfully added
-                 - `unknown`: List of DIDs that could not be found
-                 - `not_affected`: List of DIDs that did not qualify for an exception
+        Parameters
+        ----------
+        dids :
+            List of dictionaries containing the data identifiers to be excepted.
+            Each dictionary must contain:
+            * **scope** : The scope of the data identifier
+            * **name** : The name of the data identifier
+        account :
+            The account requesting the exception
+        pattern :
+            Associated pattern for the exception request
+        comments :
+            Justification for why the exception is needed (e.g. "Needed for my XYZ analysis..")
+        expires_at :
+            When the exception should expire (datetime object)
+
+        Returns
+        -------
+
+            A dictionary containing:
+            * **exceptions** : Dictionary mapping exception IDs to lists of DIDs that were successfully added
+            * **unknown** : List of DIDs that could not be found
+            * **not_affected** : List of DIDs that did not qualify for an exception
+
         """
 
         path = self.LIFETIME_BASEURL + '/'

rucio/client/lockclient.py

@@ -38,8 +38,13 @@ class LockClient(BaseClient):
         """
         Get a dataset locks of the specified dataset.
 
-        :param scope: the scope of the did of the locks to list.
-        :param name: the name of the did of the locks to list.
+        Parameters
+        ----------
+        scope :
+            The scope of the did of the locks to list.
+        name :
+            The name of the did of the locks to list.
+
         """
 
         path = '/'.join([self.LOCKS_BASEURL, quote_plus(scope), quote_plus(name)])
@@ -62,10 +67,17 @@ class LockClient(BaseClient):
         """
         Get list of locks for for all the files found, recursively, in the listed datasets or containers.
 
-        :param dids: list of dictionaries {"scope":..., "name":..., "type":...}
-                     type can be either "dataset" or "container"
-                     type is optional, but if specified, improves the query performance
-        :returns:    list of dictionaries with lock info
+        Parameters
+        ----------
+        dids :
+            list of dictionaries {"scope":..., "name":..., "type":...}
+            type can be either "dataset" or "container"
+            type is optional, but if specified, improves the query performance
+
+        Returns
+        -------
+
+            list of dictionaries with lock info
         """
 
         # convert did list to list of dictionaries
@@ -92,7 +104,10 @@ class LockClient(BaseClient):
         """
         Get all dataset locks of the specified rse.
 
-        :param rse: the rse of the locks to list.
+        Parameters
+        ----------
+        rse :
+            The rse of the locks to list
         """
 
         path = '/'.join([self.LOCKS_BASEURL, rse])

rucio/client/metaconventionsclient.py

@@ -35,13 +35,26 @@ class MetaConventionClient(BaseClient):
         """
         Sends the request to add an allowed key for DID metadata (update the DID Metadata Conventions table with a new key).
 
-        :param key: the name for the new key.
-        :param key_type: the type of the key: all(container, dataset, file), collection(dataset or container), file, derived(compute from file for collection).
-        :param value_type: the type of the value, if defined.
-        :param value_regexp: the regular expression that values should match, if defined.
-
-        :return: True if key was created successfully.
-        :raises Duplicate: if key already exists.
+        Parameters
+        ----------
+        key :
+            The name for the new key.
+
+        key_type :
+            The type of the key: all(container, dataset, file), collection(dataset or container), file, derived(compute from file for collection).
+        value_type :
+            The type of the value, if defined.
+        value_regexp :
+            The regular expression that values should match, if defined.
+
+        Returns
+        -------
+            True if key was created successfully.
+
+        Raises
+        -------
+        Duplicate
+            If key already exists..
         """
 
         path = '/'.join([self.META_BASEURL, quote_plus(key)])
@@ -62,7 +75,9 @@ class MetaConventionClient(BaseClient):
         """
         Sends the request to list all keys for DID Metadata Conventions.
 
-        :return: a list containing the names of all keys.
+        Returns
+        -------
+            A list containing the names of all keys.
         """
         path = self.META_BASEURL + '/'
         url = build_url(choice(self.list_hosts), path=path)
@@ -77,9 +92,10 @@ class MetaConventionClient(BaseClient):
     def list_values(self, key: str) -> Optional[list[str]]:
         """
         Sends the request to lists all allowed values for a DID key (all values for a key in DID Metadata Conventions).
-.
 
-        :return: a list containing the names of all values for a key.
+        Returns
+        -------
+            A list containing the names of all values for a key
         """
         path = '/'.join([self.META_BASEURL, quote_plus(key)]) + '/'
         url = build_url(choice(self.list_hosts), path=path)
@@ -95,11 +111,21 @@ class MetaConventionClient(BaseClient):
         """
         Sends the request to add a value for a key in DID Metadata Convention.
 
-        :param key: the name for key.
-        :param value: the value.
-
-        :return: True if value was created successfully.
-        :raises Duplicate: if valid already exists.
+        Parameters
+        ----------
+        key :
+            The name for key.
+        value :
+            The value to be added.
+
+        Returns
+        -------
+            True if value was created successfully.
+
+        Raises
+        -------
+        Duplicate
+            If value already exists.
         """
 
         path = '/'.join([self.META_BASEURL, quote_plus(key)]) + '/'
@@ -116,8 +142,12 @@ class MetaConventionClient(BaseClient):
         """
         Delete a key in the DID Metadata Conventions table.
 
-        :param key: the name for key.
-        :param value: the value.
+        Parameters
+        ---------
+        key :
+            The name for the key
+        value :
+            The value
         """
         pass
 
@@ -125,7 +155,10 @@ class MetaConventionClient(BaseClient):
         """
         Delete an allowed key.
 
-        :param key: the name for key.
+        Parameters
+        ----------
+        key :
+            The name for the key.
         """
         pass
 
@@ -133,8 +166,13 @@ class MetaConventionClient(BaseClient):
         """
         Update a key.
 
-        :param key: the name for key.
-        :param type_: the type of the value, if defined.
-        :param regexp: the regular expression that values should match, if defined.
+        Parameters
+        ----------
+        key :
+            The name for the key.
+        type_ :
+            The type of the value, if defined.
+        regexp :
+            The regular expression that values should match, if defined.
         """
         pass

rucio/client/pingclient.py

@@ -28,7 +28,9 @@ class PingClient(BaseClient):
         """
         Sends a ping request to the rucio server.
 
-        :return: Dictonnary with server information
+        Returns
+        --------
+            Dictionary with server information
         """
 
         headers = None