qarnot 2.15.0__tar.gz → 2.16.0__tar.gz

{qarnot-2.15.0/qarnot.egg-info → qarnot-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qarnot
-Version: 2.15.0
+Version: 2.16.0
 Summary: Qarnot Computing SDK
 Home-page: https://computing.qarnot.com
 Author: Qarnot computing
@@ -17,10 +17,19 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.6
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: boto3
+Requires-Dist: boto3>=1.36
 Requires-Dist: wheel
 Requires-Dist: deprecation
 Requires-Dist: simplejson
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 Qarnot computing Python SDK
 ===========================

{qarnot-2.15.0 → qarnot-2.16.0}/doc/source/api/compute/computeindex.rst

@@ -12,4 +12,6 @@ Compute
    privileges
    hardware_constraint
    retry_settings
+   scheduling_type
+   secrets
 

qarnot-2.16.0/doc/source/api/compute/forced_network_rule.rst

@@ -0,0 +1,8 @@
+Forced Network Rule
+-------------------
+
+.. automodule:: qarnot.forced_network_rule
+    :members:
+    :show-inheritance:
+    :special-members:
+    :exclude-members: __dict__,__weakref__,__eq__,__str__,__repr__

qarnot-2.16.0/doc/source/api/compute/secrets.rst

@@ -0,0 +1,8 @@
+Secrets
+-------
+
+.. automodule:: qarnot.secrets
+    :members:
+    :show-inheritance:
+    :special-members:
+    :exclude-members: __dict__,__weakref__,__eq__,__str__,__repr__

{qarnot-2.15.0 → qarnot-2.16.0}/doc/source/conf.py

@@ -78,7 +78,7 @@ release = v
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -106,7 +106,7 @@ html_theme = 'sphinx_rtd_theme'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code.
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -187,6 +187,6 @@ texinfo_documents = [
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/3': None,
-                       'http://boto3.readthedocs.io/en/latest/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'boto': ('http://boto3.readthedocs.io/en/latest/', None)}
 autodoc_member_order = 'bysource'

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-08-27T11:29:32+0200",
+ "date": "2025-02-07T16:27:29+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "8fe176158583e7c2db929a8a25031075991e9e36",
- "version": "v2.15.0"
+ "full-revisionid": "23daecdc71207c207e56afae3e55190f0734bd0d",
+ "version": "v2.16.0"
 }
 '''  # END VERSION_JSON
 

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/connection.py

@@ -196,7 +196,7 @@ class Connection(object):
 
         user = self.user_info
         session = boto3.session.Session()
-        conf = botocore.config.Config(user_agent=self._version)
+        conf = botocore.config.Config(user_agent=self._version, request_checksum_calculation="when_required")
 
         should_verify_or_certificate_path = True
         if storage_unsafe:

qarnot-2.16.0/qarnot/forced_constant.py

@@ -0,0 +1,44 @@
+from typing import Optional, Union, Dict
+from enum import Enum
+
+
+class ForcedConstantAccess(Enum):
+    ReadWrite = "ReadWrite"
+    ReadOnly = "ReadOnly"
+
+
+class ForcedConstant(object):
+    """Forced Constant Information
+
+    .. note:: For internal usage only
+    """
+
+    def __init__(self, forced_value: str, force_export_in_environment: Optional[bool] = None, access: Optional[ForcedConstantAccess] = None):
+        self.forced_value = forced_value
+        """:type: :class:`str`
+
+        Forced value for the constant."""
+
+        self.force_export_in_environment = force_export_in_environment
+        """:type: :class:`bool`
+
+        Whether the constant should be forced in the execution environment or not."""
+
+        self.access = access
+        """:type: :class:`~qarnot.forced_constant.ForcedConstantAccess`
+
+        The access level of the constant: ReadOnly or ReadWrite."""
+
+    def to_json(self, name: str):
+        result: Dict[str, Union[str, bool]] = {
+            "constantName": name,
+            "forcedValue": self.forced_value,
+        }
+
+        if self.force_export_in_environment is not None:
+            result["forceExportInEnvironment"] = self.force_export_in_environment
+
+        if self.access is not None:
+            result["access"] = self.access.value
+
+        return result

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/forced_network_rule.py

@@ -81,7 +81,7 @@ class ForcedNetworkRule(object):
         """Create the forced network rule from json.
 
         :param dict json: Dictionary representing the forced network rule
-        :returns: The created :class:`~qarnot.retry_settings.ForcedNetworkRule`
+        :returns: The created :class:`~qarnot.forced_network_rule.ForcedNetworkRule`
         """
 
         inbound: bool = bool(json["inbound"])

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/pool.py

@@ -23,6 +23,7 @@ from qarnot.secrets import SecretsAccessRights
 
 from . import raise_on_error, get_url, _util
 from .bucket import Bucket
+from .forced_constant import ForcedConstant
 from .status import Status
 from .hardware_constraint import HardwareConstraint
 from .scheduling_type import SchedulingType
@@ -77,6 +78,7 @@ class Pool(object):
               with :meth:`qarnot.connection.Connection.retrieve_profile`.
         """
         self._constraints: Dict[str, str] = {}
+        self._forced_constants: Dict[str, ForcedConstant] = {}
         self._labels: Dict[str, str] = {}
         self._auto_update = True
         self._last_auto_update_state = self._auto_update
@@ -252,6 +254,10 @@ class Pool(object):
             {'key': key, 'value': value}
             for key, value in self._constraints.items()
         ]
+        forced_const_list = [
+            value.to_json(key)
+            for key, value in self._forced_constants.items()
+        ]
 
         elastic_dict = {
             "isElastic": self._is_elastic,
@@ -267,6 +273,7 @@ class Pool(object):
             'name': self._name,
             'profile': self._profile,
             'constants': const_list,
+            'forcedConstants': forced_const_list,
             'constraints': constr_list,
             'instanceCount': self._instancecount,
             'tags': self._tags,
@@ -1099,6 +1106,31 @@ class Pool(object):
 
         self._secrets_access_rights = value
 
+    @property
+    def forced_constants(self):
+        """:type: dictionary{:class:`str` : :class:`~qarnot.forced_constant.ForcedConstant`}
+        :getter: Returns this pool's forced constants dictionary.
+        :setter: set the pool's forced constants dictionary.
+
+        Update the forced constants if needed.
+        Forced constants are reserved for internal use.
+        """
+        self._update_if_summary()
+        if self._auto_update:
+            self.update()
+
+        return self._forced_constants
+
+    @forced_constants.setter
+    def forced_constants(self, value: Dict[str, "ForcedConstant"]):
+        """Setter for forced_constants
+        """
+        self._update_if_summary()
+        if self._auto_update:
+            self.update()
+
+        self._forced_constants = value
+
     @property
     def forced_network_rules(self):
         """:type: list{:class:`~qarnot.forced_network_rule.ForcedNetworkRule`}
@@ -1116,7 +1148,7 @@ class Pool(object):
 
     @forced_network_rules.setter
     def forced_network_rules(self, value: List["ForcedNetworkRule"]):
-        """Setter for forced_constants
+        """Setter for forced_network_rules
         """
         if self.uuid is not None:
             raise AttributeError("can't set attribute on a launched pool")

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/secrets.py

@@ -97,7 +97,7 @@ class SecretsAccessRights(object):
 
         :param by_secret: the list of secrets the task will have access to, described using an exact key match
         :type by_secret: `List[~qarnot.secrets.SecretAccessRightBySecret]`
-        :param by_prefix:the list of secrets the task will have access to, described using a prefix key match
+        :param by_prefix: the list of secrets the task will have access to, described using a prefix key match
         :type by_prefix: `List[~qarnot.secrets.SecretAccessRightByPrefix]`
         """
         self._by_secret: List[SecretAccessRightBySecret] = by_secret or []

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot/task.py

@@ -19,7 +19,6 @@ from os import makedirs, path
 import time
 import warnings
 import sys
-from enum import Enum
 from typing import Dict, Optional, Union, List, Any, Callable
 
 from qarnot.retry_settings import RetrySettings
@@ -29,6 +28,7 @@ from qarnot.secrets import SecretsAccessRights
 from . import get_url, raise_on_error, _util
 from .status import Status
 from .hardware_constraint import HardwareConstraint
+from .forced_constant import ForcedConstant
 from .scheduling_type import SchedulingType
 from .privileges import Privileges
 from .bucket import Bucket
@@ -458,6 +458,9 @@ class Task(object):
         if 'resultBucket' in json_task and json_task['resultBucket']:
             self._result_object_id = json_task['resultBucket']
 
+        if 'ResultsCacheTTLSec' in json_task and self._result_object is not None:
+            self._result_object._cache_ttl_sec = json_task['ResultsCacheTTLSec']
+
         if 'status' in json_task:
             self._status = json_task['status']
         self._creation_date = _util.parse_datetime(json_task['creationDate'])
@@ -1340,7 +1343,7 @@ class Task(object):
 
     @property
     def forced_constants(self):
-        """:type: dictionary{:class:`str` : :class:`~qarnot.task.ForcedConstant`}
+        """:type: dictionary{:class:`str` : :class:`~qarnot.forced_constant.ForcedConstant`}
         :getter: Returns this task's forced constants dictionary.
         :setter: set the task's forced constants dictionary.
 
@@ -1380,7 +1383,7 @@ class Task(object):
 
     @forced_network_rules.setter
     def forced_network_rules(self, value: List["ForcedNetworkRule"]):
-        """Setter for forced_constants
+        """Setter for forced_network_rules
         """
         if self.uuid is not None:
             raise AttributeError("can't set attribute on a launched task")
@@ -1815,6 +1818,8 @@ class Task(object):
 
         if self._result_object is not None:
             json_task['resultBucket'] = self._result_object.uuid
+            if self._result_object._cache_ttl_sec is not None:
+                json_task['ResultsCacheTTLSec'] = self._result_object._cache_ttl_sec
 
         if self._advanced_range is not None:
             json_task['advancedRanges'] = self._advanced_range
@@ -1975,45 +1980,3 @@ class BulkTaskResponse(object):
             return ', '.join("{0}={1}".format(key, val) for (key, val) in self.__dict__.items())
         else:
             return ', '.join("{0}={1}".format(key, val) for (key, val) in self.__dict__.iteritems())  # pylint: disable=no-member
-
-
-class ForcedConstantAccess(Enum):
-    ReadWrite = "ReadWrite"
-    ReadOnly = "ReadOnly"
-
-
-class ForcedConstant(object):
-    """Forced Constant Information
-
-    .. note:: For internal usage only
-    """
-
-    def __init__(self, forced_value: str, force_export_in_environment: Optional[bool] = None, access: Optional[ForcedConstantAccess] = None):
-        self.forced_value = forced_value
-        """:type: :class:`str`
-
-        Forced value for the constant."""
-
-        self.force_export_in_environment = force_export_in_environment
-        """:type: :class:`bool`
-
-        Whether the constant should be forced in the execution environment or not."""
-
-        self.access = access
-        """:type: :class:`~qarnot.task.ForcedConstantAccess`
-
-        The access level of the constant: ReadOnly or ReadWrite."""
-
-    def to_json(self, name: str):
-        result: Dict[str, Union[str, bool]] = {
-            "constantName": name,
-            "forcedValue": self.forced_value,
-        }
-
-        if self.force_export_in_environment is not None:
-            result["forceExportInEnvironment"] = self.force_export_in_environment
-
-        if self.access is not None:
-            result["access"] = self.access.value
-
-        return result

{qarnot-2.15.0 → qarnot-2.16.0/qarnot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: qarnot
-Version: 2.15.0
+Version: 2.16.0
 Summary: Qarnot Computing SDK
 Home-page: https://computing.qarnot.com
 Author: Qarnot computing
@@ -17,10 +17,19 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.6
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: boto3
+Requires-Dist: boto3>=1.36
 Requires-Dist: wheel
 Requires-Dist: deprecation
 Requires-Dist: simplejson
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 Qarnot computing Python SDK
 ===========================

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ doc/source/_static/qarnot.png
 doc/source/api/connection.rst
 doc/source/api/exceptions.rst
 doc/source/api/compute/computeindex.rst
+doc/source/api/compute/forced_network_rule.rst
 doc/source/api/compute/hardware_constraint.rst
 doc/source/api/compute/job.rst
 doc/source/api/compute/paginate.rst
@@ -28,6 +29,7 @@ doc/source/api/compute/pool.rst
 doc/source/api/compute/privileges.rst
 doc/source/api/compute/retry_settings.rst
 doc/source/api/compute/scheduling_type.rst
+doc/source/api/compute/secrets.rst
 doc/source/api/compute/status.rst
 doc/source/api/compute/task.rst
 doc/source/api/storage/advanced_bucket.rst
@@ -44,6 +46,7 @@ qarnot/bucket.py
 qarnot/connection.py
 qarnot/error.py
 qarnot/exceptions.py
+qarnot/forced_constant.py
 qarnot/forced_network_rule.py
 qarnot/hardware_constraint.py
 qarnot/helper.py

{qarnot-2.15.0 → qarnot-2.16.0}/qarnot.egg-info/requires.txt

@@ -1,5 +1,5 @@
 requests
-boto3
+boto3>=1.36
 wheel
 deprecation
 simplejson

{qarnot-2.15.0 → qarnot-2.16.0}/requirements-lint.txt

@@ -5,5 +5,5 @@ pylint
 # libraries stubs for lint
 types-requests
 types-simplejson
-boto3-stubs
-botocore-stubs
+boto3-stubs[boto3]
+botocore-stubs

{qarnot-2.15.0 → qarnot-2.16.0}/requirements-optional.txt

@@ -1,2 +1,2 @@
 requests-toolbelt==0.8.0
-progressbar2==4.0.0
+progressbar2==4.5.0

qarnot-2.16.0/requirements.txt

@@ -0,0 +1,6 @@
+requests==2.32.3
+boto3==1.36.6
+wheel==0.45.1
+deprecation==2.1.0
+simplejson==3.19.3
+setuptools==75.7.0

{qarnot-2.15.0 → qarnot-2.16.0}/setup.py

@@ -25,7 +25,7 @@ setup(name='qarnot',
       url='https://computing.qarnot.com',
       setup_requires=['wheel'],
       packages=['qarnot'],
-      install_requires=['requests', 'boto3', 'wheel', 'deprecation', 'simplejson'],
+      install_requires=['requests', 'boto3>=1.36', 'wheel', 'deprecation', 'simplejson'],
       tests_require=['pytest'],
       python_requires='>=3.6',
       classifiers=['Development Status :: 5 - Production/Stable',

{qarnot-2.15.0 → qarnot-2.16.0}/test/test_task.py

@@ -141,6 +141,40 @@ class TestTaskProperties:
         assert "prefix1" == json_bucket["filtering"]["prefixFiltering"]["prefix"]
         assert "prefix2" == json_bucket["resourcesTransformation"]["stripPrefix"]["prefix"]
 
+    @pytest.mark.parametrize("cache_ttl", [1000, None])
+    def test_result_bucket_with_ResultsCacheTTL_to_json(self, mock_conn, cache_ttl):
+        task = Task(mock_conn, "task-with-a-ResultsCacheTTLSec", "profile")
+        resultsCacheTTLSec = cache_ttl
+        bucket = Bucket(mock_conn, "name", False)
+        bucket_copy_with_TTL = bucket.with_cache_ttl(resultsCacheTTLSec)
+        bucket_created_with_TTL = Bucket(mock_conn, "name", False, cacheTTLSec=resultsCacheTTLSec)
+
+        task.results = bucket_created_with_TTL
+        json_task = task._to_json()
+        if cache_ttl is None:
+            assert "ResultsCacheTTLSec" not in json_task
+        else:
+            assert resultsCacheTTLSec == json_task["ResultsCacheTTLSec"]
+
+        task = Task(mock_conn, "task-with-a-ResultsCacheTTLSec", "profile")
+        task.results = bucket_copy_with_TTL
+        json_task = task._to_json()
+        if cache_ttl is None:
+            assert "ResultsCacheTTLSec" not in json_task
+        else:
+            assert resultsCacheTTLSec == json_task["ResultsCacheTTLSec"]
+
+    def test_update_task_with_ResultsCacheTTL_(self, mock_conn):
+        task = Task(mock_conn, "task-name")
+        resultsCacheTTLSec = 10000
+        bucket_created_with_TTL = Bucket(mock_conn, "name", False, cacheTTLSec=resultsCacheTTLSec)
+        task.results = bucket_created_with_TTL
+        json_task_with_ResultsCacheTTLSec = default_json_task.copy()
+        json_task_with_ResultsCacheTTLSec["ResultsCacheTTLSec"] = resultsCacheTTLSec
+        task._update(json_task_with_ResultsCacheTTLSec)
+        task_json = task._to_json()
+        assert task_json["ResultsCacheTTLSec"] == resultsCacheTTLSec
+
     def test_bucket_in_task_from_json(self, mock_conn):
         json_bucket = "bucket-name"
         json_task = {

qarnot-2.15.0/requirements.txt

@@ -1,6 +0,0 @@
-requests==2.32.3
-boto3==1.21.38
-wheel==0.38.1
-deprecation==2.1.0
-simplejson==3.18.3
-setuptools==70.3.0