Code cleanup and tweaks

Author: AlexKempen

.vscode/settings.json

@@ -24,6 +24,7 @@
         "exportstl",
         "featureid",
         "FEATURESTUDIO",
+        "Kempen",
         "levelname",
         "Onshape",
         "UNCONFIGURABLE",

backend/common/evaluate.py

@@ -1,12 +1,11 @@
 """"Utilities for evaluating FeatureScripts against part studios."""
 
-
 from concurrent import futures
 import dataclasses
 import pathlib
 from typing import Iterable, TypedDict
 import onshape_api
-from onshape_api import endpoints
+from onshape_api.endpoints.part_studios import evaluate_feature_script
 
 SCRIPT_PATH = pathlib.Path("../scripts")
 
@@ -28,23 +27,23 @@ class AutoAssemblyTarget(TypedDict):
 def evalute_auto_assembly_part(
     api: onshape_api.Api, part_studio_path: onshape_api.ElementPath
 ) -> dict:
-    return endpoints.evaluate_feature_script(
+    return evaluate_feature_script(
         api, part_studio_path, open_script("parseAutoAssembly")
     )
 
 
 def evalute_auto_assembly_target_part(
     api: onshape_api.Api, part_studio_path: onshape_api.ElementPath
 ) -> dict:
-    return endpoints.evaluate_feature_script(
+    return evaluate_feature_script(
         api, part_studio_path, open_script("parseAutoAssemblyTarget")
     )
 
 
 def evaluate_assembly_mirror_part(
     api: onshape_api.Api, part_studio_path: onshape_api.ElementPath
 ) -> dict:
-    return endpoints.evaluate_feature_script(
+    return evaluate_feature_script(
         api, part_studio_path, open_script("parseAssemblyMirror")
     )
 

backend_tools/pull_scripts.py

@@ -3,9 +3,10 @@
 import pathlib
 from onshape_api.api import key_api
 from onshape_api.endpoints import feature_studios
-from featurescript import endpoints, feature_studio
+from featurescript import feature_studio
 from featurescript.transform import transform
 from featurescript import conf
+from robot_code.documents import BACKEND
 
 
 def insert_code(function: str, code: list[str]) -> str:
@@ -17,11 +18,7 @@ def insert_code(function: str, code: list[str]) -> str:
 
 def main():
     onshape = key_api.make_key_api()
-    config = conf.Config()
-    backend_path = config.get_document("backend")
-    if not backend_path:
-        raise ValueError("Unexpectedly failed to find backend document")
-    studio_path_map = feature_studio.get_feature_studios(onshape, backend_path)
+    studio_path_map = feature_studio.get_feature_studios(onshape, BACKEND)
 
     json_code = feature_studios.pull_code(onshape, studio_path_map["toJson.fs"].path)
     assembly_script_code = feature_studios.pull_code(
@@ -40,7 +37,7 @@ def main():
         function = transform.extract_function(assembly_script_code, name)
         function = insert_code(
             "function" + (function.strip().removeprefix("function " + name)), functions
-        )  # .replace("\\", "\\\\")
+        )
         pathlib.Path("backend/scripts/" + name + ".fs").write_text(function)
 
 

featurescript/base/ctxt.py

@@ -35,7 +35,7 @@ class Context:
       which circumvents nested predicate restrictions.
     """
 
-    std_version: int
+    std_version: str
 
     imports: list[imp.Import] = dataclasses.field(default_factory=list)
 

featurescript/base/imp.py

@@ -2,7 +2,7 @@
 from typing import override
 from featurescript.base import node, ctxt, user_error
 from featurescript.core import utils
-from featurescript.feature_studio import FeatureStudio
+from featurescript.feature_studio import LocalFeatureStudio
 from onshape_api.assertions import assert_instance_type
 from onshape_api.paths.instance_type import InstanceType
 from onshape_api.paths.paths import ElementPath
@@ -48,7 +48,7 @@ def build(self, context: ctxt.Context):
         ).build(context)
 
 
-def external_import(studio: FeatureStudio, export: bool = False) -> Import:
+def external_import(studio: LocalFeatureStudio, export: bool = False) -> Import:
     """An import of a feature studio from an external document."""
     path = studio.path
     assert_instance_type(path, InstanceType.VERSION)

featurescript/conf.py

@@ -7,7 +7,7 @@
 
 STORAGE_FILE: str = "studio_data.pickle"
 
-FileData = dict[str, feature_studio.FeatureStudio]
+FileData = dict[str, feature_studio.LocalFeatureStudio]
 
 
 class ConfigData(Protocol):
@@ -30,7 +30,7 @@ def __init__(self) -> None:
         if not path.is_file:
             raise IOError("Failed to find conf.json in the root directory")
         config = json5.load(path.open())
-        self._parse_config(config)  # type: ignore
+        self._parse_config(config)
 
     def _get_config_key(self, config: dict, key: str) -> Any:
         """Fetches the value of key from config. Throws if key does not exist."""

featurescript/feature_studio.py

@@ -11,21 +11,25 @@
 
 
 @dataclasses.dataclass
-class FeatureStudio:
+class LocalFeatureStudio:
     """Represents a FeatureStudio in Onshape.
 
     Attributes:
         name: The name of the feature studio.
         path: The path to the feature studio.
-        microversion_id: The most recent microverison id of the feature studio.
+        microversion_id: The most recent microverison id of the feature studio in the cloud.
             Used for external FeatureScript imports.
-        created: Whether the FeatureStudio is newly created.
+        created: True if the FeatureStudio actually exists in the cloud.
+        generated: True if the FeatureStudio is locally generated.
+        modified: True if the FeatureStudio has been modified since being pulled.
     """
 
     name: str
     path: ElementPath
     microversion_id: str
     created: bool
+    generated: bool = False
+    modified: bool = False
 
     def push(self, api: Api, code: str) -> dict:
         """Pushes this Studio to Onshape. The studio is created if it does not already exist."""
@@ -39,14 +43,14 @@ def push(self, api: Api, code: str) -> dict:
 
 def pull_feature_studio(
     api: Api, instance_path: InstancePath, studio_name: str
-) -> FeatureStudio:
+) -> LocalFeatureStudio:
     """Fetches a single feature studio by name, creating it if necessary."""
     feature_studio = get_feature_studio(api, instance_path, studio_name)
     if feature_studio == None:
         response = feature_studios.create_feature_studio(
             api, instance_path, studio_name
         )
-        return FeatureStudio(
+        return LocalFeatureStudio(
             studio_name,
             ElementPath.from_path(instance_path, response["id"]),
             response["microversionId"],
@@ -57,7 +61,7 @@ def pull_feature_studio(
 
 def get_feature_studios(
     api: Api, instance_path: InstancePath
-) -> dict[str, FeatureStudio]:
+) -> dict[str, LocalFeatureStudio]:
     """Returns a dict mapping feature studio names to feature studios."""
     elements = api.get(
         api_path("documents", instance_path, InstancePath, "elements"),
@@ -68,20 +72,20 @@ def get_feature_studios(
 
 def get_feature_studio(
     api: Api, document_path: InstancePath, studio_name: str
-) -> FeatureStudio | None:
+) -> LocalFeatureStudio | None:
     """Fetches a single feature studio by name, or None if no such studio exists."""
     return get_feature_studios(api, document_path).get(studio_name, None)
 
 
 def _extract_studios(
     elements: list[dict],
     instance_path: InstancePath,
-) -> dict[str, FeatureStudio]:
+) -> dict[str, LocalFeatureStudio]:
     """Constructs a list of FeatureStudios from a list of elements returned by a get documents request."""
     return dict(
         (
             element["name"],
-            FeatureStudio(
+            LocalFeatureStudio(
                 element["name"],
                 ElementPath.from_path(instance_path, element["id"]),
                 element["microversionId"],

featurescript/onshape.py featurescript/fs_cli.py

@@ -1,5 +1,6 @@
-"""Defines a command line parser for the `onshape` command.
+"""Defines a command line parser for the `fs` command.
 """
+
 import argparse
 
 from onshape_api import key_api

featurescript/manager.py

@@ -8,12 +8,13 @@
 
 from featurescript.base import ctxt, studio
 from featurescript import conf
-from featurescript.feature_studio import FeatureStudio, get_feature_studios
+from featurescript.feature_studio import LocalFeatureStudio, get_feature_studios
 from onshape_api import api_base
 from onshape_api.endpoints import feature_studios
 from onshape_api.endpoints.feature_studios import create_feature_studio
 from onshape_api.endpoints.std_versions import get_latest_std_version
 from onshape_api.paths.paths import ElementPath
+from robot_code.documents import BACKEND
 
 OUTDATED_VERSION_MATCH: re.Pattern[str] = re.compile(
     r'version : "(\d{2,7})\.0"|FeatureScript (\d{2,7});'
@@ -43,15 +44,15 @@ def _finish(self) -> None:
         if self.conflict:
             print(CONFLICT_MESSAGE)
 
-    def _report_conflict(self, studio: FeatureStudio) -> None:
+    def _report_conflict(self, studio: LocalFeatureStudio) -> None:
         self.conflict = True
         print(
             "{} has been modified both locally and in Onshape. Skipping.".format(
                 studio.name
             )
         )
 
-    def _get_studio_map(self) -> dict[str, FeatureStudio]:
+    def _get_studio_map(self) -> dict[str, LocalFeatureStudio]:
         """Returns a dict mapping Feature Studio names to FeatureStudios."""
         with futures.ThreadPoolExecutor() as executor:
             threads = [
@@ -97,8 +98,8 @@ def pull(self, force: bool = False) -> None:
             self._finish()
 
     def pull_studio(
-        self, force: bool, studio_to_pull: FeatureStudio
-    ) -> FeatureStudio | None:
+        self, force: bool, studio_to_pull: LocalFeatureStudio
+    ) -> LocalFeatureStudio | None:
         curr_studio = self.curr_data.get(studio_to_pull.path.element_id, None)
         if curr_studio is not None:
             if (
@@ -163,10 +164,10 @@ def push(self, force: bool = False) -> None:
 
     def push_studio(
         self,
-        onshape_studio_map: dict[str, FeatureStudio],
+        onshape_studio_map: dict[str, LocalFeatureStudio],
         force: bool,
-        studio_to_push: FeatureStudio,
-    ) -> FeatureStudio | None:
+        studio_to_push: LocalFeatureStudio,
+    ) -> LocalFeatureStudio | None:
         onshape_studio = onshape_studio_map.get(studio_to_push.path.element_id, None)
         # next(
         #     filter(
@@ -264,7 +265,7 @@ def _send_code(self, studio: studio.Studio, std_version: str) -> bool:
             return True
 
         print("{}: Successfully built.".format(studio.studio_name))
-        document = self.config.get_document("backend")
+        document = BACKEND
         if document is None:
             print(
                 "{}: Failed to find document in config.json named {}. Valid names are: {}".format(
@@ -278,10 +279,11 @@ def _send_code(self, studio: studio.Studio, std_version: str) -> bool:
 
         if feature_studio is None:
             result = create_feature_studio(self.api, document, studio.studio_name)
-            feature_studio = FeatureStudio(
+            feature_studio = LocalFeatureStudio(
                 result["name"],
                 ElementPath.from_path(document, result["id"]),
                 result["microversionId"],
+                True,
             )
         feature_studio.generated = True
         feature_studio.modified = True

onshape_api/endpoints/std_versions.py

@@ -4,7 +4,7 @@
 from onshape_api.model.constants import STD_PATH
 
 
-def get_latest_std_version(api: Api) -> int:
+def get_latest_std_version(api: Api) -> str:
     """Returns the name of the latest version of the Onshape std."""
     response = get_latest_version(api, STD_PATH)
     version_number = _extract_version_number(response["name"])
@@ -13,7 +13,7 @@ def get_latest_std_version(api: Api) -> int:
     return version_number
 
 
-def get_std_versions(api: Api) -> list[int]:
+def get_std_versions(api: Api) -> list[str]:
     """Returns a list of the names of all versions of the Onshape std.
 
     The versions are in reverse chronological order, with the oldest version first.
@@ -26,8 +26,8 @@ def get_std_versions(api: Api) -> list[int]:
     return [number for number in version_numbers if number != None]
 
 
-def _extract_version_number(version_name: str) -> int | None:
+def _extract_version_number(version_name: str) -> str | None:
     match = re.fullmatch(r"(\d+)\.0", version_name)
     if match == None:
         return None
-    return int(match.group(1))
+    return match.group(1)

robot_code/release.py

@@ -12,7 +12,7 @@
 
 from featurescript import *
 from featurescript.feature_studio import (
-    FeatureStudio,
+    LocalFeatureStudio,
     get_feature_studio,
     pull_feature_studio,
 )
@@ -228,8 +228,8 @@ def release_preamble(version_name: str, studio_path: ElementPath) -> str:
 
 def get_release_studio_code(
     version_name: str,
-    std_version: int,
-    backend_studio: FeatureStudio,
+    std_version: str,
+    backend_studio: LocalFeatureStudio,
 ) -> str:
     """Generates a studio which exposes a backend Feature Script.
 

robot_code/robot_cli.py

@@ -86,26 +86,31 @@ def parse_args() -> argparse.Namespace:
         "-l", "--log", help="whether to run with logging enabled", action="store_true"
     )
 
-    subparsers = parser.add_subparsers(required=True, dest="action")
+    action_parsers = parser.add_subparsers(required=True, dest="action")
 
     release_parser = get_release_parser()
-    subparsers.add_parser(
+    action_parsers.add_parser(
         "release",
         help="release a new version of a FeatureScript",
         parents=[release_parser],
         description="Release a FeatureScript to the frontend document.",
     )
-    subparsers.add_parser(
+    action_parsers.add_parser(
         "test-release",
         parents=[release_parser],
         help="release a test FeatureScript",
         description="Release a test FeatureScript in the test-frontend document.",
     )
-    subparsers.add_parser(
+    action_parsers.add_parser(
         "sync-versions",
         help="sync versions to the frontend document",
         description="Create all missing versions in the frontend document.",
     )
+    action_parsers.add_parser(
+        "update-fs-versions",
+        help="Update all Feature Studios to the latest FeatureScript version",
+        description="Update all Feature Studios to the latest FeatureScript version.",
+    )
 
     return parser.parse_args()
 

scripts/fs.sh

@@ -0,0 +1,3 @@
+#! /bin/sh
+# A simple wrapper for fs_cli.py
+python featurescript/fs_cli.py "$@"