contentgrid-application-client 0.2.9__tar.gz → 0.2.11__tar.gz

{contentgrid_application_client-0.2.9/src/contentgrid_application_client.egg-info → contentgrid_application_client-0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contentgrid-application-client
-Version: 0.2.9
+Version: 0.2.11
 Summary: Python Client for interacting with ContentGrid Applications
 Author-email: Ranec Belpaire <ranec.belpaire@xenit.eu>
 License: Copyright 2024 Xenit Solutions
@@ -16,13 +16,15 @@ License: Copyright 2024 Xenit Solutions
         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
         See the License for the specific language governing permissions and
         limitations under the License.
+Project-URL: Homepage, https://github.com/xenit-eu/contentgrid-python-client
+Project-URL: Source, https://github.com/xenit-eu/contentgrid-python-client
 Classifier: Development Status :: 4 - Beta
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: contentgrid-hal-client==0.2.9
+Requires-Dist: contentgrid-hal-client==0.2.11
 Dynamic: license-file
 Dynamic: requires-dist
 

{contentgrid_application_client-0.2.9 → contentgrid_application_client-0.2.11}/pyproject.toml

@@ -9,7 +9,7 @@ description = "Python Client for interacting with ContentGrid Applications"
 readme = "README.md"
 authors = [{ name = "Ranec Belpaire", email = "ranec.belpaire@xenit.eu" }]
 license = { file = "LICENSE" }
- 
+
 classifiers = [
     "Development Status :: 4 - Beta",
     "Operating System :: OS Independent",
@@ -18,6 +18,10 @@ classifiers = [
 
 requires-python = ">=3.5"
 
+[project.urls]
+Homepage = "https://github.com/xenit-eu/contentgrid-python-client"
+Source = "https://github.com/xenit-eu/contentgrid-python-client"
+
 [tool.setuptools_scm]
-write_to = "_version.txt"                                                                                                                                                                                                  
+write_to = "_version.txt"
 root = "../"

{contentgrid_application_client-0.2.9 → contentgrid_application_client-0.2.11}/src/contentgrid_application_client/application.py

@@ -25,6 +25,7 @@ hal_form_type_check = {
 }
 
 DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%fZ"
+MULTI_VALUED_ATTRIBUTE_TYPES = ["string_set"]
 
 
 def is_valid_date_format(date_string):
@@ -59,6 +60,7 @@ class InteractiveApplicationResponse(InteractiveHALResponse):
 class SearchType(Enum):
     EXACT_MATCH = "exact-match"
     PREFIX_MATCH = "prefix-match"
+    CONTAINS = "contains"
     FULL_TEXT_MATCH = "full-text"
     LESS_THAN = "less-than"
     LESS_THAN_OR_EQUAL = "less-than-or-equal"
@@ -258,11 +260,11 @@ class EntityObject(InteractiveApplicationResponse):
         params = self.client._add_page_and_size_to_params(size=size, params=params)
         relation_link = self.get_relation_link(relation_name=relation_name)
         return self.client.follow_link(relation_link, infer_type=EntityCollection, params=params)
-    
+
     def get_related_entity(self, relation_name: str) -> "EntityObject":
         relation_link = self.get_relation_link(relation_name=relation_name)
         return self.client.follow_link(relation_link, infer_type=EntityObject)
-    
+
     def set_related_entity(self, relation_name: str, related_entity : "EntityObject") -> None:
         self.put_relation(relation_name=relation_name, related_entity_links=[related_entity], prefix_client_endpoint=True)
 
@@ -481,6 +483,7 @@ class AttributeProfile(InteractiveApplicationResponse):
         self.__prefix_search_option: Optional[SearchOption] = None
         self.__exact_search_option: Optional[SearchOption] = None
         self.__full_text_search_option: Optional[SearchOption] = None
+        self.__contains_search_option: Optional[SearchOption] = None
         self.__less_than_search_option: Optional[SearchOption] = None
         self.__less_than_or_equal_search_option: Optional[SearchOption] = None
         self.__greater_than_search_option: Optional[SearchOption] = None
@@ -489,9 +492,21 @@ class AttributeProfile(InteractiveApplicationResponse):
     def get_nested_attributes(self) -> List["AttributeProfile"]:
         return self.nested_attributes
 
+    @property
     def is_content_attribute(self) -> bool:
         return self.type == "object" and any(attr.name in ["length", "mimetype", "filename"] for attr in self.nested_attributes)
 
+    @property
+    def is_audit_attribute(self) -> bool:
+        return  self.has_created_by_constraint() or \
+            self.has_created_date_constraint() or \
+            self.has_modified_by_constraint() or \
+            self.has_modified_date_constraint()
+
+    @property
+    def is_multi_valued_attribute(self) -> bool:
+        return self.type in MULTI_VALUED_ATTRIBUTE_TYPES
+
     def get_constraints(self) -> List[AttributeConstraint]:
         return self.constraints
 
@@ -506,32 +521,25 @@ class AttributeProfile(InteractiveApplicationResponse):
 
     def has_constrained_values(self) -> bool:
         return self.get_constraint("allowed-values") is not None
-    
+
     def has_allowed_values_constraint(self) -> bool:
         return self.has_constrained_values()
-    
+
     def has_unique_constraint(self) -> bool:
         return self.get_constraint("unique") is not None
-    
+
     def has_created_by_constraint(self) -> bool:
         return self.get_constraint("created-by") is not None
-    
+
     def has_created_date_constraint(self) -> bool:
         return self.get_constraint("created-date") is not None
-    
+
     def has_modified_by_constraint(self) -> bool:
         return self.get_constraint("modified-by") is not None
-    
+
     def has_modified_date_constraint(self) -> bool:
         return self.get_constraint("modified-date") is not None
- 
-    @property
-    def is_audit_attribute(self) -> bool:
-        return  self.has_created_by_constraint() or \
-            self.has_created_date_constraint() or \
-            self.has_modified_by_constraint() or \
-            self.has_modified_date_constraint() 
-    
+
     def get_allowed_values(self) -> Optional[List[str]]:
         if self.has_constrained_values():
             return self.get_constraint("allowed-values").values  # type: ignore
@@ -557,7 +565,7 @@ class AttributeProfile(InteractiveApplicationResponse):
         if self.__prefix_search_option is None:
             self.__prefix_search_option = self.get_search_option(search_type=SearchType.PREFIX_MATCH)
         return self.__prefix_search_option
-    
+
     @property
     def _full_text_search_option(self) -> Optional[SearchOption]:
         if self.__full_text_search_option is None:
@@ -575,6 +583,12 @@ class AttributeProfile(InteractiveApplicationResponse):
                 self.__exact_search_option = case_insensitive_match
         return self.__exact_search_option
 
+    @property
+    def _contains_search_option(self) -> Optional[SearchOption]:
+        if self.__contains_search_option is None:
+            self.__contains_search_option = self.get_search_option(search_type=SearchType.CONTAINS)
+        return self.__contains_search_option
+
     @property
     def _less_than_search_option(self) -> Optional[SearchOption]:
         if self.__less_than_search_option is None:
@@ -710,18 +724,18 @@ _search_form_relation_delimiter = "."
 
 class AttributeSearch(ABC):
     """Abstract base class for attribute search implementations."""
-    
+
     def __init__(self, attribute_name: str, ignore_errors: bool = False) -> None:
         self.attribute_name: str = attribute_name
         self.ignore_errors: bool = ignore_errors
-    
+
     @abstractmethod
     def get_search_params(self, attribute_profile: AttributeProfile) -> List[SearchParam]:
         """Convert this search specification into search parameters.
-        
+
         Args:
             attribute_profile: The attribute profile to validate against and extract search options from.
-            
+
         Returns:
             List of SearchParam objects representing the search criteria.
         """
@@ -730,11 +744,11 @@ class AttributeSearch(ABC):
 
 class AttributeMatchSearch(AttributeSearch):
     def __init__(
-        self, 
-        attribute_name: str, 
-        value: Union[float | int | date | datetime | bool | str], 
-        use_prefix: bool = False, 
-        use_full_text: bool = False, 
+        self,
+        attribute_name: str,
+        value: Union[float | int | date | datetime | bool | str],
+        use_prefix: bool = False,
+        use_full_text: bool = False,
         use_exact: bool = False,
         ignore_errors: bool = False
     ) -> None:
@@ -753,7 +767,7 @@ class AttributeMatchSearch(AttributeSearch):
                     or (not attribute_profile._exact_search_option
                     and not attribute_profile._prefix_search_option
                     and not attribute_profile._full_text_search_option)
-                ):                    
+                ):
                     raise BadRequest(f"Attribute {self.attribute_name} does not support search. Available options: {attribute_profile.search_options}")
 
             # Extract available search options
@@ -762,10 +776,10 @@ class AttributeMatchSearch(AttributeSearch):
             exact_option = attribute_profile._exact_search_option
 
             selected_option = None
-            
+
             # Check if any specific search type is explicitly requested
             any_use_flag_set = self.use_prefix or self.use_full_text or self.use_exact
-            
+
             if any_use_flag_set:
                 # Use explicitly requested search types (in priority order)
                 if self.use_full_text and full_text_option:
@@ -788,7 +802,7 @@ class AttributeMatchSearch(AttributeSearch):
                     selected_option = exact_option
                 elif attribute_profile.has_search_capability():
                     selected_option = attribute_profile.search_options[0]
-            
+
             if selected_option:
                 search_params.append(SearchParam(value=self.value, option=selected_option))
 
@@ -943,12 +957,12 @@ class ContentGridApplicationClient(HALFormsClient):
         self.attribute_validation = attribute_validation
         self.use_profile_cache = use_profile_cache
         self.profile_cache: dict[str, dict[str, Any]] = {}
-    
+
     # PROFILE CACHING
     def load_profile_cache(self, url: str, json_data: dict | str) -> None:
         """
         Load JSON data into the profile cache.
-        
+
         Args:
             url: The URL to cache the response for (relative to client_endpoint)
             json_data: The JSON data to cache (as dict or JSON string)
@@ -958,11 +972,11 @@ class ContentGridApplicationClient(HALFormsClient):
 
         self.profile_cache[url] = cast(dict, json_data)
         logging.info(f"Loaded JSON data into profile cache for {url}")
-    
+
     def clear_profile_cache(self):
         logging.info(f"Clearing profile cache... clearing {len(self.profile_cache.keys())} entries")
-        self.profile_cache = {} 
-    
+        self.profile_cache = {}
+
     def get_profile(self) -> Profile:
         if self.use_profile_cache:
             profile_cache_key = self.client_endpoint.click("/profile").normalize().to_text()
@@ -982,7 +996,7 @@ class ContentGridApplicationClient(HALFormsClient):
 
     def get_entity_profiles(self) -> List[EntityProfile]:
         return [entity_profile for entity_profile in self.get_profile().get_entity_profiles_generator()]
-    
+
     def load_or_fetch_entity_profile(self, profile_link : HALLink, params: dict={}) -> EntityProfile:
         if self.use_profile_cache:
             if profile_link.uri in self.profile_cache:
@@ -1158,12 +1172,12 @@ class ContentGridApplicationClient(HALFormsClient):
 
     def _prefix_url_in_form_payload(self, template: HALFormsTemplate, payload: dict) -> None:
         """Prefix URL properties in the payload with the client_endpoint if needed.
-        
-        Modifies the payload in-place, prefixing any URL-type properties with the 
+
+        Modifies the payload in-place, prefixing any URL-type properties with the
         client_endpoint if they don't already start with it.
         """
         client_endpoint = self.client_endpoint
-        
+
         for key, value in payload.items():
             try:
                 hal_property = None
@@ -1171,7 +1185,7 @@ class ContentGridApplicationClient(HALFormsClient):
                     if prop.name == key:
                         hal_property = prop
                         break
-                
+
                 if hal_property and hal_property.type == HALFormsPropertyType.url:
                     if isinstance(value, list):
                         payload[key] = [

{contentgrid_application_client-0.2.9 → contentgrid_application_client-0.2.11/src/contentgrid_application_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contentgrid-application-client
-Version: 0.2.9
+Version: 0.2.11
 Summary: Python Client for interacting with ContentGrid Applications
 Author-email: Ranec Belpaire <ranec.belpaire@xenit.eu>
 License: Copyright 2024 Xenit Solutions
@@ -16,13 +16,15 @@ License: Copyright 2024 Xenit Solutions
         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
         See the License for the specific language governing permissions and
         limitations under the License.
+Project-URL: Homepage, https://github.com/xenit-eu/contentgrid-python-client
+Project-URL: Source, https://github.com/xenit-eu/contentgrid-python-client
 Classifier: Development Status :: 4 - Beta
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: contentgrid-hal-client==0.2.9
+Requires-Dist: contentgrid-hal-client==0.2.11
 Dynamic: license-file
 Dynamic: requires-dist
 

contentgrid_application_client-0.2.11/src/contentgrid_application_client.egg-info/requires.txt

@@ -0,0 +1 @@
+contentgrid-hal-client==0.2.11

contentgrid_application_client-0.2.11/src/contentgrid_application_client.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.2.11",
+  "distance": 0,
+  "node": "g09d57a7729482291739655ce81dd3657f494faf3",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-02"
+}

{contentgrid_application_client-0.2.9 → contentgrid_application_client-0.2.11}/tests/test_profile.py

@@ -61,7 +61,7 @@ def test_content_attribute_detection(cg_client: ContentGridApplicationClient):
     entity_profile = cg_client.get_entity_profile(profile.get_entity_links()[0].name)
 
     for attribute in entity_profile.get_attribute_profiles():
-        if attribute.is_content_attribute():
+        if attribute.is_content_attribute:
             nested_attrs = attribute.get_nested_attributes()
             assert any(attr.name in ["length", "mimetype", "filename"] for attr in nested_attrs)
 
@@ -111,9 +111,9 @@ def test_load_profile_cache_with_dict(cg_client: ContentGridApplicationClient):
         "name": "test-entity",
         "description": "Test entity"
     }
-    
+
     cg_client.load_profile_cache("/profile/test-entity", test_data)
-    
+
     # Verify it's in the cache
     assert "/profile/test-entity" in cg_client.profile_cache
     cached_data = cg_client.profile_cache["/profile/test-entity"]
@@ -129,9 +129,9 @@ def test_load_profile_cache_with_json_string(cg_client: ContentGridApplicationCl
         "name": "test-entity2"
     }
     json_string = json.dumps(test_data)
-    
+
     cg_client.load_profile_cache("/profile/test-entity2", json_string)
-    
+
     # Verify it's in the cache
     assert "/profile/test-entity2" in cg_client.profile_cache
     cached_data = cg_client.profile_cache["/profile/test-entity2"]
@@ -142,65 +142,65 @@ def test_profile_cache_hit_returns_cached_response(cg_client: ContentGridApplica
     # First request to populate cache
     profile1 = cg_client.get_profile()
     initial_cache_size = len(cg_client.profile_cache)
-    
+
     # Second request should use cache
     profile2 = cg_client.get_profile()
-    
+
     # Cache size should not have increased
     assert len(cg_client.profile_cache) == initial_cache_size
-    
+
     # Both profiles should have the same data
     assert profile1.data == profile2.data
 
 def test_profile_cache_only_affects_profile_endpoints(cg_client: ContentGridApplicationClient):
     """Test that cache only affects profile endpoints"""
     initial_cache_size = len(cg_client.profile_cache)
-    
+
     # Get profile - should be cached
     cg_client.get_profile()
-    
+
     # Cache should have grown
     assert len(cg_client.profile_cache) > initial_cache_size
-    
+
     # Getting entity collection should not add to profile cache
     profile = cg_client.get_profile()
     if profile.get_entity_links():
         entity_name = profile.get_entity_links()[0].name
         entity_profile = cg_client.get_entity_profile(entity_name)
         cache_size_after_entity_profile = len(cg_client.profile_cache)
-        
+
         # Getting the entity collection should not be cached
         try:
             cg_client.get_entity_collection(entity_name, size=1)
         except Exception:
             pass  # We don't care if this fails, just testing cache behavior
-        
+
         # Profile cache size should not change from non-profile requests
         assert len(cg_client.profile_cache) >= cache_size_after_entity_profile
 
 def test_profile_cache_caches_entity_profiles(cg_client: ContentGridApplicationClient):
     """Test that entity profile requests are also cached"""
     profile = cg_client.get_profile()
-    
+
     if not profile.get_entity_links():
         pytest.skip("No entity profiles available to test caching")
-    
+
     entity_name = profile.get_entity_links()[0].name
     initial_cache_size = len(cg_client.profile_cache)
-    
+
     # First request
     entity_profile1 = cg_client.get_entity_profile(entity_name)
     cache_size_after_first = len(cg_client.profile_cache)
-    
+
     # Cache should have grown (at least entity profile URL)
     assert cache_size_after_first > initial_cache_size
-    
+
     # Second request - should hit cache
     entity_profile2 = cg_client.get_entity_profile(entity_name)
-    
+
     # Cache size should not change
     assert len(cg_client.profile_cache) == cache_size_after_first
-    
+
     # Data should be the same
     assert entity_profile1.name == entity_profile2.name
 
@@ -208,7 +208,7 @@ def test_clear_empty_profile_cache(cg_client: ContentGridApplicationClient):
     """Test clearing an empty cache doesn't cause issues"""
     # Clear empty cache
     cg_client.clear_profile_cache()
-    
+
     # Verify cache is still empty
     assert len(cg_client.profile_cache) == 0
     assert cg_client.profile_cache == {}
@@ -218,16 +218,16 @@ def test_clear_profile_cache_removes_all_entries(cg_client: ContentGridApplicati
     # Populate cache with some data
     test_data1 = {"_links": {"self": {"href": "/profile/entity1"}}, "name": "entity1"}
     test_data2 = {"_links": {"self": {"href": "/profile/entity2"}}, "name": "entity2"}
-    
+
     cg_client.load_profile_cache("/profile/entity1", test_data1)
     cg_client.load_profile_cache("/profile/entity2", test_data2)
-    
+
     # Verify entries are in cache
     assert len(cg_client.profile_cache) >= 2
-    
+
     # Clear cache
     cg_client.clear_profile_cache()
-    
+
     # Verify cache is empty
     assert len(cg_client.profile_cache) == 0
     assert "/profile/entity1" not in cg_client.profile_cache
@@ -238,15 +238,15 @@ def test_clear_profile_cache_allows_repopulation(cg_client: ContentGridApplicati
     # Populate cache
     profile1 = cg_client.get_profile()
     assert len(cg_client.profile_cache) > 0
-    
+
     # Clear cache
     cg_client.clear_profile_cache()
     assert len(cg_client.profile_cache) == 0
-    
+
     # Repopulate cache - should work normally
     profile2 = cg_client.get_profile()
     assert len(cg_client.profile_cache) > 0
-    
+
     # Data should be consistent
     assert profile1.data == profile2.data
 
@@ -254,14 +254,14 @@ def test_clear_profile_cache_doesnt_affect_caching_flag(cg_client: ContentGridAp
     """Test that clearing cache doesn't disable caching"""
     # Check caching is enabled
     assert cg_client.use_profile_cache is True
-    
+
     # Load and clear cache
     cg_client.load_profile_cache("/profile/test", {"name": "test"})
     cg_client.clear_profile_cache()
-    
+
     # Caching should still be enabled
     assert cg_client.use_profile_cache is True
-    
+
     # Cache should still work
     cg_client.get_profile()
     assert len(cg_client.profile_cache) > 0
@@ -272,14 +272,14 @@ def test_clear_profile_cache_forces_fresh_request(cg_client: ContentGridApplicat
     cg_client.get_profile()
     cache_size_after_first = len(cg_client.profile_cache)
     assert cache_size_after_first > 0
-    
+
     # Clear cache
     cg_client.clear_profile_cache()
     assert len(cg_client.profile_cache) == 0
-    
+
     # Next request should repopulate cache (new request made)
     cg_client.get_profile()
     cache_size_after_clear = len(cg_client.profile_cache)
-    
+
     # Cache should be populated again
     assert cache_size_after_clear > 0

contentgrid_application_client-0.2.9/src/contentgrid_application_client.egg-info/requires.txt

@@ -1 +0,0 @@
-contentgrid-hal-client==0.2.9

contentgrid_application_client-0.2.9/src/contentgrid_application_client.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.2.9",
-  "distance": 0,
-  "node": "gb651e852c776cf5978adb8a0bd8a52662b8dd34b",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-12"
-}