Added Pydantic Model Autodocs

README.md

@@ -10,8 +10,6 @@
 
 ## Python wrapper for Homeassistant's [REST API](https://developers.home-assistant.io/docs/api/rest/)
 
-Please ⭐️ the repo if you find this project useful or cool!
-
 Here is a quick example.
 ```py
 from homeassistant_api import Client

docs/api.rst

@@ -1,7 +1,7 @@
 Code Reference
 ***************
 
-Clients
+Client
 --------
 
 .. autoclass:: homeassistant_api.Client
@@ -14,33 +14,35 @@ Data Models
 
 .. automodule:: homeassistant_api.models
 
-   .. autoclass:: Domain
+   .. autopydantic_model:: Domain
 
-   .. autoclass:: Service
+   .. autopydantic_model:: Service
 
-   .. autoclass:: Group
+   .. autopydantic_model:: Group
 
-   .. autoclass:: Entity
+   .. autopydantic_model:: Entity
 
-   .. autoclass:: History
+   .. autopydantic_model:: History
 
-   .. autoclass:: State
+   .. autopydantic_model:: LogbookEntry
 
-   .. autoclass:: Event
+   .. autopydantic_model:: State
+
+   .. autopydantic_model:: Event
 
 
 
 .. automodule:: homeassistant_api._async.models
 
-   .. autoclass:: AsyncDomain
+   .. autopydantic_model:: AsyncDomain
 
-   .. autoclass:: AsyncService
+   .. autopydantic_model:: AsyncService
 
-   .. autoclass:: AsyncGroup
+   .. autopydantic_model:: AsyncGroup
 
-   .. autoclass:: AsyncEntity
+   .. autopydantic_model:: AsyncEntity
 
-   .. autoclass:: AsyncEvent
+   .. autopydantic_model:: AsyncEvent
 
 
 Processing

docs/conf.py

@@ -43,7 +43,12 @@
     else "v" + version
 )
 
-extensions = ["sphinx.ext.autodoc", "resourcelinks", "sphinx_autodoc_typehints"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "resourcelinks",
+    "sphinx_autodoc_typehints",
+    "sphinxcontrib.autodoc_pydantic",
+]
 
 resource_links = {
     "repo": "https://github.com/GrandMoff100/HomeassistantAPI/",

docs/doc_requirements.txt

@@ -7,6 +7,7 @@ appdirs
 astroid                      
 async-timeout                
 attrs                        
+autodoc-pydantic             
 babel                        
 black                        
 brotli                       
@@ -25,6 +26,7 @@ frozenlist
 identify                     
 idna                         
 imagesize                    
+importlib-metadata           
 iniconfig                    
 isort                        
 itsdangerous                 
@@ -80,4 +82,5 @@ url-normalize
 urllib3                      
 virtualenv                   
 wrapt                        
-yarl
+yarl                         
+zipp                         

homeassistant_api/_async/models/domains.py

@@ -1,13 +1,23 @@
 """File for Service and Domain data models"""
 
-from typing import Any, Dict, Tuple, cast
+from typing import TYPE_CHECKING, Any, Dict, Optional, Tuple, cast
 
-from ...models import Domain, Service, State
+from pydantic import BaseModel, Field
 
+from ...models import State
+from ...models.domains import ServiceField
 
-class AsyncDomain(Domain):
+if TYPE_CHECKING:
+    from homeassistant_api import Client
+
+
+class AsyncDomain(BaseModel):
     """A class representing the domain that services belong to."""
 
+    domain_id: str
+    client: "Client" = Field(exclude=True, repr=False)
+    services: Dict[str, "AsyncService"] = {}
+
     def add_service(self, service_id: str, **data) -> None:
         """Registers services into a domain to be used or accessed"""
         self.services.update(
@@ -24,10 +34,25 @@ def get_service(self, service_id: str):
         """Return a Service with the given service_id, returns None if no such service exists"""
         return self.services.get(service_id, None)
 
+    def __getattr__(self, attr: str):
+        """Allows services accessible as attributes"""
+        if attr in self.__dict__:
+            return super().__getattribute__(attr)
+        if attr in self.services:
+            return self.get_service(attr)
+        return super().__getattribute__(attr)
 
-class AsyncService(Service):
+
+class AsyncService(BaseModel):
     """Class representing services from homeassistant"""
 
+    service_id: str
+    domain: AsyncDomain
+    name: Optional[str] = None
+    description: Optional[str] = None
+    fields: Optional[Dict[str, ServiceField]] = None
+    target: Optional[Dict[str, dict]] = None
+
     async def async_trigger(self, **service_data) -> Tuple[State, ...]:
         """Triggers the service associated with this object."""
         data = await self.domain.client.async_trigger_service(

main.py

@@ -1 +0,0 @@
-