chore: small test refactors, all linting fixes

Author: rihp

packages/polywrap-client-config-builder/polywrap_client_config_builder/__init__.py

@@ -1 +1,11 @@
+"""
+Polywrap Python Client.
+
+ClientConfigBuilder Package
+
+docs.polywrap.io
+
+Copyright 2022 Polywrap
+"""
+
 from .client_config_builder import *

packages/polywrap-client-config-builder/polywrap_client_config_builder/client_config_builder.py

@@ -1,18 +1,30 @@
+"""
+Polywrap Python Client.
+
+The ClientConfigBuilder Package provides a simple interface for building a ClientConfig object,
+which is used to configure the Polywrap Client and its sub-components. You can use the
+ClientConfigBuilder to set the wrappers, packages, and other configuration options for the
+Polywrap Client.
+
+docs.polywrap.io
+Copyright 2022 Polywrap
+"""
+
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from polywrap_core import Uri, IUriResolver, Env, UriWrapper,UriPackage
-from polywrap_uri_resolvers import IUriResolver
-from typing import Dict, Any, List, Optional, Union
-from polywrap_uri_resolvers import UriResolverLike
+from typing import Any, Dict, List, Union
+
+from polywrap_core import Env, Uri, UriPackage, UriWrapper
 
-# from polywrap_plugin import PluginPackage
+UriResolverLike = Union[Uri, UriPackage, UriWrapper, List["UriResolverLike"]]
 
 
 @dataclass(slots=True, kw_only=True)
 class ClientConfig:
     """
-    This Abstract class is used to configure the polywrap client before it executes a call
-    The ClientConfig class is created and modified with the ClientConfigBuilder module
+    Abstract class used to configure the polywrap client before it executes a call.
+
+    The ClientConfig class is created and modified with the ClientConfigBuilder module.
     """
 
     envs: Dict[Uri, Dict[str, Any]]
@@ -25,23 +37,28 @@ class ClientConfig:
 
 class BaseClientConfigBuilder(ABC):
     """
-    An abstract base class of the `ClientConfigBuilder`, which uses the ABC module
-    to define the methods that can be used to configure the `ClientConfig` object.
+    An abstract base class of the `ClientConfigBuilder`.
+
+    It uses the ABC module to define the methods that can be used to
+    configure the `ClientConfig` object.
     """
 
     def __init__(self):
+        """Initialize the builder's config attributes with empty values."""
         self.config = ClientConfig(
             envs={}, interfaces={}, resolver=[], wrappers=[], packages=[], redirects={}
         )
 
     @abstractmethod
     def build(self) -> ClientConfig:
-        """Returns a sanitized config object from the builder's config."""
-        pass
+        """Return a sanitized config object from the builder's config."""
 
-    
     def add(self, new_config: ClientConfig):
-        """Returns a sanitized config object from the builder's config after receiving a partial `ClientConfig` object."""
+        """
+        Return a sanitized config object from the builder's config.
+
+        Input is a partial `ClientConfig` object.
+        """
         if new_config.envs:
             self.config.envs.update(new_config.envs)
         if new_config.interfaces:
@@ -55,18 +72,21 @@ def add(self, new_config: ClientConfig):
         return self
 
     def get_envs(self) -> Dict[Uri, Dict[str, Any]]:
-        """Returns the envs dictionary from the builder's config."""
+        """Return the envs dictionary from the builder's config."""
         return self.config.envs
 
     def set_env(self, env: Env, uri: Uri):
-        """Sets the envs dictionary in the builder's config, overiding any existing values."""
+        """Set the envs dictionary in the builder's config, overiding any existing values."""
         self.config.envs[uri] = env
         return self
 
     def add_env(self, env: Env, uri: Uri):
-        """Adds an environment (in the form of an `Env`) for a given uri, without overwriting existing environments,
-        unless the env key already exists in the environment, then it will overwrite the existing value"""
+        """
+        Add an environment (in the form of an `Env`) for a given uri.
 
+        Note it is not overwriting existing environments, unless the
+        env key already exists in the environment, then it will overwrite the existing value.
+        """
         if uri in self.config.envs.keys():
             for key in env.keys():
                 self.config.envs[uri][key] = env[key]
@@ -75,19 +95,15 @@ def add_env(self, env: Env, uri: Uri):
         return self
 
     def add_envs(self, envs: List[Env], uri: Uri = None):
-        """
-        Adds a list of environments (each in the form of an `Env`) for a given uri
-        """
+        """Add a list of environments (each in the form of an `Env`) for a given uri."""
         for env in envs:
             self.add_env(env, uri)
         return self
 
     def add_interface_implementations(
         self, interface_uri: Uri, implementations_uris: List[Uri]
     ):
-        """
-        Adds a list of implementations (each in the form of an `Uri`) for a given interface
-        """
+        """Add a list of implementations (each in the form of an `Uri`) for a given interface."""
         if interface_uri is None:
             raise ValueError()
         if interface_uri in self.config.interfaces.keys():
