merge develop to main

Author: VigneshVSV

CONTRIBUTING.md

@@ -11,16 +11,15 @@ All types of contributions are encouraged and valued.
 > - Mention the project at local meetups/conferences and tell your friends/colleagues
 > - Donate to cover the costs of maintaining it
 
-
 ## I Have a Question
 
-Do feel free to reach out to me at vignesh.vaidyanathan@hololinked.dev. I will try my very best to respond. 
+Do feel free to reach out to me at vignesh.vaidyanathan@hololinked.dev or in discord. I will try my very best to respond. 
 
 Nevertheless, one may also refer the available how-to section of the [Documentation](https://hololinked.readthedocs.io/en/latest/index.html).
 If the documentation is insufficient for any reason including being poorly documented, one may open a new discussion in the [Q&A](https://github.com/VigneshVSV/hololinked/discussions/categories/q-a) section of GitHub discussions. 
 
 For questions related to workings of HTTP, JSON schema, basic concepts of python like descriptors, decorators etc., it is also advisable to search the internet for answers first.
-For generic questions related to web of things standards or its ideas, I recommend to join web of things [discord](https://discord.com/invite/RJNYJsEgnb) group and [community](https://www.w3.org/community/wot/) group.
+For generic questions related to web of things standards or its ideas, it is recommended to join web of things [discord](https://discord.com/invite/RJNYJsEgnb) group and [community](https://www.w3.org/community/wot/) group.
 
 If you believe your question might also be a bug, you might want to search for existing [Issues](https://github.com/VigneshVSV/hololinked/issues) that might help you. 
 In case you have found a suitable issue and still need clarification, you can write your question in this issue. If an issue is not found:
@@ -44,13 +43,21 @@ Otherwise, I will then take care of the issue as soon as possible.
 > ### Legal Notice <!-- omit in toc -->
 > When contributing to this project, you must agree that you have authored 100% of the content or that you have the necessary rights to the content. For example, you copied code from projects with MIT/BSD License. Content from GPL-related licenses may be maintained in a separate repository as an add-on. 
 
-Developers are always welcome to contribute to the code base. If you want to tackle any issues, un-existing features, let me know (at my email), I can create some open issues and features which I was never able to solve or did not have the time. You can also suggest what else can be contributed functionally or conceptually or also simply code-refactoring. The lack of issues or features in the [Issues](https://github.com/VigneshVSV/hololinked/issues) section of github does not mean the project is considered feature complete or I dont have ideas what to do next. On the contrary, there is tons of work to do. 
+Developers are always welcome to contribute to the code base. If you want to tackle any issues, un-existing features, let me know (at my email), I can create some open issues and features which I was never able to solve or did not have the time. You can also suggest what else can be contributed functionally, conceptually or also simply code-refactoring.
 
-There are also repositories which can use your skills:
+There are also other repositories which can use your skills:
 - An [admin client](https://github.com/VigneshVSV/thing-control-panel) in react
 - [Documentation](https://github.com/VigneshVSV/hololinked-docs) in sphinx which needs significant improvement in How-To's, beginner level docs which may teach people concepts of data acquisition or IoT, Docstring or API documentation of this repository itself 
 - [Examples](https://github.com/VigneshVSV/hololinked-examples) in nodeJS, Dashboard/PyQt GUIs or server implementations using this package. Hardware implementations of unexisting examples are also welcome, I can open a directory where people can search for code based on hardware and just download your code. 
 
+## Git Branching
+
+A simpler model is used roughly based on [this article](https://www.bitsnbites.eu/a-stable-mainline-branching-model-for-git/) - 
+- main branch is where all stable developments are merged, all your branches must merge here 
+- main branch is merged to release branch when it is decided to created a release. 
+- A specific release is tagged and not created as its own branch. Instead release branch simply follows the main branch at the release time. People should clone the main branch for latest (mostly-) stable code base and release branch for released code base. 
+- other branches are feature or bug fix branches. A develop branch may be used to make general improvements as the package is constantly evolving, but its not a specific philosophy to use a develop branch. 
+- Bug fixes on releases must proceed from the tag of that release. Perhaps, even a new release can be made after fixing the bug by merging a bug fix branch to main branch. 
 
 ## Attribution
 This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

hololinked/server/eventloop.py

@@ -353,8 +353,8 @@ async def execute_once(cls, instance_name : str, instance : Thing, instruction_s
             if action == "write": 
                 if resource.state is None or (hasattr(instance, 'state_machine') and  
                                         instance.state_machine.current_state in resource.state):
-                    if isinstance(arguments, dict) and len(arguments) == 1 and "value" in arguments:
-                        return prop.__set__(owner_inst, arguments["value"])
+                    if isinstance(arguments, dict) and len(arguments) == 1 and 'value' in arguments:
+                        return prop.__set__(owner_inst, arguments['value'])
                     return prop.__set__(owner_inst, arguments)
                 else: 
                     raise StateMachineError("Thing {} is in `{}` state, however attribute can be written only in `{}` state".format(

hololinked/server/events.py

@@ -61,6 +61,8 @@ def __get__(self, obj, objtype) -> "EventDispatcher":
 
     def __get__(self, obj : ParameterizedMetaclass, objtype : typing.Optional[type] = None):
         try:
+            if not obj:
+                return self
             return obj.__dict__[self._internal_name]
         except KeyError:
             raise AttributeError("Event object not yet initialized, please dont access now." +

hololinked/server/state_machine.py

@@ -5,6 +5,7 @@
 
 from ..param.parameterized import Parameterized
 from .utils import getattr_without_descriptor_read
+from .exceptions import StateMachineError
 from .dataklasses import RemoteResourceInfoValidator
 from .property import Property
 from .properties import ClassSelector, TypedDict, Boolean
@@ -107,7 +108,7 @@ def _prepare(self, owner : Parameterized) -> None:
                         raise AttributeError(f"Object {resource} was not made remotely accessible," + 
                                     " use state machine with properties and actions only.")
             else:
-                raise AttributeError("Given state {} not in states Enum {}".format(state, self.states.__members__))
+                raise StateMachineError("Given state {} not in states Enum {}".format(state, self.states.__members__))
 
         # then the callbacks 
         for state, objects in self.on_enter.items():

hololinked/server/td.py

@@ -13,7 +13,6 @@
 
 
 
-
 @dataclass
 class Schema:
     """
@@ -53,7 +52,9 @@ def format_doc(cls, doc : str):
             if index > 0:
                 line = ' ' + line # add space to left in case of new line            
             final_doc.append(line)
-        return ''.join(final_doc)
+        final_doc = ''.join(final_doc)
+        final_doc = final_doc.lstrip().rstrip()
+        return final_doc
 
 
 
@@ -187,14 +188,14 @@ def build(self, property : Property, owner : Thing, authority : str) -> None:
             self.description = Schema.format_doc(property.doc)
         if property.metadata and property.metadata.get("unit", None) is not None:
             self.unit = property.metadata["unit"]
-        # if property.allow_None:
-        #     if not hasattr(self, 'oneOf'):
-        #         self.oneOf = []
-        #     if hasattr(self, 'type'):
-        #         self.oneOf.append(dict(type=self.type))
-        #         del self.type
-        #     if not any(types["type"] == None for types in self.oneOf):
-        #         self.oneOf.append(dict(type=None))
+        if property.allow_None:
+            if not hasattr(self, 'oneOf'):
+                self.oneOf = []
+            if hasattr(self, 'type'):
+                self.oneOf.append(dict(type=self.type))
+                del self.type
+            if not any(types["type"] == None for types in self.oneOf):
+                self.oneOf.append(dict(type="null"))
 
 
 
@@ -262,6 +263,17 @@ def generate_schema(self, property : Property, owner : Thing, authority : str) -
             schema = OneOfSchema()
         elif self._custom_schema_generators.get(property, NotImplemented) is not NotImplemented:
             schema = self._custom_schema_generators[property]()
+        elif isinstance(property, Property) and property.model is not None:
+            from .td_pydantic_extensions import GenerateJsonSchemaWithoutDefaultTitles, type_to_dataschema
+            schema = PropertyAffordance()
+            schema.build(property=property, owner=owner, authority=authority)
+            data_schema = type_to_dataschema(property.model).model_dump(mode='json', exclude_none=True)
+            final_schema = schema.asdict()
+            if schema.oneOf: # allow_None = True
+                final_schema['oneOf'].append(data_schema)
+            else:
+                final_schema.update(data_schema)
+            return final_schema
         else:
             raise TypeError(f"WoT schema generator for this descriptor/property is not implemented. name {property.name} & type {type(property)}")     
         schema.build(property=property, owner=owner, authority=authority)
@@ -719,17 +731,18 @@ class ThingDescription(Schema):
                     'events', 'thing_description', 'GUI', 'object_info' ]
 
     skip_actions = ['_set_properties', '_get_properties', '_add_property', '_get_properties_in_db', 
-                    'push_events', 'stop_events', 'get_postman_collection', 'get_thing_description']
+                    'push_events', 'stop_events', 'get_postman_collection', 'get_thing_description',
+                    'get_our_temp_thing_description']
 
     # not the best code and logic, but works for now
 
     def __init__(self, instance : Thing, authority : typing.Optional[str] = None, 
-                    allow_loose_schema : typing.Optional[bool] = False) -> None:
+                    allow_loose_schema : typing.Optional[bool] = False, ignore_errors : bool = False) -> None:
         super().__init__()
         self.instance = instance
         self.authority = authority
         self.allow_loose_schema = allow_loose_schema
-
+        self.ignore_errors = ignore_errors
 
     def produce(self) -> typing.Dict[str, typing.Any]: 
         self.context = "https://www.w3.org/2022/wot/td/v1.1"
@@ -754,26 +767,38 @@ def produce(self) -> typing.Dict[str, typing.Any]:
     def add_interaction_affordances(self):
         # properties and actions
         for resource in self.instance.instance_resources.values():
-            if (resource.isproperty and resource.obj_name not in self.properties and 
-                resource.obj_name not in self.skip_properties and hasattr(resource.obj, "_remote_info") and 
-                resource.obj._remote_info is not None): 
-                if (resource.obj_name == 'state' and (not hasattr(self.instance, 'state_machine') or 
-                            not isinstance(self.instance.state_machine, StateMachine))):
-                    continue
-                self.properties[resource.obj_name] = PropertyAffordance.generate_schema(resource.obj, 
+            try:
+                if (resource.isproperty and resource.obj_name not in self.properties and 
+                    resource.obj_name not in self.skip_properties and hasattr(resource.obj, "_remote_info") and 
+                    resource.obj._remote_info is not None): 
+                    if (resource.obj_name == 'state' and (not hasattr(self.instance, 'state_machine') or 
+                                not isinstance(self.instance.state_machine, StateMachine))):
+                        continue
+                    self.properties[resource.obj_name] = PropertyAffordance.generate_schema(resource.obj, 
                                                                             self.instance, self.authority) 
-            elif (resource.isaction and resource.obj_name not in self.actions and 
-                  resource.obj_name not in self.skip_actions and hasattr(resource.obj, '_remote_info')):
-                self.actions[resource.obj_name] = ActionAffordance.generate_schema(resource.obj, 
-                                                                            self.instance, self.authority)
+                
+                elif (resource.isaction and resource.obj_name not in self.actions and 
+                    resource.obj_name not in self.skip_actions and hasattr(resource.obj, '_remote_info')):
+                   
+                    self.actions[resource.obj_name] = ActionAffordance.generate_schema(resource.obj, 
+                                                                                self.instance, self.authority)
+            except Exception as ex:
+                if not self.ignore_errors:
+                    raise ex from None
+                self.instance.logger.error(f"Error while generating schema for {resource.obj_name} - {ex}")
         # Events
         for name, resource in inspect._getmembers(self.instance, lambda o : isinstance(o, Event),
                                                 getattr_without_descriptor_read):
             if not isinstance(resource, Event):
                 continue
             if '/change-event' in resource.URL_path:
                 continue
-            self.events[name] = EventAffordance.generate_schema(resource, self.instance, self.authority)
+            try:
+                self.events[name] = EventAffordance.generate_schema(resource, self.instance, self.authority)
+            except Exception as ex:
+                if not self.ignore_errors:
+                    raise ex from None
+                self.instance.logger.error(f"Error while generating schema for {resource.obj_name} - {ex}")
         # for name, resource in inspect._getmembers(self.instance, lambda o : isinstance(o, Thing), getattr_without_descriptor_read):
         #     if resource is self.instance or isinstance(resource, EventLoop):
         #         continue