Merge pull request #151 from robotpy/no-extras

Replace 'robotpy_extras' with 'components'

Author: virtuald

robotpy_installer/cli_sync.py

@@ -30,12 +30,12 @@ class Sync:
         # Version of robotpy this project depends on
         robotpy_version = "{robotpy_version}"
 
-        # Which extras should be installed
-        # -> equivalent to `pip install robotpy[extra1, ...]
-        robotpy_extras = []
+        # Which optional RobotPy components should be installed?
+        # -> equivalent to `pip install robotpy[component1, ...]
+        components = []
 
-        # Other pip packages to install (each element is equivalent to
-        # a line in requirements.txt)
+        # Other pip packages to install, such as vendor packages (each element
+        # is equivalent to a line in requirements.txt)
         requires = []
 
     If no pyproject.toml exists, a default is created using the current robotpy

robotpy_installer/pyproject.py

@@ -50,7 +50,7 @@ class RobotPyProjectToml:
         robotpy_version = "2024.0.0b4"
 
         # equivalent to `robotpy[cscore, ...]`
-        robotpy_extras = ["cscore"]
+        components = ["cscore"]
 
         # Other pip installable requirement lines
         requires = [
@@ -62,17 +62,17 @@ class RobotPyProjectToml:
     #: Version of robotpy that is depended on
     robotpy_version: Version
 
-    robotpy_extras: typing.List[str] = dataclasses.field(default_factory=list)
+    components: typing.List[str] = dataclasses.field(default_factory=list)
 
     #: Requirement for the robotpy meta package -- all RobotPy projects must
     #: depend on it
     @property
     def robotpy_requires(self) -> Requirement:
-        if self.robotpy_extras:
-            extras = f"[{','.join(self.robotpy_extras)}]"
+        if self.components:
+            components = f"[{','.join(self.components)}]"
         else:
-            extras = ""
-        return Requirement(f"robotpy{extras}=={self.robotpy_version}")
+            components = ""
+        return Requirement(f"robotpy{components}=={self.robotpy_version}")
 
     #: User's custom requirements
     requires: typing.List[Requirement] = dataclasses.field(default_factory=list)
@@ -401,13 +401,14 @@ def write_default_pyproject(
             # Version of robotpy this project depends on
             robotpy_version = "{robotpy_version}"
             
-            # Which extra RobotPy components should be installed
+            # Which optional robotpy components should be installed?
             # -> equivalent to `pip install robotpy[extra1, ...]
-            robotpy_extras = [
+            components = [
                 # ##EXTRAS##
             ]
 
-            # Other pip packages to install
+            # Other pip packages to install, such as vendor packages (each element
+            # is equivalent to a line in requirements.txt)
             requires = []
 
         """
@@ -484,13 +485,18 @@ def _load(
         )
         raise UnsupportedRobotpyVersion(msg)
 
-    robotpy_extras_any = robotpy_data.get("robotpy_extras")
-    if isinstance(robotpy_extras_any, list):
-        robotpy_extras = list(map(str, robotpy_extras_any))
-    elif not robotpy_extras_any:
-        robotpy_extras = []
+    if "robotpy_extras" in robotpy_data:
+        raise PyprojectError(
+            "'robotpy_extras' has been replaced with 'components', see the documentation for details"
+        )
+
+    components_any = robotpy_data.get("components")
+    if isinstance(components_any, list):
+        components = list(map(str, components_any))
+    elif not components_any:
+        components = []
     else:
-        robotpy_extras = [str(robotpy_extras_any)]
+        components = [str(components_any)]
 
     requires_any = robotpy_data.get("requires")
     if isinstance(requires_any, list):
@@ -504,7 +510,7 @@ def _load(
 
     return RobotPyProjectToml(
         robotpy_version=robotpy_version,
-        robotpy_extras=robotpy_extras,
+        components=components,
         requires=requires,
     )