Allow to skip saving of package dependencies to the "platformio.ini" // Issue #3373

platformio/project/savedeps.py

@@ -0,0 +1,71 @@
+# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+from platformio.compat import ci_strings_are_equal
+from platformio.package.meta import PackageSpec
+from platformio.project.config import ProjectConfig
+from platformio.project.exception import InvalidProjectConfError
+
+
+def save_project_dependencies(
+    project_dir, specs, scope, action="add", environments=None
+):
+    config = ProjectConfig.get_instance(os.path.join(project_dir, "platformio.ini"))
+    config.validate(environments)
+    for env in config.envs():
+        if environments and env not in environments:
+            continue
+        config.expand_interpolations = False
+        candidates = []
+        try:
+            candidates = ignore_deps_by_specs(config.get("env:" + env, scope), specs)
+        except InvalidProjectConfError:
+            pass
+        if action == "add":
+            candidates.extend(spec.as_dependency() for spec in specs)
+        if candidates:
+            result = []
+            for item in candidates:
+                item = item.strip()
+                if item and item not in result:
+                    result.append(item)
+            config.set("env:" + env, scope, result)
+        elif config.has_option("env:" + env, scope):
+            config.remove_option("env:" + env, scope)
+    config.save()
+
+
+def ignore_deps_by_specs(deps, specs):
+    result = []
+    for dep in deps:
+        ignore_conditions = []
+        depspec = PackageSpec(dep)
+        if depspec.external:
+            ignore_conditions.append(depspec in specs)
+        else:
+            for spec in specs:
+                if depspec.owner:
+                    ignore_conditions.append(
+                        ci_strings_are_equal(depspec.owner, spec.owner)
+                        and ci_strings_are_equal(depspec.name, spec.name)
+                    )
+                else:
+                    ignore_conditions.append(
+                        ci_strings_are_equal(depspec.name, spec.name)
+                    )
+        if not any(ignore_conditions):
+            result.append(dep)
+    return result