def _build_query_url(self):
query = QueryOptions()
for n in self._properties_to_include:
prop_val = self._binding_type.get_property(n)
if isinstance(prop_val, ClientObject):
query.expand.append(n)
query.select.append(n)
return query.to_url()
def __init__(self,
context,
resource_path=None,
properties=None,
parent_collection=None):
self._properties = {}
self._changes = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
if properties is not None:
for k, v in properties.items():
self.set_property(k, v, True)
def __init__(self, context, resource_path=None, parent_collection=None, namespace=None):
"""
Base client object which define named properties and relationships of an entity
:type parent_collection: office365.runtime.client_object_collection.ClientObjectCollection or None
:type resource_path: office365.runtime.resource_path.ResourcePath or None
:type context: office365.runtime.client_runtime_context.ClientRuntimeContext
:type namespace: str
"""
self._properties = {}
self._changed_properties = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
self._namespace = namespace
def __init__(self, entity_to_read, properties_to_include=None):
super(ReadEntityQuery, self).__init__(entity_to_read, None, None,
entity_to_read)
if properties_to_include:
self._query_options = QueryOptions()
self._query_options.expand = properties_to_include
else:
self._query_options = entity_to_read.queryOptions
def __init__(self, context, resource_path=None, properties=None, parent_collection=None):
"""
Base client object which define named properties and relationships of an entity
:type parent_collection: office365.runtime.client_object_collection.ClientObjectCollection or None
:type properties: dict or None
:type resource_path: office365.runtime.resource_path.ResourcePath or None
:type context: office365.runtime.client_runtime_context.ClientRuntimeContext
"""
self._properties = {}
self._changed_properties = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
if properties is not None:
for k, v in properties.items():
self.set_property(k, v, True)
class ClientObject(object):
def __init__(self,
context,
resource_path=None,
properties=None,
parent_collection=None):
"""
Base client object which define named properties and relationships of an entity
:type parent_collection: office365.runtime.client_object_collection.ClientObjectCollection or None
:type properties: dict or None
:type resource_path: office365.runtime.resource_path.ResourcePath or None
:type context: office365.runtime.client_runtime_context.ClientRuntimeContext
"""
self._properties = {}
self._changed_properties = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
if properties is not None:
for k, v in properties.items():
self.set_property(k, v, True)
def is_property_available(self, name):
"""Returns a Boolean value that indicates whether the specified property has been retrieved or set.
:param str name: A Property name
"""
if name in self.properties:
return True
return False
def expand(self, names):
self.query_options.expand = names
return self
def select(self, names):
self.query_options.select = names
return self
def remove_from_parent_collection(self):
if self._parent_collection is None:
return
self._parent_collection.remove_child(self)
def get_property(self, name):
getter_name = name[0].lower() + name[1:]
if hasattr(self, getter_name):
return getattr(self, getter_name)
return self._properties.get(name, None)
def set_property(self, name, value, persist_changes=True):
"""Sets Property value
:param str name: Property name
:param any value: Property value
:param bool persist_changes: Persist changes
"""
if persist_changes:
self._changed_properties.append(name)
safe_name = name[0].lower() + name[1:]
if hasattr(self, safe_name) and value is not None:
prop_type = getattr(self, safe_name)
if isinstance(prop_type, ClientObject) or isinstance(
prop_type, ClientValue):
[
prop_type.set_property(k, v, persist_changes)
for k, v in value.items()
]
self._properties[name] = prop_type
else:
self._properties[name] = value
else:
self._properties[name] = value
def to_json(self):
return dict((k, v) for k, v in self.properties.items()
if k in self._changed_properties)
def ensure_property(self, name_or_names, action):
"""
Ensures if property is loaded or list of properties are loaded
:type action: () -> None
:type name_or_names: str or list[str]
"""
names_to_include = []
if isinstance(name_or_names, list):
names_to_include = [
n for n in name_or_names if not self.is_property_available(n)
]
else:
if not self.is_property_available(name_or_names):
names_to_include.append(name_or_names)
if len(names_to_include) > 0:
self.context.load(self, names_to_include, action)
else:
action()
@property
def entity_type_name(self):
if self._entity_type_name is None:
self._entity_type_name = "SP." + type(self).__name__
return self._entity_type_name
@property
def resource_url(self):
"""Generate resource Url"""
if self.resource_path:
url = self.context.service_root_url + self.resource_path.to_url()
if not self.query_options.is_empty:
url = url + "?" + self._query_options.to_url()
return url
return None
@property
def context(self):
return self._context
@property
def resource_path(self):
return self._resource_path
@property
def query_options(self):
return self._query_options
@property
def properties(self):
return self._properties
@property
def parent_collection(self):
return self._parent_collection
class ClientObject(object):
"""Base client object"""
def __init__(self,
context,
resource_path=None,
properties=None,
parent_collection=None):
self._properties = {}
self._changes = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
if properties is not None:
for k, v in properties.items():
self.set_property(k, v, True)
def is_property_available(self, name):
"""Returns a Boolean value that indicates whether the specified property has been retrieved or set."""
if name in self.properties:
return True
return False
def expand(self, names):
self.queryOptions.expand = names
return self
def select(self, names):
self.queryOptions.select = names
return self
def remove_from_parent_collection(self):
if self._parent_collection is None:
return
self._parent_collection.remove_child(self)
def set_property(self, name, value, persist_changes=True):
"""Set resource property value"""
if persist_changes:
self._changes.append(name)
safe_name = name[0].lower() + name[1:]
if hasattr(self, safe_name):
prop_type = getattr(self, safe_name)
if isinstance(prop_type, ClientObject) or isinstance(
prop_type, ClientValueObject):
[
prop_type.set_property(k, v, persist_changes)
for k, v in value.items()
]
self._properties[name] = prop_type
else:
self._properties[name] = value
else:
self._properties[name] = value
def to_json(self):
return dict(
(k, v) for k, v in self.properties.items() if k in self._changes)
@property
def entityTypeName(self):
if self._entity_type_name is None:
self._entity_type_name = "SP." + type(self).__name__
return self._entity_type_name
@entityTypeName.setter
def entityTypeName(self, value):
self._entity_type_name = value
@property
def resourceUrl(self):
"""Generate resource Url"""
if self.resourcePath:
url = self.context.serviceRootUrl + self.resourcePath.to_url()
if not self.queryOptions.is_empty:
url = url + "?" + self._query_options.to_url()
return url
return None
@property
def context(self):
return self._context
@property
def resourcePath(self):
return self._resource_path
@property
def queryOptions(self):
return self._query_options
@property
def properties(self):
return self._properties
@property
def parent_collection(self):
return self._parent_collection
class ClientObject(object):
def __init__(self,
context,
resource_path=None,
properties=None,
parent_collection=None):
"""
Base client object which define named properties and relationships of an entity
:type parent_collection: office365.runtime.client_object_collection.ClientObjectCollection or None
:type properties: dict or None
:type resource_path: office365.runtime.resource_path.ResourcePath or None
:type context: office365.runtime.client_runtime_context.ClientRuntimeContext
"""
self._properties = {}
self._changed_properties = []
self._entity_type_name = None
self._query_options = QueryOptions()
self._parent_collection = parent_collection
self._context = context
self._resource_path = resource_path
if properties is not None:
for k, v in properties.items():
self.set_property(k, v, True)
def clear(self):
self._changed_properties = []
def execute_query(self):
self.context.execute_query()
return self
def execute_query_retry(self,
max_retry=5,
timeout_secs=5,
success_callback=None,
failure_callback=None):
self.context.execute_query_retry(max_retry=max_retry,
timeout_secs=timeout_secs,
success_callback=success_callback,
failure_callback=failure_callback)
return self
def build_request(self):
return self.context.build_request()
def get(self):
self.context.load(self)
return self
def is_property_available(self, name):
"""Returns a Boolean value that indicates whether the specified property has been retrieved or set.
:param str name: A Property name
"""
if name in self.properties:
return True
return False
def expand(self, names):
"""
:type names: list[str]
"""
self.query_options.expand = names
return self
def select(self, names):
"""
:param list[str] names:
:return:
"""
self.query_options.select = names
return self
def remove_from_parent_collection(self):
if self._parent_collection is None:
return
self._parent_collection.remove_child(self)
def get_property(self, name):
"""
Gets property value
:param str name: property name
"""
normalized_name = name[0].lower() + name[1:]
return getattr(self, normalized_name, self._properties.get(name, None))
def set_property(self, name, value, persist_changes=True):
"""Sets property value
:param str name: Property name
:param any value: Property value
:param bool persist_changes: Persist changes
"""
if persist_changes:
self._changed_properties.append(name)
prop_type = self.get_property(name)
if isinstance(prop_type, ClientObject) or isinstance(
prop_type, ClientValue) and value is not None:
if isinstance(value, list):
[
prop_type.set_property(i, v, persist_changes)
for i, v in enumerate(value)
]
else:
[
prop_type.set_property(k, v, persist_changes)
for k, v in value.items()
]
self._properties[name] = prop_type
else:
self._properties[name] = value
return self
def to_json(self):
return dict((k, v) for k, v in self.properties.items()
if k in self._changed_properties)
def ensure_property(self, name, action):
"""
Ensures if property is loaded
:type action: () -> None
:type name: str
"""
return self.ensure_properties([name], action)
def ensure_properties(self, names, action):
"""
Ensure if list of properties are loaded
:type action: () -> None
:type names: str or list[str]
"""
names_to_include = [
n for n in names if not self.is_property_available(n)
]
if len(names_to_include) > 0:
qry = self.context.load(self, names_to_include)
if callable(action):
def _process_query(current_query):
if current_query.id == qry.id:
action()
self.context.after_execute_query(_process_query)
else:
action()
return self
def clone_object(self):
result = copy.deepcopy(self)
result._context = self.context
return result
@property
def entity_type_name(self):
if self._entity_type_name is None:
self._entity_type_name = "SP." + type(self).__name__
return self._entity_type_name
@property
def resource_url(self):
"""Generate resource Url
:rtype: str or None
"""
if self.resource_path:
url = self.context.service_root_url() + self.resource_path.to_url()
if not self.query_options.is_empty:
url = url + "?" + self._query_options.to_url()
return url
return None
@property
def context(self):
return self._context
@property
def resource_path(self):
return self._resource_path
@property
def query_options(self):
return self._query_options
@property
def properties(self):
return self._properties
@property
def parent_collection(self):
return self._parent_collection