@@ -98,67 +114,50 @@ def add_interface_implementations(
             self.config.interfaces[interface_uri] = implementations_uris
         return self
 
-    def add_wrapper(self, wrapper_uri: Uri):
-        """
-        Adds a wrapper to the list of wrappers
-        """
+    def add_wrapper(self, wrapper_uri: UriWrapper):
+        """Add a wrapper to the list of wrappers."""
         self.config.wrappers.append(wrapper_uri)
         return self
 
-    def add_wrappers(self, wrappers_uris: List[Uri]):
-        """
-        Adds a list of wrappers to the list of wrappers
-        """
+    def add_wrappers(self, wrappers_uris: List[UriWrapper]):
+        """Add a list of wrappers to the list of wrappers."""
         for wrapper_uri in wrappers_uris:
             self.add_wrapper(wrapper_uri)
         return self
 
-    def remove_wrapper(self, wrapper_uri: Uri):
-        """
-        Removes a wrapper from the list of wrappers
-        """
+    def remove_wrapper(self, wrapper_uri: UriWrapper):
+        """Remove a wrapper from the list of wrappers."""
         self.config.wrappers.remove(wrapper_uri)
         return self
 
     def set_package(self, uri_package: UriPackage):
-        """
-        Sets the package in the builder's config, overiding any existing values.
-        """
+        """Set the package in the builder's config, overiding any existing values."""
         self.config.packages = [uri_package]
         return self
 
     def add_package(self, uri_package: UriPackage):
-        """
-        Adds a package to the list of packages
-        """
+        """Add a package to the list of packages."""
         self.config.packages.append(uri_package)
         return self
+
     def add_packages(self, uri_packages: List[UriPackage]):
-        """
-        Adds a list of packages to the list of packages
-        """
+        """Add a list of packages to the list of packages."""
         for uri_package in uri_packages:
             self.add_package(uri_package)
         return self
 
     def remove_package(self, uri_package: UriPackage):
-        """
-        Removes a package from the list of packages
-        """
+        """Remove a package from the list of packages."""
         self.config.packages.remove(uri_package)
         return self
 
     def set_resolver(self, uri_resolver: UriResolverLike):
-        """
-        Sets a single resolver for the `ClientConfig` object before it is built
-        """
+        """Set a single resolver for the `ClientConfig` object."""
         self.config.resolver = [uri_resolver]
         return self
 
     def add_resolver(self, resolver: UriResolverLike):
-        """
-        Adds a resolver to the list of resolvers
-        """
+        """Add a resolver to the list of resolvers."""
         if self.config.resolver is None:
             raise ValueError(
                 "This resolver is not set. Please set a resolver before adding resolvers."
@@ -167,45 +166,43 @@ def add_resolver(self, resolver: UriResolverLike):
         return self
 
     def add_resolvers(self, resolvers_list: List[UriResolverLike]):
-        """
-        Adds a list of resolvers to the list of resolvers
-        """
+        """Add a list of resolvers to the list of resolvers."""
         for resolver in resolvers_list:
             self.add_resolver(resolver)
         return self
 
     def set_uri_redirect(self, uri_from: Uri, uri_to: Uri):
         """
-        Sets an uri redirect, from one uri to another
-        If there was a redirect previously listed, it's changed to the new one
-        """ 
+        Set an uri redirect, from one uri to another.
+
+        If there was a redirect previously listed, it's changed to the new one.
+        """
         self.config.redirects[uri_from] = uri_to
         return self
-    
+
     def remove_uri_redirect(self, uri_from: Uri):
-        """
-        Removes an uri redirect, from one uri to another
-        """
+        """Remove an uri redirect, from one uri to another."""
         self.config.redirects.pop(uri_from)
         return self
 
-    def set_uri_redirects(self, redirects: List[Dict[Uri,Uri]]):
-        """
-        Sets various Uri redirects from a list simultaneously
-        """
+    def set_uri_redirects(self, redirects: List[Dict[Uri, Uri]]):
+        """Set various Uri redirects from a list simultaneously."""
         count = 0
         for redir in redirects:
-            for k,v in redir.items():
-                self.set_uri_redirect(k,v)
+            for key, value in redir.items():
+                self.set_uri_redirect(key, value)
             count += 1
         return self
 
 
 class ClientConfigBuilder(BaseClientConfigBuilder):
+    """
+    A class that can build the `ClientConfig` object.
+
+    This class inherits the `BaseClientConfigBuilder` class,
+    and adds the `build` method
+    """
 
     def build(self) -> ClientConfig:
-        """
-        Returns a sanitized config object from the builder's config.
-        """
+        """Return a sanitized config object from the builder's config."""
         return self.config
-

packages/polywrap-client-config-builder/tests/conftest.py

@@ -1,5 +1,28 @@
+from pytest import fixture
+from abc import ABC
+from typing import Any, Dict, TypeVar, Generic, List
+from typing import Generic, Optional, cast
+import pytest
+
+from typing import List, Any, Dict, Union
+from polywrap_core import Env
 from polywrap_core import  Uri
+from polywrap_core import IUriResolver, UriPackage, UriWrapper, IWrapPackage
 from pytest import fixture
+from polywrap_client_config_builder import ClientConfig
+from dataclasses import asdict
+
+
+# polywrap plugins
+
+from polywrap_core import Invoker, InvokeOptions, InvocableResult, GetFileOptions
+from polywrap_result import Err, Ok, Result
+
+from polywrap_core import IWrapPackage, Wrapper, GetManifestOptions
+from polywrap_manifest import AnyWrapManifest
+from polywrap_result import Ok, Result
+from polywrap_msgpack import msgpack_decode
+from polywrap_core import  Uri
 
 # Variables 
 
@@ -36,3 +59,7 @@ def env_uriY():
 @fixture
 def env_uriZ():
     return Uri("wrap://pinlist/dev.wrappers.io/Z")
+
+
+
+