siliconcompiler 0.34.2__py3-none-any.whl → 0.34.3__py3-none-any.whl

siliconcompiler/packageschema.py

@@ -11,7 +11,13 @@ from siliconcompiler.package import Resolver
 
 
 class PackageSchema(PathSchema):
+    """
+    A class for managing package-related schema data.
+    """
     def __init__(self):
+        """
+        Initializes a PackageSchema object.
+        """
         super().__init__()
 
         schema_package(self)
@@ -26,11 +32,13 @@ class PackageSchema(PathSchema):
         return self.set("package", "description", trim(desc))
 
     def get_description(self) -> str:
-        """Get the description of the package.
+        """
+        Get the description of the package.
 
         Returns:
             str: The description string.
         """
+
         return self.get("package", "description")
 
     def set_version(self, version: str):
@@ -51,6 +59,24 @@ class PackageSchema(PathSchema):
         """
         return self.get("package", "version")
 
+    def set_vendor(self, vendor: str):
+        """
+        Set the vendor of the package.
+
+        Args:
+            vendor (str): The vendor name.
+        """
+        return self.set("package", "vendor", vendor)
+
+    def get_vendor(self) -> str:
+        """
+        Get the vendor of the package.
+
+        Returns:
+            str: The vendor name.
+        """
+        return self.get("package", "vendor")
+
     def add_license(self, name: str):
         """
         Add a license name to the package.
@@ -77,12 +103,18 @@ class PackageSchema(PathSchema):
     def get_license(self) -> List[str]:
         """
         Get a list of license names associated with the package.
+
+        Returns:
+            List[str]: A list of license names.
         """
         return self.get("package", "license")
 
     def get_licensefile(self) -> List[str]:
         """
         Get a list of license file paths associated with the package.
+
+        Returns:
+            List[str]: A list of file paths.
         """
         return self.find_files("package", "licensefile")
 
@@ -163,11 +195,25 @@ class PackageSchema(PathSchema):
                 docs[type] = doc_files
         return docs
 
+    @classmethod
+    def _getdict_type(cls) -> str:
+        """
+        Returns the meta data for getdict
+        """
+
+        return PackageSchema.__name__
+
 
 ############################################
 # Package information
 ############################################
 def schema_package(schema):
+    """
+    Adds package schema parameters to the given schema.
+
+    Args:
+        schema (EditableSchema): The schema to modify.
+    """
     schema = EditableSchema(schema)
 
     schema.insert(
@@ -183,6 +229,18 @@ def schema_package(schema):
             help=trim("""Package version. Can be a branch, tag, commit hash,
             or a semver compatible version.""")))
 
+    schema.insert(
+        'package', 'vendor',
+        Parameter(
+            'str',
+            scope=Scope.GLOBAL,
+            shorthelp="Package: vendor",
+            switch="-package_vendor <str>",
+            example=[
+                "cli: -package_vendor acme",
+                "api: chip.set('package', 'vendor', 'acme')"],
+            help=trim("""Package vendor.""")))
+
     schema.insert(
         'package', 'description',
         Parameter(
@@ -262,14 +320,20 @@ def schema_package(schema):
 
 
 class PackageSchemaTmp(BaseSchema):
+    """
+    A temporary package schema used for development and testing.
+    """
     def __init__(self):
+        """
+        Initializes a temporary PackageSchemaTmp object.
+        """
         super().__init__()
 
         schema_package_tmp(self)
 
     def register(self, name, path, ref=None, clobber=True):
         """
-        Registers a package by its name with the source path and reference
+        Registers a package by its name with the source path and reference.
 
         Registered package sources are stored in the package section of the schema.
 
@@ -301,12 +365,12 @@ class PackageSchemaTmp(BaseSchema):
         return success
 
     def get_resolver(self, package):
-        '''
-        Returns a specific resolver
+        """
+        Returns a specific resolver for a package.
 
         Args:
             package (str): name of package
-        '''
+        """
         resolver_cls = Resolver.find_resolver(self.get("source", package, "path"))
         resolver = resolver_cls(package, self._parent(root=True),
                                 self.get("source", package, "path"),
@@ -314,20 +378,37 @@ class PackageSchemaTmp(BaseSchema):
         return resolver
 
     def get_resolvers(self):
-        '''
+        """
         Returns a dictionary of packages with their resolver method.
-        '''
+
+        Returns:
+            Dict[str, callable]: A dictionary of package names mapped to their resolver methods.
+        """
         resolvers = {}
         for package in self.getkeys("source"):
             resolvers[package] = self.get_resolver(package).get_path
 
         return resolvers
 
+    @classmethod
+    def _getdict_type(cls) -> str:
+        """
+        Returns the meta data for getdict
+        """
+
+        return PackageSchemaTmp.__name__
+
 
 ############################################
 # Package information
 ############################################
 def schema_package_tmp(schema):
+    """
+    Adds temporary package schema parameters to the given schema.
+
+    Args:
+        schema (EditableSchema): The schema to modify.
+    """
     schema = EditableSchema(schema)
 
     schema.insert(

siliconcompiler/pathschema.py

@@ -48,7 +48,8 @@ class PathSchemaBase(BaseSchema):
         """
         schema_root = self._parent(root=True)
         cwd = getattr(schema_root, "cwd", os.getcwd())
-        collection_dir = getattr(schema_root, "collection_dir", None)
+        collection_dir = getattr(schema_root, "collection_dir",
+                                 getattr(schema_root, "getcollectiondir", None))
         if collection_dir:
             collection_dir = collection_dir()
 
@@ -73,7 +74,9 @@ class PathSchemaBase(BaseSchema):
         logger = getattr(schema_root,
                          "logger",
                          logging.getLogger("siliconcompiler.check_filepaths"))
-        collection_dir = getattr(schema_root, "collection_dir", None)
+        collection_dir = getattr(schema_root, "collection_dir",
+                                 getattr(schema_root, "getcollectiondir",
+                                         None))
         if collection_dir:
             collection_dir = collection_dir()
 
@@ -84,6 +87,32 @@ class PathSchemaBase(BaseSchema):
             cwd=cwd)
 
 
+class PathSchemaSimpleBase(PathSchemaBase):
+    def find_files(self, *keypath, missing_ok=False):
+        """
+        Returns absolute paths to files or directories based on the keypath
+        provided.
+        The keypath provided must point to a schema parameter of type file, dir,
+        or lists of either. Otherwise, it will trigger an error.
+        Args:
+            keypath (list of str): Variable length schema key list.
+            missing_ok (bool): If True, silently return None when files aren't
+                found. If False, print an error and set the error flag.
+        Returns:
+            If keys points to a scalar entry, returns an absolute path to that
+            file/directory, or None if not found. It keys points to a list
+            entry, returns a list of either the absolute paths or None for each
+            entry, depending on whether it is found.
+        Examples:
+            >>> schema.find_files('input', 'verilog')
+            Returns a list of absolute paths to source files, as specified in
+            the schema.
+        """
+        return super().find_files(*keypath,
+                                  missing_ok=missing_ok,
+                                  step=None, index=None)
+
+
 class PathSchema(PathSchemaBase):
     '''
     Schema extension to add support for path handling with dataroots